XD714

XenApp and XenDesktop 7.
14
May 22, 20 17
What's new
Fixed issues
Known issues
T hird party notices
Deprecation
System requirements
Technical overview
Active Directory
Databases
Delivery methods
Reference Architectures
Design Guides
Implementation Guides
Install and congure

Prepare to install
Install core components
Install VDAs
Install using the command line
Install VDAs using scripts
Create a Site
Create machine catalogs
Manage machine catalogs
Create Delivery Groups
Manage Delivery Groups
Create Application Groups
Manage Application Groups
Remote PC Access
App-V
https://docs.citrix.com 1999-2017 Citrix Systems, Inc. All rights reserved. p.1

AppDisks
Local App Access and URL redirection
XenApp Secure Browser
Publish content
Server VDI
Personal vDisk
Remove components
Upgrade and migrate

Changes in 7.x
Upgrade a deployment
Migrate XenApp 6.x
Secure
Security considerations and best practices
Integrate XenApp and XenDesktop with NetScaler Gateway
Delegated Administration
Smart cards
T ransport Layer Security (T LS)
Federated Authentication Service
Print
Printing configuration example
Best practices, security considerations, and default operations
Printing policies and preferences
Provision printers
Maintain the printing environment
HDX
Adaptive transport
T hinwire
Framehawk
HDX 3D Pro
Flash Redirection
Auto client reconnect and session reliability

Host to client redirection
GPU acceleration for Windows Desktop OS
GPU acceleration for Windows Server OS
OpenGL Software Accelerator
Audio features
Network traffic priorities
USB and client drive considerations
HT ML5 multimedia redirection
Policies
Work with policies
Policy templates
Create policies
Compare, prioritize, model, and troubleshoot policies
Default policy settings
Policy settings reference
Manage
Licensing
Applications
Zones
Connections and resources
Local Host Cache
Connection leasing
Virtual IP and virtual loopback
Delivery Controllers
VDA registration with Controllers
Sessions
Use Search in Studio
T ags
IPv4/IPv6 support
Client folder redirection
User profiles
Citrix Insight Services

Monitor
Session Recording
Configuration Logging
Event logs
Director
Advanced configuration
Monitor deployments
Alerts and notifications
Delegated Administration and Director
Secure Director deployment
Configure permissions for VDAs earlier than XenDesktop 7
Configure network analysis
T roubleshoot user issues
T roubleshoot applications
T roubleshoot machines
SDKs and APIs

Monitor Service OData API
FIPS Sample Deployments
Citrix SCOM Management Pack for XenApp and XenDesktop
Citrix SCOM Management Pack for License Server

What's new
Jun 0 8 , 20 17
Important notice about XenApp and XenDesktop

7.14.1
If you downloaded the XenApp and XenDesktop 7.14.1 ISO or 7.14.1 Virtual Delivery Agents, skip the remainder of this
notice. (Check the le name. If it includes 7.14.1, youre set.)
If you already downloaded or used the original 7.14 ISO or VDAs, follow the appropriate procedure:
If you downloaded the original XenApp and XenDesktop 7.14 ISO or 7.14 VDAs (but havent installed or upgraded any
components yet), Citrix recommends you discard those files and download version 7.14.1. (If the file name includes simply
7.14 (without the appended .1), discard that file and get the newer 7.14.1 version.)
If you already installed original 7.14 components (or upgraded to 7.14 using the original components), download the
current 7.14.1 versions and then upgrade your Delivery Controllers and VDAs. (How to upgrade.) Even if you upgraded
with the original 7.14 software and encountered no issues, Citrix still recommends you upgrade to 7.14.1. T his will help
ensure you do not encounter issues identified in the original software.
If you already upgraded your deployment with the 7.14 components and the database and site upgrade failed (leaving
your site in an unusable state), follow the guidance in the Known issues article (section: Install and upgrade with the
original version 7.14 software).
T he Known issues article lists the issues in 7.14 that are resolved in 7.14.1.
About this release

T he XenApp and XenDesktop 7.14 release includes new versions of the Windows VDAs and new versions of several XenApp
and XenDesktop core components. You can:
Install or upgrade a XenApp or XenDesktop Site
Use the ISO for this release to install or upgrade all the core components and Virtual Delivery Agents. Installing or
upgrading to the latest version allows you to use all the latest features.
Install or upgrade VDAs in an existing Site
If you have a XenApp or XenDesktop deployment, and aren't ready to upgrade your core components, you can still
use several of the latest HDX features by installing (or upgrading to) a new VDA. Upgrading only the the VDAs is often
helpful when you want to test enhancements in a non-production environment.
For instructions, see Prepare to install or Upgrade a deployment.
T he XenApp and XenDesktop download pages for this release also include updated versions of the following software. For
more information on the features and installation instructions, see the component's documentation.

StoreFront
AppDNA
Citrix Receiver for Windows
Workspace Environment Management
XenApp and XenDesktop 7.14

T he product release includes the following new and enhanced features.
Maintenance and troubleshooting with Citrix Scout
T he new Citrix Scout collects diagnostics from Delivery Controllers and VDAs. Use collections for proactive maintenance
and troubleshooting. T his new version is installed automatically when you install or upgrade a Delivery Controller or a VDA.
Collect: Runs a one-time diagnostics collection on machines you select. T hen, you upload the zip file containing the
collection to Citrix or save it locally.
Trace & Reproduce: Starts a manual trace on machines you select. T hen you re-create issues on those machines. After
re-creating the issue, the trace is stopped. T hen, Scout collects other diagnostics and uploads the zip file containing the
trace and the collection to Citrix, or saves the file locally.
Schedule: Schedules daily or weekly diagnostics collections at a specified time, on machines you select. T he zip file
containing each collection is automatically uploaded to Citrix.
For details, see Citrix Insight Services.
Citrix Smart Tools agent
When installing or upgrading a Delivery Controller, you can connect to Citrix Smart Tools (formerly Citrix Lifecycle
Management), which installs a Smart Tools agent. Smart Tools enables you to automate deployment tasks, health checks,
and power management. You can also enroll in Call Home, as in earlier releases.
T he Smart Tools page in the installation wizard replaces the Call Home page. When installing a VDA, you are prompted to
enroll in Call Home. T he wizard page is retitled Smart Tools because Call Home is a part of Smart Tools.
For details, see Citrix Insight Services.
Local Host Cache
In a VDI deployment, the number of VDAs that can be handled effectively during an outage has increased:
In a single-zone VDI deployment, up to 10,000 VDAs can be handled during an outage.
In a multi-zone VDI deployment, up to 10,000 VDAs in each zone can be handled during an outage, to a maximum of
40,000 VDAs in the site.
In earlier releases, power-managed desktop VDAs in pooled Delivery Groups that have the ShutdownDesktopsAfterUse
property enabled are placed into maintenance mode when an outage occurs. T hat remains the default behavior. Now,
you can override that default behavior by running PowerShell cmdlets for the Site and the affected Delivery Groups. If
you enable this feature, you cannot rely on power management during an outage, and the desktops might contain data
from a previous user.

For details, see Local Host Cache.
Session Recording
Session Recording includes the following new and experimental features:
Session Recording integrated into the XenApp and XenDesktop f ull product installer. With this feature, you can
install Session Recording by using the unified XenApp/XenDesktop installer. For more information, see Install, upgrade,
and uninstall Session Recording.
Load balancing f or Session Recording. T his is an experimental feature to support load balancing across the Session
Recording Servers. Citrix recommends that you leverage Citrix NetScaler for load balancing. For more information, see
Configure Session Recording with load balancing.
Director
Director includes the following new and enhanced features:
Disk Monitoring. Director provides IOPS (I/O operations per second) and disk latency measurements of Server and
Desktop OS VDAs. Both measurements are important performance measurements of a disk. T he Machine
Utilization panel is extended to display the real-time average IOPS and disk latency for a selected VDA as graphs.
Use Historical Machine Utilization to view and export the average IOPS and disk latency measurements for a selected
time period. T his data helps you troubleshoot disk-related issues on a machine.
T he Trends -> Resource Utilization tab in Director is extended to display the historical IOPS and disk latency metrics
for all VDAs in the selected Delivery Group. T he graph displays the average IOPS for the last 24 hours, last month, and
last year time periods. T he table displays the average and peak IOPS, and the disk latency per machine. T his data helps
you size and plan disk capacity.
T his feature requires Delivery Controller(s) and VDAs version 7.14 or later.
For more information, see Monitor deployments, T roubleshoot machines, and Monitoring policy settings.
GPU Monitoring. Director provides monitoring of the NVIDIA GPU infrastructure in the environment. T he Machine
Utilization panel on Director is enhanced to display real-time NVIDIA GPU monitoring graphs. T he graphs include
percentage utilization of the NVIDIA GPU, the GPU memory, and of the Encoder and the Decoder of the Server and
Desktop OS VDAs. For VDAs that access more than one GPU, the average of the GPU metrics collected from the
individual GPUs is displayed.
T his feature requires Delivery Controller(s) and VDAs version 7.14 or later. GPUs are monitored on VDAs running 64-bit
Windows, with NVIDIA T esla M60 GPUs and running Display Driver version 369.17 or later.
For more information, see Monitor deployments, and T roubleshoot machines.
Multi-type licensing
Multi-type licensing supports consumption of different license types for Delivery Groups on a single XenApp or XenDesktop
site. Type is a single combination of Product ID (XDT, MPS) and Model (UserDevice, Concurrent). If multi-type licensing is not
congured, different license types can be used only when congured on entirely separate sites. For details, see Multi-type
licensing.
Virtual Delivery Agents (VDAs) 7.14

Version 7.14 of the VDA for Server OS and the VDA for Desktop OS include the following enhancements to HDX
technologies:

Update to the auto-created client printers setting. T he Printer driver mapping and compatibility setting is
configured to exclude Microsoft OneNote and XPS Document Writer from the auto-created client printers list.
Audio volume persistence. In XenApp, any previous playback volume settings are not lost when you reconnect to a
session. For XenDesktop, to restore the volume settings when reconnecting, use the Audio volume persistence tool.
See https://support.citrix.com/article/CT X206888.
Tablet mode in Windows 10 using Windows Continuum. Windows 10 introduced the tablet mode enhanced user
experience. Our tablet mode supports touch screen devices like phones, tablets, and laptops and optimizes the look and
behavior of the apps. When you start a VDA on a touch screen device, the Start screen, and all apps you start,
automatically display in tablet mode. All Citrix Receiver platforms support tablet mode. T ablet mode is enabled by default
on touch-enabled devices. For more information, see Tablet mode for touch screen devices in the HDX article.
VDA installation and upgrades:
T he 7.14 VDAs contain several new and enhanced features, as described in this section. However, after upgrading your
VDAs from version 7.9, 7.11, 7.12, or 7.13, you do not need to update the machine catalog's functional level. T he default
(7.9 (or newer ...)) remains the current functional level. For information, see VDA versions and functional levels.
StoreFront 3.11
StoreFront 3.11 includes a number of xed and known issues.
Citrix Licensing 11.14

Citrix Licensing 11.14 contains new features and xed and known issues.

Fixed issues
Jun 0 8 , 20 17
T he following issues have been xed since Version 7.13:
Fixed issues from 7.14 to 7.14.1

Several issues were resolved in the 7.14.1 XenApp and XenDesktop ISO and VDAs. T hose issues might have occurred if you
used the original 7.14 ISO and VDAs. Citrix recommends that you use only the 7.14.1 ISO and VDAs to install or upgrade
your deployment. If you installed or upgraded your deployment with the original 7.14 ISO and VDAs, the new 7.14.1 versions
contain xes for the following issues.
After an upgrade, Director displays a Central Configuration Service alert.
[#DNA-43728]
Published applications might fail to launch.
[#HDX-9224]
When using a machine catalog in Azure with write back cache enabled, VDAs fail to register with a Delivery Controller.
[#DNA-43545]
A Citrix Receiver logon delay occurs when the Wait for printers to be created (server desktop) policy setting is enabled.
[#HDX-9358]
An upgrade stops with the message Failed to upload database scripts and the site is inoperable. T his issue requires
manual intervention before upgrading the Controllers and VDAs to 7.14.1. See Known issues.
[#DNA-43730]
For more information about the 7.14.1 and 7.14 software, see Whats new and Known issues.
AppDNA
App-V
T he Delivery Controller for XD 7.6 CU3 does not allow the App-V Management Server URL and the Publishing Server URL
to be specified in IP format (such as http://172.16.56.185:8080/).
[#DNA-37971]
If an App-V application in an isolation group does not close down properly, future launches that depend on other
applications assigned to an isolation group with that application might fail.

[#DNA-24270]
When you have multiple App-V packages with the same package ID but different version IDs, and add an application
from one of those packages to a Delivery Group, applications from the other packages also appear to be assigned to
that Delivery Group in the Studio App-V Publishing node. T he applications from other packages are not actually added to
the Delivery Group.
[#DNA-23490]
Citrix Director
Attempts to reset the Citrix user profile using Citrix Director might fail, resulting in the following error message:
"T he reset process could not be initiated."
T he issue occurs when Citrix Director sends only the user name instead of sending the user name along with the domain
name. As a result, the Citrix Broker Service fails to locate the user in the DDC domain.
[#LC6681]
T he table data on the Filters > Application Instances page can be incomplete when you apply filters: data related to
some application instances might be missing.
[#DNA-28603]
T he table data on the Trends > Sessions page can be incomplete: data related to some sessions might be missing.
[#DNA-28604]
Citrix Policy
T he w3wp.exe process can consume 100% of the CPU.
[#LC4355]
Citrix Studio
If you remove an existing published App-V package from Citrix Studio and attempt to add a different version of the
same App-V package with the same name and publishing location to the Delivery Group, the package might enumerate
with a red exclamation point and the following error message appears:
"Failed to load application data for the application "APPLICAT ION NAME""
[#LC6254]
Attempts to publish an App-V package that contains certain third-party applications with multiple le type associations

might fail, resulting in the following error message:
"Cannot validate argument on parameter 'ExtensionName'. T he character length of the 28 argument is too long.
Shorten the character length of the argument so it is fewer than or equal to "16" characters, and then try the command
again."
T he issue occurs when you attempt to add the App-V package to Citrix Studio.
[#LC6507]
Attempts to add a Delivery Controller in a mirrored database setup by using the option to add an additional controller
from Citrix Studio and the PowerShell command "Add-XDController" might fail.
[#LC6563]
When you attempt to add virtual machines to a Citrix Provisioning Services catalog in Citrix Studio, the following error
message might appear:
"T he machine "virtual machine name is already in a Machine Catalog."
[#LC6944]
When upgrading a XenApp Site, the license model might change from XenApp to XenDesktop unexpectedly.
[#LC6981]
T he "Start-Transcript" command might fail for "Get-XDSite" and other XenDesktop high level administrative PoSH
commands when run in PowerShell 5.
[#LC7006]
Controller
Extraneous characters might appear at the end of "Service Display Name" and "Service description" of certain Citrix
services installed on a Japanese operating system.
[#LC5208]
After restarting the Citrix Monitoring Service or the Citrix Delivery Controller, event id 1013 might appear:
"Initial database housekeeping failed with: System.NullReferenceException: Object reference not set to an instance of
an object."
T he issue occurs when the Citrix Monitor Service is stopping.
[#LC6438]
T he Conguration Logging Service might consume high memory, causing the Delivery Controller to become unresponsive.
[#LC6480]
Attempts to use certain third-party applications such as RayStation on a Citrix Delivery Controller might fail and the
following error message appears:

"T he communication object, System.ServiceModel.Channels.ServiceChannel, cannot be used for communication because
it is in the Faulted state."
[#LC6552]
Attempts to add a Delivery Controller in a mirrored database setup by using the option to add an additional controller
from Citrix Studio and the PowerShell command "Add-XDController" might fail.
[#LC6563]
Attempts to delete virtual machines that are created by Machine Creation Services can cause Citrix Studio to become
unresponsive.
[#LC6581]
When using version 7.12 of Machine Creation Services to create VMs, XenTools fails to be installed, preventing graceful
shutdown of the VMs.
[#LC6769]
Permissions to publish App-V packages might be denied for administrators who do not have full permission with the
following exception:
"Citrix.Console.Models.Exceptions.PermissionDeniedException: You do not have the required permissions to perform this

operation."
[#LC6897]
When you attempt to add virtual machines to a Citrix Provisioning Services catalog in Citrix Studio, the following error
message might appear:
"T he machine "virtual machine name is already in a Machine Catalog."
[#LC6944]
Attempts to run a PowerShell script might fail due to missing parameters.
[#LC6953]
When upgrading a XenApp Site, the license model might change from XenApp to XenDesktop unexpectedly.
[#LC6981]
T he "Start-Transcript" command might fail for "Get-XDSite" and other XenDesktop high level administrative PoSH
commands when run in PowerShell 5.
[#LC7006]
T his x addresses a memory issue in Citrix Host Service.
[#LC7516]

HDX MediaStream Flash Redirection
With compatibility view enabled in Microsoft Internet Explorer, certain third-party websites with Flash content might not
work.
[#LC7513]
Licensing
Prole Management
StoreFront
VDA for Desktop OS

HDX MediaStream Flash Redirection
With compatibility view enabled in Microsoft Internet Explorer, certain third-party websites with Flash content might not
work.
[#LC7513]
Keyboard
With HDX 3D Pro enabled on a VDA, the keyboard shortcuts "Alt+p" and "Alt+s" might not work.
[#LC6826]
Printing
Printer redirection might fail intermittently.
[#LC5320]
When you attempt to print two copies or more of a document, only one copy might print. T he issue occurs if "Use only
printer model specic drivers" is congured in the Citrix policy "Universal print driver usage" and if "Enabled with no fallback
to Windows' native remote printing" is congured in the Citrix policy "Universal Print Server enable."
[#LC6023]
Security Issues
Reconnecting a locked and disconnected session automatically unlocks the desktop without prompting for
authentication.

[#LC6904]
Session/Connection
When you log on to a VDA where a user prole does not exist, a black screen might appear after the Windows Welcome
screen is displayed for a period of time before the logon completes.
[#LC2397]
When you attempt to send video in a Cisco WebEx meeting by using a webcam through Citrix Receiver for Mac, the
Cisco WebEx meeting might exit unexpectedly.
[#LC5518]
When switching between full-screen and windowed mode in published seamless applications, the applications might
become unresponsive if any one of the applications is in the unresponsive state.
[#LC5774]
When you attempt to download a le by using Citrix Receiver for HT ML5, the download window might not be correctly
focused. As a result, you cannot select the le that is to be downloaded. As a workaround, minimize the main application
window to view the download window from Citrix Receiver for HT ML5.
[#LC6167]
Attempts to disconnect from a RemotePC session running on a touch-enabled device can result in a black screen that
cannot be recovered.
[#LC6384]
Citrix Receiver for Linux might not support Spanish DNIe identity cards.
[#LC6547]
When you disconnect and reconnect to a Citrix Receiver for Mac session several times while playing, the audio might not
work.
[#LC6678]
T he server idle timer does not reset Citrix Receiver for iOS devices with the multi-touch feature enabled.
[#LC6743]
End User Experience Monitoring (EUEM) might stop collecting metrics when the number of virtual channels exceeds 32.
T he issue occurs when EUEM uses a constant value of 32 for the maximum number of virtual channels supported, which
causes an exception while creating counters. As a result, EUEM stops collecting metrics.
[#LC6768]
With "Application Lingering" congured for the Delivery Group, published applications occasionally fail to appear when
you reconnect to a session.
[#LC7405]

A gray screen might appear when using legacy graphics mode on a XenDesktop 7.13 Windows 7 VDA.
[#LC7477]
System Exceptions
VDAs can experience a fatal exception on wdica.sys, displaying a blue screen.
[#LC6883]
T he VDA for Server OS might experience a fatal exception on T DICA.sys, displaying a blue screen.
[#LC6898]
User Experience
Certain .wmv les might not play at the correct aspect ratio.
[#LC4695]
A USB device instance path might have additional characters at the end of the path name when the device is redirected
on VDA 7.6.300 for Desktop OS. To change this behavior, add the Product ID (PID) or Vendor ID (VID) to the following
registry key:
HKEY_LOCAL_MACHINE\SYST EM\CurrentControlSet\Services\icausbb\
Parameters
Name: DeviceInstanceIDOption
Type: REG_MULT I_SZ
Value: 0 (default value), 1, 2.
If "DeviceInstanceIDOption" is configured to "zero" (0 - default value), devices whose VID/PID pairs is configured to
"UsingSerialNumberDevices" use the serial number as the instance id. Other devices use
"serial_number+Bus_number+port_number" as the instance ID.
If "DeviceInstanceIDOption" is configured to "1," devices whose VID/PID pairs is configured to
"UsingSerialNumberDevices" use "serial_number+Bus_number+port_number" as the instance ID. Other devices use the
serial number as the instance ID.
If "DeviceInstanceIDOption" is configured to "2," all devices use the serial number as the instance ID.
All other values are invalid and treated as "zero."
[#LC6212]
User Interf ace
With the "Automatic keyboard display" policy set to enabled and the "Launch touch-optimized desktop" policy set to
prohibited, starting a published desktop from an iPad can cause the document viewer to display at 80%. When you close
certain applications on the desktop, the document viewer can display at 100%.
[#LC6460]
VDA for Server OS

Installing, Uninstalling, Upgrading
After upgrading from VDA 7.11 for Desktop OS to VDA 7.12 for Desktop OS, the following error message might appear
while launching certain applications:
"wfapi.dll is missing"
[#LC6874]
Printing
Printer redirection might fail intermittently.
[#LC5320]
When you attempt to print two copies or more of a document, only one copy might print. T he issue occurs if "Use only
printer model specic drivers" is congured in the Citrix policy "Universal print driver usage" and if "Enabled with no fallback
to Windows' native remote printing" is congured in the Citrix policy "Universal Print Server enable."
[#LC6023]
Session/Connection
When you log on to a VDA where a user prole does not exist, a black screen might appear after the Windows Welcome
screen is displayed for a period of time before the logon completes.
[#LC2397]
COM port mapping can intermittently fail upon reconnection when the group policy calculation is disabled in the registry.
[#LC5274]
When you attempt to send video in a Cisco WebEx meeting by using a webcam through Citrix Receiver for Mac, the
Cisco WebEx meeting might exit unexpectedly.
[#LC5518]
When switching between full-screen and windowed mode in published seamless applications, the applications might
become unresponsive if any one of the applications is in the unresponsive state.
[#LC5774]
An additional published application window might open when reconnecting to a session.
[#LC5786]
T he VDA for Server OS can become unresponsive. As a result, user sessions might fail to log off.
[#LC6117]
When you attempt to download a le by using Citrix Receiver for HT ML5, the download window might not be correctly
focused. As a result, you cannot select the le that is to be downloaded. As a workaround, minimize the main application
window to view the download window from Citrix Receiver for HT ML5.
[#LC6167]

A non-operational XenApp session might be created when a Remote Desktop session takes over a console session on a
VDA for Server OS.
[#LC6617]
Microsoft Internet Explorer 11 might not use the virtual IP loopback address assigned to that session.
[#LC6622]
When you disconnect and reconnect to a Citrix Receiver for Mac session several times while playing, the audio might not
work.
[#LC6678]
T he server idle timer does not reset Citrix Receiver for iOS devices with the multi-touch feature enabled.
[#LC6743]
End User Experience Monitoring (EUEM) might stop collecting metrics when the number of virtual channels exceeds 32.
T he issue occurs when EUEM uses a constant value of 32 for the maximum number of virtual channels supported, which
causes an exception while creating counters. As a result, EUEM stops collecting metrics.
[#LC6768]
When you launch a session in windowed mode in a published desktop and span the desktop through six monitors or
more, the taskbar or the screen might become gray.
[#LC6862]
After setting Google Chrome as the default browser, Microsoft Internet Explorer might continue to be the default
browser when you click URLs within applications.
[#LC6948]
When you launch the 64-bit version of Mozilla Firefox in a remote session and the Electrolysis (e10s) feature is enabled,
the second refox.exe process might exit unexpectedly, leaving the rst refox.exe process running in a diminished state.
[#LC6982]
With "Application Lingering" congured for the Delivery Group, published applications occasionally fail to appear when
you reconnect to a session.
[#LC7405]
System Exceptions
T he service host process (Svchost.exe) that hosts Terminal Services might exit unexpectedly. T he issue occurs because of
the faulting module, RPM.dll.
[#LC6277]
Servers might experience a fatal exception, displaying a blue screen, on picadm.sys with bugcheck code 0x22.
[#LC6669]

VDAs can experience a fatal exception on wdica.sys, displaying a blue screen.
[#LC6883]
T he VDA for Server OS might experience a fatal exception on T DICA.sys, displaying a blue screen.
[#LC6898]
User Experience
Certain .wmv les might not play at the correct aspect ratio.
[#LC4695]
A USB device instance path might have additional characters at the end of the path name when the device is redirected
on VDA 7.6.300 for Desktop OS. To change this behavior, add the Product ID (PID) or Vendor ID (VID) to the following
registry key:
HKEY_LOCAL_MACHINE\SYST EM\CurrentControlSet\Services\icausbb\
Parameters
Name: DeviceInstanceIDOption
Type: REG_MULT I_SZ
Value: 0 (default value), 1, 2.
If "DeviceInstanceIDOption" is configured to "zero" (0 - default value), devices whose VID/PID pairs is configured to
"UsingSerialNumberDevices" use the serial number as the instance id. Other devices use
"serial_number+Bus_number+port_number" as the instance ID.
If "DeviceInstanceIDOption" is configured to "1," devices whose VID/PID pairs is configured to
"UsingSerialNumberDevices" use "serial_number+Bus_number+port_number" as the instance ID. Other devices use the
serial number as the instance ID.
If "DeviceInstanceIDOption" is configured to "2," all devices use the serial number as the instance ID.
All other values are invalid and treated as "zero."
[#LC6212]
User Interf ace
With the "Automatic keyboard display" policy set to enabled and the "Launch touch-optimized desktop" policy set to
prohibited, starting a published desktop from an iPad can cause the document viewer to display at 80%. When you close
certain applications on the desktop, the document viewer can display at 100%.
[#LC6460]
Virtual Desktop Components - Other

T he App-V application can be started only by a single user. Attempts by another user to start the same application on
the same server might fail.
[#LC6414]

App-V-sequenced applications might not be contained within the actual App-V package even if they are referenced by
the package (InTarget=False.) As a result, the application launch does not apply to any dependent Connection Groups
that are required for that application to function correctly.
[#LC6534]
Attempts to launch App-V applications from a mapped drive might fail.
[#LC6961]
Other xed issues

T he VDA installer always warns about failed connection to Controller, even when connection test is successful.
[#DNA-17822]
If you are using MCS I/O Optimization for a catalog containing 32-bit Windows machines, configuring a RAM Cache
greater than the default 256 MB can cause the OS to stop.
[#DNA-35054]
If you enable the Citrix Personalization for App-V - VDA check box, the "Citrix AppDisk / Personal vDisk" components are
automatically selected.
[#DNA-29658]
If you install Studio (by itself) on a Windows 7 or Windows Server 2008 R2 machine, the installation fails.
[#DNA-34355]
Citrix Kerberos authentication (CtxAuth) does not work for VDAs installed on Windows Server 2016 machines that have
the Microsoft KB3213986 updates.
[#HDX-7402]

Known issues
Jun 0 8 , 20 17
T he following warning applies to any workaround that suggests changing a registry entry.
Warning
Editing the registry incorrectly can cause serious problems that may 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.
Install and upgrade with the original version 7.14

software
If you installed or upgraded your deployment with the original 7.14 components, some of the following issues might occur.
Citrix recommends you avoid these issues by downloading and then upgrading your deployment with the 7.14.1 ISO and
VDAs. (T he rst item below is an exception, requiring a manual intervention before the upgrade to 7.14.1.) For more
information about 7.14.1, see the important notice at the beginning of the Whats new article.
If an upgrade stops with the message Failed to upload database scripts, and your site is inoperable, run the following
PowerShell cmdlets on every Delivery Controller in your Site:
asnp citrix*
Get-TrustDBConnection (veries you are xing this issue)
Set-TrustDBConnection $null (value should already be NULL, but does no harm)
Get-CongDBConnection (not required, but does no harm)
$cs = Get-CongDBConnection
Set-TrustDBConnection DBConnection $cs
After running the cmdlets on all Controllers, launch Studio and proceed with a manual database and site upgrade.
After the database and site upgrade complete successfully, Citrix recommends upgrading Controllers and VDAs again,
this time to version 7.14.1.
[#DNA-43730]
After an upgrade, Director displays a Central Configuration Service alert. You can safely ignore this alert. T he issue does
not impact site operations. However, Citrix recommends upgrading again to version 7.14.1.
[#DNA-43728]
Published applications might fail to launch. Citrix Receiver does not move past the launching application stage.
Resolution: Upgrade the Controllers and VDAs to version 7.14.1.
[#HDX-9224]

When using a machine catalog in Azure with write back cache enabled, VDAs fail to register with a Delivery Controller.
[#DNA-43545]
A Citrix Receiver logon delay occurs when the Wait for printers to be created (server desktop) policy setting is enabled.
(#HDX-9358]
XenApp and XenDesktop

T he XenApp and XenDesktop 7.14 release contains the following issues:
Install and upgrade
Group policies in Citrix Studio are missing if the UPM - Software\Microsoft\Speech_OneCore policy under Prof ile
Management > Registry > Def ault Exclusions was configured before upgrading the Delivery Controller from 7.11 to
7.14, from 7.12 to 7.14, or from 7.13 to 7.14. As a workaround, remove the policy before upgrading the Delivery
Controller.
[#UPM-538]
When upgrading a XenDesktop 5.6 deployment to XenDesktop 7.14, group policy is missing. As a workaround, first
upgrade from XenDesktop 5.6 to XenDesktop 7.13. T hen upgrade from 7.13 to 7.14.
[#DNA-40976]
After upgrading Controllers, the power state of a VDA might indicate "Unknown." As a workaround, restart the
Controllers.
[#DNA-37756]
When installing a Controller and you select I want to connect to Smart Tools and Call Home on the Smart Tools
page of the installation wizard, Call Home might not be enabled. As a workaround, either use the schedule feature in
Citrix Scout or enable Call Home using PowerShell.
[#CAM-9907]
When installing a Delivery Controller on Windows Server 2012 R2 or Windows Server 2016, if you choose to connect to
Smart T ools, and have more than one organization linked with your Citrix Cloud account, the logon process may not
complete after you enter your Citrix Cloud credentials. As a workaround, complete one of the following:
Ensure the Windows Server and Internet Explore have the latest updates.
Clear the Internet Explore browser option: Internet Options > Security > Local Intranet > Sites > Include all sites that
bypass the proxy server.
[#CAM-9816]
App-V
When you select machines and add them to existing Delivery Groups, Studio allows you to add machines from

incompatible Machine Catalogs to the same Delivery Group. (If you first select a Delivery Group and add machines to it,
Studio correctly prevents machines from incompatible Machine Catalogs being added.)
[#DNA-39589]
In Studio, when deleting one or more App-V applications from the Applications node, or from a selected Delivery Group,
the message "An unknown error occurred" appears. You can safely ignore the message; the applications are deleted.
[#DNA-29702]
Director
T he Monitoring Group Policies - Enable monitoring of application f ailures, Enable monitoring of application
f ailures on Desktop OS VDAs, and Enable monitoring of application f ailures on Desktop OS VDAs are not
functional in XenApp and XenDesktop version 7.14.
[#DNA-42998]
General
During logon or logoff on a Windows 10 or Windows Server 2016 machine, the operation may pause and appear to be
hung. Click in the session window to resume the operation.
[#DNA-22958]
When Local Host Cache is enabled, users with desktop connections might be unable to reconnect to the desktop during
an outage. If this occurs, restart the Citrix High Availability Service.
[#DNA-22957]
Published content will not start successfully when initiated from Citrix Receiver. Content launched through the
StoreFront web client (or Web Interface) launches as expected.
[#LC6316]
When you're using Windows Media Player with Remote Audio & Video Extensions (RAVE) enabled inside a session, if you
right click the video content and select Always show Now Playing on top, a black screen displays.
[#HDX-4853]
If there are stale DNS entries for the NetScaler Gateway virtual server on the client device, adaptive transport and
Framehawk might fall back to T CP transport instead of UDP transport.
As a workaround, flush DNS cache on the client and reconnect to establish the session using UDP transport.
[#HDX-7441]
You create an RDS machine catalog and Delivery Group and you enable the Enhanced Desktop Experience policy setting
on the server. When you restart the RDS server and start an RDS hosted desktop with a non-administrator user using
BGinfo, the wallpaper might not update as expected. Workaround: Do not use BGinfo.

[#HDX-8881]
After the adaptive transport policy is changed, some Delivery Group sessions might be disconnected. T he user can
successfully reconnect but might be disconnected again if the adaptive transport policy changes.
[#HDX-8812]
Other components
Components available separately on the XenApp and XenDesktop download pages have the following known issues.
Session Recording
Attempts to install or upgrade to Session Recording Version 7.14 using the XenApp and XenDesktop full product installer
fail on Windows Server 2008 and the following error message appears: "Microsoft Message Queuing failed".
As a workaround, use the msi package for fresh installations or upgrades. For more information, see Install, upgrade, and
uninstall Session Recording.
[SRT -1782]
When you upgrade Session Recording Administration from 7.6 to 7.13 or later and choose Modif y in Session Recording
Administration to add the Administrator Logging service, the SQL Server instance name does not appear on the
Administrator Logging Configuration page. T he following error message appears when you click Next: "Database
connection test failed. Please enter correct Database instance name".
As a workaround, add the read permission for localhost users to the following SmartAuditor Server registry folder:
(HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\SmartAuditor\Server).
[SRT -1334]
When Machine Creation Services (MCS) or Provisioning Services (PVS) creates multiple VDAs with the configured master
image and Microsoft Message Queuing (MSMQ) installed, those VDAs can have the same QMId under certain
conditions. T his might cause various issues, for example:
Sessions might not be recorded even if the recording agreement is accepted.
T he Session Recording Server might not be able to receive session logoff signals and consequently, sessions might
always be in Live status.
For information about a workaround, see here.
[#528678]
When you change your XenApp or XenDesktop license type, the change might not take effect immediately for Session
Recording.
As a workaround, restart your VDA machine.
[#532393]

T he installation of the Session Recording Server components fails with error codes 2503 and 2502.
As a workaround, check the access control list (ACL) of the folder C:\windows\T emp to ensure that users under Local
Users and Groups > Groups > Users have write permission to the folder. If necessary, add the write permission
manually.
[#611487]
Attempts by a user who has the securityadmin and dbcreator permissions to SQL Server to reinstall the Administrator
Logging database might fail if the Administrator Logging database was previously installed by a different user who has
the same or greater permissions to the SQL Server.
As a workaround, reinstall the Administrator Logging database with a user account that has the sysadmin permission to
the SQL Server.
[#655644]
Citrix Licensing 11.14
For the Citrix Licensing 11.14 known issues and fixed issues, see the Citrix Licensing known and fixed issues.

Third party notices
May 22, 20 17
T his release of XenApp and XenDesktop may include third party software licensed under the terms dened in the following
documents:
PDF XenApp and XenDesktop Third Party Notices
PDF Non-Commercial Software Disclosure For FlexNet Publisher 2016 R1 (11.14.0.0)
PDF FLEXnet Publisher Documentation Supplement: Open Source Software Licenses

applicable to FlexNet Publisher 11.14.0
PDF Session Recording Third Party Notices

Deprecation
Jun 0 1, 20 17
T he announcements in this article are intended to give you advanced notice of platforms, Citrix products, and features
which are being phased out so that you can make timely business decisions. Citrix monitors customer use and feedback to
determine when they are withdrawn. T his list is subject to change in subsequent releases and may not include every
deprecated feature or functionality.
T he following platforms, Citrix products, and features are deprecated. T his does not mean that they are removed
immediately. Citrix will continue to support them up to and including the next XenApp and XenDesktop Long Term Service
Release (LT SR) release. Deprecated items will be removed in a Current Release following the next LT SR. Alternatives for
deprecated items are suggested where possible.
For complete details about product lifecycle support, see the Product Lifecycle Support Policy article.
Item Announced in Alternative
Citrix Online Integration (Goto product) with 7.14

StoreFront.
In-place upgrades from StoreFront 2.0, 2.1, 2.5, 7.13 Upgrade from one of these versions to a later
and 2.5.2. supported version and then to XenApp and
XenDesktop 7.13.
In-place upgrades from XenDesktop 5.6 or 5.6 7.12 Migrate your XenDesktop 5.6 or 5.6 FP1
FP1. deployment to the current XenDesktop version.
VDAs on Windows 8.1 and earlier Windows 7.12 Install desktop OS VDAs on Windows 10.
desktop releases.
VDAs on Windows Server 2008 R2. 7.12 Install server OS VDAs on supported versions such
as Windows Server 2012 R2 or Windows Server
2016.
XenDesktop 5.6 used on Windows XP. No VDA 7.12 Install VDAs on a supported Windows version.
installations on Windows XP will be supported.
CloudPlatform connections. 7.12 Use a different supported hypervisor or cloud

service.
Azure Classic (also known as Azure Service 7.12 Use Azure Resource Manager.
Management) connections.

Installing core components (other than Studio) 7.12 Use 64-bit machines.
on 32-bit machines: Delivery Controller,
Director, StoreFront, and License Server.
Connection leasing. 7.12 Use Local Host Cache.
Legacy T hinwire mode 7.12 Use T hinwire.
Desktop Composition Redirection (DCR) 7.12
AppDisk
Citrix is replacing the AppDisk functionality provided by XenApp and XenDesktop with recently acquired technology from
Unidesk. During this transition time, Citrix continues to maintain current support levels as described in XenApp and
XenDesktop Servicing Options.
Removed
T he following platforms, Citrix products, and features are either removed in XenApp and XenDesktop 7.14 or are no longer
supported in XenApp and XenDesktop 7.14.
Item Replacement
T he user account, CtxAppVCOMAdmin which was created during VDA T he Windows service CtxAppVService
installation and added to the Local Administrators Group on the VDA performs the same function. It is
machine, is no longer created. T he underlying "COM" mechanism is also automatically installed and configured and
removed. requires no user interaction.
T he Universal Print Server UpsServer component is no longer supported

Use one of the other supported platforms.
on Windows Server 2008 32-bit.

System requirements
May 30 , 20 17
In this article:
Introduction
Delivery Controller
Databases
Citrix Studio
Citrix Director
Virtual Delivery Agent (VDA) for Desktop OS
Virtual Delivery Agent (VDA) for Server OS
Hosts / virtualization resources
Active Directory functional levels
HDX
Session Recording
Universal Print Server
Other
Introduction
T he system requirements in this document were valid when this product version released; updates are made periodically.
System requirements components not covered here (such as StoreFront, host systems, Citrix Receivers and plug-ins, and
Provisioning Services) are described in their respective documentation.
Important: Review the Prepare to install article before beginning an installation.
Unless otherwise noted, the component installer deploys software prerequisites automatically (such as .NET and C++
packages) if the required versions are not detected on the machine. T he Citrix installation media also contains some of this
prerequisite software.
T he installation media contains several third-party components. Before using the Citrix software, check for security
updates from the third party, and install them.
For globalization information, see CT X119253.
For XenApp and XenDesktop components and features that can be installed on Windows Servers, Server Core and Nano
Server installations are not supported, unless specically noted.
For components and features that can be used on Windows 10 machines, the following Windows 10 servicing options and
editions are supported:
Current Branch for Business (CBB): Pro, Enterprise, Education, Mobile Enterprise (the IoT Core Pro Edition is supported
only for Citrix Receiver)
Long T erm Service Branch (LT SB): LT SB
Current Branch (CB): Not supported

Hardware requirements
RAM and disk space values are in addition to requirements for the product image, operating system, and other software on
the machine. Your performance will vary, depending on your conguration. T his includes the features you use, plus the
number of users, and other factors. Using only the minimum can result in slow performance.
For example, the amount of disk space needed on the Controller for connection leasing (which is enabled by default)
depends on the number of users, applications, and the mode: 100,000 RDS users with 100 recently-used applications require
approximately 3 GB for connection leases; deployments with more applications may require more space. For dedicated VDI
desktops, 40,000 desktops require at least 400-500 MB. In all cases, Citrix suggests providing several GBs of additional
space.
T he following table shows the minimum requirements for core components.
Component Minimum
All core components on one server, for an evaluation only, 5 GB RAM

not a production deployment
All core components on one server, for a test deployment 12 GB RAM

or a small production environment
Delivery Controller 5 GB RAM
(more disk space required if a high availability feature such 800 MB hard disk
as connection leasing is enabled)
Database: see the Sizing guidance article
Studio 1 GB RAM
100 MB hard disk
Director 2 GB RAM
200 MB hard disk
StoreFront 2 GB RAM
See the StoreFront documentation for disk

recommendations
License Server 2 GB RAM
See the Licensing documentation for disk

recommendations

Sizing of VMs that deliver desktops and applications
Specic recommendations cannot be provided because of the complex and dynamic nature of hardware offerings, and
every XenApp and XenDesktop deployment has unique needs. Generally, sizing a XenApp VM is based on the hardware and
not the user workloads (except for RAM; you'll need more RAM for applications that consume more).
T he Sizing XenApp Windows 2012 R2 Virtual Machines blog post contains sizing considerations.
T he Citrix Synergy 2016 video (start at 1:15:00) discusses differences between sizing VMs to deliver applications and sizing
to deliver desktops. It also covers scalability estimates: how many users to expect from a single server. Although based
on a shared desktop model, the tests measure capacity to reach maximum CPU utilization, using one application at a
time. Changing applications should have minimal impact on overall density.
Delivery Controller
Supported operating systems:
Windows Server 2016, Standard and Datacenter Editions

Windows Server 2012 R2, Standard and Datacenter Editions
Windows Server 2008 R2 SP1, Standard, Enterprise, and Datacenter Editions
Requirements:
Microsoft .NET Framework 3.5.1 (Windows Server 2008 R2 only).

Microsoft .NET Framework 4.5.2 (4.6, 4.6.1, 4.6.2, and 4.7 are also supported).
Windows PowerShell 2.0 (included with Windows Server 2008 R2) or 3.0 (included with later supported Windows Server
versions).
Microsoft Visual C++ 2015 Runtime, 32- and 64-bit.
Databases
Supported Microsoft SQL Server versions for the Site Conguration, Conguration Logging, and Monitoring databases:
SQL Server 2016, Express, Standard, and Enterprise Editions.

SQL Server 2014 through SP2, Express, Standard, and Enterprise Editions. By default, SQL Server 2014 SP2 Express is
installed when installing the Controller, if an existing supported SQL Server installation is not detected.
SQL Server 2012 through SP3, Express, Standard, and Enterprise Editions.
SQL Server 2008 R2 SP2 and SP3, Express, Standard, Enterprise, and Datacenter Editions.
T he following database high availability solutions are supported (except for SQL Server Express, which supports only
standalone mode):
SQL Server AlwaysOn Failover Cluster Instances

SQL Server 2012 AlwaysOn Availability Groups
SQL Server Database Mirroring

Windows authentication is required for connections between the Controller and the SQL Server Site database.
When installing a Controller, a SQL Server Express database is installed by default for use with the Local Host Cache
feature. T his installation is separate from the default SQL Server Express installation for the Site database.
For more information, see the following articles:
Databases
CT X114501
Database sizing guidance
Local Host Cache
Citrix Studio
Windows 10 (see edition support in the Introduction section)

Windows 8.1, Professional and Enterprise Editions
Windows 7 Professional, Enterprise, and Ultimate Editions
Requirements:
Microsoft .NET Framework 4.5.2 (4.6, 4.6.1, 4.6.2, and 4.7 are also supported)
Microsoft .NET Framework 3.5 SP1 (Windows Server 2008 R2 and Windows 7 only)
Microsoft Management Console 3.0 (included with all supported operating systems)
Windows PowerShell 2.0 (included with Windows 7 and Windows Server 2008 R2) or 3.0 (included with later supported
Windows versions)
Citrix Director

Requirements:
Microsoft .NET Framework 4.5.2 (4.6, 4.6.1, 4.6.2, and 4.7 are also supported).
Microsoft .NET Framework 3.5 SP1 (Windows Server 2008 R2 only)
Microsoft Internet Information Services (IIS) 7.0 and ASP.NET 2.0. Ensure that the IIS server role has the Static Content
role service installed. If these are not already installed, you are prompted for the Windows Server installation media, then
they are installed for you.

System Center Operations Manager (SCOM) integration requirements:
Windows Server 2012 R2

System Center 2012 R2 Operations Manager
Supported browsers for viewing Director:
Internet Explorer 11. (You can use Internet Explorer 10 only on Windows Server 2012 R2 machines.) Compatibility mode is
not supported for Internet Explorer. You must use the recommended browser settings to access Director. When you
install Internet Explorer, accept the default to use the recommended security and compatibility settings. If you already
installed the browser and chose not to use the recommended settings, go to T ools > Internet Options > Advanced >
Reset and follow the instructions.
Microsoft Edge.
Firefox ESR (Extended Support Release).
Chrome.
T he recommended optimal screen resolution for viewing Director is 1366 x 1024.
Virtual Delivery Agent (VDA) for Desktop OS

Windows 10, (see edition support in the Introduction section. T he following features are not supported on Windows 10:
desktop composition redirection and legacy graphics mode.
Windows 8.1, Professional and Enterprise Editions
Windows 7 SP1, Professional, Enterprise, and Ultimate Editions
Requirements:
Microsoft .NET Framework 3.5.1 (Windows 7 only)
Microsoft Visual C++ 2013 and 2015 Runtimes, 32- and 64-bit
Remote PC Access uses this VDA, which you install on physical ofce PCs. T his VDA supports Secure Boot for XenDesktop
Remote PC Access on Windows 10.
Several multimedia acceleration features (such as HDX MediaStream Windows Media Redirection) require that Microsoft
Media Foundation be installed on the machine on which you install the VDA. If the machine does not have Media
Foundation installed, the multimedia acceleration features will not be installed and will not work. Do not remove Media
Foundation from the machine after installing the Citrix software; otherwise, users will not be able to log on to the machine.
On most supported Windows desktop OS editions, Media Foundation support is already installed and cannot be removed.
However, N editions do not include certain media-related technologies; you can obtain that software from Microsoft or a
third party.
During VDA installation, you can choose the HDX 3D Pro mode of the VDA for Windows Desktop OS. T hat mode is
particularly suited for use with DirectX and OpenGL-driven applications and with rich media such as video. See the HDX 3D
Pro section for additional support information.
For Linux VDA information, see the Linux Virtual Delivery Agent articles.

To use the Server VDI feature, you can use the command line interface to install a VDA for Windows Desktop OS on a
supported server operating system. See Server VDI for guidance.
Virtual Delivery Agent (VDA) for Server OS


T he installer automatically deploys the following requirements, which are also available on the Citrix installation media in the
Support folders:
Microsoft .NET Framework 3.5.1 (Windows Server 2008 R2 only)
Microsoft Visual C++ 2013 and 2015 Runtimes, 32- and 64-bit
T he installer automatically installs and enables Remote Desktop Services role services, if they are not already installed and
enabled.
Several multimedia acceleration features (such as HDX MediaStream Windows Media Redirection) require that the
Microsoft Media Foundation be installed on the machine on which you install the VDA. If the machine does not have Media
Foundation installed, the multimedia acceleration features will not be installed and will not work. Do not remove Media
Foundation from the machine after installing the Citrix software; otherwise, users will not be able to log on to the machine.
On most Windows Server versions, the Media Foundation feature is installed through the Server Manager (for Windows
Server 2012 and later: ServerMediaFoundation; for Windows Server 2008 R2: DesktopExperience). However, N editions do
not include certain media-related technologies; you can obtain that software from Microsoft or a third party.
For Linux VDA information, see the Linux Virtual Delivery Agent articles.
Hosts / virtualization resources

Some XenApp and XenDesktop features may not be supported on all host platforms or all platform versions. For example,
AppDisks are supported with XenServer, VMware, and System Center Virtual Machine Manager hosts. See the feature
documentation for details.
CT X131239 contains additional hypervisor support information, plus links to informatin about known issues. T he
Connections and resources article lists host information sources.
T he Remote PC Access Wake on LAN feature requires Microsoft System Center Conguration Manager minimum 2012.
Supported host platf orms and virtualization environments
T he following major.minor versions are supported, including updates to those versions (such as a, b, or c releases).
XenServer

XenServer 7.2
XenServer 7.1
XenServer 7.0
XenServer 6.5 and SP1
XenServer 6.2 SP1 plus hotfixes (you must apply SP1 to enable application of future hotfixes)
XenServer 6.1
VMware vSphere (vCenter + ESXi). No support is provided for vSphere vCenter Linked Mode operation.
VMware vSphere 6.5

VMware vSphere 6.0 and Updates 1 and 2
VMware vSphere 5.5 and Updates 1 through 3
VMware vSphere 5.1 Updates 2 and 3
VMware vSphere 5.0 Updates 2 and 3
VMware vCenter 5.5 / 6 appliance
System Center Virtual Machine Manager. Includes any version of Hyper-V that can register with the supported System
Center Virtual Machine Manager versions.
System Center Virtual Machine Manager 2016

System Center Virtual Machine Manager 2012 R2
System Center Virtual Machine Manager 2012 SP1
System Center Virtual Machine Manager 2012
Nutanix Acropolis 4.5
Amazon Web Services (AWS)
You can provision applications and desktops on supported Windows server operating systems.
T he Amazon Relational Database Service (RDS) is not supported.
See Citrix XenDesktop on AWS for additional information.
CloudPlatform
T he minimum supported version is 4.2.1 with hotfixes 4.2.1-4.

Deployments were tested using XenServer 6.2 (with Service Pack 1 and hotfix XS62ESP1003) and vSphere 5.1 hypervisors.
CloudPlatform does not support Hyper-V hypervisors.
CloudPlatform 4.3.0.1 supports VMware vSphere 5.5.
See the CloudPlatform documentation (including the Release Notes for your CloudPlatform version) for
more information.
Microsoft Azure
Microsoft Azure Resource Manager
Active Directory functional levels

T he following functional levels for the Active Directory forest and domain are supported:

Windows Server 2016
Windows Server 2012
Windows Server 2008
Windows Server 2003
Windows 2000 native (not supported for domain controllers)
HDX
UDP audio for Multi-Stream ICA is supported on Receiver for Windows and Citrix Receiver for Linux 13.
Echo cancellation is supported on Citrix Receiver for Windows.
See the specic HDX feature support and requirements below.
HDX Desktop Composition Redirection
T he Windows user device or thin client must support or contain:
DirectX 9
Pixel Shader 2.0 (supported in hardware)
32 bits per pixel
1.5 GHz 32-bit or 64-bit processor
1 GB RAM
128 MB video memory on the graphic card or an integrated graphics processor
HDX queries the Windows device to verify that it has the required GPU capabilities, and then automatically reverts to
server-side desktop composition if it does not. List the devices with the required GPU capabilities that do not meet the
processor speed or RAM specications in the GPO group for devices excluded from Desktop Composition Redirection.
T he minimum available bandwidth is 1.5 Mbps; the recommended bandwidth is 5 Mbps. T hose values incorporate end-to-
end latency.
HDX Windows Media delivery
T he following clients are supported for Windows Media client-side content fetching, Windows Media redirection, and
realtime Windows Media multimedia transcoding: Citrix Receiver for Windows, Citrix Receiver for iOS, and Citrix Receiver for
Linux.
To use Windows Media client-side content fetching on Windows 8 devices, set the Citrix Multimedia Redirector as a default
program: in Control Panel > Programs > Def ault Programs > Set your def ault programs, select Citrix Multimedia
Redirector and click either Set this program as def ault or Choose def aults f or this program. GPU transcoding requires
an NVIDIA CUDA-enabled GPU with Compute Capability 1.1 or higher; see http://developer.nvidia.com/cuda/cuda-gpus.
HDX Flash Redirection
T he following clients and Adobe Flash Players are supported:
Citrix Receiver for Windows (for second generation Flash Redirection features) - Second generation Flash Redirection

features require Adobe Flash Player for Other Browsers, sometimes referred to as an NPAPI (Netscape Plugin
Application Programming Interface) Flash Player.
Citrix Receiver for Linux (for second generation Flash Redirection features) - Second generation Flash Redirection
features require Adobe Flash Player for other Linux or Adobe Flash Player for Ubuntu.
Citrix Online plug-in 12.1 (for legacy Flash Redirection features) - Legacy Flash Redirection features require Adobe Flash
Player for Windows Internet Explorer (sometimes referred to as an ActiveX player).
T he major version number of the Flash Player on the user device must be greater than or equal to the major version number
of the Flash Player on the server. If an earlier version of the Flash Player is installed on the user device, or if the Flash Player
cannot be installed on the user device, Flash content is rendered on the server.
T he machines running VDAs require:
Adobe Flash Player for Windows Internet Explorer (the ActiveX player)
Internet Explorer 11 (in non-Modern UI mode). You can use Internet Explorer versions 7-10, but Microsoft supports (and
Citrix recommends using) version 11. Flash redirection requires Internet Explorer on the server; with other browsers, Flash
content is rendered on the server.
Protected mode disabled in Internet Explorer (T ools > Internet Options > Security tab > Enable Protected Mode check
box cleared). Restart Internet Explorer to effect the change.
HDX 3D Pro
When installing a VDA for Windows Desktop OS, you can choose to install the HDX 3D Pro version.
T he physical or virtual machine hosting the application can use GPU Passthrough or Virtual GPU (vGPU):
GPU Passthrough is available with: Citrix XenServer; VMware vSphere and VMware ESX, where it is referred to as virtual
Direct Graphics Acceleration (vDGA); and with Microsoft Hyper-V in Windows Server 2016 where it is referred to as
Discrete Device Assignment (DDA).
vGPU is available with Citrix XenServer and VMware vSphere; see https://www.citrix.com/products/xenapp-
xendesktop/hdx-3d-pro.html.
Citrix recommends that the host computer have at least 4 GB of RAM and four virtual CPUs with a clock speed of 2.3 GHz
or higher.
Graphical Processing Unit (GPU):
For CPU-based compression (including lossless compression), HDX 3D Pro supports any display adapter on the host
computer that is compatible with the application being delivered.
For virtualized graphics acceleration using the NVIDIA GRID API, HDX 3D Pro can be used with supported NVIDIA GRID
cards (see NVIDIA GRID). T he NVIDIA GRID delivers a high frame rate, resulting in a highly interactive user experience.
Virtualized graphics acceleration is supported on the Intel Xeon Processor E3 Family of data center graphics platform.
For more information, see http://www.citrix.com/intel and http://www.intel.com/content/www/us/en/servers/data-
center-graphics.html
Virtualized graphics acceleration is supported with AMD RapidFire on the AMD FirePro S-series server cards (see AMD
Virtualization Solution).
User device:
HDX 3D Pro supports all monitor resolutions that are supported by the GPU on the host computer. However, for
optimum performance with the minimum recommended user device and GPU specifications, Citrix recommends a

maximum monitor resolution for user devices of 1920 x 1200 pixels for LAN connections, and 1280 x 1024 pixels for WAN
connections.
Citrix recommends that user devices have at least 1 GB of RAM and a CPU with a clock speed of 1.6 GHz or higher. Use of
the default deep compression codec, which is required on low-bandwidth connections, requires a more powerful CPU
unless the decoding is done in hardware. For optimum performance, Citrix recommends that user devices have at least 2
GB of RAM and a dual-core CPU with a clock speed of 3 GHz or higher.
For multi-monitor access, Citrix recommends user devices with quad-core CPUs.
User devices do not need a GPU to access desktops or applications delivered with HDX 3D Pro.
Citrix Receiver must be installed.
For more information, see the HDX 3D Pro articles and www.citrix.com/xenapp/3d.
HDX video conf erencing requirements f or webcam video compression
Supported clients: Citrix Receiver for Windows, Citrix Receiver for Mac, and Citrix Receiver for Linux.
Supported video conferencing applications:
Adobe Connect
Cisco WebEx
Citrix GoT oMeeting HDFaces
Google+ Hangouts
IBM Sametime
Media Foundation-based video applications on Windows 8.x, Windows Server 2012, and Windows Server 2012 R2
Microsoft Lync 2010 and 2013
Microsoft Office Communicator
Microsoft Skype 6.7
To use Skype on a Windows client, edit the registry on the client and the server:
Client registry key HKEY_CURRENT _USER\Software\Citrix\HdxRealT ime
Name: DefaultHeight , Type: REG_DWORD, Data: 240
Name: DefaultWidth, Type: REG_DWORD, Data: 320
Server registry key HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\Vd3d\Compatibility
Name: skype.exe, Type: REG_DWORD, Data: Set to 0
Other user device requirements:
Appropriate hardware to produce sound.

DirectShow-compatible webcam (use the webcam default settings). Webcams that are hardware encoding capable
reduces client-side CPU usage.
Webcam drivers, obtained from the camera manufacturer if possible.
Session Recording
Session Recording administration components

You can install the Session Recording administration components (Session Recording Database, Session Recording Server,
and Session Recording Policy Console) on a single server or on different servers.
Session Recording Database

Windows Server 2016

Windows Server 2012
Windows Server 2008 R2 SP1
Supported Microsoft SQL Server versions:
Microsoft SQL Server 2016 SP1 Enterprise, Express, and Standard editions
Requirement: .NET Framework 4.6.2 or 4.5.2.
Session Recording Server

Windows Server 2016

Windows Server 2012
Other requirements:
Internet Information Services (IIS) 10, 8.5, 8.0, or 7.5.

.NET Framework Version 4.6.2 or 4.5.2.
If the Session Recording Server uses HT T PS as its communications protocol, add a valid certificate. Session Recording
uses HT T PS by default, which Citrix recommends.
Microsoft Message Queuing (MSMQ), with Active Directory integration disabled and MSMQ HT T P support enabled.
For Administrator Logging: Latest version of Chrome, Firefox, or Internet Explorer 11.
Session Recording Policy Console

Windows Server 2016

Windows Server 2012
Requirement: .NET Framework 4.6.2, 4.5.2.
Session Recording Agent

Install the Session Recording Agent on every XenApp and XenDesktop server on which you want to record sessions.
Windows Server 2016

Windows Server 2012
Windows 10
Windows 8.1
Windows 7 SP1
Requirements:
XenApp/XenDesktop 7.14 with Platinum license

XenApp/XenDesktop 7.6.4000 with Platinum license (VDA for Windows Server OS only; VDA for Windows Desktop OS
not supported)
.NET Framework 4.6.2 or 4.5.2
Microsoft Message Queuing (MSMQ), with Active Directory integration disabled and MSMQ HT T P support enabled
Session Recording Player
Windows 10
Windows 8.1
Windows 7 SP1
Requirement: .NET Framework 4.6.2 or 4.5.2.
For optimal results, install Session Recording Player on a workstation with:
Screen resolution of 1024 x 768

Color depth of at least 32-bit
2GB RAM minimum; additional RAM and CPU/GPU resources can improve performance when playing graphics-intensive
recordings, especially when recordings contain many animations
T he seek response time depends on the size of the recording and your machine's hardware specications.
Universal Print Server

T he Universal Print Server comprises client and server components. T he UpsClient component is included in the VDA
installation. You install the UpsServer component on each print server where shared printers reside that you want to
provision with the Citrix Universal Print Driver in user sessions.
T he UpsServer component is supported on:
Windows Server 2016

Windows Server 2012 R2 and 2012

Requirement: Microsoft Visual C++ 2013 Runtime, 32- and 64-bit
For VDAs for Windows Server OS, user authentication during printing operations requires the Universal Print Server to be
joined to the same domain as the VDA.
Standalone client and server component packages are also available for download.
For more information, see Provision printers.
Other
StoreFront 3.0.1 is the minimum supported version with this release. To use the zone preference feature, you must be using
minimum StoreFront 3.7 and NetScaler Gateway 11.0-65.x.
When using Provisioning Services with this release, the minimum supported Provisioning Services version is 7.0.
Only Citrix License Server 11.14 is supported.
T he Microsoft Group Policy Management Console (GPMC) is required if you store Citrix policy information in Active
Directory rather than the Site Conguration database. If you install CitrixGroupPolicyManagement_x64.msi separately (for
example, on a machine that does not have a XenApp or XenDesktop core component installed), that machine must have
Visual Studio 2015 runtime installed. For more information, see the Microsoft documentation.
Multiple network interface cards are supported.
By default, the Citrix Receiver for Windows is installed when you install a VDA. For more information, see the Citrix Receiver
for Windows documentation.
See App-V for supported versions of Microsoft App-V.
See Local App Access for supported browser information for that feature.
See the Self-Service Password Reset documentation for support and requirements information.
Client folder redirection - Supported operating systems:
Server: Windows Server 2008 R2 SP1, Windows Server 2012, and Windows Server 2012 R2
Client (with latest Citrix Receiver for Windows): Windows 7, Windows 8, and Windows 8.1
Mixed DPIs with multi-monitors. T he use of different DPIs between monitors is not supported in Citrix XenDesktop and
XenApp environments. You can verify the DPI (% scaling) using Windows Control Panel > Display options. If using a Windows
8.1 or Windows 10 client device, enabling the Let me choose one scaling level f or all my displays option in the Windows
Control Panel > Display options will congure the monitors appropriately. For more information, see CT X201696.
T his version of XenApp and XenDesktop is not compatible with AppDNA 7.8 and AppDNA 7.9. Citrix recommends using the
current AppDNA release.

Technical overview
May 22, 20 17
In this article:
Key XenApp and XenDesktop components

How typical deployments work
How user connections are handled
How data access works
Deliver desktops and applications: Machine Catalogs, Delivery Groups, and Application Groups
XenApp and XenDesktop are virtualization solutions that give IT control of virtual machines, applications, licensing, and
security while providing anywhere access for any device.
XenApp and XenDesktop allow:

End users to run applications and desktops independently of the device's operating system and interface.
Administrators to manage the network and control access from selected devices or from all devices.
Administrators to manage an entire network from a single data center.
XenApp and XenDesktop share a unied architecture called FlexCast Management Architecture (FMA). FMA's key features
are the ability to run multiple versions of XenApp or XenDesktop from a single Site and integrated provisioning.
Key XenApp and XenDesktop components

Tip: T his article is most helpful if you're new to XenApp or XenDesktop. If you currently have a 6.x or earlier XenApp farm, or
a XenDesktop 5.6 or earlier site, take a look at the Changes in 7.x article, too.
T his illustration shows the key components in a typical XenApp or XenDesktop deployment, which is called a Site.

Delivery Controller
T he Delivery Controller is the central management component of a XenApp or XenDesktop Site. Each Site has one or
more Delivery Controllers. It is installed on at least one server in the data center. For Site reliability and availability,
Controllers should be installed on more than one server. If your deployment includes virtual machines hosted on a
hypervisor or cloud service, the Controller services communicate with the hypervisor to distribute applications and
desktops, authenticate and manage user access, broker connections between users and their virtual desktops and
applications, optimize use connections, and load-balance these connections.
T he Controller's Broker Service tracks which users are logged on and where, what session resources the users have,
and if users need to reconnect to existing applications. T he Broker Service executes PowerShell cmdlets and
communicates with a broker agent on the VDAs over TCP port 80. It does not have the option to use TCP port 443.
T he Monitor Service collects historical data and places it in the Monitor database. T his service uses TCP port 80 or
443.
Data from the Controller services is stored in the Site database.
T he Controller manages the state of desktops, starting and stopping them based on demand and administrative
conguration. In some editions, the Controller allows you to install Prole management to manage user
personalization settings in virtualized or physical Windows environments.
Database
At least one Microsoft SQL Server database is required for every XenApp or XenDesktop Site to store conguration
and session information. T his database stores the data collected and managed by the services that make up the
Controller. Install the database within your data center, and ensure it has a persistent connection to the Controller.
T he Site also uses a Conguration Logging database and a Monitoring database. By default, these are installed in the

same location as the Site database, but you can change this.
Virtual Delivery Agent (VDA)
T he VDA is installed on each physical or virtual machine in your Site that you make available to users; those machines
can deliver applications or desktops. T he VDA enables the machine to register with the Controller, which in turn allows
the machine and the resources it is hosting to be made available to users. VDAs establish and manage the connection
between the machine and the user device, verify that a Citrix license is available for the user or session, and apply
whatever policies have been congured for the session.
T he VDA communicates session information to the Broker Service in the Controller through the broker agent included
in the VDA. T he broker agent hosts multiple plugins and collects real-time data. It communicates with the Controller
over TCP port 80. It does not have the option to use TCP port 443.
T he word "VDA" is often used to refer to the agent as well as the machine on which it is installed.
VDAs are available for Windows server and desktop operating systems. VDAs for Windows server operating systems
allow multiple users to connect to the server at one time. VDAs for Windows desktop operating systems allow only
one user to connect to the desktop at a time. A Linux VDA is also available.
Citrix StoreFront
StoreFront authenticates users to Sites hosting resources, and manages stores of desktops and applications that
users access. It can host your enterprise application store, which gives users self-service access to the desktops and
applications that you make available to them. It also keeps track of users application subscriptions, shortcut names,
and other data to ensure users have a consistent experience across multiple devices.
Citrix Receiver
Installed on user devices and other endpoints (such as virtual desktops), Citrix Receiver provides users with quick,
secure, self-service access to documents, applications, and desktops from any of the user's devices, including
smartphones, tablets, and PCs. Citrix Receiver provides on-demand access to Windows, Web, and Software as a
Service (SaaS) applications. For devices that cannot install Citrix Receiver software, Citrix Receiver for HT ML5 provides
a connection through a HT ML5-compatible web browser.
Citrix Studio
Studio is the management console that enables you to congure and manage your XenApp and XenDesktop
deployment, eliminating the need for separate management consoles for managing delivery of applications and
desktops. Studio provides various wizards to guide you through the process of setting up your environment, creating
your workloads to host applications and desktops, and assigning applications and desktops to users. You can also use
Studio to allocate and track Citrix licenses for your Site.
Studio gets the information it displays from the Broker Service in the Controller, communicating over TCP port 80.

Citrix Director
Director is a web-based tool that enables IT support and help desk teams to monitor an environment, troubleshoot
issues before they become system-critical, and perform support tasks for end users. You can use one Director
deployment to connect to and monitor multiple XenApp or XenDesktop Sites.
Director displays:
Real-time session data from the Broker Service in the Controller, which includes data the Broker Service gets
from the broker agent in the VDA.
Historical Site data from the Monitor Service in the Controller.
Data about HDX trafc (also known as ICA trafc) captured by HDX Insight from the NetScaler, if your
deployment includes a NetScaler and your XenApp or XenDesktop edition includes HDX Insight.
You can also view and interact with a user's sessions through Director, using Windows Remote Assistance.
Citrix License Server
T he License Server manages your Citrix product licenses. It communicates with the Controller to manage licensing for
each user's session and with Studio to allocate license les. You must create at least one license server to store and
manage your license les.
Hypervisor or cloud service
T he hypervisor or cloud service hosts the virtual machines in your Site. T hese can be the VMs you use to host
applications and desktops, as well as VMs you use to host the XenApp and XenDesktop components. A hypervisor is
installed on a host computer dedicated entirely to running the hypervisor and hosting virtual machines.
XenApp and XenDesktop support a variety of hypervisors and cloud services.
Although many XenApp and XenDesktop deployments require a hypervisor, you don't need one to provide Remote PC
Access or when you are using Provisioning Services (included with some editions of XenApp and XenDesktop) instead
of Machine Creation Services (MCS) to provision VMs.
For more information about:
Ports, see Network ports.

Databases, see Databases.

Windows services in XenApp and XenDesktop components, see Configure user rights.
Supported hypervisors and cloud services, see System requirements.
Additional components
T he following additional components, not shown in the illustration above, can also be included in XenApp or XenDesktop
deployments. For more information, see their documentation.
Provisioning Services (PVS)
PVS is an optional component of XenApp and XenDesktop available with some editions. It provides an alternative to
MCS for provisioning virtual machines. Whereas MCS creates copies of a master image, PVS streams the master image
to user device. PVS doesnt require a hypervisor to do this, so you can use it to host physical machines. When PVS is
included in a Site, it communicates with the Controller to provide users with resources.
NetScaler Gateway
When users connect from outside the corporate rewall, XenApp and XenDesktop can use Citrix NetScaler Gateway
(formerly Access Gateway) technology to secure these connections with T LS. T he NetScaler Gateway or NetScaler
VPX virtual appliance is an SSL VPN appliance that is deployed in the demilitarized zone (DMZ) to provide a single
secure point of access through the corporate rewall.
NetScaler SD-WAN
In deployments where virtual desktops are delivered to users at remote locations such as branch ofces, Citrix
NetScaler SD-WAN (formerly Citrix CloudBridge, Branch Repeater, or WANScaler) technology can be employed to
optimize performance. Repeaters accelerate performance across wide-area networks, so with repeaters in the
network, users in the branch ofce experience LAN-like performance over the WAN. NetScaler SD-WAN can prioritize
different parts of the user experience so that, for example, the user experience does not degrade in the branch
location when a large le or print job is sent over the network. HDX WAN optimization provides tokenized
compression and data deduplication, dramatically reducing bandwidth requirements and improving performance.
How typical deployments work

A XenApp and XenDesktop Site is made up of machines with dedicated roles that allow for scalability, high availability, and
failover, and provide a solution that is secure by design. A XenApp or XenDesktop Site consists of VDA-installed servers and
desktop machines, and the Delivery Controller, which manages access.

T he VDA enables users to connect to desktops and applications. It is installed on server or desktop machines in the data
center for most delivery methods, but it can also be installed on physical PCs for Remote PC Access.
T he Controller is made up of independent Windows services that manage resources, applications, and desktops, and
optimize and balance user connections. Each Site has one or more Controllers, and because sessions are dependent on
latency, bandwidth, and network reliability, all Controllers ideally should be on the same LAN.
Users never directly access the Controller. T he VDA serves as an intermediary between users and the Controller. When users
log on to the Site using StoreFront, their credentials are passed through to the Broker Service on the Controller, which
obtains their proles and available resources based on the policies set for them.
How user connections are handled

To start a XenApp or XenDesktop session, the user connects either through Citrix Receiver, which is installed on the user's
device, or a StoreFront Citrix Receiver for Web site.
T he user selects the physical or virtual desktop or virtual application that is needed.
T he user's credentials move through this pathway to access the Controller, which determines which resources are needed
by communicating with a Broker Service. Citrix recommends that administrators place an SSL certicate on StoreFront to
encrypt the credentials coming from Citrix Receiver.

T he Broker Service determines which desktops and applications the user is allowed to access.
After the credentials are veried, information about available applications or desktops is sent back to the user through the
StoreFront-Citrix Receiver pathway. When the user selects applications or desktops from this list, that information goes
back down the pathway to the Controller, which determines the proper VDA to host the specic applications or desktop.
T he Controller sends a message to the VDA with the user's credentials, and then sends all the data about the user and the
connection to the VDA. T he VDA accepts the connection and sends the information back through the same pathways to
Citrix Receiver. A set of required parameters is collected on StoreFront. T hese parameters are then sent to Citrix Receiver,
either as part of the Receiver-StoreFront protocol conversation, or converted to an Independent Computing Architecture
(ICA) le and downloaded. As long as the Site was properly set up, the credentials remain encrypted throughout this
process.
T he ICA le is copied to the user's device and establishes a direct connection between the device and the ICA stack running
on the VDA. T his connection bypasses the management infrastructure (Citrix Receiver, StoreFront, and Controller).
T he connection between Citrix Receiver and the VDA uses the Citrix Gateway Protocol (CGP). If a connection is lost, the
Session Reliability feature enables the user to reconnect to the VDA rather than having to relaunch through the
management infrastructure. Session Reliability can be enabled or disabled in Citrix policies.
After the client connects to the VDA, the VDA noties the Controller that the user is logged on, and the Controller sends
this information to the Site database and starts logging data in the Monitoring database.
How data access works

Every XenApp or XenDesktop session produces data that IT can access through Studio or Director. Using Studio,
administrators can access real-time data from the Broker Agent to better manage sites. Director accesses to the same
real-time data plus historical data stored in the Monitoring database, as well as HDX data from NetScaler Gateway for
help-desk support and troubleshooting.
Within the Controller, the Broker Service reports session data for every session on the machine providing real-time data. T he
Monitor Service also tracks the real-time data and stores it as historical data in the Monitoring database.
Studio communicates only with the Broker Service; therefore, it accesses only to real-time data. Director communicates
with the Broker Service (through a plugin in the Broker Agent) to access the Site database.
Director can also access NetScaler Gateway to get information on the HDX data.
Deliver desktops and applications: Machine Catalogs,

Delivery Groups, and Application Groups
You set up the machines that will deliver applications and desktops with Machine Catalogs. T hen, you create Delivery
Groups that specify the applications and desktops that will be available (using some or all of the machines in the catalogs),
and which users can access them.
Machine Catalogs
Machine Catalogs are collections of virtual or physical machines that you manage as a single entity. T hese machines, and
the application or virtual desktops on them, are the resources you provide to your users. All the machines in a catalog have

the same operating system and the same VDA installed. T hey also have the same applications or virtual desktops.
Typically, you create a master image and use it to create identical VMs in the catalog. For VMs you can specify the
provisioning method for the machines in that catalog: Citrix tools (PVS or MCS) or other tools. Alternatively, you can use
your own existing images. In that case, you must manage target devices on an individual basis or collectively using third-
party electronic software distribution (ESD) tools.
Valid machine types are:
Server OS machines: Virtual or physical machines based on a server operating system used for delivering XenApp
published apps, also known as server-based hosted applications, and XenApp published desktops, also known as server-
hosted desktops. T hese machines allow multiple users to connect to them at one time.
Desktop OS machines: Virtual or physical machines based on a desktop operating system used for delivering VDI
desktops (desktops running desktop operating systems that can be fully personalized, depending on the options you
choose), and VM-hosted apps (applications from desktop operating systems) and hosted physical desktops. Only one
user at a time can connect each of these desktops.
Remote PC Access: Enables remote users to access their physical office PCs from any device running Citrix Receiver. T he
office PCs are managed through the XenDesktop deployment, and require user devices to be specified in a whitelist.
For more information, see the Create Machine Catalogs article.
Delivery Groups
Delivery Groups specify which users can access which applications and/or desktops on which machines. Delivery Groups
contain machines from your Machine Catalogs, and Active Directory users who have access to your Site. It often makes
sense to assign users to your Delivery Groups by their Active Directory group because both Active Directory groups and
Delivery Groups are ways of grouping users with similar requirements.
Each Delivery Group can contain machines from more than one Machine Catalog, and each catalog can contribute
machines to more than one Delivery Group, but each individual machine can only belong to one Delivery Group at a time.
You dene which resources users in the Delivery Group can access. For example, if you want to deliver different applications
to different users, one way to do this is to install all the applications you want to deliver on the master image for one
Machine Catalog and create enough machines in that catalog to distribute among several Delivery Groups. T hen you
congure each Delivery Group to deliver a different subset of the applications installed on the machines.
For more information, see the Create Delivery Groups article.
Application Groups
Application Groups provide application management and resource control advantages over using more Delivery Groups.
Using the tag restriction feature, you can use your existing machines for more than one publishing task, saving the costs
associated with deployment and managing additional machines. A tag restriction can be thought of as subdividing (or
partitioning) the machines in a Delivery Group. Application Groups can also be helpful when isolating and troubleshooting a
subset of machines in a Delivery Group.
For more information, see the Create Application Groups article.

Active Directory
May 22, 20 17
Active Directory is required for authentication and authorization. T he Kerberos infrastructure in Active Directory is used to
guarantee the authenticity and condentiality of communications with the Delivery Controllers. For information about
Kerberos, see the Microsoft documentation.
T he System requirements article lists the supported functional levels for the forest and domain. To use Policy Modeling, the
domain controller must be running on Windows Server 2003 to Windows Server 2012 R2; this does not affect the domain
functional level.
T his product supports:

Deployments in which the user accounts and computer accounts exist in domains in a single Active Directory forest. User
and computer accounts can exist in arbitrary domains within a single forest. All domain functional levels and forest
functional levels are supported in this type of deployment.
Deployments in which user accounts exist in an Active Directory forest that is different from the Active Directory forest
containing the computer accounts of the controllers and virtual desktops. In this type of deployment, the domains
containing the Controller and virtual desktop computer accounts must trust the domains containing user accounts.
Forest trusts or external trusts can be used. All domain functional levels and forest functional levels are supported in this
type of deployment.
Deployments in which the computer accounts for Controllers exist in an Active Directory forest that is different from
one or more additional Active Directory forests that contain the computer accounts of the virtual desktops. In this type
of deployment a bi-directional trust must exist between the domains containing the Controller computer accounts and
all domains containing the virtual desktop computer accounts. In this type of deployment, all domains containing
Controller or virtual desktop computer accounts must be at "Windows 2000 native" functional level or higher. All forest
functional levels are supported.
Writable domain controllers. Read-only domain controllers are not supported.
Optionally, Virtual Delivery Agents (VDAs) can use information published in Active Directory to determine which Controllers
they can register with (discovery). T his method is supported primarily for backward compatibility, and is available only if the
VDAs are in the same Active Directory forest as the Controllers. For information about this discovery method see the
Delivery Controllers article and CT X118976.
Tip: Do not change the computer name or the domain membership of a Controller after the Site is congured.
Deploy in a multiple Active Directory f orest environment
Note: T his information applies to minimum version XenDesktop 7.1 and XenApp 7.5. It does not apply to earlier versions of
XenDesktop or XenApp.
In an Active Directory environment with multiple forests, if one-way or two-way trusts are in place you can use DNS
forwarders for name lookup and registration. To allow the appropriate Active Directory users to create computer accounts,
use the Delegation of Control wizard. Refer to Microsoft documentation for more information about this wizard.
No reverse DNS zones are necessary in the DNS infrastructure if appropriate DNS forwarders are in place between forests.
T he SupportMultipleForest key is necessary if the VDA and Controller are in separate forests, regardless of whether the
Active Directory and NetBios names are different. T he SupportMultipleForest key is only necessary on the VDA. Use the
following information to add the registry key:

Caution: Editing the registry incorrectly can cause serious problems that may 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.
HKEY_LOCAL_MACHINE\Software\Citrix\VirtualDesktopAgent\SupportMultipleForest
Name: SupportMultipleForest
T ype: REG_DWORD
Data: 0x00000001 (1)
You might need reverse DNS conguration if your DNS namespace is different than that of Active Directory.
If external trusts are in place during setup, the ListOfSIDs registry key is required. T he ListOfSIDs registry key is also
necessary if the Active Directory FQDN is different than the DNS FQDN or if the domain containing the Domain Controller
has a different Netbios name than the Active Directory FQDN. T o add the registry key, use the following information:
For a 32-bit or 64-bit VDA, locate the registry key
HKEY_LOCAL_MACHINE\Software\Citrix\VirtualDesktopAgent\ListOfSIDs
Name: ListOfSIDs
T ype: REG_SZ
Data: Security Identifier (SID) of the Controllers
When external trusts are in place, make the following changes on the VDA:
1. Locate the file <ProgramFiles>\Citrix\Virtual Desktop Agent\brokeragentconfig.exe.config.
2. Make a backup copy of the file.
3. Open the file in a text editing program such as Notepad.
4. Locate the text allowNtlm="false" and change the text to allowNtlm="true".
5. Save the file.
After adding the ListOfSIDs registry key and editing the brokeragent.exe.cong le, restart the Citrix Desktop Service to
apply the changes.
T he following table lists the supported trust types:
Trust type Transitivity Direction Supported in this release
Parent and child T ransitive T wo-way Yes
T ree-root T ransitive T wo-way Yes
External Nontransitive One-way or two-way Yes
Forest T ransitive One-way or two-way Yes
Shortcut T ransitive One-way or two-way Yes
Realm T ransitive or nontransitive One-way or two-way No
For more information about complex Active Directory environments, see CT X134971.

Databases
May 22, 20 17
A XenApp or XenDesktop Site uses three SQL Server databases:
Site: (also known as Site Configuration) stores the running Site configuration, plus the current session state and
connection information.
Conf iguration Logging: (also known as Logging) stores information about Site configuration changes and
administrative activities. T his database is used when the Configuring Logging feature is enabled (default = enabled).
Monitoring: stores data used by Director, such as session and connection information.
Each Delivery Controller communicates with the Site database; Windows authentication is required between the Controller
and the databases. A Controller can be unplugged or turned off without affecting other Controllers in the Site. T his means,
however, that the Site database forms a single point of failure. If the database server fails, existing connections continue
to function until a user either logs off or disconnects. New connections cannot be established if the database server is
unavailable, except in certain cases when connection leasing is congured.
Citrix recommends that you back up the databases regularly so that you can restore from the backup if the database
server fails. T he backup strategy for each database may differ. For instructions, see CT X135207.
If your Site contains more than one zone, the Site database should always be in the primary zone. Controllers in every zone
communicate with that database.
High availability
T here are several high availability solutions to consider for ensuring automatic failover:
AlwaysOn Availability Groups: T his enterprise-level high availability and disaster recovery solution introduced in SQL
Server 2012 enables you to maximize availability for one or more databases. AlwaysOn Availability Groups requires that
the SQL Server instances reside on Windows Server Failover Clustering (WSFC) nodes. For more information, see
http://msdn.microsoft.com/en-us/library/hh510230.
SQL Server database mirroring: Mirroring the database ensures that, should you lose the active database server, an
automatic failover process happens in a matter of seconds, so that users are generally unaffected. T his method is more
expensive than other solutions because full SQL Server licenses are required on each database server; you cannot use
SQL Server Express edition in a mirrored environment.
SQL clustering: T he Microsoft SQL clustering technology can be used to automatically allow one server to take over
the tasks and responsibilities of another server that has failed. However, setting up this solution is more complicated, and
the automatic failover process is typically slower than alternatives such as SQL mirroring.
Using the hypervisor's high availability f eatures: With this method, you deploy the database as a virtual machine
and use your hypervisor's high availability features. T his solution is less expensive than mirroring because it uses your
existing hypervisor software and you can also use SQL Server Express edition. However, the automatic failover process is
slower, as it can take time for a new machine to start for the database, which may interrupt the service to users.
Note: Installing a Controller on a node in an SQL clustering or SQL mirroring installation is not supported.
T he Local Host Cache feature supplements the SQL Server high availability best practices by enabling users to connect and
reconnect to applications and desktops even when the Site database is not available. For more information, see the Local

Host Cache article.
If all Controllers in a Site fail, you can congure the VDAs to operate in high availability mode so that users can continue to
access and use their desktops and applications. In high availability mode, the VDA accepts direct ICA connections from
users, rather than connections brokered by the Controller. T his feature should be used only on the rare occasion when
communication with all Controllers fails; it is not an alternative to other high availability solutions. For more information, see
CT X 127564.
Install database software

By default, SQL Server Express edition is installed when you install the rst Delivery Controller if another SQL Server instance
is not detected on that server. T hat default action is generally sufcient for proof of concept or pilot deployments;
however, SQL Server Express does not support Microsoft high availability features.
T he default installation uses the default Windows service accounts and permissions. See the Microsoft documentation for
details of these defaults, including the addition of Windows service accounts to the sysadmin role. T he Controller uses the
Network Service account in this conguration. T he Controller does not require any additional SQL Server roles or
permissions.
If required, you can select Hide instance for the database instance. When conguring the address of the database in
Studio, enter the instance's static port number, rather than its name. See the Microsoft documentation for details about
hiding an instance of SQL Server Database Engine.
Most production deployments, and any deployment that uses Microsoft high availability features, should use supported
non-Express editions of SQL Server installed on machines other than the server where the rst Controller is installed. T he
System requirements article lists the supported SQL Server versions. T he databases can reside on one or more machines.
Ensure the SQL Server software is installed before creating a Site. You don't have to create the database, but if you do, it
must be empty. Conguring Microsoft high availability technologies is also recommended.
Use Windows Update to keep SQL Server up-to-date.
Set up the databases from the Site creation wizard

Specify the database names and addresses (location) on the Databases page in the Site creation wizard; see Database
address formats below. To avoid potential errors when Director queries the Monitor Service, do not use whitespace in the
name of the Monitoring database.
T he Databases page offers two options for setting up the databases: automatic and using scripts. Generally, you can use
the automatic option if you (the Studio user and Citrix administrator) have the required database privileges; see Permissions
required to set up databases below.
You can change the location of a database later, after you create the Site; see Change database locations below.
To congure a Site to use a mirror database, complete the following and then proceed with the automatic or scripted
setup procedures.
1. Install the SQL Server software on two servers, A and B.

2. On Server A, create the database intended to be used as the principal. Back up the database on Server A and then copy
it to server B.
3. On Server B, restore the backup file.
4. Start mirroring on server A.
Tip: To verify mirroring after creating the Site, run the PowerShell cmdlet get-congdbconnection to ensure that the
Failover Partner has been set in the connection string to the mirror.
If you later add, move, or remove a Delivery Controller in a mirrored database environment, see the Delivery Controllers
article.
Automatic setup
If you have the required database privileges, select the "Create and set up databases from Studio" option on the
Databases page of the Site creation wizard, and then provide the names and addresses of the principal databases.
If a database exists at an address you specify, it must be empty. If databases don't exist at a specied address, you are
informed that a database cannot be found, and then asked if you want the database to be created for you. When you
conrm that action, Studio automatically creates the databases, and then applies the initialization scripts for the principal
and replica databases.
Scripted setup
If you do not have the required database privileges, someone with those permissions must help, such as a database
administrator. Here's the sequence:
1. In the Site creation wizard, select the Generate scripts option. T his action generates six scripts: two for each of the
three databases (one for each principal database and another for each replica). You can indicate where to store the
scripts.
2. Give those scripts to your database administrator. T he Site creation wizard stops automatically at this point; you'll be
prompted when you return later to continue the Site creation.
T he database administrator then creates the databases. Each database should have the following characteristics:
Use a collation that ends with "_CI_AS_KS". Citrix recommends using a collation that ends with "_100_CI_AS_KS".
For optimum performance, enable the SQL Server Read-Committed Snapshot. For details, see CT X 137161.
High availability features should be configured, if desired.
T o configure mirroring, first set the database to use the full recovery model (simple model is the default). Back up the
principal database to a file and copy it to the mirror server. On the mirror database, restore the backup file to the mirror
server. T hen, start mirroring on the principal server.
T he database administrator uses the SQLCMD command-line utility or SQL Server Management Studio in SQLCMD mode
to run each of the xxx_Replica.sql scripts on the high availability SQL Server database instances (if high availability is
congured), and then run each of the xxx_Principal.sql scripts on the principal SQL Server database instances. See the
Microsoft documentation for SQLCMD details.
When all the scripts complete successfully, the database administrator gives the Citrix administrator the three principal
database addresses.
In Studio, you are prompted to continue the Site creation, and are returned to the Databases page. Enter the addresses. If
any of the servers hosting a database cannot be contacted, an error message is displayed.

Permissions required to set up databases
You must be a local administrator and a domain user to create and initialize the databases (or change the database
location). You must also have certain SQL Server permissions. T he following permissions can be explicitly congured or
acquired by Active Directory group membership. If your Studio user credentials do not include these permissions, you are
prompted for SQL Server user credentials.
Operation Purpose Server role Database role
Create a database Create a suitable empty database dbcreator
Create a schema Create all service-specic schemas and add the securityadmin * db_owner
rst Controller to the Site
Add a Controller Add a Controller (other than the rst) to the securityadmin * db_owner
Site
Add a Controller (mirror Add a Controller login to the database server securityadmin *
server) currently in the mirror role of a mirrored
database
Update a schema Apply schema updates or hotxes db_owner
* While technically more restrictive, in practice, the securityadmin server role should be treated as equivalent to the
sysadmin server role.
When using Studio to perform these operations, the user account must be a member of the sysadmin server role.
Database address formats

You can specify a database address in one of the following forms:
ServerName
ServerName\InstanceName
ServerName,PortNumber
For an AlwaysOn Availability Group, specify the group's listener in the location eld.
Change database locations

After you create a Site, you can change the location of the databases. When you change the location of a database:

T he data in the previous database is not imported to the new database.
Logs cannot be aggregated from both databases when retrieving logs.
T he first log entry in the new database indicates that a database change occurred, but it does not identify the previous
database.
You cannot change the location of the Conguration Logging database when mandatory logging is enabled.
To change the location of a database:
1. Ensure a supported version of Microsoft SQL Server is installed on the server where you want the database to reside.
Set up high availability features as needed.
2. Select Conf iguration in the Studio navigation pane.
3. Select the database for which you want to specify a new location and then select Change Database in the Actions
pane.
4. Specify the new location and the database name.
5. If you want Studio to create the database and you have the appropriate permissions, click OK. When prompted, click OK,
and then Studio creates the database automatically. Studio attempts to access the database using your credentials; if
that fails, you are prompted for the database user's credentials. Studio then uploads the database schema to the
database. T he credentials are retained only for the database creation time frame.
6. If you do not want Studio to create the database, or you do not have sufficient permissions, click Generate script. T he
generated scripts include instructions for manually creating the database and a mirror database, if needed. Before
uploading the schema, ensure that the database is empty and that at least one user has permission to access and
change the database.
For more information

Articles in the Advanced Concepts section contain the most technical and in-depth articles from across the Citrix teams. For
example:
T he Design collection contains an article about a database sizing tool.

T he Implementation and Configuration collections contains guidance for sizing the Site database and configuring
connection strings when using SQL Server high availability solutions.

Delivery methods
May 22, 20 17
Its challenging to meet the needs of every user with one virtualization deployment. XenApp and XenDesktop allow
administrators to customize the user experience with a variety of methods sometimes referred to as FlexCast models.
T his collection of delivery methods each with its own advantages and disadvantages provide the best user experience
in any use-case scenario.
Mobilize Windows applications on mobile devices
Touch-screen devices, such as tablets and smartphones, are now standard in mobility. T hese devices can cause problems
when running Windows-based applications that typically utilize full-size screens and rely on right-click inputs for full
functionality.
XenApp with Citrix Receiver offers a secure solution that allows mobile-device users access to all the functionality in their
Windows-based apps without the cost of rewriting those apps for native mobile platforms.
T he XenApp published apps delivery method utilizes HDX Mobile technology that solves the problems associated with
mobilizing Windows applications. T his method allows Windows applications to be refactored for a touch experience while
maintaining features such as multitouch gestures, native menu controls, camera, and GPS functions. Many touch features
are available natively in XenApp and XenDesktop and do not require any application source code changes to activate.
T hese features include:

Automatic display of the keyboard when an editable field has the focus
Larger picker control to replace Windows combo box control
Multitouch gestures, such as pinch and zoom
Inertia-sensed scrolling
T ouchpad or direct-cursor navigation
Reduce PC ref resh costs
Upgrading physical machines is a daunting task many businesses face every three to ve years, especially if the business
needs to maintain the most up-to-date operating systems and applications. Growing businesses also face daunting
overhead costs of adding new machines to their network.
T he VDI Personal vDisk delivery method provides fully personalized desktop operating systems to single users on any
machine or thin client using server resources. Administrators can create virtual machines whose resources such as
processing, memory, and storage are stored in the networks data center.
T his can extend the life of older machines, keep software up to date, and minimize downtime during upgrades.
Secure access to virtual apps and desktops f or contractors and partners
Network security is an ever-growing problem, especially when working with contractors, partners, and other third-party
contingent workers who need access to a companys apps and data. T he workers may also need loaner laptops or other
devices, which cause additional cost concerns.
Data, applications, and desktops are stored behind the rewall of the secure network with XenDesktop and XenApp, so the
only thing the end user transmits is user-device inputs and outputs, such as keystrokes, mouse clicks, audio, and screen

updates. By maintaining these resources in a data center, XenDesktop and XenApp offer a more secure remote access
solution than using the typical SSL VPN.
With a VDI with Personal vDisk deployment, administrators can utilize thin clients or users personal devices by creating a
virtual machine on a network server and providing a single-user desktop operating system. T his allows IT to maintain
security with third-party workers without the need of purchasing expensive equipment.
Accelerate Migration
When switching to a new operating system, IT can face the challenge of delivering legacy and incompatible applications.
With virtual-machine-hosted apps, users can run older applications through Citrix Receiver on the upgraded virtual machine
without any compatibility issues. T his allows IT additional time to resolve and test application compatibility issues, ease
users into the transition, and make help desk calls more efcient.
Additional benefit for using XenDesktop during migration include:

Reducing complexity for desktops
Improving IT s control
Enhancing end-user flexibility in terms of device usage and workspace location
Enable designers and engineers by virtualizing prof essional 3-D graphics apps
Many design rms and manufacturing companies rely heavily on professional 3-D graphics applications. T hese companies
face nancial strain from the costs of powerful hardware to support this type of software and also logistic problems that
come with the sharing of large design les via FT P, email, and similar ad hoc methods.
XenDesktops hosted physical desktop delivery method provides a single desktop image to workstations and blade servers
without the need of hypervisors to run graphic-intensive 3-D applications on a native operating system.
All les are saved in a central data center within the network, so sharing large design les to other users in the network is
faster and more secure because the les are not being transferred from one workstation to another.
Transf orm call centers
Businesses that need large-scale call centers face the difcult challenge of maintaining adequate stafng for peak periods
while not overprovisioning machines during less busy hours.
T he Pooled VDI delivery method provides multiple users access to a standardized desktop dynamically at a minimal cost
when provisioning a large number of users. T he pooled machines are allocated on a per-session, rst-come, rst-served
basis.
T here is less day-to-day management of these virtual machines because any change made during the session is discarded
when the user logs off. T his also increases security.
T he XenApp hosted desktops delivery method is another viable option for transforming call centers. T his method hosts
multiple user desktops on a single server-based operating system.
T his is a more cost-efcient method than Pooled VDI, but with XenApp hosted desktops, users are restricted from installing
applications, changing system settings, and restarting the server.

XenApp published apps and desktops
May 22, 20 17
Use server OS machines to deliver XenApp published apps and published desktops.
Use case
You want inexpensive server-based delivery to minimize the cost of delivering applications to a large number of users,
while providing a secure, high-definition user experience.
Your users perform well-defined tasks and do not require personalization or offline access to applications. Users may
include task workers such as call center operators and retail workers, or users that share workstations.
Application types: any application.
Benets and considerations
Manageable and scalable solution within your datacenter.

Most cost effective application delivery solution.
Hosted applications are managed centrally and users cannot modify the application, providing a user experience that is
consistent, safe, and reliable.
Users must be online to access their applications.
User experience
User requests one or more applications from StoreFront, their Start menu, or a URL you provide to them.
Applications are delivered virtually and display seamlessly in high definition on user devices.
Depending on profile settings, user changes are saved when the user's application session ends. Otherwise, the changes
are deleted.
Process, host , and deliver applications
Application processing takes place on hosting machines, rather than on the user devices. T he hosting machine can be a
physical or a virtual machine.
Applications and desktops reside on a server OS machine.
Machines become available through Machine Catalogs.
Machines from Machine Catalogs are organized into Delivery Groups that deliver the same set of applications to groups
of users.
Server OS machines support Delivery Groups that host either desktops or applications, or both.
Session management and assignment
Server OS machines run multiple sessions from a single machine to deliver multiple applications and desktops to multiple,
simultaneously connected users. Each user requires a single session from which they can run all their hosted applications.
For example, a user logs on and requests an application. One session on that machine becomes unavailable to other
users. A second user logs on and requests an application which that machine hosts. A second session on the same
machine is now unavailable. If both users request additional applications, no additional sessions are required because a
user can run multiple application using the same session. If two more users log on and request desktops, and two
sessions are available on that same machine, that single machine is now using four sessions to host four different
users.

Within the Delivery Group to which a user is assigned, a machine on the least loaded server is selected. A machine with
session availability is randomly assigned to deliver applications to a user when that user logs on.
To deliver XenApp published apps and desktops:
1. Install the applications you want to deliver on a master image running a supported Windows server OS.
2. Create a Machine Catalog for this master image or update an existing catalog with the master image.
3. Create a Delivery Group to deliver the applications and desktops to users. If you are delivering applications, select those
you want to deliver.
See the installation and conguration articles for details.

VM hosted apps
May 22, 20 17
Use Desktop OS machines to deliver VM hosted applications
Use Case
You want a client-based application delivery solution that is secure, provides centralized management, and supports a
large number of users per host server (or hypervisor), while providing users with applications that display seamlessly in
high-definition.
Your users are internal, external contractors, third-party collaborators, and other provisional team members. Your users
do not require offline access to hosted applications.
Application types: Applications that might not work well with other applications or might interact with the operation
system, such as Microsoft .NET framework. T hese types of applications are ideal for hosting on virtual machines.
Benets and considerations
Applications and desktops on the master image are securely managed, hosted, and run on machines within your
datacenter, providing a more cost effective application delivery solution.
On log on, users can be randomly assigned to a machine within a Delivery Group that is configured to host the same
application. You can also statically assign a single machine to deliver an application to a single user each time that user
logs on. Statically assigned machines allow users to install and manage their own applications on the virtual machine.
Running multiple sessions is not supported on desktop OS machines. T herefore, each user consumes a single machine
within a Delivery Group when they log on, and users must be online to access their applications.
T his method may increase the amount of server resources for processing applications and increase the amount of
storage for users' personal vDisks.
User experience
T he same seamless application experience as hosting shared applications on Server OS machines.
Process, host , and deliver applications
T he same as server OS machines except they are virtual desktop OS machines.
Session management and assignment
Desktop OS machines run a single desktop session from a single machine. When accessing applications only, a single user
can use multiple applications (and is not limited to a single application) because the operating system sees each
application as a new session.
Within a Delivery Group, when users log on they can access either a statically assigned machine (each time the user logs
on to the same machine), or a randomly assigned machine that is selected based on session availability.
To deliver VM hosted apps:
1. Install the applications you want to deliver on a master image running a supported Windows desktop OS.
2. Create a Machine Catalog for this master image or update an existing catalog with the master image.
3. When defining the desktop experience for the machine catalog, decide whether you want users to connect to a new
VM each time they log in or connect to the same machine each time they log in.
4. Create a Delivery Group to deliver the application to users.

5. From the list of application installed, select the application you want to deliver.

VDI desktops
May 22, 20 17
Use Desktop OS machines to deliver VDI desktops.
VDI desktops are hosted on virtual machines and provide each user with a desktop operating system.
VDI desktops require more resources than XenApp published desktops, but do not require that applications installed on
them support server-based operating systems. In additional, depending on the type of VDI desktop you choose, these
desktop can be assigned to individual users and allow these users a high degree of personalization.
When you create a Machine Catalog for VDI desktops, you create one of these types of desktops:
Random non-persistent desktops, also known as pooled VDI desktops. Each time users logs on to use one of these
desktops, they connect to a dynamically selected desktop in a pool of desktops based on a single master image. All
changes to the desktop are lost when the machine reboots.
Static non-persistent desktop. T he first time a user logs on the use one off these desktops, the user is assigned a
desktop from a pool of desktops based on a single master image. After the first use, each time a user logs in to use one
of these desktop, the user connects to the same desktop that user was assigned on first use. All changes to the
desktop are lost when the machine reboots.
Static persistent, also known as VDI with Personal vDisk. Unlike other types of VDI desktops, these desktops can be fully
personalized by users. T he first time a user logs on to use one of these desktops, the user is assigned a desktop from a
pool of desktops based on a single master image. Subsequent logons from that user connect to the same desktop that
was assigned on first use. Changes to the desktop are retained when the machine reboots because they are stored in a
Personal vDisk.
To deliver VDI desktops:
1. Create a master image running a supported Windows desktop OS.

2. Create a Machine Catalog for this master image or update an existing catalog with the master image. When defining the
desktop experience for the machine catalog, decide whether you want users to connect to a new VM each time they
log in, or connect to the same machine each time they log in. If users connect to the same machine, you can specify
how changes to the desktop are retained.
3. Create a Delivery Group to deliver the desktops to users.

Network ports
May 22, 20 17
T he following table lists the default network ports used by XenApp and XenDesktop Delivery Controllers, Windows VDAs,
Director, and Citrix License Server. When Citrix components are installed, the operating system's host rewall is also
updated, by default, to match these default network ports.
You may need this port information:
For regulatory compliance purposes.

If there is a network firewall between these components and other Citrix products or components, so you can configure
that firewall appropriately.
If you use a third-party host firewall, such as one provided with an anti-malware package, rather than the operating
system's host firewall.
If you alter the configuration of the host firewall on these components (usually Windows Firewall Service).
If you reconfigure any features of these components to use a different port or port range, and then want to disable or
block ports that are not used in your configuration. Refer to the documentation for the component for details.
For port information about other components such as StoreFront and Provisioning Services, see the component's current
"System requirements" article.
T he table lists only incoming ports; outgoing ports are usually determined by the operating system and use unrelated
numbers. Information for outgoing ports is not normally needed for the purposes listed above.
Some of these ports are registered with the Internet Assigned Numbers Authority (IANA). Details about these assignments
are available at http://www.iana.org/assignments/port-numbers; however, the descriptive information held by IANA does
not always reect today's usage.
Additionally, the operating system on the VDA and Delivery Controller will require incoming ports for its own use. See the
Microsoft Windows documentation for details.
Component Usage Protocol Def ault Notes

incoming ports
VDA ICA/HDX TCP, UDP 1494 EDT protocol requires 1494 to be

open for UDP.
See ICA policy settings.
VDA ICA/HDX with Session TCP, UDP 2598 EDT protocol requires 2598 to be
Reliability open for UDP.
See ICA policy settings.
VDA ICA/HDX over T LS TCP 443 All Citrix Receivers
VDA ICA/HDX over WebSocket TCP 8008 Citrix Receiver for HT ML5, and

Citrix Receiver for Chrome 1.6 and
earlier only
VDA ICA/HDX Audio over UDP UDP 16500..16509

Real-time Transport
VDA ICA/HDX Framehawk UDP 3224-3324
Used by the Universal Print Server

VDA ICA/Universal Print Server T CP 7229 print data stream CGP (Common
Gateway Protocol) listener.
Used by the Universal Print Server

VDA ICA/Universal Print Server T CP 8080 listener for incoming HT T P/SOAP
requests.
VDA Wake On LAN UDP 9 Remote PC Access power

management
VDA Wake Up Proxy TCP 135 Remote PC Access power

management
VDA Delivery Controller TCP 80
Delivery VDA, StoreFront, Director, TCP 80

Controller Studio
Delivery StoreFront, Director, Studio TCP 443

Controller over T LS
Director Delivery Controller TCP 80, 443
For Citrix Licensing:
Component Usage Protocol Def ault Notes

incoming ports
License Server License Server TCP 27000
License Server License Server for Citrix (vendor TCP 7279

daemon)

License Server License Administration Console TCP 8082
License Server Web Services for Licensing TCP 8023

Install and congure
May 22, 20 17
Review the referenced articles before starting each deployment step, to learn about what you see and specify during the
deployment.
Use the following sequence to deploy XenApp or XenDesktop.
Prepare
Review Prepare to install and complete any necessary tasks.
Where to find information about concepts, features, differences from earlier releases, system requirements, and
databases.
Considerations when deciding where to install core components.
Permission and Active Directory requirements.
Information about the available installers, tools, and interfaces.

Install the Delivery Controller, Citrix Studio, Citrix Director, Citrix License Server, and Citrix StoreFront. For details, see Install
core components or Install using the command line.
Create a Site
After you install the core components and launch Studio, you are automatically guided to create a Site.
Install one or more Virtual Delivery Agents (VDAs)

Install a VDA on a machine running a Windows operating system, either on a master image or directly on each machine.
See Install VDAs or Install using the command line. Sample scripts are provided if you want to install VDAs through Active
Directory.
For machines with a Linux operating system, follow the guidance in Linux Virtual Delivery Agent.
For a Remote PC Access deployment, install a VDA for Desktop OS on each ofce PC. If you need only the core VDA
services, use the standalone VDAWorkstationCoreSetup.exe installer and your existing Electronic Software Distribution
(ESD) methods. (Prepare to install contains complete information about the available VDA installers.)
Install other optional components

If you plan to use the Citrix Universal Print Server, install its server component on your print servers. See Install core

components or Install using the command line.
To allow StoreFront to use authentication options such as SAML assertions, install the Citrix Federated Authentication
Service.
To enable end users to have greater control over their user accounts, install Self-Service Password Reset. For details, see the
Self-Service Password Reset documentation.
Optionally, integrate more Citrix components into your XenApp or XenDesktop deployment.
Provisioning Services is an optional component of XenApp and XenDesktop that provisions machines by streaming a
master image to target devices.
Citrix NetScaler Gateway is a secure application access solution that provides administrators with granular application-
level policy and action controls to secure access to applications and data.
Citrix NetScaler SD-WAN is a set of appliances that optimize WAN performance.
For installation guidance, see the documentation for these components, features, and technologies.
Create a machine catalog

After you create a Site in Studio, you are guided to create a machine catalog.
A catalog can contain physical or virtual machines (VMs). Virtual machines can be created from a master image. When using
a hypervisor or cloud service to provide VMs, you rst create a master image on that host. T hen, when you create the
catalog, you specify that image, which is used when creating VMs.
Create a Delivery Group

After you create your rst machine catalog in Studio, you are guided to create a Delivery Group.
A Delivery Group species which users can access machines in a selected catalog and the applications available to those
users.
Create an Application Group (optional)

After you create a Delivery Group, you can optionally create an Application Group. You can create Application Groups for
applications that are shared across different Delivery Groups or used by a subset of users within Delivery Groups.

Prepare to install
May 22, 20 17
T he XenApp and XenDesktop installation process includes installing:
One or more Delivery Controllers

Citrix Studio
Citrix Director
Citrix StoreFront
Citrix License Server
One or more Citrix Virtual Delivery Agents (VDAs)
Optional components and technologies such as the Universal Print Server, the Federated Authentication Service, and
Self-Service Password Reset
How you can install components
You can use the full-product installer on the XenApp and XenDesktop ISO to deploy many components and technologies.
You can use a standalone VDA installer to install VDAs. All installers offer graphical and command line interfaces. See
Installers.
T he product ISO contains sample scripts that install, upgrade, or remove VDAs for machines in Active Directory. You
can also use the scripts to manage master images used by Machine Creation Services (MCS) and Provisioning Services
(PVS). For details, see Install VDAs using scripts.
As an automated alternative to using the installers, Citrix Smart Tools uses blueprints to create a XenApp and XenDesktop
deployment. For details, see Smart Tools product documentation.
Information to review before installation

T echnical overview: If you're unfamiliar with the product and its components.
Changes in 7.x: If you are moving from a XenApp 6.x or XenDesktop 5.6 deployment to the current version.
Security: When planning your deployment environment.
Known issues: Issues you might encounter in this version.
Databases: Learn about the system databases and how to configure them. During Controller installation, you can install
SQL Server Express for use as the Site database. You configure most database information when you create a Site,
after you install the core components.
Remote PC Access: If you're deploying an environment that enables your users to access their physical machines in the
office remotely.
Connections and resources: If you're using a hypervisor or cloud service to host or provision VMs for applications and
desktops. You can configure the first connection when you create a Site (after you install the core components). Set up
your virtualization environment any time before then.
Microsoft System Center Configuration Manager: If you're using ConfigMgr to manage access to applications and
desktops, or if you're using the Wake on LAN feature with Remote PC Access.
Where to install components

Review the System requirements for supported platforms, operating systems, and versions. Component prerequisites are
installed automatically, except as noted. See the Citrix StoreFront and the Citrix License Server documentation for their
supported platforms and prerequisites.
You can install the core components on the same server or on different servers.
Installing all the core components on one server can work for evaluation, test, or small production deployments.
T o accommodate future expansion, consider installing components on different servers. For example, installing Studio on
a different machine than the server where you installed the Controller allows you to manage the site remotely.
For most production deployments, installing core components on separate servers is recommended.
You can install both a Delivery Controller and a VDA for Server OS on the same server. Launch the installer and select the
Delivery Controller (plus any other core components you want on that machine). T hen launch the installer again and select
the Virtual Delivery Agent for Server OS.
Ensure that each operating system has the latest updates. For example, installation of a Controller on Windows Server
2012 R2 or a VDA on Windows 8.1 or Windows Server 2012 R2 fails if Windows update KB2919355 is not installed.
Ensure that all machines have synchronized system clocks. T he Kerberos infrastructure that secures communication
between the machines requires synchronization.
T he following blog series contains optimization guidance for Windows 10 machines:
https://www.citrix.com/blogs/2015/12/17/windows-10-optimization-for-xendesktop/
https://www.citrix.com/blogs/2016/04/25/fine-tuning-windows-10-optimization-impact-on-storage-logon-time/
https://www.citrix.com/blogs/2016/01/19/windows-10-optimizations-the-untold-results/
Where NOT to install components:
Do not install any components on an Active Directory domain controller.

Installing a Controller on a node in a SQL Server clustering installation, SQL Server mirroring installation, or on a server
running Hyper-V is not supported.
Do not install Studio on a server running XenApp 6.5 Feature Pack 2 for Windows Server 2008 R2 or any earlier version of
XenApp.
Permission and Active Directory requirements

You must be a domain user and a local administrator on the machines where you are installing components.
To use the standalone VDA installer, you must have elevated administrative privileges or use Run as administrator.
Congure your Active Directory domain before starting an installation.
System requirements lists the supported Active Directory functional levels. Active Directory contains more information.
You must have at least one domain controller running Active Directory Domain Services.
Do not install any XenApp or XenDesktop components on a domain controller.
Do not use a forward slash (/) when specifying Organizational Unit names in Studio.
T he Windows user account used to install the Citrix License Server is automatically congured as a Delegated
Administration full administrator on the license server.

For more information:
Security best practices

Microsoft documentation for Active Directory configuration instructions
Installation guidance, considerations, and best

practice
During installation of any component:
Usually, if a component has prerequisites, the installer deploys them if they are not present. Some prerequisites might
require a machine restart.
When you create objects before, during, and after installation, specify unique names for each object. For example, provide
unique names for networks, groups, catalogs, and resources.
If a component does not install successfully, the installation stops with an error message. Components that installed
successfully are retained. You do not need to reinstall them.
Analytics are collected automatically when you install (or upgrade) components. By default, that data is uploaded to Citrix
automatically when the installation completes. Also, when you install components, you are automatically enrolled in the
Citrix Customer Experience Improvement Program (CEIP), which uploads anonymous data. During installation, you can also
choose to participate in other Citrix technologies (such as Smart Tools) that collect diagnostics for maintenance and
troubleshooting. For information about these programs, see Citrix Insight Services.
During VDA installation:
T he Citrix Receiver for Windows is included by default when you install a VDA, except when using the
VDAWorkstationCoreSetup.exe installer. You can exclude the Citrix Receiver from the installation. You or your users can
download and install (and upgrade) Citrix Receiver and other Citrix Receivers from the Citrix website. Alternatively, you can
make those Citrix Receivers available from your StoreFront server. See Make Citrix Receiver installation les available on the
server, or the equivalent content in the StoreFront version you're using.
T he Print Spooler Service is enabled by default on supported Windows servers. If you disable this service, you cannot
successfully install a VDA for Windows Server OS, so ensure that this service is enabled before installing a VDA.
When you install the VDA, a new local user group called Direct Access Users is created automatically. On a VDA for Desktop
OS, this group applies only to RDP connections. On a VDA for Server OS, this group applies to ICA and RDP connections.
T he VDA must have valid Controller addresses with which to communicate. Otherwise, sessions cannot be established. You
can specify Controller addresses when you install the VDA or later. Just remember that it must be done.
After installing a VDA on a Windows Server 2012 R2 system, use the Kerberos Enable Tool (XASsonKerb.exe) to ensure the
correct operation of Citrix Kerberos authentication. T he tool is in the Support > Tools > XASsonKerb folder on the
installation media. You must have local administrator privileges to use the tool. Run xassonkerb.exe -install from a command
prompt on the server. If you later apply an update that changes the registry location
HKLM\System\CurrentControlSet\Control\LSA\OSCong, run the command again. To see all available tool options, run the
command with the -help parameter.

Restarts af ter and during VDA installation:
A restart is required at the end of the VDA installation. T hat restart occurs automatically by default.
To minimize the number of restarts needed during VDA installation:
Ensure that a supported .NET Framework version is installed before beginning the VDA installation.
For Windows Server OS machines, install and enable the RDS role services before installing the VDA.
If you do not install those prerequisites before installing the VDA:
If you are using the graphical interface or the command line interface without the /noreboot option, the machine
restarts automatically after installing the prerequisite.
If you are using the command line interface with the /noreboot option, you must initiate the restart.
After each restart, run the installer or command again to continue the VDA installation.
Installers
Full-product installer
Using the full-product installer provided in the XenApp and XenDesktop ISO, you can:
Install, upgrade, or remove core XenApp and XenDesktop components: Delivery Controller, Studio, Director, StoreFront,
License Server
Install or upgrade Windows VDAs for server or desktop operating systems
Install the Universal Print Server UpsServer component on your print servers
Install the Federated Authentication Service
Install the Self-Service Password Reset Service
To deliver a desktop from a Server OS for one user (for example, for web development), use the full-product installer's
command line interface. For details, see Server VDI.
Standalone VDA installers
Standalone VDA installers are available on the Citrix download pages. T he standalone VDA installers are much smaller than
the full-product ISO. T hey more easily accommodate deployments that:
Use Electronic Software Distribution (ESD) packages that are staged or copied locally
Have physical machines
Have remote offices
By default, les in the self-extracting standalone VDAs are extracted to the Temp folder. More disk space is required on the
machine when extracting to the Temp folder than when using the full-product installer. However, les extracted to the
Temp folder are automatically deleted after the installation completes. Alternatively, you can use the /extract command
with an absolute path.
T hree standalone VDA installers are available for download.
VDAServerSet up.exe:

Installs a VDA for Server OS. It supports all the VDA for Server OS options that are available with the full-product installer.
VDAWorkst at ionSet up.exe:
Installs a VDA for Desktop OS. It supports all the VDA for Desktop OS options that are available with the full-product
installer.
VDAWorkst at ionCoreSet up.exe:
Installs a VDA for Desktop OS that is optimized for Remote PC Access deployments or core VDI installations. Remote PC
Access uses physical machines. Core VDI installations are VMs that are not being used as a master image. It installs only the
core services necessary for VDA connections such deployments. T herefore, it supports only a subset of the options that
are valid with the full-product or VDAWorkstationSetup installers.
T his installer does not install or contain the components used for:
App-V.
Profile management. Excluding Citrix Profile management from the installation affects Citrix Director displays. For details,
see Install VDAs.
Machine Identity Service.
Personal vDisk or AppDisks.
T he VDAWorkstationCoreSetup.exe installer does not install or contain a Citrix Receiver for Windows.
Using VDAWorkstationCoreSetup.exe is equivalent to using the full-product or VDAWorkstationSetup installer to install a

Desktop OS VDA and either:
In the graphical interface: Selecting the Remote PC Access option on the Environment page and clearing the Citrix
Receiver check box on the Components page.
In the command line interface: Specifying the /remotepc and /components vda options.
In the command line interface: Specifying /components vda and /exclude "Citrix Personalization for App-V - VDA"
"Personal vDisk" "Machine Identity Service" "Citrix User Profile Manager" "Citrix User Profile Manager WMI Plugin".
You can install the omitted components/features later by running the full-product installer. T hat action installs all missing
components.

Microsoft Azure Resource Manager virtualization
environments
May 22, 20 17
Follow this guidance when using Microsoft Azure Resource Manager to provision virtual machines in your XenApp or
XenDesktop deployment.
You can congure XenApp or XenDesktop to provision resources in Azure Resource Manager either when you create the
XenApp or XenDesktop Site (which includes creating a connection), or when you create a host connection later (after
creating the Site).
You should be familiar with the following:
Azure Active Directory: https://azure.microsoft.com/en-us/documentation/articles/active-directory-howto-tenant/

Consent framework: https://azure.microsoft.com/en-us/documentation/articles/active-directory-integrating-
applications/
Service principal: https://azure.microsoft.com/en-us/documentation/articles/active-directory-application-objects/
Azure Disk Encryption is not supported when using Machine Creation Services.
Create a connection to Azure Resource Manager

See the Create a Site and Connections and resources articles for complete information about all pages in the wizards that
create a Site or a connection. T he following information covers only details specic to Azure Resource Manager
connections.
T here are two ways to establish a host connection to Azure Resource Manager:
Authenticate to Azure Resource Manager to create a new service principal.

Use the details from a previously-created service principal to connect to Azure Resource Manager.
Authenticate to Azure Resource Manager to create a new service principal
Before you start, make sure:
You have a user account in your subscription's Azure Active Directory tenant.
T he Azure AD user account is also a co-administrator for the Azure subscription you want to use for provisioning
resources.
In the Site Setup or Add Connection and Resources wizard:
1. On the Connection page, select the Microsof t Azure connection type and your Azure environment.
2. On the Connection Details page, enter your Azure subscription ID and a name for the connection. T he connection
name can contain 1-64 characters, and cannot contain only blank spaces or the characters \/;:#.*?=<>|[]{}"'()'). After you
enter the subscription ID and connection name, the Create new button is enabled.
3. Enter the Azure Active Directory account username and password.
4. Click Sign in.

5. Click Accept to give XenApp or XenDesktop the listed permissions. XenApp or XenDesktop creates a service principal
that allows it to manage Azure Resource Manager resources on behalf of the specified user.
6. After you click Accept, you are returned to the Connection page in Studio. Notice that when you successfully
authenticate to Azure, the Create new and Use existing buttons are replaced with Connected, and a green check
mark indicates the successful connection to your Azure subscription.
7. Indicate which tools to use to create the virtual machines, and then click Next. (You cannot progress beyond this page in
the wizard until you successfully authenticate with Azure and accept giving the required permissions.
Resources comprise the region and the network.
On the Region page, select a region.

On the Network page,
T ype a 1-64 character resources name to help identify the region and network combination in Studio. A resource
name cannot contain only blank spaces, and cannot contain the characters \/;:#.*?=<>|[]{}"'()'.
Select a virtual network and resource group pair. (Since you can have more than one virtual network with the same
name, pairing the network name with the resource group provides unique combinations.) If you selected a region on
the previous page that does not have any virtual networks, you will need to return to that page and select a region
that has virtual networks.
Complete the wizard.
Use the details f rom a previously-created service principal to connect to Azure Resource Manager
To create a service principal manually, connect to your Azure Resource Manager subscription and use the PowerShell
cmdlets provided below.
Prerequisites:
$SubscriptionId: Azure Resource Manager SubscriptionID for the subscription where you want to provision VDAs.
$AADUser: Azure AD user account for your subscriptions AD tenant.
Make the $AADUser the co-administrator for your subscription.
$ApplicationName: Name for the application to be created in Azure AD.
$ApplicationPassword: Password for the application. You will use this password as the application secret when creating
the host connection.
To create a service principal:
Step 1: Connect to your Azure Resource Manager subscription.
Login-AzureRmAccount.
Step 2: Select the Azure Resource Manager subscription where you want to create the service principal.
Select-AzureRmSubscription -SubscriptionID $SubscriptionId;
Step 3: Create the application in your AD tenant.
$AzureADApplication = New-AzureRmADApplication -DisplayName $ApplicationName -HomePage

"https://localhost/$ApplicationName" -IdentierUris https://$ApplicationName -Password $ApplicationPassword
Step 4: Create a service principal.

New-AzureRmADServicePrincipal -ApplicationId $AzureADApplication.ApplicationId
Step 5: Assign a role to the service principal.
New-AzureRmRoleAssignment -RoleDenitionName Contributor -ServicePrincipalName

$AzureADApplication.ApplicationId scope /subscriptions/$SubscriptionId
Step 6: From the output window of the PowerShell console, note the ApplicationId. You will provide that ID when creating
the host connection.
In the Site Setup or Add Connection and Resources wizard:
1. On the Connection page, select the Microsof t Azure connection type and your Azure environment.
2. On the Connection Details page, enter your Azure subscription ID and a name for the connection. (T he connection
name can contain 1-64 characters, and cannot contain only blank spaces or the characters \/;:#.*?=<>|[]{}"'()').
3. Click Use existing. Provide the subscription ID, subscription name, authentication URL, management URL, storage suffix,
Active Directory ID or tenant ID, application ID, and application secret for the existing service principal. After you enter
the details, the OK button is enabled. Click OK.
4. Indicate which tools to use to create the virtual machines, and then click Next. T he service principal details you provided
will be used to connect to your Azure subscription. (You cannot progress beyond this page in the wizard until you provide
valid details for the Use existing option.)
Resources comprise the region and the network.
On the Region page, select a region.

On the Network page:
T ype a 1-64 character resources name to help identify the region and network combination in Studio. A resource
name cannot contain only blank spaces, and cannot contain the characters \/;:#.*?=<>|[]{}"'()'.
Select a virtual network and resource group pair. (Since you can have more than one virtual network with the same
name, pairing the network name with the resource group provides unique combinations.) If you selected a region on
the previous page that does not have any virtual networks, you will need to return to that page and select a region
that has virtual networks.
Create a Machine Catalog using an Azure Resource

Manager master image
T his information is a supplement to the guidance in the Create Machine Catalogs article.
A master image is the template that will be used to create the VMs in a Machine Catalog. Before creating the Machine
Catalog, create a master image in Azure Resource Manager. For information about master images in general, see the Create
Machine Catalogs article.
When you create a Machine Catalog in Studio:
T he Operating System and Machine Management pages do not contain Azure-specific information. Follow the
guidance in the Create Machine Catalogs article.

On the Master Image page, select a resource group and then navigate (drill down) thorugh the containers to the Azure
VHD you want to use as the master image. T he VHD must have a Citrix VDA installed on it. If the VHD is attached to a
VM, the VM must be stopped.
T he Storage and License Types page appears only when using an Azure Resource Manager master image.
Select a storage type: standard or premium. T he storage type affects which machine sizes are offered on the Virtual
Machines page of the wizard. Both storage types make multiple synchronous copies of your data within a single data
center. For details about Azure storage types and storage replication, see the following:
https://azure.microsoft.com/en-us/documentation/articles/storage-introduction/
https://azure.microsoft.com/en-us/documentation/articles/storage-premium-storage/
https://azure.microsoft.com/en-us/documentation/articles/storage-redundancy/
Select whether or not to use existing on-premises Windows Server licenses. Doing so in conjunction with using
existing on-premises Windows Server images utilizes Azure Hybrid Use Benets (HUB). More details are available at
https://azure.microsoft.com/pricing/hybrid-use-benet/
HUB reduces the cost of running VMs in Azure to the base compute rate since it waives the price of additional
Windows Server licenses from the Azure gallery. You need to bring your on-premises Windows Servers images to Azure
to use HUB. Azure gallery images are not supported. On-premises Windows Client licenses are currently not supported.
See https://blogs.msdn.microsoft.com/azureedu/2016/04/13/how-can-i-use-the-hybrid-use-benet-in-
azure/%23comment-145
To check if the provisioned Virtual Machines are successfully utilizing HUB, run the powershell command
Get-AzureRmVM -ResourceGroup MyResourceGroup -Name MyVM
and check that the license type is Windows_Server. Additional instructions are available at
https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-windows-hybrid-use-benet-licensing/
On the Virtual Machines page, indicate how many VMs you want to create; you must specify at least one. Select a
machine size. After you create a Machine Catalog, you cannot change the machine size. If you later want a different
size, delete the catalog and then create a new catalog that uses the same master image and specifies the desired
machine size.
Virtual machine names cannot contain non-ASCII or special characters.
T he Network Cards, Computer Accounts, and Summary pages do not contain Azure-specific information. Follow the

Microsoft Azure virtualization environments
May 22, 20 17
Connection conguration
When using Studio to create a Microsoft Azure connection, you need information from the Microsoft Azure Publish
Settings le. T he information in that XML le for each subscription looks similar to the sample below (your actual
management certicate will be much longer):
<Subscription
ServiceManagementUrl="https://management.core.windows.net"
Id="o1455234-0r10-nb93-at53-21zx6b87aabb7p"
Name="Test1"
ManagementCerticate=";alkjdaksdj;akjsd;akjsd; sdjfklasdlaskjdfkluqweiopruaiopdfaklsdjfjsdilfasdkl;fjerioup" />
T he following procedure assumes you are creating a connection from Studio, and have launched either the Site creation
wizard or the connection creation wizard.
1. In a browser, go to https://manage.windowsazure.com/publishsettings/index.
2. Download the Publish Settings file.
3. In Studio, on the Connection page of the wizard, after you select the Microsoft Azure connection type, click Import.
4. f you have more than one subscription, you are prompted to select the subscription you want.
T he ID and certicate are automatically and silently imported into Studio.
Power actions using a connection are subject to thresholds. Generally, the default values are appropriate and should not be
changed. However, you can edit a connection and change them (you cannot change these values when you create the
connection). For details, see Edit a connection.
Virtual machines
When creating a Machine Catalog in Studio, selecting the size of each virtual machine depends on the options presented
by Studio, the cost and performance of the selected VM instance type, and scalability.
Studio presents all of the VM instance options that Microsoft Azure makes available in a selected region; Citrix cannot
change this presentation. T herefore, you should be familiar with your applications and their CPU, memory, and I/O
requirements. Several choices are available at difference price and performance points; see the following Microsoft articles
to better understand the options.
MSDN Virtual Machine and Cloud Service Sizes for Azure: https://msdn.microsoft.com/en-
us/library/azure/dn197896.aspx
Virtual Machine Pricing: http://azure.microsoft.com/en-us/pricing/details/virtual-machines
Basic tier: VMs prexed with "Basic" represent the basic disk. T hey are limited primarily by the Microsoft supported IOPS
level of 300. T hese are not recommended for Desktop OS (VDI) or Server OS RDSH (Remote Desktop Session Host)
workloads.

Standard tier: Standard tier VMs appear in four series: A, D, DS, and G.
Series Appear in Studio as
A Extra small, small, medium, large, extra large, A5, A6, A7, A8, A9, A10, A11. Medium and large are
recommended to test using Desktop OS (VDI) or Server OS (RDSH) workloads, respectively.
D Standard_D1, D2, D3, D4, D11, D12, D13, D14. T hese VMs offer SSD for temporary storage.
DS Standard_DS1, DS2, DS3, DS4, DS11, DS12, DS13, DS14. T hese VMs offer local SSD storage for all disks.
G Standard_G1 G5. T hese VMs are for high performance computing.
When provisioning machines in Azure premium storage, be sure to select a machine size that is supported in the premium
storage account.
Cost and perf ormance of VM instance types
For US list pricing, the cost of each VM instance type per hour is available at
http://azure.microsoft.com/en-us/pricing/details/virtual-machines/.
When working with cloud environments, it is important to understand your actual computing requirements. For proof of
concept or other testing activities, it can be tempting to leverage the high-performance VM instance types. It may also be
tempting to use the lowest-performing VMs to save on costs. T he better goal is to use a VM appropriate for the task.
Starting with the best-performing may not get the results you need, and will become very expensive over time - in some
cases, within a week. For lower-performing VM instance types with a lower cost, the performance and usability may not be
appropriate for the task.
For Desktop OS (VDI) or Server OS (RDSH) workloads, testing results using LoginVSI against its medium workload found
that instance types Medium (A2) and Large (A3) offered the best price/performance ratio.
Medium (A2) and Large (A3 or A5) represent the best cost/performance for evaluating workloads. Anything smaller is not
recommended. More capable VM series may offer your applications or users the performance and usability they demand;
however, it is best to baseline against one of these three instance types to determine if the higher cost of a more capable
VM instance type provides true value.
Scalability
Several constraints affect the scalability of catalogs in a hosting unit. Some constraints, such as the number of CPU cores
in an Azure subscription, can be mitigated by contacting Microsoft Azure support to increase the default value (20). Others,
such as the number of VMs in a virtual network per subscription (2048), cannot change.
Currently, Citrix supports 40 VMs in a catalog.
To scale up the number of VMs in a catalog or a host, contact Microsoft Azure support. T he Microsoft Azure default limits
prevent scaling beyond a certain number of VMs; however, this limit changes often, so check the latest information:
http://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.

A Microsoft Azure virtual network supports up to 2048 VMs.
Microsoft recommends a limit of 40 standard disk VM images per cloud service. When scaling, consider the number of cloud
services required for the number of VMs in the entire connection. Also consider VMS needed to provide the hosted
applications.
Contact Microsoft Azure support to determine if the default CPU core limitations must be increased to support your
workloads.

Microsoft System Center Virtual Machine Manager
virtualization environments
May 22, 20 17
Follow this guidance if you use Hyper-V with Microsoft System Center Virtual Machine Manager (VMM) to provide virtual
machines.
T his release supports the VMM versions listed in the System requirements article.
You can use Provisioning Services to provision:
Generation 1 Desktop or Server OS VMs

Generation 2 Windows Server 2012 R2, Windows Server 2016, and Windows 10 VMs (with or without Secure Boot)
You can use Machine Creation Services to provision Generation 1 Desktop or Server OS VMs. When creating VMs with MCS,
Generation 2 VMs do not appear in the selection list for a master VM.
Upgrade VMM
Upgrade from VMM 2012 to VMM 2012 SP1 or VMM 2012 R2

For VMM and Hyper-V Hosts requirements, see http://technet.microsoft.com/en-us/library/gg610649.aspx. For VMM
Console requirements, see http://technet.microsoft.com/en-us/library/gg610640.aspx.
A mixed Hyper-V cluster is not supported. An example of a mixed cluster is one in which half the cluster is running Hyper-
V 2008 and the other is running Hyper-V 2012.
Upgrade from VMM 2008 R2 to VMM 2012 SP1

If you are upgrading from XenDesktop 5.6 on VMM 2008 R2, follow this sequence to avoid XenDesktop downtime.
1. Upgrade VMM to 2012 (now running XenDesktop 5.6 and VMM 2012)
2. Upgrade XenDesktop to the latest version (now running the latest XenDesktop and VMM 2012)
3. Upgrade VMM from 2012 to 2012 SP1 (now running the latest XenDesktop and VMM 2012 SP1)
Upgrade from VMM 2012 SP1 to VMM 2012 R2
If you are starting from XenDesktop or XenApp 7.x on VMM 2012 SP1, follow this sequence to avoid XenDesktop
downtime.
1. Upgrade XenDesktop or XenApp to the latest version (now running the latest XenDesktop or XenApp, and VMM 2012
SP1)
2. Upgrade VMM 2012 SP1 to 2012 R2 (now running the latest XenDesktop or XenApp, and VMM 2012 R2)
Installation and conguration summary
1. Install and configure a hypervisor.

1. Install Microsoft Hyper-V server and VMM on your servers. All Delivery Controllers must be in the same forest as the
VMM servers.
2. Install the System Center Virtual Machine Manager console on all Controllers.
3. Verify the following account information:
T he account you use to specify hosts in Studio is a VMM administrator or VMM delegated administrator for the
relevant Hyper-V machines. If this account only has the delegated administrator role in VMM, the storage data is
not listed in Studio during the host creation process.

T he user account used for Studio integration must also be a member of the administrators local security group on
each Hyper-V server to support VM life cycle management (such as VM creation, update, and deletion).
Note: Installing a Controller on a server running Hyper-V is not supported.

2. Create a master VM.
1. Install a Virtual Delivery Agent on the master VM, and select the option to optimize the desktop. T his improves
performance.
2. T ake a snapshot of the master VM to use as a backup.
3. Create virtual desktops. If you are using MCS to create VMs, when creating a Site or a connection,
1. Select the Microsoft virtualization host type.
2. Enter the address as the fully qualified domain name of the host server.
3. Enter the credentials for the administrator account you set up earlier that has permissions to create new VMs.
4. In the Host Details dialog box, select the cluster or standalone host to use when creating new VMs.
Important: Browse for and select a cluster or standalone host even if you are using a single Hyper-V host deployment.
MCS on SMB 3 le shares
For Machine Catalogs created with MCS on SMB 3 file shares for VM storage, make sure that credentials meet the
following requirements so that calls from the Controller's Hypervisor Communications Library (HCL) connect successfully to
SMB storage:
VMM user credentials must include full read write access to the SMB storage.
Storage virtual disk operations during VM life cycle events are performed through the Hyper-V server using the VMM user
credentials.
When you use SMB as storage, enable the Authentication Credential Security Support Provider (CredSSP) from the
Controller to individual Hyper-V machines when using VMM 2012 SP1 with Hyper-V on Windows Server 2012. For more
information, see CT X137465.
Using a standard PowerShell V3 remote session, the HCL uses CredSSP to open a connection to the Hyper-V machine. T his
feature passes Kerberos-encrypted user credentials to the Hyper-V machine, and the PowerShell commands in the session
on the remote Hyper-V machine run with the credentials provided (in this case, those of the VMM user), so that
communication commands to storage work correctly.
T he following tasks use PowerShell scripts that originate in the HCL and are then sent to the Hyper-V machine to act on
the SMB 3.0 storage.
Consolidate Master Image - A master image creates a new MCS provisioning scheme (machine catalog). It clones and
flattens the master VM ready for creating new VMs from the new disk created (and removes dependency on the original
master VM).
ConvertVirtualHardDisk on the root\virtualization\v2 namespace
Example:
$ims = Get-WmiObject -class $class -namespace " root\virtualization\v2" ;
$result = $ims.ConvertVirtualHardDisk($diskName, $vhdastext)
$result
Create dif f erence disk - Creates a difference disk from the master image generated by consolidating the master image.
T he difference disk is then attached to a new VM.
CreateVirtualHardDisk on the root\virtualization\v2 namespace
Example:

$ims = Get-WmiObject -class $class -namespace " root\virtualization\v2" ;
$result = $ims.CreateVirtualHardDisk($vhdastext);
$result
Upload identity disks - T he HCL cannot directly upload the identity disk to SMB storage. T herefore, the Hyper-V
machine must upload and copy the identity disk to the storage. Because the Hyper-V machine cannot read the disk from
the Controller, the HCL must first copy the identity disk through the Hyper-V machine as follows.
1. T he HCL uploads the Identity to the Hyper-V machine through the administrator share.
2. T he Hyper-V machine copies the disk to the SMB storage through a PowerShell script running in the PowerShell
remote session. A folder is created on the Hyper-V machine and the permissions on that folder are locked for the
VMM user only (through the remote PowerShell connection).
3. T he HCL deletes the file from the administrator share.
4. When the HCL completes the identity disk upload to the Hyper-V machine, the remote PowerShell session copies the
identity disks to SMB storage and then deletes it from the Hyper-V machine.
T he identity disk folder is recreated if it is deleted so that it is available for reuse.
Download identity disks - As with uploads, the identity disks pass though the Hyper-V machine to the HCL. T he
following process creates a folder that only has VMM user permissions on the Hyper-V server if it does not exist.
1. T he HyperV machine copies the disk from the SMB storage to local Hyper-V storage through a PowerShell script
running in the PowerShell V3 remote session.
2. HCL reads the disk from the Hyper-V machine's administrator share into memory.
3. HCL deletes the file from the administrator share.
Personal vDisk creation - If the administrator creates the VM in a Personal vDisk machine catalog, you must create an
empty disk (PvD).
T he call to create an empty disk does not require direct access to the storage. If you have PvD disks that reside on
different storage than the main or operating system disk, then the use remote PowerShell to create the PvD in a
directory folder that has the same name of the VM from which it was created. For CSV or LocalStorage, do not use
remote PowerShell. Creating the directory before creating an empty disk avoids VMM command failure.
From the Hyper-V machine, perform a mkdir on the storage.

VMware virtualization environments
May 22, 20 17
Follow this guidance if you use VMware to provide virtual machines.
Install vCenter Server and the appropriate management tools. (No support is provided for vSphere vCenter Linked Mode
operation.)
If you plan to use MCS, do not disable the Datastore Browser feature in vCenter Server (described in
https://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2101567). If you
disable this feature, MCS does not work correctly.
Required privileges
Create a VMware user account and one or more VMware roles with a set or all of the privileges listed below. Base the roles'
creation on the specic level of granularly required over the users permissions to request the various XenApp or
XenDesktop operations at any time. To grant the user specic permissions at any point, associate them with the respective
role, at the DataCenter level at a minimum.
T he following tables show the mappings between XenApp and XenDesktop operations and the minimum required VMware
privileges.
Add connection and resources
SDK User interf ace
Added automatically. Can use the built-in

System.Anonymous, System.Read, and System.View
read-only role.
Provision machines (Machine Creation Services)
SDK User interf ace
Datastore.AllocateSpace Datastore > Allocate space
Datastore.Browse Datastore > Browse datastore
Datastore.FileManagement Datastore > Low level le operations
Network.Assign Network > Assign network
Resource.AssignVMToPool Resource > Assign virtual machine to resource pool

VirtualMachine.Cong.AddExistingDisk Virtual machine > Conguration > Add existing disk
VirtualMachine.Cong.AddNewDisk Virtual machine > Conguration > Add new disk
VirtualMachine.Cong.AdvancedCong Virtual machine > Conguration > Advanced
VirtualMachine.Cong.RemoveDisk Virtual machine > Conguration > Remove disk
VirtualMachine.Interact.PowerOff Virtual machine > Interaction > Power Off
VirtualMachine.Interact.PowerOn Virtual machine > Interaction > Power On
VirtualMachine.Inventory.CreateFromExisting Virtual machine > Inventory > Create from existing
VirtualMachine.Inventory.Create Virtual machine > Inventory > Create new
VirtualMachine.Inventory.Delete Virtual machine > Inventory > Remove
VirtualMachine.Provisioning.Clone Virtual machine > Provisioning > Clone virtual machine
vSphere 5.0, Update 2 and vSphere 5.1, Update 1: Virtual machine > State
> Create snapshot
VirtualMachine.State.CreateSnapshot
vSphere 5.5: Virtual machine > Snapshot management > Create
snapshot
If you want the VMs you create to be tagged, add the following permissions for the user account:
SDK User interf ace
Global.ManageCustomFields Global > Manage custom attributes
Global.SetCustomField Global > Set custom attribute
To ensure that you use a clean base image for creating new VMs, tag VMs created with Machine Creation Services to
exclude them from the list of VMs available to use as base images.
Provision machines (Provisioning Services)
All privileges from "Provision machines (Machine Creation Services)" and:

SDK User interf ace
Virtual machine > Conguration > Add or remove

VirtualMachine.Cong.AddRemoveDevice
device
Virtual machine > Conguration > Change CPU

VirtualMachine.Cong.CPUCount
Count
VirtualMachine.Cong.Memory Virtual machine > Conguration > Memory
VirtualMachine.Cong.Settings Virtual machine > Conguration > Settings
VirtualMachine.Provisioning.CloneTemplate Virtual machine > Provisioning > Clone template
VirtualMachine.Provisioning.DeployTemplate Virtual machine > Provisioning > Deploy template
Power management
SDK User interf ace
VirtualMachine.Interact.Reset Virtual machine > Interaction > Reset
VirtualMachine.Interact.Suspend Virtual machine > Interaction > Suspend
Image update and rollback
SDK User interf ace

Network.Assign Network > Assign network
Resource > Assign virtual machine to resource

Resource.AssignVMToPool
pool
Virtual machine > Conguration > Add existing

VirtualMachine.Cong.AddExistingDisk
disk
VirtualMachine.Interact.Reset Virtual machine > Interaction > Reset
Virtual machine > Inventory > Create from

VirtualMachine.Inventory.CreateFromExisting
existing
VirtualMachine.Inventory.Create Virtual machine > Inventory > Create new
Virtual machine > Provisioning > Clone virtual

VirtualMachine.Provisioning.Clone
machine
Delete provisioned machines
SDK User interf ace

Create AppDisks (valid for VMware vSphere minimum version 5.5 and XenApp and XenDesktop minimum version 7.8)
SDK User interf ace
Virtual machine > Conguration > Add existing

VirtualMachine.Cong.AddExistingDisk
disk
Virtual machine > Conguration > Modify Device

VirtualMachine.Cong.EditDevice
Settings
Delete AppDisks (valid for VMware vSphere minimum version 5.5 and XenApp and XenDesktop minimum version 7.8 )
SDK User interf ace

Obtain and import a certicate

To protect vSphere communications, Citrix recommends that you use HT T PS rather than HT T P. HT T PS requires digital
certicates. Citrix recommends you use a digital certicate issued from a certicate authority in accordance with your
organization's security policy.
If you are unable to use a digital certicate issued from a certicate authority, and your organization's security policy
permits it, you can use the VMware-installed self-signed certicate. Add the VMware vCenter certicate to each Controller.
Follow this procedure:
1. Add the fully qualified domain name (FQDN) of the computer running vCenter Server to the hosts file on that server,
located at %SystemRoot%/WINDOWS/system32/Drivers/etc/. T his step is required only if the FQDN of the computer
running vCenter Server is not already present in the domain name system.
2. Obtain the vCenter certificate using any of the following methods:
From the vCenter server:
1. Copy the file rui.crt from the vCenter server to a location accessible on your Delivery Controllers.
2. On the Controller, navigate to the location of the exported certificate and open the rui.crt file.
Download the certificate using a web browser. If you are using Internet Explorer, depending on your user account,
you may need to right-click on Internet Explorer and choose Run as Administrator to download or install the
certificate.
1. Open your web browser and make a secure web connection to the vCenter server; for example
https://server1.domain1.com
2. Accept the security warnings.
3. Click on the address bar where it shows the certificate error.
4. View the certificate and click on the Details tab.
5. Select Copy to file and export in .CER format, providing a name when prompted to do so.
6. Save the exported certificate.
7. Navigate to the location of the exported certificate and open the .CER file.
Import directly from Internet Explorer running as an administrator:
1. Open your web browser and make a secure web connection to the vCenter server; for example
https://server1.domain1.com.
2. Accept the security warnings.
3. Click on the address bar where it shows the certificate error.
4. View the certificate.
Import the certificate into the certificate store on each of your Controllers:
1. Click Install certificate, select Local Machine, and then click Next.
2. Select Place all certificates in the following store, and then click Browse.
3. If you are using Windows Server 2008 R2:
1. Select the Show physical stores check box.
2. Expand T rusted People.

3. Select Local Computer.
4. Click Next, then click Finish.
If you are using Windows Server 2012, Windows Server 2012 R2, or Windows Server 2016:
1. Select T rusted People, then click OK.

2. Click Next, then click Finish.
Important: If you change the name of the vSphere server after installation, you must generate a new self-signed
certicate on that server before importing the new certicate.
Create a master VM
Use a master VM to provide user desktops and applications. On your hypervisor:

1. Install a VDA on the master VM, selecting the option to optimize the desktop, which improves performance.
2. T ake a snapshot of the master VM to use as a back-up.
Create virtual desktops
If you are using Studio to create VMs, rather than selecting an existing Machine Catalog, specify the following information
when setting up your hosting infrastructure to create virtual desktops.
1. Select the VMware vSphere host type.
2. Enter the address of the access point for the vCenter SDK.
3. Enter the credentials for the VMware user account you set up earlier that has permissions to create new VMs. Specify
the username in the form domain/username.
VMware SSL thumbprint
T he VMware SSL thumbprint feature addresses a frequently-reported error when creating a host connection to a VMware
vSphere hypervisor. Previously, administrators had to manually create a trust relationship between the Delivery Controllers in
the Site and the hypervisor's certicate before creating a connection. T he VMware SSL thumbprint feature removes that
manual requirement: the untrusted certicate's thumbprint is stored on the Site database so that the hypervisor can be
continuously identied as trusted by XenApp or XenDesktop, even if not by the Controllers.
When creating a vSphere host connection in Studio, a dialog box allows you to view the certicate of the machine you are
connecting to. You can then choose whether to trust it.

Microsoft System Center Conguration Manager
environments
May 22, 20 17
Sites that use Microsoft System Center Conguration Manager (Conguration Manager) to manage access to applications
and desktops on physical devices can extend that use to XenApp or XenDesktop through these integration options.
Citrix Connector 7.5 f or Conf iguration Manager 2012 Citrix Connector provides a bridge between Configuration
Manager and XenApp or XenDesktop. T he Connector enables you to unify day-to-day operations across the physical
environments you manage with Configuration Manager and the virtual environments you manage with XenApp or
XenDesktop. For information about the Connector, see Citrix Connector 7.5 for System Center Configuration Manager
2012 .
Conf iguration Manager Wake Proxy f eature T he Remote PC Access Wake on LAN feature requires Configuration
Manager. For more information, see below.
XenApp and XenDesktop properties XenApp and XenDesktop properties enable you to identify Citrix virtual
desktops for management through Configuration Manager. T hese properties are automatically used by the Citrix
Connector but can also be manually configured, as described in the following section.
Properties
Properties are available to Microsoft System Center Conguration Manager to manage virtual desktops.
Boolean properties displayed in Conguration Manager may appear as 1 or 0, not true or false.
T he properties are available for the Citrix_virtualDesktopInfo class in the Root\Citrix\DesktopInformation namespace.
Property names come from the Windows Management Instrumentation (WMI) provider.
Property Description
AssignmentType Sets the value of IsAssigned. Valid values are:

ClientIP
ClientName
None
User Sets IsAssigned to T rue
BrokerSiteName Site; returns the same value as HostIdentier.
DesktopCatalogName Machine catalog associated with the desktop.
DesktopGroupName Delivery Group associated with the desktop.
HostIdentier Site; returns the same value as BrokerSiteName.
IsAssigned True to assign the desktop to a user, set to False for a random desktop.

IsMasterImage
Property Allows decisions about the environment. For example, you may want to install
Description
applications on the master image and not on the provisioned machines, especially if
those machines are in a clean state on boot machines. Valid values are:
T rue on a VM that is used as a master image (this value is set during installation based
on a selection).
Cleared on a VM that is provisioned from that image.
IsVirtualMachine True for a virtual machine, false for a physical machine.
OSChangesPersist False if the desktop operating system image is reset to a clean state every time it is
restarted; otherwise, true.
PersistentDataLocation T he location where Conguration Manager stores persistent data. T his is not accessible
to users.
PersonalvDiskDriveLetter For a desktop with a Personal vDisk, the drive letter you assign to the Personal vDisk.
BrokerSiteName, Determined when the desktop registers with the Controller; they are null for a desktop
DesktopCatalogName, that has not fully registered.
DesktopGroupName,
HostIdentier
To collect the properties, run a hardware inventory in Conguration Manager. To view the properties, use the Conguration
Manager Resource Explorer. In these instances, the names may include spaces or vary slightly from the property names. For
example, BrokerSiteName may appear as Broker Site Name.
Configure Configuration Manager to collect Citrix WMI properties from the Citrix VDA
Create query-based device collections using Citrix WMI properties
Create global conditions based on Citrix WMI properties
Use global conditions to define application deployment type requirements
You can also use Microsoft properties in the Microsoft class CCM_DesktopMachine in the Root\ccm_vdi namespace. For
more information, see the Microsoft documentation.
Conguration Manager and Remote PC Access Wake on LAN
To congure the Remote PC Access Wake on LAN feature, complete the following before installing a VDA on the ofce
PCs and using Studio to create or update the Remote PC Access deployment:
Configure ConfigMgr 2012, 2012 R2, or 2016 within the organization. T hen deploy the ConfigMgr client to all Remote PC
Access machines, allowing time for the scheduled SCCM inventory cycle to run (or force one manually, if required). T he
access credentials you specify in Studio to configure the connection to ConfigMgr must include collections in the scope
and the Remote T ools Operator role.
For Intel Active Management T echnology (AMT ) support:
T he minimum supported version on the PC must be AMT 3.2.1.

Provision the PC for AMT use with certificates and associated provisioning processes.
Only ConfigMgr 2012 and 2012 R2 can be used, not ConfigMgr 2016.
For ConfigMgr Wake Proxy and/or magic packet support:
Configure Wake on LAN in each PC's BIOS settings.
For Wake Proxy support, enable the option in ConfigMgr. For each subnet in the organization that contains PCs that
will use the Remote PC Access Wake on LAN feature, ensure that three or more machines can serve as sentinel
machines.
For magic packet support, configure network routers and firewalls to allow magic packets to be sent, using either a
subnet-directed broadcast or unicast.
After you install the VDA on office PCs, enable or disable power management when you create the Remote PC Access
deployment in Studio.
If you enable power management, specify connection details: the ConfigMgr address and access credentials, plus a
name.
If you do not enable power management, you can add a power management (Configuration Manager) connection later
and then edit a Remote PC Access machine catalog to enable power management and specify the new power
management connection.
You can edit a power management connection to congure the use of the CongMgr Wake Proxy and magic packets, as
well as change the packet transmission method.
For more information, see Remote PC Access.

Nutanix virtualization environments
May 22, 20 17
Follow this guidance when using Nutanix Acropolis to provide virtual machines in your XenApp or XenDesktop deployment.
T he setup process includes the following tasks:
Install and register the Nutanix plugin in your XenApp or XenDesktop environment.
Create a connection to the Nutanix Acropolis hypervisor.
Create a Machine Catalog that uses a snapshot of a master image you created on the Nutanix hypervisor.
For more information, see the Nutanix Acropolix MCS Plugin Installation Guide, available at the Nutanix Support Portal:
https://portal.nutanix.com.
Install and register the Nutanix plugin

After you install the XenApp or XenDesktop components, complete the following procedure to install and register the
Nutanix plugin on the Delivery Controllers. You will then be able to use Studio to create a connection to the Nutanix
hypervisor and then create a Machine Catalog that uses a snapshot of a master image you created in the Nutanix
environment.
1. Obtain the Nutanix plugin from Nutanix, and install it on the Delivery Controllers.
2. Verify that a Nutanix Acropolis folder has been created in C:\Program Files\Common
Files\Citrix\HCLPlugins\CitrixMachineCreation\v1.0.0.0.
3. Run C:\Program Files\Common Files\Citrix\HCLPlugins\RegisterPlugin.exe PluginRoot C:\Program Files\Common
Files\Citrix\HCLPlugins\CitrixMachineCreation\v1.0.0.0.
4. Restart the Citrix Host Service, Citrix Broker Service, and Citrix Machine Creation Service.
5. Run the following PowerShell cmdlets to verify that the Nutanix Acropolis plugin has been registered:
Add-PSSnapin Citrix*
Get-HypHypervisorPlugin
Create a connection to Nutanix

See the Create a Site and Connections and resources articles for complete information about all pages in the wizards that
create a connection.
In the Site Setup or Add Connection and Resources wizard, select the Nutanix connection type on the Connection page,
and then specify the hypervisor address and credentials, plus a name for the connection. On the Network page, select a
network for the hosting unit.
Create a Machine Catalog using a Nutanix snapshot

T his information is a supplement to the guidance in the Create Machine Catalogs article. It describes only the elds that are
unique to Nutanix.

T he snapshot you select is the template that will be used to create the VMs in the Machine Catalog. Before creating the
Machine Catalog, create images and snapshots in Nutanix.
For information about master images in general, see the Create Machine Catalogs article.
For Nutanix procedures for creating images and snapshots, see the Nutanix documentation referenced above.
T he Operating System and Machine Management pages do not contain Nutanix-specic information. Follow the
On the Container page, which is unique to Nutanix, select the container where the VMs' disks will be placed.
On the Master Image page, select the image snapshot. Acropolis snapshot names must be prexed with "XD_" to be used
in XenApp and XenDesktop. Use the Acropolis console to rename your snapshots, if needed. If you rename snapshots,
restart the Create Catalog wizard to see a refreshed list.
On the Virtual Machines page, indicate the number of virtual CPUs and the number of cores per vCPU.
T he Network Cards, Computer Accounts, and Summary pages do not contain Nutanix-specic information. Follow the

Jun 0 8 , 20 17
Important
Ensure that you download and use the 7.14.1 XenApp and XenDesktop ISO and VDAs. (T he le name contains the version number.)
Do not use the original 7.14 versions.
T he core components are the Delivery Controller, Studio, Director, StoreFront, and License Server.
Important: Before you start an installation, review Prepare to install. Also, review this article before starting an installation.
T his article describes the installation wizard sequence when installing core components. Command-line equivalents are
provided. For more information, see Install using the command line.
Step 1. Download the product software and launch

the wizard
Use your Citrix account credentials to access the XenApp and XenDesktop download page. Download the product ISO le.
Unzip the le. Optionally, burn a DVD of the ISO le.
Log on to the machine where you are installing the core components, using a local administrator account.
Insert the DVD in the drive or mount the ISO le. If the installer does not launch automatically, double-click the AutoSelect
application or the mounted drive.
Step 2. Choose which product to install

Click Start next to the product to install: XenApp or XenDesktop.
(If the machine already has XenApp or XenDesktop components installed on it, this page does not appear.)
Command-line option: /xenapp to install XenApp; XenDesktop is installed if option is omitted
Step 3. Choose what to install

If you're just getting started, select Delivery Controller. (On a later page, you select the specic components to install on
this machine.)
If you've already installed a Controller (on this machine or another) and want to install another component, select the
component from the Extend Deployment section.
Command-line option: /components
Step 4. Read and accept the license agreement

On the Licensing Agreement page, after you read the license agreement, indicate that you have read and accepted it.
T hen click Next.
Step 5. Select the components to install and the

installation location

On the Core components page:
Location: By default, components are installed in C:\Program Files\Citrix. T he default is fine for most deployments. If
you specify a different location, it must have execute permissions for network service.
Components: By default, the check boxes for all core components are selected. Installing all core components on one
server is fine for proof of concept, test, or small production deployments. For larger production environments, Citrix
recommends installing Director, StoreFront, and the License Server on separate servers.
Select only the components you want to install on this machine. After you install components on this machine, you
can run the installer again on other machines to install other components.
An icon alerts you when you choose not to install a required core component on this machine. T hat alert reminds you
to install that component, although not necessarily on this machine.
Click Next.
Command-line options: /installdir, /components, /exclude
Step 6. Enable or disable features
On the Features page:
Choose whether to install Microsoft SQL Server Express for use as the Site database. By default, this selection is
enabled. If you're not familiar with the XenApp and XenDesktop databases, review Databases.
When you install Director, Windows Remote Assistance is installed automatically. You choose whether to enable
shadowing in Windows Remote Assistance for use with Director user shadowing. Enabling shadowing opens T CP port
3389. By default, this feature is enabled. T he default setting is fine for most deployments. T his feature appears only

when you are installing Director.
Click Next.
Command-line options: /nosql (to prevent installation), /no_remote_assistance (to prevent enabling)
Step 7. Open Windows rewall ports automatically
By default, the ports on the Firewall page are opened automatically if the Windows Firewall Service is running, even if the
rewall is not enabled. T he default setting is ne for most deployments. For port information, see Network ports.
Click Next.
(T he graphic shows the port lists when you install all the core components on this machine. T hat type of installation is
usually done only for test deployments.)
Command-line option: /congure_rewall
Step 8. Review prerequisites and conrm installation

T he Summary page lists what will be installed. Use the Back button to return to earlier wizard pages and change selections,
if needed.
When you're ready, click Install.
T he display shows the progress of the installation:

Step 9. Connect to Smart Tools and Call Home
When installing or upgrading a Delivery Controller, the Smart Agent page offers several options:
Enable connections to Smart T ools and Call Home. T his is the recommended selection.
Enable connections to Call Home. During an upgrade, this option does not appear if Call Home is already enabled or if
the installer encounters an error related to the Citrix T elemetry Service.
Do not enable connections to Smart T ools or Call Home.
If you install StoreFront (but not a Controller), the wizard displays the Call Home page, which allows you to participate in
Call Home. If you install other core components (but not a Controller or StoreFront), the wizard does not display either the
Smart Tools or Call Home pages.
If you choose an option to enable connections to Smart Tools and/or Call Home:
1. Click Connect.
2. Provide your Citrix or Citrix Cloud credentials.
3. After your credentials are validated, the process downloads a Smart Agent certificate. After this completes successfully,
a green check mark appears next to the Connect button. If an error occurs during this process, change your
participation selection (to "I do not want to "). You can enroll later.
4. Click Next to continue with the installation wizard.
If you choose not to participate, click Next.
Command-line option: /exclude "Smart Tools Agent" (to prevent installation)
Step 10. Finish this installation

T he Finish page contains green check marks for all prerequisites and components that installed and initialized successfully.
Click Finish.
Step 11: Install remaining core components on other

machines
If you installed all the core components on one machine, continue with Next steps. Otherwise, run the installer on other
machines to install other core components. You can also install more Controllers on other servers.
Next steps
After you install all the required core components, use Studio to create a Site.
After creating the Site, install VDAs.
At any time, you can use the full-product installer to extend your deployment with the following components:
Universal Print Server server component: Launch the installer on the print server. Select Universal Print Server in the
Extend Deployment section. Accept the license agreement, then proceed to the end of the wizard. T here is nothing else
to specify or select. T o install this component form the command line, see Install using the command line.
Federated Authentication Service: See Federated Authentication Service.
Self-Service Password Reset Service: See the current Self-Service Password Reset Service documentation.

Install VDAs
Jun 0 8 , 20 17
Important
T here are two types of VDAs for Windows machines: VDA for Server OS and VDA for Desktop OS. (For information about
VDAs for Linux machines, see the Linux Virtual Delivery Agent documentation.)
Important: Before you start an installation, review Prepare to install. For example, the machine should have the latest
Windows updates. If required updates are not present (such as KB2919355), installation fails.
Before installing VDAs, you should have already installed the core components. You can also create the Site before
installing VDAs.
T his article describes the installation wizard sequence when installing a VDA. Command-line equivalents are provided. For
details, see Install using the command line.
Step 1. Download the product software and launch

the wizard
If you're using the full-product installer:
If you haven't downloaded the XenApp and XenDesktop ISO yet:

Use your Citrix account credentials to access the XenApp and XenDesktop download page. Download the product
ISO file.
Unzip the file. Optionally, burn a DVD of the ISO file.
Use a local administrator account on the image or machine where you're installing the VDA. Insert the DVD in the drive or
mount the ISO file. If the installer does not launch automatically, double-click the AutoSelect application or the
mounted drive.
T he installation wizard launches.
If you're using a standalone package:
Use your Citrix account credentials to access the XenApp and XenDesktop download page. Download the appropriate
package:
Component name on download page Installer le name
Server OS Virtual Delivery Agent <version> VDAServerSetup.exe

Desktop OS Virtual Delivery Agent <version> VDAWorkstationSetup.exe
Desktop OS Core Services Virtual Delivery Agent <version> VDAWorkstationCoreSetup.exe
Right-click the package and choose Run as administrator.

Step 2. Choose which product to install
Click Start next to the product to install: XenApp or XenDesktop. (If the machine already has a XenApp or XenDesktop
component installed, this page does not appear.)
Command-line option: /xenapp to install XenApp; XenDesktop is installed if option is omitted
Step 3. Select the VDA

Select the Virtual Delivery Agent entry. T he installer knows whether it's running on a Desktop or Server OS, so it offers only
the appropriate VDA type.
For example, when you run the installer on a Windows 10 machine, the VDA for Desktop OS option is available. T he VDA for
Server OS option is not offered.
Step 4. Specify how the VDA will be used

On the Environment page, specify how you plan to use the VDA. Choose one of the following:
Master image: (default) You are installing the VDA on a machine image. You plan to use Citrix tools (Machine Creation
Services or Provisioning Services) to create VMs from that master image.
Enable connections to a server machine (if installing on a server) or Remote PC Access (if installing on a desktop
machine): You are installing the VDA on a physical machine or on a VM that was provisioned without a VDA. If you
choose the Remote PC Access option, the following components are not installed/enabled:
App-V
User Profile Manager
Machine Identify Service
Personal vDisk
Click Next.
Command-line options: /masterimage, /remotepc
If you are using the VDAWorkstationCoreSetup.exe installer, this page does not appear in the wizard and the command-line
options are not valid.
Step 5. Choose whether to enable HDX 3D Pro mode

T he HDX 3D Pro page appears only when installing a VDA for Desktop OS.
T he standard VDA mode is recommended for most desktops, including those enabled with Microsoft RemoteFX. T he
standard VDA mode is the default.
T he HDX 3D Pro VDA mode optimizes the performance of graphics-intensive programs and media-rich applications. HDX
3D Pro VDA mode is recommended if the machine accesses a graphics processor for 3D rendering.
For Remote PC Access, the VDA is usually configured with the standard VDA mode. For Remote PC Access configured
with HDX 3D Pro, monitor blanking is supported with
Intel Iris Pro graphics and Intel HD graphics 5300 and above (5th Generation Intel Core Processors and 6th Generation
Intel Core i5 Processors)
NVIDIA Quadro and NVIDIA GRID GPUs
AMD RapidFire
Standard mode HDX 3D Pro mode
Usually best for virtual desktops without graphics Usually best for data center desktops with graphics
hardware acceleration, and for Remote PC Access. hardware acceleration, unless more than four monitors are
necessary.
Any GPU can be used for Remote PC Access, with some Supports GPU acceleration with any GPU. However, console
app compatibility limitations: blanking, non-standard screen resolutions and true multi-
monitor support require NVIDIA GRID, Intel Iris Pro, or AMD
On Windows 7, 8, and 8.1, GPU acceleration for
RapidFire graphics.
DirectX feature levels up to 9.3. Some DirectX 10, 11,
12 applications may not run if they do not tolerate Leverages graphics vendor's driver for broadest application
fallback to DirectX 9. compatibility:

On Windows 10, GPU acceleration is provided for All 3D APIs (DirectX or OpenGL) that the GPU supports.
windowed DirectX 10, 11, and 12 apps. DX 9 apps are Full-screen 3D app support with Intel Iris Pro (Win10
rendered by WARP. DX apps cannot be used in full- only), NVIDIA GRID, and AMD RapidFire.
screen mode. Support for custom driver extensions and APIs. For
OpenGL application acceleration in remote sessions if example, CUDA or OpenCL.
supported by the GPU vendor (currently only NVIDIA).
Arbitrary monitor resolutions (limit determined by Supports up to four monitors.

Windows OS and performance) and up to eight monitors.
H.264 hardware encoding available with Intel Iris Pro H.264 hardware encoding available with Intel Iris Pro
graphics processors. graphics processors and NVIDIA cards.
Click Next .
Command-line option: /enable_hdx_3d_pro
Step 6. Select the components to install and the

installation location
On the Core components page:
Location: By default, components are installed in C:\Program Files\Citrix. T his default is fine for most deployments. If
you specify a different location, that location must have execute permissions for network service.

Components: By default, Citrix Receiver for Windows is installed with the VDA (unless you are using the
VDAWorkstationCoreSetup.exe installer). Clear the check box if you do not want that Citrix Receiver installed. If you are
using the VDAWorkstationCoreSetup.exe installer, Citrix Receiver for Windows is never installed, so this check box is not
displayed.
Click Next.
Command-line options: /installdir, "/components vda" to prevent Citrix Receiver for Windows installation
Step 7. Install additional components
T he Additional Components page contains check boxes to enable or disable installation of other features and
technologies with the VDA. T his page does not appear if:
You are using the VDAWorkstationCoreSetup.exe installer. Also, the command-line options for the additional
components are not valid with that installer.
You are upgrading a VDA and all the additional components are already installed. (If some of the additional components
are already installed, the page lists only components that are not installed.)
Citrix Personalization f or App-V:
Install this component if you use applications from Microsoft App-V packages. For details, see App-V.
Command-line option: /exclude "Citrix Personalization for App-V VDA" to prevent component installation
Citrix AppDisk / Personal vDisk:
Valid only when installing a VDA for Desktop OS on a VM. Installs components used for AppDisk and Personal vDisk.

For more information, see AppDisks and Personal vDisk.
Command-line option: /exclude "Personal vDisk" to prevent AppDisk and Personal vDisk component installation
Citrix User Prole Manager:
T his component manages user personalization settings in user proles. For details, see Prole Management.
Excluding Citrix Prole management from the installation affects the monitoring and troubleshooting of VDAs with
Citrix Director. On the User details and EndPoint pages, the Personalization panel and the Logon Duration panel fail.
On the Dashboard and Trends pages, the Average Logon Duration panel display data only for machines that have
Prole management installed.
Even if you are using a third-party user prole management solution, Citrix recommends that you install and run the
Citrix Prole management Service. Enabling the Citrix Prole management Service is not required.
Command-line option: /exclude "Citrix User Prole Manager" to prevent component installation
Citrix User Prole Manager WMI Plugin:
T his plug-in provides Prole management runtime information in WMI (Windows Management Instrumentation)
objects (for example, prole provider, prole type, size, and disk usage). WMI objects provide session information to
Director.
Command-line option: /exclude "Citrix User Prole Manager WMI Plugin" to prevent component installation
Citrix Machine Identity Service:
T his service prepares the master image for a MCS-provisioned catalog. T he service also manages each provisioned
machine's unique Active Directory identity.
Command-line option: /exclude "Machine Identity Service" to prevent component installation
Default values in the graphical interface:
If you select "Create a master image" on the Environment page (Step 4), items on the Additional Components page
are enabled by default.
If you select "Enable Remote PC Access" or "Enable connections to a server machine" on the Environment page, items
on the Additional Components page are disabled by default.
Step 8. Delivery Controller addresses

On the Delivery Controller page, choose how you want to enter the addresses of installed Controllers. Citrix recommends
that you specify the addresses while you're installing the VDA ("Do it manually"). T he VDA cannot register with a Controller
until it has this information. If a VDA cannot register, users cannot access applications and desktops on that VDA.
Do it manually: (default): Enter the FQDN of an installed Controller and then click Add. If you've installed additional
Controllers, add their addresses.
Do it later (Advanced): If you choose this option, the wizard asks you to confirm that's what you want to do before
continuing. T o specify addresses later, you can either rerun the installer or use Citrix Group Policy. T he wizard also
reminds you on the Summary page.
Choose locations f rom Active Directory: Valid only when the machine is joined to a domain and the user is a domain
user.
Let Machine Creation Services do it automatically: Valid only when using MCS to provision machines.
Click Next. If you selected "Do it later (Advanced)," you are prompted to conrm that you will specify Controller addresses
later.
Other considerations:
T he address cannot contain the characters { | } ~ [ \ ] ^ ' : ; < = > ? & @ ! " # $ % ( ) + / ,
If you specify addresses during VDA installation and in Group Policy, the policy settings override settings provided during
installation.
Successful VDA registration requires that the firewall ports used to communicate with the Controller are open. T hat
action is enabled by default on the Firewall page of the wizard.
After you specify Controller locations (during or after VDA installation), you can use the auto-update feature to update
the VDAs when Controllers are added or removed. For details about how VDAs discover and register with Controllers, see
Delivery Controllers.
Command-line option: /controllers

Step 9. Enable or disable features
On the Features page, use the check boxes to enable or disable features you want to use.
Optimize perf ormance:
Valid only when installing a VDA on a VM, not a physical machine. When this feature is enabled (default), the
optimization tool is used for VDAs running in a VM on a hypervisor. VM optimization includes disabling ofine les,
disabling background defragmentation, and reducing event log size. For details, see CT X125874.
Command-line option: /optimize
If you are using the VDAWorkstationCoreSetup.exe installer, this feature does not appear in the wizard and the
command-line option is not valid. If you are using another installer in a Remote PC Access environment, disable this
feature.
Use Windows Remote Assistance:
When this feature is enabled, Windows Remote Assistance is used with the user shadowing feature of Director.
Windows Remote Assistance opens the dynamic ports in the rewall. (Default = disabled)
Command-line option: /enable_remote_assistance
Use Real-Time Audio Transport f or audio:
Enable this feature if voice-over-IP is widely used in your network. T he feature reduces latency and improves audio
resilience over lossy networks. It allows audio data to be transmitted using RT P over UDP transport. (Default =
disabled)

Command-line option: /enable_real_time_transport
Framehawk:
When this feature is enabled, bidirectional UDP ports 3224-3324 are opened. (Default = disabled)
You can change the port range later with the "Framehawk display channel port range" Citrix policy setting. You must
then open local rewall ports. A UDP network path must be open on any internal (VDA to Citrix Receiver or NetScaler
Gateway) and external (NetScaler Gateway to Citrix Receiver) rewalls. If NetScaler Gateway is deployed, Framehawk
datagrams are encrypted using DT LS (default UDP port 443). For details, see the Framehawk article.
Command-line option: /enable_framehawk_port
AppDisk / Personal vDisk:
Valid only when installing a VDA for Desktop OS on a VM. T his check box is available only if the Citrix AppDisk /
Personal vDisk check box is selected on the Additional Components page. When this check box is enabled, AppDisks
and Personal vDisks can be used. For details, see AppDisks and Personal vDisks.
Command-line option: /baseimage
If you are using the VDAWorkstationCoreSetup.exe installer, this feature does not appear in the wizard and the
command-line option is not valid.
Click Next.
Step 10. Firewall ports
On the Firewall page, by default, the ports are opened automatically if the Windows Firewall Service is running, even if the

rewall is not enabled. T his default setting is ne for most deployments. For port information, see Network ports.
Click Next.
Command-line option: /enable_hdx_ports
Step 11. Review prerequisites and conrm installation
T he Summary page lists what will be installed. Use the Back button to return to earlier wizard pages and change selections.
When you're ready, click Install.
If prerequisites aren't already installed/enabled, the machine may restart once or twice. See Prepare to install.
Step 12. Participate in Call Home

On the Smart Tools page, choose whether to participate in Citrix Call Home, which is now a part of Citrix Smart Tools. If
you choose to participate (the default), click Connect. When prompted, enter your Citrix account credentials.
After your credentials are validated (or if you choose not to participate), click Next.
Step 13. Complete this installation

T he Finish page contains green check marks for all prerequisites and components that installed and initialized successfully.
Click Finish. By default, the machine restarts automatically. (Although you can disable this automatic restart, the VDA
cannot be used until the machine restarts.)
Next: Install other VDAs and continue conguration

Repeat the steps above to install VDAs on other machines or images, if needed.
After you install all VDAs, launch Studio. If you haven't created a Site yet, Studio automatically guides you to that task.
After that's done, Studio guides you to create a machine catalog and then a Delivery Group. See:
Create a Site
Later, if you want to customize an installed VDA:
1. From the Windows feature for removing or changing programs, select Citrix Virtual Delivery Agent or Citrix Remote
PC Access/VDI Core Services VDA. T hen right-click and select Change.
2. Select Customize Virtual Delivery Agent Settings. When the installer launches, you can change:
Controller addresses
T CP/IP port to register with the Controller (default = 80)
Whether to open Windows Firewall ports automatically
Troubleshoot
If your deployment uses Microsoft System Center Conguration Manager, a VDA installation might appear to fail with exit
code 3, even though the VDA installed successfully. To avoid the misleading message, you can wrap your installation in a
CMD script or change the success codes in your Conguration Manager package. For more information, see the forum
discussion at http://discussions.citrix.com/topic/350000-sccm-install-of-vda-71-fails-with-exit-code-3/.
In the Studio display for a Delivery Group, the "Installed VDA version" entry in the Details pane might not be the version
installed on the machines. T he machine's Windows Programs and Features display shows the actual VDA version.

Install using the command line
Jun 0 8 , 20 17
Important
T his article applies to installing components on machines with Windows operating systems. For information about VDAs for
Linux operating systems, see the Linux Virtual Delivery Agent documentation.
In this article:
Use the full-product installer

Use a standalone VDA installer
Command-line options for installing core components
Examples: Install core components
Command-line options for installing a VDA
Examples: Install a VDA
Customize a VDA using the command line
Install the Universal Print Server using the command line
Important: T his article describes how to issue product installation commands. Before beginning any installation, review the
Prepare to install article. T hat article includes descriptions of the available installers.
To see command execution progress and return values, you must be the original administrator or use Run as administrator.
For more information, see the Microsoft command documentation.
As a complement to using the installation commands directly, sample scripts are provided on the product ISO that install,
upgrade, or remove VDAs machines in Active Directory. For details, see Install VDAs using scripts.
Use the full-product installer

To access the full product installer's command-line interface:
1. Download the product package from Citrix. Citrix account credentials are required to access the download site.
2. Unzip the file. Optionally, burn a DVD of the ISO file.
3. Log on to the server where you are installing the components, using a local administrator account.
4. Insert the DVD in the drive or mount the ISO file.
5. From the \x64\XenDesktop Setup directory on the media, run the appropriate command.
To install core components:
Run the XenDesktopServerSetup.exe command, with the options listed in Command-line options for installing core
components.

To install a VDA:
Run the XenDesktopVDASetup.exe command with the options listed in Command-line options for installing a VDA.
To install the Universal Print Server:
Follow the guidance in Install the Universal Print Server using the command line.
To install the Federated Authentication Service:
Citrix recommends using the graphical interface.
To install the Self-Service Password Reset Service:
Follow the guidance in the Self-Service Password Reset Service documentation.
Use a standalone VDA installer

Citrix account credentials are required to access the download site. You must either have elevated administrative privileges
before starting the installation or use Run as administrator.
Download the appropriate package from Citrix:
Component name on download page Installer le name
Server OS Virtual Delivery Agent <version> VDAServerSetup.exe
Desktop OS Virtual Delivery Agent <version> VDAWorkstationSetup.exe
Desktop OS Core Services Virtual Delivery Agent <version> VDAWorkstationCoreSetup.exe
Either extract the files from the package to an existing directory first and then run the installation command, or just run
the package.
To extract the les before installing them, use /extract with the absolute path, for example
.\VDAWorkstationCoreSetup.exe /extract %temp%\CitrixVDAInstallMedia. (T he directory must exist. Otherwise, the
extract fails.) T hen in a separate command, run XenDesktopVdaSetup.exe from the directory containing the
extracted content (in the example above, CitrixVDAInstallMedia). Use the valid options in Command-line options for
installing a VDA.
To run the downloaded package, just run its name: VDAServerSetup.exe, VDAWorkstationSetup.exe, or
VDAWorkstationCoreSetup.exe. Use the valid options in Command-line options for installing a VDA.
If you are familiar with the full product installer:
Run the standalone VDAServerSetup.exe or VDAWorkstationSetup.exe installer as if it was the

XenDesktopVdaSetup.exe command in everything except its name.

T he VDAWorkstationCoreSetup.exe installer is different, because it supports a subset of the options available
to the other installers.
Command-line options for installing core components

T he following options are valid when installing core components with the XenDesktopServerSetup.exe command. For
more detail about options, see Install core components.
/components <component > [,<component >] ...
Comma-separated list of components to install or remove. Valid values are:
CONT ROLLER: Controller
DESKTOPST UDIO: Studio
DESKTOPDIRECTOR: Director
LICENSESERVER: Citrix License Server
STOREFRONT : StoreFront
If this option is omitted, all components are installed (or removed, if the /remove option is also specied).
/congure_rewall
Opens all ports in the Windows rewall used by the components being installed, if the Windows Firewall Service is
running, even if the rewall is not enabled. If you are using a third-party rewall or no rewall, you must manually open
the ports.
/disableexperiencemetrics
Prevents automatic upload of analytics collected during installation, upgrade, or removal to Citrix.
/exclude
Prevents installation of one or more comma-separated features, services, or technologies, enclosed in quotation
marks. Valid values are:
"Local Host Cache Storage (LocalDB)": Prevents installation of the database used for Local Host Cache. T his option
has no effect on whether or not SQL Server Express is installed for use as the Site database.
"Smart Tools Agent": Prevents installation of the Citrix Smart Tools agent.
/help or /h
Displays command help.
/installdir <directory>
Existing empty directory where components will be installed. Default = c:\Program Files\Citrix.
/logpath <path>

Log le location. T he specied folder must exist. T he installer does not create it. Default =
"%T EMP%\Citrix\XenDesktop Installer"
/no_remote_assistance
Valid only when installing Director. Disables the user shadowing feature that uses Windows Remote Assistance.
/noreboot
Prevents a restart after installation. (For most core components, a restart is not enabled by default.)
/nosql
Prevents installation of Microsoft SQL Server Express on the server where you are installing the Controller. If this
option is omitted, SQL Server Express is installed for use as the Site database. (T his option has no effect on the
installation of SQL Server Express LocalDB used for Local Host Cache.)
/quiet or /passive
No user interface appears during the installation. T he only evidence of the installation process is in Windows Task
Manager. If this option is omitted, the graphical interface launches.
/remove
Removes the core components specied with the /components option.
/removeall
Removes all installed core components.
/sendexperiencemetrics
Automatically sends analytics collected during the installation, upgrade, or removal to Citrix. If this option is omitted
(or /disableexperiencemetrics is specied), the analytics are collected locally, but not sent automatically.
/tempdir <directory>
Directory that holds temporary les during installation. Default = c:\Windows\Temp.
/xenapp
Installs XenApp. If this option is omitted, XenDesktop is installed.
Examples: Install core components

T he following command installs a XenDesktop Controller, Studio, Citrix Licensing, and SQL Server Express on a server.
Firewall ports required for component communications are opened automatically.
\x64\XenDesktop Setup\XenDesktopServerSetup.exe /components controller,desktopstudio,licenseserver

/congure_rewall
T he following command installs a XenApp Controller, Studio, and SQL Server Express on the server. Firewall ports required

for component communication are opened automatically.
\x64\XenDesktop Setup\XenDesktopServerSetup.exe /xenapp /components controller,desktopstudio

/congure_rewall
Command-line options for installing a VDA

T he following options are valid with one or more of the following commands: XenDesktopVDASetup.exe,
VDAServerSetup.exe, VDAWorkstationSetup.exe, or VDAWorkstationCoreSetup.exe.
/baseimage
Valid only when installing a VDA for Desktop OS on a VM. Enables the use of Personal vDisks with a master image. For
details, see Personal vDisk.
T his option is not valid when using the VDAWorkstationCoreSetup.exe installer.
/components <component >[,<component >]
Comma-separated list of components to install or remove. Valid values are:
VDA: Virtual Delivery Agent
PLUGINS: Citrix Receiver for Windows (CitrixReceiver.exe)
For example, to install the VDA but not Citrix Receiver, specify /components vda.
If this option is omitted, all components are installed.
T his option is not valid when using the VDAWorkstationCoreSetup.exe installer. T hat installer cannot install a Citrix
Receiver.
/controllers "<controller> [<controller>] [...]"
Space-separated FQDNs of Controllers with which the VDA can communicate, enclosed in quotation marks. Do not
specify both the /site_guid and /controllers options.
/disableexperiencemetrics
Prevents the automatic upload of analytics collected during installation, upgrade, or removal to Citrix.
/enable_framehawk_port
Opens the UDP ports used by Framehawk. Default = false
/enable_hdx_3d_pro
Installs the VDA in HDX 3D Pro mode.
/enable_hdx_ports
Opens ports in the Windows rewall required by the Controller and enabled features (except Windows Remote
Assistance), if the Windows Firewall Service is detected, even if the rewall is not enabled. If you are using a different

rewall or no rewall, you must congure the rewall manually. For port information, see Network ports.
T ip: To open the UDP ports that HDX adaptive transport uses to communicate with the Controller, specify the
/enable_hdx_udp_ports option, in addition to the /enable_hdx_ports option.
/enable_hdx_udp_ports
Opens UDP ports in the Windows rewall that are required by HDX adaptive transport, if the Windows Firewall Service
is detected, even if the rewall is not enabled. If you are using a different rewall or no rewall, you must congure
the rewall manually. For port information, see Network ports.
T ip: To open additional ports that the VDA uses to communicate with the Controller and enabled features, specify
the /enable_hdx_ports option, in addition to the /enable_hdx_udp_ports option.
/enable_real_time_transport
Enables or disables use of UDP for audio packets (Real-T ime Audio Transport for audio). Enabling this feature can
improve audio performance. Include the /enable_hdx_ports option if you want the UDP ports opened automatically
when the Windows Firewall Service is detected.
/enable_remote_assistance
Enables the shadowing feature in Windows Remote Assistance for use with Director. If you specify this option,
Windows Remote Assistance opens the dynamic ports in the rewall.
/exclude "<component >"[,"<component >"]
Prevents installation of one or more comma-separated optional components, enclosed in quotation marks. For
example, installing or upgrading a VDA on an image that is not managed by MCS does not require the Personal vDisk
or Machine Identity Service components. Valid values are:
Personal vDisk
Machine Identity Service
Citrix User Prole Manager
Citrix User Prole Manager WMI Plugin
Citrix Universal Print Client
Citrix Telemetry Service
Citrix Personalization for App-V - VDA
Excluding Citrix Prole management from the installation (using the /exclude "Citrix User Prole Manager" option)
affects monitoring and troubleshooting of VDAs with Citrix Director. On the User details and EndPoint pages, the
Personalization panel and the Logon Duration panel fail. On the Dashboard and Trends pages, the Average Logon
Duration panel display data only for machines that have Prole management installed.
Even if you are using a third-party user prole management solution, Citrix recommends that you install and run the
Citrix Prole management Service. Enabling the Citrix Prole management Service is not required.
T his option is not valid when using the VDAWorkstationCoreSetup.exe installer. T hat installer automatically excludes

many of these items.
/h or /help
Displays command help.
/hdxashv2only
Prevents installation of Flash redirection legacy binaries, for enhanced security.
T his option is not available in the graphical interface.
/installdir <directory>
Existing empty directory where components will be installed. Default = c:\Program Files\Citrix.
/logpath <path>
Log le location. T he specied folder must exist. T he installer does not create it. Default =
"%T EMP%\Citrix\XenDesktop Installer"
/masterimage
Valid only when installing a VDA on a VM. Sets up the VDA as a master image.
T his option is not valid when using the VDAWorkstationCoreSetup.exe installer.
/nocitrixwddm
Valid only on Windows 7 machines that do not include a WDDM driver. Disables installation of the Citrix WDDM driver.
/nodesktopexperience
Valid only when installing a VDA for Server OS. Prevents enabling of the Enhanced Desktop Experience feature. T his
feature is also controlled with the Enhanced Desktop Experience Citrix policy setting.
/noreboot
Prevents a restart after installation. T he VDA cannot be used until after a restart.
/optimize
Valid only when installing a VDA on a VM. Enables optimization for VDAs running in a VM on a hypervisor. VM
optimization includes disabling ofine les, disabling background defragmentation, and reducing event log size. Do not
specify this option for Remote PC Access deployments. For more information, see CT X125874.
/portnumber <port >
Valid only when the /recong option is specied. Port number to enable for communications between the VDA and
the Controller. T he previously congured port is disabled, unless it is port 80.

/quiet or /passive
No user interface appears during the installation. T he only evidence of the installation and conguration process is in
Windows Task Manager. If this option is omitted, the graphical interface launches.
/recong
Customizes previously congured VDA settings when used with the /portnumber, /controllers, or /enable_hdx_ports
options. If you specify this option without also specifying the /quiet option, the graphical interface for customizing
the VDA launches.
/remotepc
Valid only for Remote PC Access deployments. Excludes installation of the following components on a Desktop OS:
Citrix Personalization for App-V
Personal vDisk
T his option is not valid when using the VDAWorkstationCoreSetup.exe installer. T hat installer automatically excludes
installation of these components.
/remove
Removes the components specied with the /components option.
/removeall
Removes all installed VDA components.
/sendexperiencemetrics
Automatically sends analytics collected during the installation, upgrade, or removal to Citrix. If this option is omitted
(or the /disableexperiencemetrics option is specied), the analytics are collected locally, but not sent automatically.
/servervdi
Installs a VDA for Desktop OS on a supported Windows server. Omit this option when installing a VDA for Server OS
on a Windows server. Before using this option, see Server VDI.
T his option should be used only with the full-product VDA installer. T his option is not available in the graphical
interface.
/site_guid <guid>
Globally Unique Identier of the site Active Directory Organizational Unit (OU). T his associates a virtual desktop with a
Site when you are using Active Directory for discovery (auto-update is the recommended and default discovery
method). T he site GUID is a site property displayed in Studio. Do not specify both the /site_guid and /controllers

options.
/tempdir <directory>
Directory to hold temporary les during installation. Default = c:\Windows\Temp.
/virtualmachine
Valid only when installing a VDA on a VM. Overrides detection by the installer of a physical machine, where BIOS
information passed to VMs makes them appear as physical machines.
Examples: Install a VDA

Install a VDA with the f ull-product installer:
T he following command installs a VDA for Desktop OS and Citrix Receiver to the default location on a VM. T his VDA will be
used as a master image. T he VDA will register initially with the Controller on the server named 'Contr-Main' in the domain
'mydomain.' T he VDA will use Personal vDisks, the optimization feature, and Windows Remote Assistance.
\x64\XenDesktop Setup\XenDesktopVdaSetup.exe /quiet /components vda,plugins /controllers "Contr-

Main.mydomain.local" /enable_hdx_ports /optimize /masterimage /baseimage /enable_remote_assistance
Install a Desktop OS VDA with the VDAWorkstationCoreSetup standalone installer:
T he following command installs a Core Services VDA on a Desktop OS for use in a Remote PC Access or VDI deployment.
Citrix Receiver and other non-core services are not installed. T he address of a Controller is specied, and ports in the
Windows Firewall Service will be opened automatically. T he administrator will handle restarts.
VDAWorkstationCoreSetup .exe /quiet /controllers "Contr-East.domain.com" /enable_hdx_ports /noreboot
Customize a VDA using the command line

After you install a VDA, you can customize several settings. From the \x64\XenDesktop Setup directory on the product
media, run the XenDesktopVdaSetup.exe command, using one or more of the following options, which are described in
Command-line options for installing a VDA.
/reconfigure (required when customizing a VDA)

/h or /help
/quiet
/noreboot
/controllers
/portnumber port
/enable_hdx_ports

Install the Universal Print Server using the command
line
Run one of the following commands on each print server:
On a supported 32-bit operating system: From the \x86\Universal Print Server\ directory on the Citrix installation media,
run UpsServer_x86.msi.
On a supported 64-bit operating system: From the \x64\Universal Print Server\ directory on the Citrix installation media,
run UpsServer_x64 .msi.
After you install the Universal Print Server component on your print servers, congure it using the guidance in Provision
printers.

Install VDAs using scripts
May 22, 20 17
T his article applies to installing VDAs on machines with Windows operating systems. For information about VDAs for Linux
operating systems, see the Linux Virtual Delivery Agent documentation.
T he installation media contains sample scripts that install, upgrade, or remove Virtual Delivery Agents (VDAs) for machines in
Active Directory. You can also use the scripts to maintain master images used by Machine Creation Services and Provisioning
Services.
Required access:
T he scripts need Everyone Read access to the network share where the VDA installation command is located. T he
installation command is XenDesktopVdaSetup.exe in the full product ISO, or VDAWorkstationSetup.exe or
VDAServerSetup.exe in a standalone installer.
Logging details are stored on each local machine. T o log results centrally for review and analysis, the scripts need
Everyone Read and Write access to the appropriate network share.
To check the results of running a script, examine the central log share. Captured logs include the script log, the installer log,
and the MSI installation logs. Each installation or removal attempt is recorded in a time-stamped folder. T he folder title
indicates the operation result with the prex PASS or FAIL. You can use standard directory search tools to nd a failed
installation or removal in the central log share. T hose tools offer an alternative to searching locally on the target machines.
Important: Before beginning any installation, read and complete the tasks in Prepare to install.
Install or upgrade VDAs using the script

1. Obtain the sample script InstallVDA.bat from \Support\AdDeploy\ on the installation media. Citrix recommends that you
make a backup of the original script before customizing it.
2. Edit the script:
Specify the version of the VDA to install: SET DESIREDVERSION. For example, version 7 can be specified as 7.0. T he
full value can be found on the installation media in the ProductVersion.txt file (such as 7.0.0.3018). However, a
complete match is not required.
Specify the network share where the installer will be invoked. Point to the root of the layout (the highest point of the
tree). T he appropriate version of the installer (32-bit or 64-bit) is called automatically when the script runs. For
example: SET DEPLOYSHARE=\\fileserver1\share1.
Optionally, specify a network share location for storing centralized logs. For example: SET
LOGSHARE=\\fileserver1\log1).
Specify VDA configuration options as described in Install using the command line. T he /quiet and /noreboot options
are included by default in the script and are required: SET COMMANDLINEOPT IONS=/QUIET /NOREBOOT .
3. Using Group Policy Startup Scripts, assign the script to the OU containing your machines. T his OU should contain only
machines on which you want to install the VDA. When the machines in that OU are restarted, the script runs on all of
them. A VDA is installed on each machine that has a supported operating system.
Remove VDAs using the script

1. Obtain the sample script UninstallVDA.bat from \Support\AdDeploy\ on the installation media. Citrix recommends that
you make a backup of the original script before customizing it.
2. Edit the script.
Specify the version of the VDA to remove: SET CHECK_VDA_VERSION. For example, version 7 can be specified as 7.0.
T he full value can be found on the installation media in the ProductVersion.txt file (such as 7.0.0.3018). However, a
complete match is not required.
Optionally, specify a network share location for storing centralized logs.
3. Using Group Policy Startup Scripts, assign the script to the OU containing your machines. T his OU should contain only
machines from which you want to remove the VDA. When the machines in the OU are restarted, the script runs on all of
them. T he VDA is removed from each machine.
Troubleshoot
T he script generates internal log les that describe script execution progress. T he script copies a
Kickoff_VDA_Startup_Script log to the central log share within seconds of starting the deployment. You can verify that
the overall process is working. If this log is not copied to the central log share as expected, troubleshoot further by
inspecting the local machine. T he script places two debugging log les in the %temp% folder on each machine:
Kickoff_VDA_Startup_Script_<DateT imeStamp>.log
VDA_Install_ProcessLog_<DateT imeStamp>.log
Review these logs to ensure that the script is:
Running as expected.
Properly detecting the target operating system.
Correctly configured to point to the ROOT of the DEPLOYSHARE share (contains the file named AutoSelect.exe).
Capable of authenticating to both the DEPLOYSHARE and LOG shares.

Create a Site
May 22, 20 17
A Site is the name you give to a XenApp or XenDesktop deployment. It comprises the Delivery Controllers and other core
components, Virtual Delivery Agents (VDAs), connections to hosts, machine catalogs, and Delivery Groups. You create the
Site after you install the core components and before creating the rst machine catalog and Delivery Group.
When you create a Site, you are automatically enrolled in the Citrix Customer Experience Improvement Program (CEIP). CEIP
collects anonymous statistics and usage information, and then sends it to Citrix. T he rst data package is sent to Citrix
approximately seven days after you create the Site. You can change your enrollment at any time after Site creation. Select
Conguration in the Studio navigation pane, then the Product Support tab, and follow the guidance. For details, see
http://more.citrix.com/XD-CEIP.
T he user who creates a Site becomes a full administrator; for more information, see Delegated Administration.
Review this article before you start the Site creation wizard.
To create a Site:
Open Studio if it is not already open. You are automatically guided to the action that starts the Site creation wizard. T he
wizard pages cover the following conguration:
Site type and name
T here are two Site types; choose one:
Application and desktop delivery Site. When you create an application and desktop delivery Site, you can further
choose to create a full deployment Site (recommended) or an empty Site. An empty Site is only partially configured, and
is usually created by advanced administrators.
Remote PC Access Site. A Remote PC Access Site allows designated users to remotely access their office PCs through
a secure connection.
If you create an application and desktop delivery deployment now, you can add a Remote PC Access deployment later.
Conversely, if you create a Remote PC Access deployment now, you can add a full deployment later.
Type a name for the Site. After the Site is created, its name appears at the top of the Studio navigation pane: Citrix
Studio (site-name).
Databases
T he Databases page contains selections for setting up the Site, Monitoring, and Conguration Logging databases. For
details about database setup choices and requirements, see Databases.
If you choose to install SQL Server Express for use as the Site database (the default), a restart occurs after that software
is installed. T hat restart does not occur if you choose not to install the SQL Server Express software for use as the Site
database.
If you are not using the default SQL Server Express, ensure the SQL Server software is installed on the machines before
creating a Site. System requirements lists the supported versions.
If you want to add more Controllers to the Site, and have already installed the Controller software on other servers, you

can add those Controllers from this page. If you plan to generate scripts that set up the databases, add the Controllers
before generating the scripts.
Licensing
Consider whether you will use existing licenses or the 30-day free trial that allows you to add license les later. You can also
add or download license les from within the Site creation wizard. For details, see the Licensing documentation.
Specify the License Server address in the form name:[port ]. T he name must be an FQDN, NetBIOS, or IP address. FQDN is
recommended. If you omit the port number, the default is 27000. Click Connect. You cannot proceed to the next page in
the wizard until a successful connection is made to the License Server.
Power management (Remote PC Access only)
See Remote PC Access.
Host connection, network, and storage
If you are using VMs on a hypervisor or cloud service to deliver applications and desktops, you can optionally create the rst
connection to that host. You can also specify storage and network resources for that connection. After creating the Site,
you can modify this connection and resources, and create more connections. For details, see Connections and resources.
Connection page: See Connection type information sources.
If you are not using VMs on a hypervisor or cloud service (or if you use Studio to manage desktops on dedicated blade
PCs), select the connection type None.
If you are conguring a Remote PC Access Site and plan to use the Wake on LAN feature, select the Microsof t
System Center Conguration Manager type.
In addition to the connection type, specify whether you will use Citrix tools (such as Machine Creation Services) or other
tools to create VMs.
Storage and Network pages: See Host storage, Storage management, and Storage selection for details about storage
types and management methods.
Additional Features
You can select features to customize your Site. When you select the check box for an item that requires information, a
conguration box appears.
AppDNA Integration
Valid if you use AppDisks and have installed AppDNA. AppDNA integration allows analysis of applications in the
AppDisks. You can then review compatibility issues and take remedial actions to resolve those issues. For more
information, see AppDisks.
App-V Publishing
Select this feature if you use applications from Microsoft App-V packages on App-V servers. Provide the URL of the
App-V management server and the URL and port number of the App-V publishing server.
If you use applications from App-V packages on network share locations only, you do not need to select this feature.

You can also enable/disable and congure this feature later in Studio. For more information, see App-V.
Remote PC Access
For information about Remote PC Access deployments, see Remote PC Access.
If you use the Wake on LAN feature, complete the conguration steps on the Microsoft System Center Conguration
Manager before creating the Site. For details, see Microsoft System Center Conguration Manager.
When you create a Remote PC Access Site:
If you're using the Wake on LAN feature, specify the Microsoft System Center Configuration Manager address,
credential, and connection information on the Power Management page.
Specify users or user groups on the Users page. T here is no default action that automatically adds all users. Also, specify
machine accounts (domain and OU) information on the Machine Accounts page.
To add user information, click Add Users. Select users and user groups, and then click Add users.
To add machine accounts information, click Add machine accounts. Select the machine accounts, and then click Add
machine accounts. Click Add OUs. Select the domain and Organizational Units, and indicate whether to include items
in subfolders. Click Add OUs.
When you create a Remote PC Access Site, a machine catalog named Remote PC User Machine Accounts is created
automatically. T he catalog contains all the machine accounts you added in the Site creation wizard. A Delivery Group
named Remote PC User Desktops is created automatically. T he group contains all the users and user groups you added.
Summary
T he last page of the Site creation wizard summarizes the information you specied. Use the Back button if you want to
change anything. When you're nished, click Create and the Site creation begins.
Test a Site conguration

To run the tests after you create the Site, select Citrix Studio (Site site-name) at the top of the navigation pane. T hen
click Test site in the center pane. You can view an HT ML report of the Site test results.
T he site test functionality might fail for a Controller installed on Windows Server 2016. T he failure occurs when a local SQL
Server Express is used for the Site database and the SQL Server Browser service is not started. To avoid this failure,
complete the following tasks.
1. Enable the SQL Server Browser service (if necessary) and then start it.
2. Restart the SQL Server (SQLEXPRESS) service.
Troubleshoot
After conguring the Site, you can install Studio and add it through the MMC as a snap-in on a remote machine. If you later
attempt to remove that snap-in, the MMC might stop responding. As a workaround, restart the MMC.

May 22, 20 17
Collections of physical or virtual machines are managed as a single entity called a machine catalog. All the machines in a
catalog have the same type of operating system: server or desktop. A catalog containing Server OS machines can contain
either Windows or Linux machines, not both.
Studio guides you to create the rst machine catalog after you create the Site. After you create the rst catalog, Studio
guides you to create the rst Delivery Group. Later, you can change the catalog you created, and create more catalogs.
Overview
When you create a catalog of VMs, you specify how to provision those VMs. You can use Citrix tools such as Machine
Creation Services (MCS) or Provisioning Services (PVS). Or, you can use your own tools to provide machines.
If you use PVS to create machines, see the Provisioning Services documentation for instructions.
If you use MCS to provision VMs, you provide a master image (or snapshot) to create identical VMs in the catalog.
Before you create the catalog, you first use hypervisor or cloud service tools to create and configure the master image.
T his process includes installing a Virtual Delivery Agent (VDA) on the image. T hen you create the machine catalog in
Studio. You select that image (or a snapshot of an image), specify the number of VMs to create in the catalog, and
configure additional information.
If your machines are already available (so you do not need master images), you must still create one or more machine
catalogs for those machines.
When using MCS or PVS to create the rst catalog, you use the host connection that you congured when you created
the Site. Later (after you create your rst catalog and Delivery Group), you can change information about that connection
or create more connections.
After you complete the catalog creation wizard, tests run automatically to ensure that it is congured correctly. When the
tests complete, you can view a test report. You can run the tests at any time from Studio.
Tip: If you are creating a catalog using the PowerShell SDK directly, you can specify a hypervisor template (VMTemplates),
rather than an image or a snapshot.
VDA registration with a Delivery Controller
A VDA must be registered with a Delivery Controller to be considered when launching brokered sessions. Unregistered VDAs
can result in underutilization of otherwise available resources. T here are a variety of reasons a VDA might not be registered,
many of which an administrator can troubleshoot. Studio provides troubleshooting information in the catalog creation
wizard, and after you add a catalog to a Delivery Group.
In the catalog creation wizard, after you add existing machines, the list of computer account names indicates whether
each machine is suitable for adding to the catalog. Hover over the icon next to each machine to display an informative
message about that machine.
If the message identies a problematic machine, you can either remove that machine (using the Remove button), or add
the machine. For example, if a message indicates that information could not be obtained about a machine (perhaps
because it had never registered with a Delivery Controller), you might choose to add the machine anyway.

For messages about functional level, see VDA versions and functional levels.
For more information about VDA registration troubleshooting, see CT X136668.
MCS catalog creation summary
Here's a brief overview of default MCS actions after you provide information in the catalog creation wizard.
If you selected a master image (rather than a snapshot), MCS creates a snapshot.
MCS creates a full copy of the snapshot and places the copy on each storage location defined in the host connection.
MCS adds the machines to Active Directory, which creates unique identities.
MCS creates the number of VMs specified in the wizard, with two disks defined for each VM. In addition to the two
disks per VM, a master is also stored in the same storage location. If you have multiple storage locations defined, each
gets the following disk types:
T he full copy of the snapshot (noted above), which is read-only and shared across the just-created VMs.
A unique 16 MB identity disk that gives each VM a unique identity. Each VM gets an identity disk.
A unique difference disk to store writes made to the VM. T his disk is thin provisioned (if supported by the host
storage) and increases to the maximum size of the master image, if necessary. Each VM gets a difference disk. T he
difference disk holds changes made during sessions. It is permanent for dedicated desktops. For pooled desktops, it is
deleted and a new one created after each restart.
Alternatively, when creating VMs to deliver static desktops, you can specify (on the Machines page of the catalog creation
wizard) thick (full copy) VM clones. Full clones do not require retention of the master image on every data store. Each VM
has its own le.
Prepare a master image on the hypervisor or cloud

service
Tip: For information about creating connections to hypervisors and cloud providers, see Connections and resources.
T he master image contains the operating system, non-virtualized applications, VDA, and other software.
Good to know:
A master image might also be known as a clone image, golden image, base VM, or base image. Host vendors and cloud
service providers may use different terms.
When using PVS, you can use a master image or a physical computer as the master target device. PVS uses different
terminology than MCS to refer to images; see the Provisioning Services documentation for details.
Ensure that the hypervisor or cloud service has enough processors, memory, and storage to accommodate the number
of machines created.
Configure the correct amount of hard disk space needed for desktops and applications. T hat value cannot be changed
later or in the machine catalog.
Remote PC Access machine catalogs do not use master images.
Microsoft KMS activation considerations when using MCS: If your deployment includes 7.x VDAs with a XenServer 6.1 or
6.2, vSphere, or Microsoft System Center Virtual Machine Manager host, you do not need to manually re-arm Microsoft
Windows or Microsoft Office. If your deployment includes a 5.x VDA with a XenServer 6.0.2 host, see CT X128580.
Install and configure the following software on the master image:

Integration tools for your hypervisor (such as XenServer T ools, Hyper-V Integration Services, or VMware tools). If you
omit this step, applications and desktops might not function correctly.
A VDA. Citrix recommends installing the latest version to allow access to the newest features. Failure to install a VDA
on the master image causes the catalog creation to fail.
T hird-party tools as needed, such as anti-virus software or electronic software distribution agents. Configure services
with settings that are appropriate for users and the machine type (such as updating features).
T hird-party applications that you are not virtualizing. Citrix recommends virtualizing applications. Virtualizing reduces
costs by eliminating having to update the master image after adding or reconfiguring an application. Also, fewer
installed applications reduce the size of the master image hard disks, which saves storage costs.
App-V clients with the recommended settings, if you plan to publish App-V applications. T he App-V client is available
from Microsoft.
When using MCS, if you localize Microsoft Windows, install the locales and language packs. During provisioning, when
a snapshot is created, the provisioned VMs use the installed locales and language packs.
Important: If you are using PVS or MCS, do not run Sysprep on master images.
To prepare a master image:
1. Using your hypervisors management tool, create a master image and then install the operating system, plus all service packs and updates.
Specify the number of vCPUs. You can also specify the vCPU value if you create the machine catalog using PowerShell. You cannot specify
the number of vCPUs when creating a catalog using Studio. Configure the amount of hard disk space needed for desktops and applications.
That value cannot be changed later or in the catalog.
2. Ensure that the hard disk is attached at device location 0. Most standard master image templates configure this location by default, but
some custom templates might not.
3. Install and configure the software listed above on the master image.
4. When using PVS, create a VHD file for the vDisk from your master target device before you join the master target device to a domain. See
the Provisioning Services documentation for details.
5. If you are not using MCS, join the master image to the domain where applications and desktops are members. Ensure that the master
image is available on the host where the machines are created. If you are using MCS, joining the master image to a domain is not required.
The provisioned machines are joined to the domain specified in the catalog creation wizard.
6. Citrix recommends that you create and name a snapshot of your master image so that it can be identified later. If you specify a master
image rather than a snapshot when creating a catalog, Studio creates a snapshot, but you cannot name it.
Prepare a master image f or GPU-capable machines on XenServer
When using XenServer for your hosting infrastructure, GPU-capable machines require a dedicated master image. T hose VMs
require video card drivers that support GPUs. Congure GPU-capable machines to allow the VM to operate with software
that uses the GPU for operations.
1. In XenCenter, create a VM with standard VGA, networks, and vCPU.

2. Update the VM configuration to enable GPU use (either Passthrough or vGPU).
3. Install a supported operating system and enable RDP.
4. Install XenServer T ools and NVIDIA drivers.
5. T urn off the Virtual Network Computing (VNC) Admin Console to optimize performance, and then restart the VM.
6. You are prompted to use RDP. Using RDP, install the VDA and then restart the VM.
7. Optionally, create a snapshot for the VM as a baseline template for other GPU master images.
8. Using RDP, install customer-specific applications that are configured in XenCenter and use GPU capabilities.
Create a machine catalog using Studio

Before starting the catalog creation wizard, review this section to learn about the choices you make and information you

supply.
Important: If you are using a master image, ensure that you have installed a VDA on the image before creating the
catalog.
From Studio:
If you already created a Site but havent yet created a machine catalog, Studio guides you to the correct starting place
to create a catalog.
If you already created a catalog and want to create another, select Machine Catalogs in the Studio navigation pane.
T hen select Create Machine Catalog in the Actions pane.
T he wizard walks you through the items described below. T he wizard pages you see may differ, depending on the selections
you make.
Operating system
Each catalog contains machines of only one type:
Server OS: A Server OS catalog provides hosted shared desktops and applications. T he machines can be running
supported versions of the Windows or Linux operating systems, but the catalog cannot contain both. (See the Linux
VDA documentation for details about that OS.)
Desktop OS: A Desktop OS catalog provides VDI desktops and applications that can be assigned to various different
users.
Remote PC Access: A Remote PC Access catalog provides users with remote access to their physical office desktop
machines. Remote PC Access does not require a VPN to provide security.
Machine management
T his page does not appear when you are creating Remote PC Access catalogs.
T he Machine Management page indicates how machines are managed and which tool you use to deploy machines.
Choose whether or not machines in the catalog will be power managed through Studio.
Machines are power managed through Studio or provisioned through a cloud environment, for example, VMs or blade
PCs. T his option is available only if you already configured a connection to a hypervisor or cloud service.
Machines are not power managed through Studio, for example, physical machines.
If you indicated that machines are power managed through Studio or provisioned through a cloud environment, choose
which tool to use to create VMs.
Citrix Machine Creation Services (MCS) Uses a master image to create and manage virtual machines. Machine
catalogs in cloud environments use MCS. MCS is not available for physical machines.
Citrix Provisioning Services (PVS) Manages target devices as a device collection. A PVS vDisk imaged from a master
target device delivers desktops and applications. T his option is not available for cloud deployments.
Other A tool that manages machines already in the data center. Citrix recommends that you use Microsoft System
Center Configuration Manager or another third-party application to ensure that the machines in the catalog are
consistent.
Desktop types (desktop experience)

T his page appears only when you are creating a catalog containing Desktop OS machines.
T he Desktop Experience page determines what occurs each time a user logs on. Select one of:
Users connect to a new (random) desktop each time they log on.
Users connect to the same (static) desktop each time they log on.
If you choose the second option and are using PVS to provision the machines, you can congure how user changes to the
desktop are handled:
Save user changes to the desktop on a separate Personal vDisk.

Save user changes to the desktop on the local disk.
Discard user changes and clear the virtual desktop when the user logs off.
Master image
T his page appears only when you are using MCS to create VMs.
Select the connection to the host hypervisor or cloud service, and then select the snapshot or VM created earlier. If you are
creating the rst catalog, the only available connection will be the one you congured when you created the Site.
Remember:
When you are using MCS or PVS, do not run Sysprep on master images.
If you specify a master image rather than a snapshot, Studio creates a snapshot, but you cannot name it.
To enable use of the latest product features, ensure the master image has the latest VDA version installed. Do not change
the default minimum VDA selection. However, if you must use an earlier VDA version, see VDA versions and functional levels.
An error message appears if you select a snapshot or VM that is not compatible with the machine management technology
you selected earlier in the wizard.
Cloud platf orm and service environments
When you are using a cloud service or platform to host VMs (such as Azure Resource Manager, Nutanix, or Amazon Web
Services), the catalog creation wizard may contain additional pages specic to that host.
For details, see Where to nd information about connection types.
Device Collection
T his page appears only when using PVS to create VMs. It displays the device collections and the devices that have not
already been added to catalogs.
Select the device collections to use. See the Provisioning Services documentation for details.
Machines
T he title of this page depends on what you selected on the Machine Management page: Machines, Virtual Machines, or
VMs and users.
When using MCS to create machines:

Specify how many virtual machines to create.
Choose the amount of memory (in MB) each VM will have.
Important: Each created VM will have a hard disk. Its size is set in the master image; you cannot change the hard disk
size in the catalog.
If you indicated on the Desktop Experience page that user changes to static desktops should be saved on a separate
Personal vDisk, specify the vDisk size in gigabytes and the drive letter.
If your deployment contains more than one zone, you can select a zone for the catalog.
If you are creating static desktop VMs, select a virtual machine copy mode. See Virtual machine copy mode.
If you are creating random desktop VMs that do not use personal vDisks, you can configure a cache to be used for
temporary data on each machine. See Configure cache for temporary data.
When using PVS to create machines:
T he Devices page lists the machines in the device collection that you selected on the previous wizard page. You
cannot add or remove machines on this page.
When using other tools to provide machines:
Add (or import a list of) Active Directory machine account names. You can change the Active Directory account name
for a VM after you add/import it. If you specied static machines on the Desktop Experience wizard page, you can
optionally specify the Active Directory user name for each VM you add.
After you add or import names, you can use the Remove button to delete names from the list, while you are still on
this wizard page.
When using PVS or other tools (but not MCS):
An icon and tooltip for each machine added (or imported, or from a PVS device collection) help identify machines that
might not be eligible to add to the catalog, or be unable to register with a Delivery Controller. For details, see VDA
versions and functional levels.
Virtual machine copy mode

T he copy mode you specify on the Machines page determines whether MCS creates thin (fast copy) or thick (full copy)
clones from the master image. (Default = thin clones)
Use fast copy clones for more efficient storage use and faster machine creation.
Use full copy clones for better data recovery and migration support, with potentially reduced IOPS after the machines
are created.
VDA versions and functional levels

A catalog's functional level controls which product features are available to machines in the catalog. Using features
introduced in new product versions may require a new VDA. Setting a functional level makes all features introduced in that
version (and later, if the functional level does not change) available to machines in the catalog. However, machines in that
catalog with an earlier VDA version will not be able to register.
A drop-down near the bottom of the Machines (or Devices) page allows you to select the minimum VDA level that will
successfully register; this sets the catalog's minimum functional level. By default, the most current functional level is
selected for on-premises deployments. If you follow the Citrix recommendation to always install and upgrade VDAs and

core components to the latest version, you don't need to change this selection. However, if you must continue using older
VDA versions, select the correct value.
A XenApp and XenDesktop release might not include a new VDA version, or the new VDA does not impact the
functional level. In such cases, the functional level might indicate a VDA version that is earlier than the installed or
upgraded components. For example, although XenApp and XenDesktop 7.14 contain a 7.14 VDA that supports new
and enhanced features, the default functional level ("7.9 ...") remains the most current. T herefore, after installing or
upgrading components from 7.9, 7.11, 7.12, or 7.13 to 7.14, you do not need to change the default functional level.
In Citrix Cloud deployments, Studio uses a default functional level that can be earlier than the most current.
T he selected functional level affects the list of machines above it. In the list, a tooltip next to each entry indicates whether
the machine's VDA is compatible with the catalog at that functional level.
Messages are posted on the page if the VDA on each machine does not meet or exceed the minimum functional level
selected. You can continue with the wizard, but be aware that those machines will likely not be able to register with a
Controller later. Alternatively, you can:
Remove the machines containing older VDAs from the list, upgrade their VDAs and then add them back to the catalog.
Choose a lower functional level; however, that will prevent access to the latest product features.
A message is also posted if a machine was not be added to the catalog because it is the wrong machine type. Examples
include attempting to add a server to a Desktop OS catalog, or adding a Desktop OS machine originally created for random
allocation to a catalog of static machines.
Congure cache for temporary data

Caching temporary data locally on the VM is optional. You can enable use of the temporary data cache on the machine
when you use MCS to manage pooled (not dedicated) machines in a catalog. If the catalog uses a connection that
species storage for temporary data, you can enable and congure the temporary data cache information when you
create the catalog.
To enable the caching of temporary data, the VDA on each machine in the catalog must be minimum version 7.9.
You specify whether temporary data uses shared or local storage when you create the connection that the catalog uses;
for details, see Connections and resources. Enabling and conguring the temporary cache in the catalog includes two check
boxes and values: Memory allocated to cache (MB) and Disk cache size (GB). T he default values differ according to the
connection type. Generally, the default values are sufcient for most cases; however, take into account the space needed
for:
T emporary data files created by Windows itself, including the Windows page file.
User profile data.
ShareFile data that is synced to users' sessions.
Data that may be created or copied by a session user or any applications users may install inside the session.
Windows will not allow a session to use an amount of cache disk that is signicantly larger than the amount of free space
on the original master image from which machines in the machine catalog are provisioned. For example, there is no benet
specifying a 20 GB cache disk if there is only 10 GB of free space on the master image.
If you enable the Disk cache size check box, temporary data is initially written to the memory cache. When the memory
cache reaches its congured limit (the Memory allocated to cache value), the oldest data is moved to the temporary data

cache disk.
T he memory cache is part of the total amount of memory on each machine; therefore, if you enable the Memory
allocated to cache check box, consider increasing the total amount of memory on each machine.
If you clear the Memory allocated to cache check box and leave the Disk cache size check box enabled, temporary data
is written directly to the cache disk, using a minimal amount of memory cache.
Changing the Disk cache size from its default value can affect performance. T he size must match user requirements and
the load placed on the machine.
Important: If the disk cache runs out of space, the user's session becomes unusable.
If you clear the Disk cache size check box, no cache disk will be created. In this case, specify a Memory allocated to
cache value that is large enough to hold all of the temporary data; this is feasible only if large amounts of RAM are
available for allocation to each VM.
If you clear both check boxes, temporary data is not cached; it is written to the difference disk (located in the OS storage)
for each VM. (T his is the provisioning action in releases earlier than 7.9.)
Do not enable caching if you intend to use this catalog to create AppDisks.
You cannot change the cache values in a machine catalog after it is created.
Network Interf ace Cards (NICs)
If you plan to use multiple NICs, associate a virtual network with each card. For example, you can assign one card to access
a specic secure network, and another card to access a more commonly-used network. You can also add or remove NICs
from this page.
Machine accounts

T his page appears only when creating Remote PC Access catalogs.
Specify the Active Directory machine accounts or Organizational Units (OUs) to add that correspond to users or user
groups. Do not use a forward slash (/) in an OU name.
You can choose a previously-congured power management connection or elect not to use power management. If you
want to use power management but a suitable connection hasn't been congured yet, you can create that connection
later and then edit the machine catalog to update the power management settings.
Computer accounts
T his page appears only when using MCS to create VMs.
Each machine in the catalog must have a corresponding Active Directory computer account. Indicate whether to create
new accounts or use existing accounts, and the location for those accounts.
If you create new accounts, you must have access to a domain administrator account for the domain where the
machines will reside.
Specify the account naming scheme for the machines that will be created, using hash marks to indicate where
sequential numbers or letters will appear. Do not use a forward slash (/) in an OU name. A name cannot begin with a
number. For example, a naming scheme of PC-Sales-## (with 0-9 selected) results in computer accounts named PC-
Sales-01, PC-Sales-02 , PC-Sales-03, and so on.
If you use existing accounts, either browse to the accounts or click Import and specify a .csv file containing account
names. T he imported file content must use the format:
[ADComputerAccount]
ADcomputeraccountname.domain
...
Ensure that there are enough accounts for all the machines youre adding. Studio manages these accounts, so either
allow Studio to reset the passwords for all the accounts or specify the account password, which must be the same
for all accounts.
For catalogs containing physical machines or existing machines, select or import existing accounts and assign each machine
to both an Active Directory computer account and to a user account.
For machines created with PVS, computer accounts for target devices are managed differently; see the Provisioning
Services documentation.
Summary, name, and description
On the Summary page of the wizard, review the settings you specied. Enter a name and description for the catalog; this
information appears in Studio.
After reviewing the information you specied, click Finish to start the catalog creation.

Manage machine catalogs
May 22, 20 17
In this article:
Introduction
Add machines to a Machine Catalog
Delete machines from a Machine Catalog
Change a Machine Catalog description or change Remote PC Access settings
Rename a Machine Catalog
Move a Machine Catalog to another zone
Delete a Machine Catalog
Manage Active Directory computer accounts in a Machine Catalog
Update a Machine Catalog
Upgrade a Machine Catalog
Introduction
You can add or remove machines from a Machine Catalog, as well as rename, change the description, or manage a catalog's
Active Directory computer accounts.
Maintaining catalogs can also include making sure each machine has the latest OS updates, anti-virus software updates,
operating system upgrades, or conguration changes.
For Machine Catalogs containing pooled random machines created using Machine Creation Services (MCS), you can
maintain machines by updating the master image used in the catalog and then updating the machines. T his enables you
to efficiently update large numbers of user machines. For machines created using Provisioning Services, updates to
machines are propagated through the vDisk. See the Provisioning Services documentation for details.
For catalogs containing static, permanently assigned machines, and for Remote PC Access Machine catalogs, you
manage updates to users' machines outside of Studio, either individually or collectively using third-party software
distribution tools.
For information about creating and managing connections to host hypervisors and cloud services, see Connections and
resources.
Add machines to a Machine Catalog

Before you start:
Make sure the virtualization host (hypervisor or cloud service provider) has sufficient processors, memory, and storage to
accommodate the additional machines.
Make sure that you have enough unused Active Directory computer accounts. If you are using existing accounts, the
number of machines you can add is limited by the number of accounts available.
If you use Studio to create Active Directory computer accounts for the additional machines, you must have appropriate
domain administrator permission.

To add machines to a catalog:
1. Select Machine Catalogs in the Studio navigation pane.

2. Select a Machine Catalog and then select Add machines in the Actions pane.
3. Select the number of virtual machines to add.
4. If there are insufficient existing Active Directory accounts for the number of VMs you are adding, select the domain and
location where the accounts will be created. Specify an account naming scheme, using hash marks to indicate where
sequential numbers or letters will appear. Do not use a forward slash (/) in an OU name. A name cannot begin with a
number. For example, a naming scheme of PC-Sales-## (with 0-9 selected) results in computer accounts named PC-
Sales-01, PC-Sales-02 , PC-Sales-03, and so on.
5. If you use existing Active Directory accounts, either browse to the accounts or click Import and specify a .csv file
containing account names. Make sure that there are enough accounts for all the machines youre adding. Studio
manages these accounts, so either allow Studio to reset the passwords for all the accounts, or specify the account
password, which must be the same for all accounts.
T he machines are created as a background process, and can take a lot of time when creating a large number of machines.
Machine creation continues even if you close Studio.
Delete machines from a Machine Catalog

After you delete a machine from a Machine Catalog, users can no longer access it, so before deleting a machine, ensure
that:
User data is backed up or no longer required.

All users are logged off. T urning on maintenance mode will stop new connections from being made to a machine.
Machines are powered off.
To delete machines from a catalog:

2. Select a catalog and then select View Machines in the Actions pane.
3. Select one or more machines and then select Delete in the Actions pane.
Choose whether to delete the machines being removed. If you choose to delete the machines, indicate whether the Active
Directory accounts for those machines should be retained, disabled, or deleted.
Change a Machine Catalog description or change

Remote PC Access settings
2. Select a catalog and then select Edit Machine Catalog in the Actions pane.
3. (Remote PC Access catalogs only) On the Power Management page, you can change the power management settings
and select a power management connection. On the Organizational Units page, add or remove Active Directory OUs.
4. On the Description page, change the catalog description.

Rename a Machine Catalog
2. Select a catalog and then select Rename Machine Catalog in the Actions pane.
3. Enter the new name.
Move a Machine Catalog to a different zone

If your Site has more than one zone, you can move a catalog from one zone to another.
Caution: Moving a catalog to a different zone than the hypervisor or cloud service containing the VMs in that catalog can
affect performance.

2. Select a catalog and then select Move in the Actions pane.
3. Select the zone where you want to move the catalog.
Delete a Machine Catalog

Before deleting a Machine Catalog, ensure that:
All users are logged off and that no disconnected sessions are running.
Maintenance mode is turned on for all machines in the catalog so that new connections cannot be made.
All machines in the catalog are powered off.
T he catalog is not associated a Delivery Group in other words, the Delivery Group does not contain machines from the
catalog.
To delete a Machine Catalog:

2. Select a catalog and then select Delete Machine Catalog in the Actions pane.
3. Indicate whether the machines in the catalog should be deleted. If you choose to delete the machines, indicate whether
the Active Directory computer accounts for those machines should be retained, disabled, or deleted.
Manage Active Directory computer accounts in a

Machine Catalog
To manage Active Directory accounts in a Machine Catalog, you can:
Free unused machine accounts by removing Active Directory computer accounts from Desktop OS and Server OS
Machine Catalogs. T hose accounts can then be used for other machines.
Add accounts so that when more machines are added to the catalog, the computer accounts are already in place. Do
not use a forward slash (/) in an OU name.

To manage Active Directory accounts:

2. Select a catalog and then select Manage AD accounts in the Actions pane.
3. Choose whether to add or delete computer accounts. If you add accounts, specify what to do with the account
passwords: either reset them all or enter a password that applies to all accounts. You might reset passwords if you do
not know the current account passwords; you must have permission to perform a password reset. If you enter a
password, the password will be changed on the accounts as they are imported. If you delete an account, choose
whether the account in Active Directory should be kept, disabled, or deleted.
Note: You can also indicate whether Active Directory accounts should be retained, disabled, or deleted when you remove
machines from a catalog or delete a catalog.
Update a Machine Catalog

Citrix recommends that you save copies or snapshots of master images before you update the machines in the catalog.
T he database keeps an historical record of the master images used with each Machine Catalog. You can roll back (revert)
machines in a catalog to use the previous version of the master image if users encounter problems with updates you
deployed to their desktops, thereby minimizing user downtime. Do not delete, move, or rename master images; otherwise,
you will not be able to revert a catalog to use them.
For catalogs that use Provisioning Services, you must publish a new vDisk to apply changes to the catalog. For details, see
the Provisioning Services documentation.
After a machine is updated, it restarts automatically.
Update or create a new master image

T ip: For information about managing connections, see the Connections and resources article.
Before you update the Machine Catalog, either update an existing master image or create a new one on your host
hypervisor.
1. On your hypervisor or cloud service provider, take a snapshot of the current VM and give the snapshot a meaningful
name. T his snapshot can be used to revert (roll back) machines in the catalog, if needed.
2. If necessary, power on the master image, and log on.
3. Install updates or make any required changes to the master image.
4. If the master image uses a personal vDisk, update the inventory.
5. Review these operating system optimization guides and apply the optimizations for your environment: Windows 7
Optimization Guide and Windows 8/8.1 Virtual Desktop Optimization Guide.
6. Power off the VM.
7. T ake a snapshot of the VM, and give the snapshot a meaningful name that will be recognized when the catalog is
updated in Studio. Although Studio can create a snapshot, Citrix recommends that you create a snapshot using the
hypervisor management console, and then select that snapshot in Studio. T his enables you to provide a meaningful
name and description rather than an automatically generated name. For GPU master images, you can change the master
image only through the XenServer XenCenter console.
Update the catalog

To prepare and roll out the update to all machines in a catalog:

2. Select a catalog and then select Update Machines in the Actions pane.
3. On the Master Image page, select the host and the image you want to roll out.
4. On the Rollout Strategy page, choose when the machines in the Machine Catalog will be updated with the new master
image: on the next shutdown or immediately. See below for details.
5. Verify the information on the Summary page and then click Finish. Each machine restarts automatically after it is
updated.
Tip: If you are updating a catalog using the PowerShell SDK directly, rather than Studio, you can specify a hypervisor
template (VMTemplates), as an alternative to an image or a snapshot of an image.
Rollout strategy
Updating the image on the next shutdown is provided when you are using the Citrix Connector for System Center
Conguration Manager.
If you choose to update the image immediately, congure a distribution time and notications.
Distribution time: You can choose to update all machines at the same time, or specify the total length of time it should
take to begin updating all machines in the catalog. An internal algorithm determines when each machine is updated and
restarted during that interval.
Notif ication: In the left notification dropdown, choose whether to display a notification message on the machines
before an update begins. By default, no message is displayed. If you choose to display a message 15 minutes before the
update begins, you can choose (in the right dropdown) to repeat the message every five minutes after the initial
message. By default, the message is not repeated. Unless you choose to update all machines at the same time, the
notification message displays on each machine at the appropriate time before the update begins, calculated by an
internal algorithm.
Roll back an update
After you roll out an updated/new master image, you can roll it back. T his might be necessary if issues occur with the
newly-updated machines. When you roll back, machines in the catalog are rolled back to the last working image. Any new
features that require the newer image will no longer be available. As with the rollout, rolling back a machine includes a
restart.

2. Select the catalog and then select Rollback machine update in the Actions pane.
3. Specify when to apply the earlier master image to machines, as described above for the rollout operation.
T he rollback is applied only to machines that need to be reverted. For machines that have not been updated with the
new/updated master image (for example, machines with users who have not logged off), users do not receive notication
messages and are not forced to log off.
Upgrade a Machine Catalog or revert an upgrade

Upgrade the Machine Catalog after you upgrade the VDAs on the machines to a newer version. Citrix recommends
upgrading all VDAs to the latest version to enable access to all the newest features.

Before upgrading a Machine Catalog:
If youre using Provisioning Services, upgrade the VDA version in the Provisioning Services console.
Start the upgraded machines so that they register with the Controller. T his lets Studio determine that the machines in
the Machine Catalog need upgrading.
To upgrade a Machine Catalog:

2. Select the catalog. T he Details tab in the lower pane displays version information.
3. Select Upgrade Catalog. If Studio detects that the Machine Catalog needs upgrading, it displays a message. Follow the
prompts. If one or more machines cannot be upgraded, a message explains why. Citrix recommends you resolve machine
issues before upgrading the Machine Catalog to ensure that all machines function properly.
After the catalog upgrade completes, you can revert the machines to their previous VDA versions by selecting the catalog
and then selecting Undo in the Actions pane.
Note: If you have Windows XP or Windows Vista machines, they must use an earlier VDA version, and will not be able to use
the latest product features. If you cannot upgrade those machines to a currently supported Windows operating system,
Citrix recommends you keep them in a separate catalog.

May 22, 20 17
A Delivery Group is a collection of machines selected from one or more Machine Catalogs. T he Delivery Group species
which users can use those machines, plus the applications and/or desktops available to those users.
Creating a Delivery Group is the next step in conguring your deployment after creating a Site and creating a Machine
Catalog. Later, you can change the initial settings in the rst Delivery Group and create other Delivery Groups. T here are
also features and settings you can congure only when editing a Delivery Group, not when creating it.
For Remote PC Access, when you create a Site, a Delivery Group named Remote PC Access Desktops is automatically
created.
To create a Delivery Group:
1. If you have created a Site and a Machine Catalog, but haven't yet created a Delivery Group, Studio will guide you to the
correct starting place to create a Delivery Group. If you have already created a Delivery Group and want to create
another, select Delivery Groups in the Studio navigation pane and then select Create Delivery Group in the Actions
pane.
2. T he Create Delivery Group wizard launches with an Introduction page, which you can remove from future launches of
this wizard.
3. T he wizard then guides you through the pages described below. When you are done with each page, click Next until you
reach the final page.
Machines
Select a Machine Catalog and select the number of machines you want to use from that catalog.
Good to know:
At least one machine must remain unused in a selected Machine Catalog.

A Machine Catalog can be specified in more than one Delivery Group; however, a machine can be used in only one
Delivery Group.
A Delivery Group can use machines from more than one catalog; however, those catalogs must contain the same
machine types (Server OS, Desktop OS, or Remote PC Access). In other words, you cannot mix machine types in a
Delivery Group. Similarly, if your deployment has catalogs of Windows machines and catalogs of Linux machines, a
Delivery Group can contain machines from either OS type, but not both.
Citrix recommends that you install or upgrade all machines with the most recent VDA version, and then upgrade Machine
Catalogs and Delivery Groups as needed. When creating a Delivery Group, if you select machines that have different VDA
versions installed, the Delivery Group will be compatible with the earliest VDA version. (T his is called the groups functional
level.) For example, if one of the machines you select has VDA version 7.1 installed and other machines have the current
version, all machines in the group can use only those features that were supported in VDA 7.1. T his means that some
features that require later VDA versions might not be available in that Delivery Group. For example, to use the AppDisks
feature, the VDAs (and therefore the group's functional level) must be a minimum version 7.8.
Each machine in a Remote PC Access Machine Catalog is automatically associated with a Delivery Group; when you
create a Remote PC Access Site, a catalog named Remote PC Access Machines and a Delivery Group named Remote
PC Access Desktops are created automatically.

Delivery type
T his page appears only if you chose a Machine Catalog containing static (assigned) desktop OS machines. Choose either
Applications or Desktops on the Delivery Type page; you cannot enable both.
(If you selected machines from a Server OS or Desktop OS random (pooled) catalog, the delivery type is assumed to be
applications and desktops: you can deliver applications, desktops, or both.
AppDisks
To add an AppDisk, click Add. T he Select AppDisks dialog box lists available AppDisks in the left column. T he right column
lists the applications on the AppDisk. (Selecting the Applications tab above the right column lists applications in a format
similar to a Start menu; selecting the Installed packages tab lists applications in a format similar to the Programs and
Features list.)
Select one or more checkboxes.
For more information, see the AppDisks article.
Users
Specify the users and user groups who can use the applications and desktops in the Delivery Group.
Where user lists are specied

Active Directory user lists are specied when you create or edit the following:
A Sites user access list, which is not configured through Studio. By default, the application entitlement policy rule
includes everyone; see the PowerShell SDK BrokerAppEntitlementPolicyRule cmdlets for details.
Application Groups (if configured).
Delivery Groups.
Applications.
T he list of users who can access an application through StoreFront is formed by the intersection of the above user lists. For
example, to congure the use of application A to a particular department, without unduly restricing access to other
groups:
Use the default application entitlement policy rule that includes everyone.
Configure the Delivery Group user list to allow all headquarters users to use any of the applications specified in the
Delivery Group.
(If Application Groups are configured) Configure the Application Group user list to allow members of the Administration
and Finance business unit to access applications A through L.
Configure application As properties to restrict its visibility to only Accounts Receivable staff in Administration and
Finance.
Authenticated and unauthenticated users

T here are two types of users: authenticated and unauthenticated (unauthenticated is also called anonymous). You can
congure one or both types in a Delivery Group.
Authenticated

To access applications and desktops, the users and group members you specify by name must present credentials
such as smart card or user name and password to StoreFront or Citrix Receiver. (For Delivery Groups containing
Desktop OS machines, you can import user data (a list of users) later by editing the Delivery Group.)
Unauthenticated (anonymous)
For Delivery Groups containing Server OS machines, you can allow users to access applications and desktops without
presenting credentials to StoreFront or Citrix Receiver. For example, at kiosks, the application might require credentials,
but the Citrix access portal and tools do not. An Anonymous Users Group is created when you install the rst Delivery
Controller.
To grant access to unauthenticated users, each machine in the Delivery Group must have a VDA for Windows Server
OS (minimum version 7.6) installed. When unauthenticated users are enabled, you must have an unauthenticated
StoreFront store.
Unauthenticated user accounts are created on demand when a session is launched, and named AnonXYZ, in
which XYZ is a unique three-digit value.
Unauthenticated user sessions have a default idle timeout of 10 minutes, and are logged off automatically when the
client disconnects. Reconnection, roaming between clients, and Workspace Control are not supported.
T he following table describes your choices on the Users page:
Enable access f or Add/assign users and Enable the "Give access to unauthenticated
user groups? users" check box?
Only authenticated users Yes No
Only unauthenticated users No Yes
Both authenticated and Yes Yes

unauthenticated users
Applications
Good to know:
You cannot add applications to Remote PC Access Delivery Groups.

By default, new applications you add are placed in a folder named Applications. You can specify a different folder. For
details, see the Manage Applications article.
You can change the properties for an application when you add it to a Delivery Group, or later. For details, see the
Manage Applications article.
If you try to add an application and one with the same name already exists in that folder, you are prompted to rename
the application you are adding. If you decline, the application is added with a suffix that makes it unique within that
application folder.
When you add an application to more than one Delivery Group, a visibility issue can occur if you do not have sufficient
permission to view the application in all of those Delivery Groups. In such cases, either consult an administrator with

greater permissions or have your scope extended to include all the Delivery Groups to which the application was added.
If you publish two applications with the same name to the same users, change the Application name (for user) property
in Studio; otherwise, users will see duplicate names in Receiver.
Click the Add dropdown to display the application sources.
From Start menu: Applications that are discovered on a machine created from the master image in the selected
catalog. When you select this source, a new page launches with a list of discovered applications; select those you want
to add and then click OK.
Manually def ined: Applications located in the Site or elsewhere in your network. When you select this source, a new
page launches where you type the path to the executable, working directory, optional command line arguments, and
display names for administrators and users. After entering this information, click OK.
Existing: Applications previously added to the Site, perhaps in another Delivery Group. When you select this source, a
new page launches with a list of discovered applications; select those you want to add and then click OK.
App-V: Applications in App-V packages. When you select this source, a new page launches where you select the App-V
server or the Application Library. Select the applications you want to add from the resulting display and then click OK. For
more information, see the App-V article.
If an application source or application is not available or valid, it is either not visible or cannot be selected. For example, the
Existing source is not available if no applications have been added to the Site. Or, an application might not be compatible
with the supported session types on machines in the selected Machine Catalog.
Desktops (or Desktop Assignment Rules)
T he title of this page depends on the Machine Catalog you chose earlier in the wizard:
If you chose a Machine Catalog containing pooled machines, this page is titled Desktops.
If you chose a Machine Catalog containing assigned machines and specified "Desktops" on the Delivery T ype page, this
page is titled Desktop User Assignments.
If you chose a Machine Catalog containing assigned machines and specified "Applications" on the Delivery T ype page,
this page is titled Application Machine User Assignments.
Click Add. In the dialog box:
In the Display name and Description fields, type the information to be displayed in Receiver.
T o add a tag restriction to a desktop, select Restrict launches to machines with this tag and then select the tag
from the dropdown. (See the T ags article for more information.)
Using the radio buttons, indicate who can launch a desktop (for groups with pooled machines) or who will be assigned a
machine when they launch the desktop (for groups with assigned machines). T he users can be either everyone who can
access this Delivery Group, or specific users and user groups.
If the group contains assigned machines, specify the maximum number of desktops per user. T his must be a value of one
or greater.
Enable or disable the desktop (for pooled machines) or desktop assignment rule (for assigned machines). Disabling a
desktop stops desktop delivery; disabling a desktop assignment rule stops desktop auto-assignment to users.
When you are finished with the dialog box, click OK.
Summary
Enter a name for the Delivery Group. You can also (optionally) enter a description, which will appear in Receiver and in Studio.

Review the summary information and then click Finish. If you did not select any applications or specify any desktops to
deliver, you are asked if you want to continue.

May 22, 20 17
In this article:
Introduction
Change user settings in a Delivery Group
Add or remove users in a Delivery Group
Change the delivery type of a Delivery Group
Change StoreFront addresses
Add, change, or remove a tag restriction for a desktop
Upgrade a Delivery Group or revert an upgrade
Manage Remote PC Access Delivery Groups
Shut down and restart machines in a Delivery Group
Power manage machines in a Delivery Group
Create a restart schedule for machines in a Delivery Group
Create multiple restart schedules for machines in a Delivery Group
Prevent users from connecting to a machine (maintenance mode) in a Delivery Group
Change assignments of machines to users in a Delivery Group
Change the maximum number of machines per user in a Delivery Group
Load manage machines in Delivery Groups
Remove a machine from a Delivery Group
Restrict access to machines in a Delivery Group
Update a machine in a Delivery Group
Log off or disconnect a session, or send a message to Delivery Group users
Configure session prelaunch and session linger
Introduction
T his article describes the procedures for managing Delivery Groups. In addition to changing settings specied when creating
the group, you can congure other settings that are not available when you create a Delivery Group.
See Applications for information about managing applications in Delivery Groups, including how to add and remove
applications in a Delivery Group, and change application properties.
Managing Delivery Groups requires the Delegated Administration permissions of the Delivery Group Administrator built-in
role. See Delegated Administration for details.
Tip: In the Studio display for a Delivery Group, the "Installed VDA version" in the Details pane might differ from the actual
version installed on the machines. T he machine's Windows Programs and Features display shows the actual VDA version.
VDA registration with a Delivery Controller
VDAs that are not registered with a Delivery Controller are not considered when launching brokered sessions, which results
in underutilization of otherwise available resources. T here are various reasons a VDA might not be registered, many of which
an administrator can troubleshoot. Studio provides troubleshooting information in the catalog creation wizard, and after
you add a catalog to a Delivery Group.

After you create a Delivery Group, Studio displays details about machines associated with that group. T he details pane for
a Delivery Group indicates the number of machines that should be registered but are not. In other words, there might be
one or more machines that are powered on and not in maintenance mode, but are not currently registered with a
Controller. When viewing a "not registered, but should be" machine, review the Troubleshoot tab in the details pane for
possible causes and recommended corrective actions.
For messages about functional level, see VDA versions and functional levels.
Change user settings in a Delivery Group

T he name of this page may appear as either User Settings or Basic Settings.
1. Select Delivery Groups in the Studio navigation pane.

2. Select a group and then select Edit Delivery Group in the Actions pane.
3. On the User Settings (or Basic Settings) page, change any of the settings in the following table.
4. Click Apply to apply any changes you made and keep the window open, or click OK to apply changes and close the
window.
Setting Description
Description T he text that StoreFront uses and that users see.
Enable Delivery Group Whether or not the Delivery Group is enabled.
T ime zone
Enable Secure ICA Secures communications to and from machines in the Delivery Group using SecureICA, which
encrypts the ICA protocol (default level is 128-bit; the level can be changed using the SDK).
Citrix recommends using additional encryption methods such as T LS encryption when
traversing public networks. Also, SecureICA does not check data integrity.
Add or remove users in a Delivery Group

For detailed information about users, see the Users section in the Create Delivery Groups article.

3. On the Users page, to add users, click Add, and then specify the users you want to add. T o remove users, select one or
more users and then click Remove. You can also select/clear the check box that enables or disables access by
unauthenticated users.

window.
Import or export user lists
For Delivery Groups containing physical Desktop OS machines, you can import user information from a .csv le after you
create the Delivery Group. You can also export user information to a .csv le. T he .csv le can contain data from a previous
product version.
T he rst line in the .csv le must contain comma-separated column headings (in any order), which can include:
ADComputerAccount, AssignedUser, VirtualMachine, and HostId. Subsequent lines in the le contain comma-separated
data. T he ADComputerAccount entries can be common names, IP addresses, distinguished names, or domain and computer
name pairs.
To import or export user information:

2. Select a Delivery Group, and then select Edit Delivery Group in the Actions pane.
3. On the Machine Allocation page, select Import list or Export list, and then browse to the file location.
window.
Change the delivery type of a Delivery Group

T he delivery type indicates what the group can deliver: applications, desktops, or both.
Before changing an application only or desktops and applications type to a desktops only type, delete all applications
from the group.

3. On the Delivery Type page, select the delivery type you want.
window.
Change StoreFront addresses

3. On the StoreFront page, select or add StoreFront URLs that will be used by the Citrix Receiver that is installed on each
machine in the Delivery Group.
window.
You can also specify StoreFront server address by selecting Conguration > StoreFront in the Studio navigation pane.
Add, change, or remove a tag restriction for a desktop

Important: Adding, changing, and removing tag restrictions can have unanticipated effects on which desktops are
considered for launch. Be sure to review the considerations and cautions in the Tags article.

3. On the Desktops page, select the desktop and click Edit.
4. T o add a tag restriction, select Restrict launches to machines with the tag and then select the tag.
5. T o change or remove a tag restriction, either select a different tag or remove the tag restriction entirely by clearing
Restrict launches to machines with this tag.
window.
Upgrade a Delivery Group or revert an upgrade

Upgrade a Delivery Group after you upgrade the VDAs on its machines and the machine catalogs containing the machines
used in the Delivery Group.
Before you start the Delivery Group upgrade:
If you use Provisioning Services, upgrade the VDA version in the Provisioning Services console.
Start the machines containing the upgraded VDA so that they can register with a Delivery Controller. T his process tells
Studio what needs upgrading in the Delivery Group.
If you must continue to use earlier VDA versions, newer product features may not be available. For more information, see
the Upgrade articles.
To upgrade a Delivery Group:

2. Select a group and then select Upgrade Delivery Group in the Actions pane. T he Upgrade Delivery Group action
appears only if Studio detects upgraded VDAs.
Before starting the upgrade process, Studio tells you which, if any, machines cannot be upgraded and why. You can then
cancel the upgrade, resolve the machine issues, and then start the upgrade again.
After the upgrade completes, you can revert the machines to their previous states by selecting the Delivery Group and then
selecting Undo in the Actions pane.
Manage Remote PC Access Delivery Groups

If a machine in a Remote PC Access machine catalog is not assigned to a user, Studio temporarily assigns the machine to a
Delivery Group associated with that catalog. T his temporary assignment enables the machine to be assigned to a user later.
T he Delivery Group-to-machine catalog association has a priority value. Priority determines which Delivery Group that
machine is assigned to when it registers with the system or when a user needs a machine assignment: the lower the value,
the higher the priority. If a Remote PC Access machine catalog has multiple Delivery Group assignments, the software
selects the match with the highest priority. You can set this priority value using the PowerShell SDK.
When rst created, Remote PC Access machine catalogs are associated with a Delivery Group. T his means that machine

accounts or Organizational Units added to the catalog later can be added to the Delivery Group. T his association can be
switched off or on.
To add or remove a Remote PC Access machine catalog association with a Delivery Group:

2. Select a Remote PC Access group.
3. In the Details section, select the Machine Catalogs tab and then select a Remote PC Access catalog.
4. T o add or restore an association, select Add Desktops. T o remove an association, select Remove Association.
Shut down and restart machines in a Delivery Group

T his procedure is not supported for Remote PC Access machines.

2. Select a group and then select View Machines in the Actions pane.
3. Select the machine and then select one of the following in the Actions pane (some options may not be available,
depending on the machine state):
Force shut down. Forcibly powers off the machine and refreshes the list of machines.
Restart. Requests the operating system to shut down and then start the machine again. If the operating system
cannot comply, the machine remains in its current state.
Force restart. Forcibly shuts down the operating system and then restarts the machine.
Suspend. Pauses the machine without shutting it down, and refreshes the list of machines.
Shut down. Requests the operating system to shut down.
For non-force actions, if the machine does not shut down within 10 minutes, it is powered off. If Windows attempts to
install updates during the shutdown, there is a risk that the machine will be powered off before the updates nish.
Citrix recommends that you prevent Desktop OS machine users from selecting Shut down within a session. See the
Microsoft policy documentation for details.
You can also shut down and restart machines on a connection; see the Connections and resources article.
Power manage machines in a Delivery Group

You can power manage only virtual Desktop OS machines, not physical ones (including Remote PC Access machines).
Desktop OS machines with GPU capabilities cannot be suspended, so power-off operations fail. For Server OS machines,
you can create a restart schedule, which is also described in this article.
In Delivery Groups containing pooled machines, virtual Desktop OS machines can be in one of the following states:
Randomly allocated and in use

Unallocated and unconnected
In Delivery Groups containing static machines, virtual Desktop OS machines can be:
Permanently allocated and in use

Permanently allocated and unconnected (but ready)
Unallocated and unconnected
During normal use, static Delivery Groups typically contain both permanently allocated and unallocated machines. Initially, all
machines are unallocated (except for those manually allocated when the Delivery Group was created). As users connect,
machines become permanently allocated. You can fully power manage the unallocated machines in those Delivery Groups,
but only partially manage the permanently allocated machines.
Pools and buf f ers: For pooled Delivery Groups and static Delivery Groups with unallocated machines, a pool (in this
instance) is a set of unallocated or temporarily allocated machines that are kept in a powered-on state, ready for users to
connect; a user gets a machine immediately after logon. T he pool size (the number of machines kept powered-on) is
congurable by time of day. For static Delivery Groups, use the SDK to congure the pool.
A buffer is an additional standby set of unallocated machines that are turned on when the number of machines in the pool
falls below a threshold that is a percentage of the Delivery Group size. For large Delivery Groups, a signicant number of
machines might be turned on when the threshold is exceeded, so plan Delivery Group sizes carefully or use the SDK to
adjust the default buffer size.
Power state timers: You can use power state timers to suspend machines after users have disconnected for a specied
amount of time. For examples, machines will suspend automatically outside of ofce hours if users have been disconnected
for at least 10 minutes. Random machines or machines with personal vDisks automatically shut down when users log off,
unless you congure the ShutdownDesktopsAfterUse Delivery Group property in the SDK.
You can congure timers for weekdays and weekends, and for peak and nonpeak intervals.
Partial power management of permanently allocated machines: For permanently allocated machines, you can set
power state timers, but not pools or buffers. T he machines are turned on at the start of each peak period, and turned off
at the start of each off-peak period. You do not have the ne control that you have with unallocated machines over the
number of machines that become available to compensate for machines that are consumed.
To power manage virtual Desktop OS machines:

2. Select a group, and then select Edit Delivery Group in the Actions pane.
3. On the Power Management page, select Weekdays in the Power manage machines drop-down. By default, weekdays
are Monday to Friday.
4. For random Delivery Groups, in Machines to be powered on, select Edit and then specify the pool size during
weekdays. T hen, select the number of machines to power on.
5. In Peak hours, set the peak and off-peak hours for each day.
6. Set the power state timers for peak and non-peak hours during weekdays: In During peak hours > When
disconnected, specify the delay (in minutes) before suspending any disconnected machine in the Delivery Group, and
select Suspend. In During of f -peak hours > When disconnected, specify the delay before turning off any logged-off
machine in the Delivery Group, and select Shutdown. T his timer is not available for Delivery Groups with random
machines.
7. Select Weekend in the Power manage machines drop-down, and then configure the peak hours and power state timers
for weekends.
window.
Use the SDK to:

Shut down, rather than suspend, machines in response to power state timers, or if you want the timers to be based on
logoffs, rather than disconnections.
Change the default weekday and weekend definitions.
Create a restart schedule for machines in a Delivery

Group
Note: T his section describes how to congure a single restart schedule in Studio. Alternatively, you can use PowerShell to
congure multiple restart schedules for different subsets of machines in a Delivery Group. See the next section for details.
A restart schedule species when to periodically restart all the machines in a Delivery Group.

3. On the Restart Schedule page, if you do not want to restart machines in the Delivery Group automatically, select the
No radio button and skip to the last step in this procedure. No restart schedule or rollout strategy will be configured. If a
schedule was previously configured, this selection cancels it.
4. If you do want to restart machines in the Delivery Group automatically, select the Yes radio button.
5. For Restart frequency, choose either Daily or the day of the week the restarts will occur.
6. For Begin restart at, using a 24-hour clock, specify the time of day to begin the restart.
7. For Restart duration, choose whether all machines should be started at the same time, or the total length of time to
begin restarting all machines in the Delivery Group. An internal algorithm determines when each machine is restarted
during that interval.
8. In the left Notif ication drop-down, choose whether to display a notification message on the affected machines before
a restart begins. By default, no message is displayed. If you choose to display a message 15 minutes before the restart
begins, you can choose (in the Repeat notif ication drop-down) to repeat the message every five minutes after the
initial message. By default, the message is not repeated.
9. Enter the notification text in the Notif ication message box; there is no default text. If you want the message to
include the number of minutes before restart, include the variable %m% (for example: Warning: Your computer will be
automatically restarted in %m% minutes.) If you select a repeat notification interval and your message includes the %m%
placeholder, the value decrements by five minutes in each repeated message. Unless you chose to restart all machines at
the same time, the notification message displays on each machine in the Delivery Group at the appropriate time before
the restart, calculated by the internal algorithm.
window.
You cannot perform an automated power-on or shutdown from Studio, only a restart.
Create multiple restart schedules for machines in a

Delivery Group
You can use PowerShell cmdlets to create multiple restart schedules for machines in a Delivery Group. Each schedule can be
congured to affect only those machines in the group that have a specied tag. T his tag restriction functionality allows

you to easily create different restart schedules for different subsets of machines in one Delivery Group.
For example, let's say you use one Delivery Group for all machines in the company. You want to restart every machine at
least once every week (on Sunday night), but the machines used by the accounting team should be restarted daily. You can
set up a weekly schedule for all machines, and a daily schedule for just the machines used by the accounting team.
Schedule overlap
Multiple schedules might overlap. In the example above, the machines used by accounting are affected by both schedules,
and might be restarted twice on Sunday.
T he scheduling code is designed to avoid restarting the same machine more often than needed, but it cannot be
guaranteed. If both schedules coincide precisely in start and duration times, it is more likely that the machines will be
restarted only once. However, the more the schedules differ in start and/or duration times, the more likely two restarts will
occur. Also, the number of machines affected by the schedules can also inuence the chances of an overlap. In the
example, the weekly schedule that restarts all machines could initiate restarts signicantly faster than the daily schedule
(depending on the congured duration for each).
Requirements
Support for creating multiple restart schedules and using tag restrictions in a restart schedule is currently available only
through the PowerShell command line, using RebootScheduleV2 PowerShell cmdlets that are new in XenApp and
XenDesktop 7.12. (T hese are referred to as the "V2" cmdlets throughout this article.)
Using the V2 cmdlets requires:
Delivery Controller version 7.12 (minimum).

If you use the latest SDK plug-in with a Controller earlier than 7.12, any new schedules you create will not work as
intended.
In a mixed site (where some, but not all Controllers have been upgraded), the V2 cmdlets will not work until the
database is upgraded and at least one Controller has been upgraded and is being used (by specifying the
adminaddress <controller> parameter with the V2 cmdlets).
Best practice: Do not create any new schedules until all Controllers in the site are upgraded.
PowerShell SDK snap-in provided with XenApp and XenDesktop 7.12 (minimum). After you install or upgrade your
components and site, run asnp Citrix.* to load the latest cmdlets.
Studio currently uses earlier V1 RebootSchedule PowerShell cmdlets, and will not display schedules that are created with
the V2 cmdlets.
After you create a restart schedule that uses a tag restriction, and then later use Studio to remove the tag from an
affected machine during a restart interval (cycle) or add the tag to additional machines during a restart cycle, those
changes will not take effect until the next restart cycle. (T he changes will not affect the current restart cycle.)
PowerShell cmdlets
Use the following RebootScheduleV2 cmdlets from the command line to create multiple schedules and use tag restrictions
in the schedules.
New (V2) cmdlet Replaces earlier (V1) cmdlet

New-BrokerRebootScheduleV2 New-BrokerRebootSchedule
Get-BrokerRebootScheduleV2 Get-BrokerRebootSchedule
Set- BrokerRebootScheduleV2 Set-BrokerRebootSchedule
Remove-BrokerRebootScheduleV2 Remove-BrokerRebootSchedule
Rename-BrokerRebootScheduleV2 -
For complete cmdlet syntax and parameter descriptions, enter Get-Help f ull <cmdlet-name>.
Terminology reminder: In the PowerShell SDK, the DesktopGroup parameter identies the Delivery Group.
If you're familiar with the Studio interface for creating a restart schedule, all of those parameters are available when using
the V2 cmdlet to create or update a schedule. Additionally, you can:
Restrict the schedule to machines that have a specified tag.

Specify an interval before sending the first warning message, during which no new sessions will be brokered to the
affected machines.
Conguration
If you congure a restart schedule that uses a tag restriction, you must also add (apply) that tag to the machines that you
want the schedule to affect. (For more information, see Tags.)
1. From Studio, select Delivery Groups in the navigation pane.

2. Select the Delivery Group containing the machines that will be affected by the schedule.
3. Select View Machines and then select the machines where you'll add a tag.
4. Select Manage Tags in the Actions pane.
5. If the tag already exists, enable the check box next to the tag name. If the tag does not exist, click Create and then
specify the name for the tag. After the tag is created, enable the check box next to the newly-created tag name.
6. Click Save in the Manage T ags dialog box.
After creating and adding (applying) tags, use the RestrictToTag parameter to specify the tag name when creating or
editing the schedule with the V2 cmdlet.
If you created a restart schedule with an earlier XenApp or XenDesktop version
Studio currently uses the V1 RebootSchedule cmdlets. If you have a restart schedule that was created before you
upgraded to 7.12 (minimum), you can continue to manage it in Studio with V1 cmdlets, but you cannot use Studio to add a
tag restriction to that schedule, or to create additional schedules (because Studio does not support the V2 cmdlets). As
long as you use the V1 cmdlets for your existing schedule, Studio will display correct information about the restart schedule.
Alternatively, you can edit your existing schedule from the command line, using the new V2 RebootSchedule cmdlets. When
using the new V2 cmdlets, you can use the tag restriction parameters in that schedule, and create additional restart
schedules. However, after you use V2 cmdlets to change your existing schedule, Studio will not display complete schedule

information (because it recognizes only V1 information). You cannot see whether a tag restriction is used, or the schedule's
name and description.
Prevent users from connecting to a machine

(maintenance mode) in a Delivery Group
When you need to temporarily stop new connections to machines, you can turn on maintenance mode for one or all
machines in a Delivery Group. You might do this before applying patches or using management tools.
When a Server OS machine is in maintenance mode, users can connect to existing sessions, but cannot start new
sessions.
When a Desktop OS machine (or a PC using Remote PC Access) is in maintenance mode, users cannot connect or
reconnect. Current connections remain connected until they disconnect or log off.
To turn maintenance mode on or off:

2. Select a group.
3. T o turn on maintenance mode for all machines in the Delivery Group, select Turn On Maintenance Mode in the Actions
pane. T o turn on maintenance mode for one machine, select View Machines in the Actions pane. Select a machine, and
then select Turn On Maintenance Mode in the Actions pane.
4. T o turn maintenance mode off for one or all machines in a Delivery Group, follow the previous instructions, but select
Turn Of f Maintenance Mode in the Actions pane.
Windows Remote Desktop Connection (RDC) settings also affect whether a Server OS machine is in maintenance mode.
Maintenance mode is on when any of the following occur:
Maintenance mode is set to on, as described above.

RDC is set to Dont allow connections to this computer.
RDC is not set to Dont allow connections to this computer, and the Remote Host Configuration User Logon Mode
setting is either Allow reconnections, but prevent new logons or Allow reconnections, but prevent new logons
until the server is restarted.
You can also turn maintenance mode on or off for a connection (which affects the machines that use that connection), or
for a machine catalog (which affects the machines in that catalog).
Change assignments of machines to users in a

Delivery Group
You can change the assignments of Desktop OS machines, not Server OS machines or machines created through
Provisioning Services.

2. Select a group.
3. Select Edit Delivery Group in the Actions pane. On the Desktops or Desktop Assignment Rules page (only one of

those pages will be available, depending on the type of machine catalog the Delivery Group uses), specify the new users.
window.
Change the maximum number of machines per user

3. On the Desktop Assignment Rules page, set the maximum desktops per user value.
window.
Load manage machines in Delivery Groups

You can load manage Server OS machines only.
Load Management measures the server load and determines which server to select under the current environment
conditions. T his selection is based on:
Server maintenance mode status: A Server OS machine is considered for load balancing only when maintenance mode is
off.
Server load index: Determines how likely a server delivering Server OS machines is to receive connections. T he index is a
combination of load evaluators: the number of sessions and the settings for performance metrics such as CPU, disk, and
memory use. You specify the load evaluators in load management policy settings.
You can monitor the load index in Director, Studio search, and the SDK.
In Studio, the Server Load Index column is hidden by default. To display it, select a machine, right-select a column heading
and then choose Select Column. In the Machine category, select Load Index.
In the SDK, use the Get-BrokerMachine cmdlet. For details, see CT X202150.
A server load index of 10000 indicates that the server is fully loaded. If no other servers are available, users might receive a
message that the desktop or application is currently unavailable when they launch a session.
Concurrent logon tolerance policy setting: T he maximum number of concurrent requests to log on to the server. (T his
setting is equivalent to load throttling in XenApp versions earlier than 7.5.)
If all servers are at or higher than the concurrent logon tolerance setting, the next logon request is assigned to the server
with the lowest pending logons. If more than one server meets these criteria, the server with the lowest load index is
selected.
Remove a machine from a Delivery Group

Removing a machine deletes it from a Delivery Group but does not delete it from the machine catalog that the Delivery
Group uses. T herefore, that machine is available for assignment to another Delivery Group.

Machines must be shut down before they can be removed. To temporarily stop users from connecting to a machine while
you are removing it, put the machine into maintenance mode before shutting it down.
Keep in mind that machines may contain personal data, so use caution before allocating the machine to another user. You
may want to reimage the machine.

2. Select a group and the select View Machines in the Actions pane.
3. Make sure that the machine is shut down.
4. Select Remove f rom Delivery Group in the Actions pane.
You can also remove a machine from a Delivery Group through the connection the machine uses. For details, see
Connections and resources.
Restrict access to machines in a Delivery Group

Any changes you make to restrict access to machines in a Delivery Group supersede previous settings, regardless of the
method you use. You can:
Restrict access f or administrators using Delegated Administration scopes. You can create and assign a scope that
permits administrators to access all applications, and another scope that provides access to only certain applications. See
the Delegated Administration article for details.
Restrict access f or users through SmartAccess policy expressions that lter user connections made through
NetScaler Gateway.

2. Select group and then select Edit Delivery Group in the Actions pane.
3. On the Access Policy page, select Connections through NetScaler Gateway.
4. T o choose a subset of those connections, select Connections meeting any of the f ollowing f ilters. T hen define the
NetScaler Gateway site, and add, edit, or remove the SmartAccess policy expressions for the allowed user access
scenarios. For details, see the NetScaler Gateway documentation.
window.
Restrict access f or users through exclusion lters on access policies that you set in the SDK. Access policies are applied
to Delivery Groups to rene connections. For example, you can restrict machine access to a subset of users, and you can
specify allowed user devices. Exclusion lters further rene access policies. For example, for security you can deny access to
a subset of users or devices. By default, exclusion lters are disabled.
For example, for a teaching lab on a subnet in the corporate network, to prevent access from that lab to a particular
Delivery Group, regardless of who is using the machines in the lab, use the following command: Set-BrokerAccessPolicy -
Name VPDesktops_Direct -ExcludedClientIPFilterEnabled $True -
You can use the asterisk (*) wildcard to match all tags that start with the same policy expression. For example, if you add
the tag VPDesktops_Direct to one machine and VPDesktops_Test to another, setting the tag in the Set-
BrokerAccessPolicy script to VPDesktops_* applies the lter to both machines.

Update a machine in a Delivery Group
2. Select a group and then select View Machines in the Action pane.
3. Select a machine and then select Update Machines in the Actions pane.
To choose a different master image, select Master image, and then select a snapshot.
To apply changes and notify machine users, select Rollout notication to end-users. T hen specify: when to update the
master image: now or on the next restart, the restart distribution time (the total time to begin updating all machines in the
group), and whether users will be notied of the restart, plus the message they will receive.
Log off or disconnect a session, or send a message to

Delivery Group users
2. Select a group and then select View Machines in the Actions pane.
3. T o log a user off a session, select the session or desktop and select Log of f in the Actions pane. T he session closes and
the machine becomes available to other users, unless it is allocated to a specific user.
4. T o disconnect a session, select the session or desktop, and select Disconnect in the Actions pane. Applications continue
to run and the machine remains allocated to that user. T he user can reconnect to the same machine.
5. T o send a message to users, select the session, machine, or user, and then select Send message in the Actions pane.
Enter the message.
You can congure power state timers for Desktop OS machines to automatically handle unused sessions. See the Power
manage machines section for details.
Congure session prelaunch and session linger in a

Delivery Group
T hese features are supported on Server OS machines only.
T he session prelaunch and session linger features help specied users access applications quickly, by starting sessions
before they are requested (session prelaunch) and keeping application sessions active after a user closes all applications
(session linger).
By default, session prelaunch and session linger are not used: a session starts (launches) when a user starts an application,
and remains active until the last open application in the session closes.
Considerations:
T he Delivery Group must support applications, and the machines must be running a VDA for Windows Server OS,
minimum version 7.6.

T hese features are supported only when using Citrix Receiver for Windows, and also require additional Citrix Receiver
configuration. For instructions, search for session prelaunch in the product documentation for your Citrix Receiver for
Windows version.
Note that Citrix Receiver for HT ML5 is not supported.
When using session prelaunch, if a user's machine is put into "suspend" or "hibernate" mode, prelaunch will not work
(regardless of session prelaunch settings). Users can lock their machines/sessions, but if a user logs off from Citrix
Receiver, the session is ended and prelaunch no longer applies.
When using session prelaunch, physical client machines cannot use the suspend or hibernate power management
functions. Client machine users can lock their sessions but should not log off.
Prelaunched and lingering sessions consume a license, but only when connected. Unused prelaunched and lingering
sessions disconnect after 15 minutes by default. T his value can be configured in PowerShell (New/Set-
BrokerSessionPreLaunch cmdlet).
Careful planning and monitoring of your users activity patterns are essential to tailoring these features to complement
each other. Optimal configuration balances the benefits of earlier application availability for users against the cost of
keeping licenses in use and resources allocated.
You can also configure session prelaunch for a scheduled time of day in Citrix Receiver.
How long unused prelaunched and lingering sessions remain active
T here are several ways to specify how long an unused session remains active if the user does not start an application: a
congured timeout and server load thresholds. You can congure all of them; the event that occurs rst causes the unused
session to end.
Timeout: A configured timeout specifies the number of minutes, hours, or days an unused prelaunched or lingering
session remains active. If you configure too short a timeout, prelaunched sessions will end before they provide the user
benefit of quicker application access. If you configure too long a timeout, incoming user connections might be denied
because the server doesn't have enough resources.
You cannot disable this timeout from Studio, but you can in the SDK (New/Set-BrokerSessionPreLaunch cmdlet). If
you disable the timeout, it will not appear in the Studio display for that Delivery Group or in the Edit Delivery Group
wizard.
Thresholds: Automatically ending prelaunched and lingering sessions based on server load ensures that sessions remain
open as long as possible, assuming server resources are available. Unused prelaunched and lingering sessions will not cause
denied connections because they will be ended automatically when resources are needed for new user sessions.
You can congure two thresholds: the average percentage load of all servers in the Delivery Group, and the maximum
percentage load of a single server in the Delivery Group. When a threshold is exceeded, the sessions that have been in
the prelaunch or lingering state for the longest time are ended, sessions are ended one-by-one at minute intervals
until the load falls below the threshold. (While the threshold is exceeded, no new prelaunch sessions are started.)
Servers with VDAs that have not registered with the Controller and servers in maintenance mode are considered fully
loaded. An unplanned outage causes prelaunch and lingering sessions end automatically to free capacity.
To enable session prelaunch

2. Select a Delivery Group, and then click Edit Delivery Group in the Actions pane.
3. On the Application Prelaunch page, enable session prelaunch by choosing when sessions should launch:
When a user starts an application. T his is the default setting; session prelaunch is disabled.

When any user in the Delivery Group logs on to Citrix Receiver for Windows.
When anyone in a list of users and user groups logs on to Citrix Receiver for Windows. Be sure to also specify users or
user groups if you choose this option.
4. A prelaunched session is replaced with a regular session when the user starts an application. If the user does not start an
application (the prelaunched session is unused), the following settings affect how long that session remains active.
When a specified time interval elapses. You can change the time interval (1-99 days, 1-2376 hours, or 1-142,560
minutes).
When the average load on all machines in the Delivery Group exceeds a specified percentage (1-99%).
When the load on any machine in the Delivery Group exceeds a specified percentage (1-99%).
Recap: A prelaunched session remains active until one of the following events occurs: a user starts an application, the
specied time elapses, or a specied load threshold is exceeded.
To enable session linger

2. Select a Delivery Group, and then click Edit Delivery Group in the Actions pane.
3. On the Application Lingering page, enable session linger by selecting the Keep sessions active until radio button.

4. Several settings affect how long a lingering session remains active if the user does not start another application.
When a specified time interval elapses. You can change the time interval (1-99 days, 1-2376 hours, or 1-142,560
minutes).
When the average load on all machines in the Delivery Group exceeds a specified percentage (1-99%).
When the load on any machine in the Delivery Group exceeds a specified percentage (1-99%).
Recap: A lingering session remains active until one of the following events occurs: a user starts an application, the
specied time elapses, or a specied load threshold is exceeded.

May 22, 20 17
Introduction
Application Groups let you manage collections of applications. You can create Application Groups for applications shared
across different Delivery Groups or used by a subset of users within Delivery Groups. Application Groups are optional; they
offer an alternative to adding the same applications to multiple Delivery Groups. Delivery Groups can be associated with
more than one Application Group, and an Application Group can be associated with more than one Delivery Group.
Using Application Groups can provide application management and resource control advantages over using more Delivery
Groups:
T he logical grouping of applications and their settings lets you manage those applications as a single unit. For example,
you dont have to add (publish) the same application to individual Delivery Groups one at a time.
Session sharing between Application Groups can conserve resource consumption. In other cases, disabling session sharing
between Application Groups may be beneficial.
You can use the tag restriction feature to publish applications from an Application Group, considering only a subset of
the machines in selected Delivery Groups. With tag restrictions, you can use your existing machines for more than one
publishing task, saving the costs associated with deploying and managing additional machines. A tag restriction can be
thought of as subdividing (or partitioning) the machines in a Delivery Group. Using an Application Group or desktops with
a tag restriction can be helpful when isolating and troubleshooting a subset of machines in a Delivery Group.
Example congurations
Example 1
T he following graphic shows a XenApp or XenDesktop deployment that includes Application Groups:

In this conguration, applications are added to the Application Groups, not the Delivery Groups. T he Delivery Groups specify
which machines will be used. (Although not shown, the machines are in Machine Catalogs.)
Application Group 1 is associated with Delivery Group 1. T he applications in Application Group 1 can be accessed by the
users specied in Application Group 1, as long as they are also in the user list for Delivery Group 1. T his follows the guidance
that the user list for an Application Group should be a subset (a restriction) of the user lists for the associated Delivery
Groups. T he settings in Application Group 1 (such as application session sharing between Application Groups, associated
Delivery Groups) apply to applications and users in that group. T he settings in Delivery Group 1 (such as anonymous user
support) apply to users in Application Groups 1 and 2, because those Application Groups have been associated with that
Delivery Group.
Application Group 2 is associated with two Delivery Groups: 1 and 2. Each of those Delivery Groups can be assigned a
priority in Application Group 2, which indicates the order in which the Delivery Groups will be checked when an application is
launched. Delivery Groups with equal priority are load balanced. T he applications in Application Group 2 can be accessed by
the users specied in Application Group 2, as long as they are also in the user lists for Delivery Group 1 and Delivery Group 2.
Example 2:
T his simple layout uses tag restrictions to limit which machines will be considered for certain desktop and application
launches. T he site has one shared Delivery Group, one published desktop, and one Application Group congured with two
applications.
Tags have been added to each of the three machines (VDA 101-103).
T he Application Group was created with the "Orange" tag restriction, so each of its applications (Calculator and Notepad)
can be launched only on machines in that Delivery Group that have the tag "Orange": VDA 102 and 103.
For more comprehensive examples and guidance for using tag restrictions in Application Groups (and for desktops), see the
Tags article.
Guidance and considerations

Citrix recommends adding applications to either Application Groups or Delivery Groups, but not both. Otherwise, the

additional complexity of having applications in two group types can make it more difcult to manage.
By default, an Application Group is enabled. After you create an Application Group, you can edit the group to change this
setting; see the Manage Application Groups article.
By default, application session sharing between Application Groups is enabled; see Session sharing between Application
Groups below.
Citrix recommends that your Delivery Groups be upgraded to the current version. T his requires (1) upgrading VDAs on the
machines used in the Delivery Group, then (2) upgrading the Machine Catalogs containing those machines, and then (3)
upgrading the Delivery Group. For details, see Manage Delivery Groups. To use Application Groups, your core components
must be minimum version 7.9.
Creating Application Groups requires the Delegated Administration permission of the Delivery Group Administrator built-in
role. See the Delegated Administration article for details.
T his article refers to "associating" an application with more than one Application Group to differentiate that action from
adding a new instance of that application from an available source. Similarly, Delivery Groups are associated with
Application Groups (and vice versa), rather than being additions or components of one another.
Session sharing with Application Groups

When application session sharing is enabled, all applications launch in the same application session. T his saves the costs
associated with launching additional application sessions, and allows the use of application features that involve the
clipboard, such as copy-paste operations. However, in some situations you may wish to turn off session sharing.
When you use Application Groups you can congure application session sharing in the following three ways which extend
the standard session sharing behavior available when you are using only Delivery Groups:
Session sharing enabled between Application Groups.

Session sharing enabled only between applications in the same Application Group.
Session sharing disabled.
Session sharing between Application Groups
You can enable application session sharing between Application Groups, or you can disable it to limit application session
sharing only to applications in the same Application Group.
Example when enabling session sharing between Application Groups is helpful:
Application Group 1 contains Microsoft Ofce applications such as Word and Excel. Application Group 2 contains
other applications such as Notepad and Calculator, and both Application Groups are attached to the same Delivery
Group. A user who has access to both Application Groups starts an application session by launching Word, and then
launches Notepad. If the controller nds that the users existing session running Word is suitable for running Notepad
then Notepad is started within the existing session. If Notepad cannot be run from the existing session for example
if the tag restriction excludes the machine that the session is running on then a new session on a suitable machine
is created rather than using session sharing.
Example when disabling session sharing between Application Groups is helpful:

You have a set of applications that do not interoperate well with other applications that are installed on the same
machines, such as two different versions of the same software suite or two different versions of the same web
browser. You prefer not to allow a user to launch both versions in the same session.
You create an Application Group for each version of the software suite, and add the applications for each version of
the software suite to the corresponding Application Group. If session sharing between groups is disabled for each of
those Application Groups, a user specied in those groups can run applications of the same version in the same
session, and can still run other applications at the same time, but not in the same session. If the user launches one of
the different-versioned applications (that are in a different Application Group), or launches any application that is not
contained in an Application Group, then that application is launched in a new session.
IMPORTANT: T his session sharing between Application Groups feature is not a security sandboxing feature. It is not
foolproof, and it cannot prevent users from launching applications into their sessions through other means (for example,
through Windows Explorer).
If a machine is at capacity, new sessions are not started on it. New applications are started in existing sessions on the
machine as needed using session sharing (providing that this complies with the session sharing restrictions described here).
You can only make prelaunched sessions available to Application Groups which have application session sharing allowed.
(Sessions which use the session linger feature are available to all Application Groups.) T hese features must be enabled and
congured in each of the Delivery Groups associated with the Application Group; you cannot congure them in the
Application Groups.
By default, application session sharing between Application Groups is enabled when you create an Application Group; you
cannot change this when you create the group. After you create an Application Group, you can edit the group to change
this setting; see the Manage Application Groups article.
Disable session sharing within an Application Group
You can prevent application session sharing between applications which are in the same Application Group.
Example when disabling session sharing within Application Groups is helpful:
You want your users to access multiple simultaneous full screen sessions of an application on separate monitors.
You create an Application Group and add the applications to it. If session sharing is prohibited between applications in
that Application Group, when a user specied in it starts one application after another they launch in separate
sessions, and the user can move each to a separate monitor.
By default, application session sharing is enabled when you create an Application Group; you cannot change this when you
create the group. After you create an Application Group, you can edit the group to change this setting; see the Manage
Application Groups article.
Create an Application Group

To create an Application Group:
1. Select Applications in the Studio navigation pane, and then select Create Application Group in the Actions pane.
2. T he Create Application Group wizard launches with an Introduction page, which you can remove from future launches
of this wizard.

3. T he wizard guides you through the pages described below. When you are done with each page, click Next until you
reach the Summary page.
Delivery Groups
All Delivery Groups are listed, with the number of machines each contains.
T he Compatible Delivery Groups list contains Delivery Groups you can select. Compatible Delivery Groups contain
random (not permanently or statically assigned) server or desktop OS machines.
T he Incompatible Delivery Groups list contains Delivery Groups you cannot select. Each entry explains why it is not
compatible, such as containing static assigned machines.
An Application Group can be associated with Delivery Groups containing shared (not private) machines that can deliver
applications.
You can also select Delivery Groups containing shared machines that deliver desktops only, if (1) the Delivery Group contains
shared machines and was created with an earlier XenDesktop 7.x version, and (2) you have Edit Delivery Group permission.
T he Delivery Group type is automatically converted to "desktops and applications" when the Create Application Group
wizard is committed.
Although you can create an Application Group that has no associated Delivery Groups perhaps to organize applications or
to serve as storage for applications not currently in use the Application Group cannot be used to deliver applications until
it species at least one Delivery Group. Additionally, you cannot add applications to the Application Group from the From
Start menu source if there are no Delivery Groups specied.
T he Delivery Groups you select specify the machines that will be used to deliver applications. Select the check boxes next
to the Delivery Groups you want to associate with the Application Group.
To add a tag restriction, select Restrict launches to machines with the tag and then select the tag from the dropdown.
See the Tags article for full details.
Users
Specify who can use the applications in the Application Group. You can either allow all users and user groups in the Delivery
Groups you selected on the previous page, or select specic users and user groups from those Delivery Groups. If you
restrict use to users you specify, then only the users specied in the Delivery Group and the Application Group can access
the applications in this Application Group. Essentially, the user list in the Application Group provides a lter on the user lists in
the Delivery Groups.
Enabling or disabling application use by unauthenticated users is available only in Delivery Groups, not in Application Groups.
Where user lists are specied
Active Directory user lists are specied when you create or edit the following:
T he entitlement user list for the delivery group, which is not configured through Studio. By default, the application
entitlement policy rule includes everyone; see the PowerShell SDK BrokerAppEntitlementPolicyRule cmdlets for details.
T he Application Group user list.
T he Delivery Group user list.
T he Application visibility property.
T he list of users who can access an application through StoreFront is formed by the intersection of the above user lists. For

example, to congure the use of application A to a particular department, without unduly restricting access to other
groups:
Use the default application entitlement policy rule that includes everyone.
Configure the Delivery Group user list to allow all headquarters users to use any of the applications specified in the
Delivery Group.
Configure the Application Group user list to allow members of the Administration and Finance business unit to access
applications named A through L.
Configure application As properties to restrict its visibility to only Accounts Receivable staff in Administration and
Finance.
Applications
Good to know:
By default, new applications you add are placed in a folder named Applications. You can specify a different folder. If you
try to add an application and one with the same name already exists in that folder, you are prompted to rename the
application you are adding. If you agree with the suggested unique name, the application is added with that new name;
otherwise, you must rename it yourself before it can be added. For details, see Manage application folders.
You can change an application's properties (settings) when you add it, or later. See Change application properties. If you
publish two applications with the same name to the same users, change the Application name (for user) property in
Studio; otherwise, users will see duplicate names in Citrix Receiver.
When you add an application to more than one Application Group, a visibility issue can occur if you do not have
sufficient permission to view the application in all of those groups. In such cases, either consult an administrator with
greater permissions or have your scope extended to include all the groups to which the application was added.
Source Description
From Start menu Applications that are discovered on a machine in the selected Delivery Groups. When you
select this source, a new page launches with a list of discovered applications. Select the
check boxes of applications to add, and then click OK.
T his source cannot be selected if you (1) selected Application Groups that have no
associated Delivery Groups, (2) selected Application Groups with associated Delivery Groups
that contain no machines, or (3) selected a Delivery Group containing no machines.
Manually dened Applications located in the Site or elsewhere in your network. When you select this source, a
new page launches where you type the path to the executable, working directory, optional
command line arguments, and display names for administrators and users. After entering this
information, click OK.
Existing Applications previously added to the Site. When you select this source, a new page launches
with a list of discovered applications. Select the check boxes of applications to add and
then click OK.
T his source cannot be selected If the Site has no applications.

App-V Applications in App-V packages. When you select this source, a new page launches where
you select the App-V server or the Application Library. From the resulting display, select the
checkboxes of applications to add, and then click OK. For more information, see the App-
V article.
T his source cannot be selected (or might not appear) if App-V is not congured for the Site.
As noted, certain entries in the Add dropdown will not be selectable if there is no valid source of that type. Sources that
are incompatible are not listed at all (for example, you cannot add Application Groups to Application Groups, so that source
is not listed when you create an Application Group.
Scopes
This page appears only if you have previously created a scope. By default, the All scope is selected. For more information, see the Delegated
Administration article.
Summary
Enter a name for the Application Group. You can also (optionally) enter a description.
Review the summary information and then click Finish.

May 22, 20 17
In this article:
Introduction
Enable or disable an Application Group
Enable or disable application session sharing between Application Groups
Disable application session sharing within an Application Group
Rename an Application Group
Add, remove, or change priority of Delivery Group associations with an Application Group
Add, change, or remove a tag restriction in an Application Group
Add or remove users in an Application Group
Change scopes in an Application Group
Delete an Application Group
Introduction
T his article describes the procedures for managing Application Groups you created.
See Applications for information about managing applications in Application Groups or Delivery Groups, including how to:
Add or remove applications in an Application Group.

Change Application Group associations.
Managing Application Groups requires the Delegated Administration permissions of the Delivery Group Administrator built-in
role. See Delegated Administration for details.
Enable or disable an Application Group

When an Application Group is enabled, it can deliver the applications that have been added to it. Disabling an Application
Group disables each application in that group. However, if those applications are also associated with other enabled
Application Groups, they can be delivered from those other groups. Similarly, if the application was explicitly added to
Delivery Groups associated with the Application Group (in addition to being added to the Application Group), disabling the
Application Group does not affect the applications in those Delivery Groups.
An Application Group is enabled when you create it; you cannot change this when you create the group.
1. Select Applications in the Studio navigation pane.

2. Select an Application Group in the middle pane and then select Edit Application Group in the Actions pane.
3. On the Settings page, select or clear the Enable Application Group check box.
window.
Enable or disable application session sharing between

Application Groups
Session sharing between Application Groups is enabled when you create an Application Group; you cannot change this
when you create the group. For more information about application session sharing, see Session sharing between
Application Groups.

3. On the Settings page, select or clear the Enable application session sharing between Application Groups check
box.
window.
Disable application session sharing within an

Application Group
Session sharing between applications in the same Application Group is enabled by default when you create an Application
Group. If you disable application session sharing between Application Groups, session sharing between applications in the
same Application Group remains enabled. You can use the Broker PowerShell SDK to congure Application Groups with
application session sharing disabled between the applications they contain. In some circumstances this may be desirable: for
example, you may want users to start non-seamless applications in full-size application windows on separate monitors. For
more information about application session sharing, see Session sharing with Application Groups.
When you disable application session sharing within an Application Group, each application in that group launches in a new
application session. If a suitable disconnected session is available which is running the same application, it is reconnected.
For example, if you launch Notepad, and there is a disconnected session with Notepad running, that session is reconnected
instead of creating a new one. If multiple suitable disconnected sessions are available, one of the sessions is chosen to
reconnect to, in a random but deterministic manner: if the situation reoccurs in the same circumstances, the same session is
chosen, but the session is not necessarily predictable otherwise.
You can use the Broker PowerShell SDK either to disable application session sharing for all applications in an existing
Application Group, or to create an Application Group with application session sharing disabled.
PowerShell cmdlet examples
To disable session sharing, use the Broker PowerShell cmdlets New-BrokerApplicationGroup or Set-
BrokerApplicationGroup with the parameter SessionSharingEnabled set to False and the parameter
SingleAppPerSession set to True.
For example to create an Application Group with application session sharing disabled for all applications in the group:
New-BrokerApplicationGroup AppGr1 -SessionSharingEnabled $False SingleAppPerSession $True
For example to disable application session sharing between all applications in an existing Application Group:
Set-BrokerApplicationGroup AppGR1 -SessionSharingEnabled $False SingleAppPerSession $True

Notes
T o enable the SingleAppPerSession property you must set SessionSharingEnabled property to False. T he two properties
must not be enabled at the same time. T he SessionSharingEnabled parameter refers to sharing sessions between
Application Groups.
Application session sharing only works for applications which are associated with Application Groups but are not
associated with Delivery Groups. (All applications associated directly with a Delivery Group share sessions by default.)
If an application is assigned to multiple Application Groups, make sure that the groups do not have conflicting settings
(for example, one having the option set to T rue, the other set to False) which results in unpredictable behavior.
Rename an Application Group

2. Select an Application Group in the middle pane and then select Rename Application Group in the Actions pane.
3. Specify the new unique name and then click OK.
Add, remove, or change priority of Delivery Group

associations with an Application Group
An Application Group can be associated with Delivery Groups containing shared (not private) machines that can deliver
applications.
You can also select Delivery Groups containing shared machines that deliver desktops only, if (1) the Delivery Group contains
shared machines and was created with an earlier XenDesktop 7.x version, and (2) you have Edit Delivery Group permission.
T he Delivery Group type is automatically converted to "desktops and applications" when the Edit Application Group dialog is
committed.

3. Select the Delivery Groups page.
4. T o add Delivery Groups, click Add. Select the check boxes of available Delivery Groups. (Incompatible Delivery Groups
cannot be selected.) When you finish your selections, click OK.
5. T o remove Delivery Groups, select the check boxes of the groups you want to remove and then click Remove. Confirm
the deletion when prompted.
6. T o change the priority of Delivery Groups, select the checkbox of the Delivery Group and then click Edit Priority. Enter
the priority (0 = highest) and then click OK.
window.
Add, change, or remove a tag restriction in an

Application Group

Important: Adding, changing, and removing tag restrictions can have unanticipated effects on which machines are
considered for application launch. Be sure to review the considerations and cautions in the Tags article.

3. Select the Delivery Groups page.
4. T o add a tag restriction, select Restrict launches to machines with the tag and then select the tag from the
dropdown.
5. T o change or remove a tag restriction, either select a different tag from the dropdown or remove the tag restriction
entirely by clearing Restrict launches to machines with this tag.
window.
Add or remove users in an Application Group

For detailed information about users, see the Users section in the Create Application Groups article.

3. Select the Users page. Indicate whether you want to allow all users in the associated Delivery Groups to use
applications in the Application Group, or only specific users and groups. T o add users, click Add, and then specify the
users you want to add. T o remove users, select one or more users and then click Remove.
window.
Change scopes in an Application Group

You can change a scope only if you have created a scope (you cannot edit the All scope). For more information, see the
Delegated Administration article.

3. Select the Scopes page. Select or clear the check box next to a scope.
window.
Delete an Application Group

An application must be associated with at least one Delivery Group or Application Group. If your attempt to delete an
Application Group will result in one or more applications no longer belonging to a group, you will be warned that deleting
that group will also delete those applications. You can then conrm or cancel the deletion.
Deleting an application does not delete it from its original source, but if you want to make it available again, you must add
it again.

2. Select an Application Group in the middle pane and then select Delete Group in the Actions pane.
3. Confirm the deletion when prompted.

Remote PC Access
May 22, 20 17
Remote PC Access allows an end user to log on remotely from virtually anywhere to the physical Windows PC in the ofce.
T he Virtual Delivery Agent (VDA) is installed on the ofce PC; it registers with the Delivery Controller and manages the HDX
connection between the PC and the end user client devices. Remote PC Access supports a self-service model; after you set
up the whitelist of machines that users are permitted to access, those users can join their ofce PCs to a Site themselves,
without administrator intervention. T he Citrix Receiver running on their client device enables access to the applications and
data on the ofce PC from the Remote PC Access desktop session.
A user can have multiple desktops, including more than one physical PC or a combination of physical PCs and virtual
desktops.
Note: Sleep mode and hibernation mode are not supported for Remote PC Access. Remote PC Access is valid only for
XenDesktop licenses; sessions consume licenses in the same way as other XenDesktop sessions.
Active Directory considerations

Before conguring the Remote PC Access deployment Site, set up your Organizational Units (OUs) and security groups and
then create user accounts. Use these accounts to specify users for the Delivery Groups you will use to provide Remote PC
Access.
If you modify Active Directory after a machine has been added to a machine catalog, Remote PC Access does not
reevaluate that assignment. You can manually reassign a machine to a different catalog, if needed.
If you move or delete OUs, those used for Remote PC Access can become out of date. VDAs might no longer be
associated with the most appropriate (or any) machine catalog or Delivery Group.
Machine catalog and Delivery Group considerations

A machine can be assigned to only one machine catalog and one Delivery Group at a time.
You can put machines in one or more Remote PC Access machine catalogs.
When choosing machine accounts for a catalog, select the lowest applicable OU to avoid potential conicts with machines
in another catalog. For example, in the case of bank/ofcers/tellers, select tellers.
You can allocate all machines from one Remote PC Access machine catalog through one or more Delivery Groups. For
example, if one group of users requires certain policy settings and another group requires different settings, assigning the
users to different Delivery Groups enables you to lter the HDX policies according to each Delivery Group.
If your IT infrastructure assigns responsibility for servicing users based on geographic location, department, or some other
category, you can group machines and users accordingly to allow for delegated administration. Ensure that each
administrator has permissions for both the relevant catalogs and the corresponding Delivery Groups.

Deployment considerations
You can create a Remote PC Access deployment and then add traditional Virtual Desktop Infrastructure (VDI) desktops or
applications later. You can also add Remote PC Access desktops to an existing VDI deployment.
Consider whether to enable the Windows Remote Assistance checkbox when you install the VDA on the ofce PC. T his
option allows help desk teams using Director to view and interact with a user sessions using Windows Remote Assistance.
Consider how you will deploy the VDA to each ofce PC. Citrix recommends using electronic software distribution such as
Active Directory scripts and Microsoft System Center Conguration Manager. T he installation media contains sample Active
Directory scripts.
Review the security considerations for Remote PC Access deployments.
Secure Boot for Remote PC Access is currently supported on Windows 10.
Each ofce PC must be domain-joined with a wired network connection.
Windows 7 Aero is supported on the ofce PC, but not required.
Connect the keyboard and mouse directly to the PC or laptop, not to the monitor or other components that can be turned
off. If you must connect input devices to components such as monitors, they should not be turned off.
If you are using smart cards, see Smart cards.
Remote PC Access can be used on most laptop computers. To improve accessibility and deliver the best connection
experience, congure the laptop power saving options to those of a desktop PC. For example:
Disable the hibernate feature.

Disable the sleep feature.
Set the close lid action to Do Nothing.
Set the press the power button action to Shut Down.
Disable video card energy saving features.
Disable network interface card energy saving features.
Disable battery saving technologies.
T he following are not supported for Remote PC Access devices:
Docking and undocking the laptop.

KVM switches or other components that can disconnect a session.
Hybrid PCs, including All-in-One and NVIDIA Optimus laptops and PCs.
Citrix supports Remote PC Access on Surface Pro devices with Windows 10. To improve accessibility and deliver the best
connection experience, congure the Surface device in a similar way to a desktop or laptop computer. For example:
Disable the hibernate or sleep feature

Use wired network connectivity
Always have the keyboard attached when initiating or reconnecting a session
Disable battery saving technologies

Install Citrix Receiver on each client device that remotely accesses the ofce PC.
Multiple users with remote access to the same ofce PC see the same icon in Citrix Receiver. When any user remotely logs
on to the PC, that resource appears as unavailable to other users.
By default, a remote users session is automatically disconnected when a local user initiates a session on that machine (by
pressing CT RL+AT L+DEL). To prevent this automatic action, add the following registry entry on the ofce PC, and then
restart the machine.
Caut ion: Editing the registry incorrectly can cause serious problems that may 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.
HKLM\SOFTWARE\Citrix\PortICA\RemotePC "SasNotication"=dword:00000001
To further customize the behavior of this feature under HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\PortICA\RemotePC
RpcaMode (dword):
1 = The remote user will always win if he does not respond to the messaging UI in the specied timeout period.
2 = The local user will always win. If this setting is not specied, the remote user will always win by default.
RpcaTimeout (dword):
The number of seconds given to the user before the type of mode to enforce is determined. If this setting is not specied, the
default value is 30 seconds. The minimum value here should be 30 seconds. The user must restart the machine for these changes
to take place.
When user wants to forcibly get the console access: The local user can press Ctr+Alt+Del twice in a gap of 10 seconds to get
local control over a remote session and force a disconnect event.
After the registry change and machine restart, if a local user presses CTRL+ALT+DEL to log on to that PC while it is in use by a
remote user, the remote user receives a prompt asking whether or not to allow or deny the local user's connection. Allowing the
connection will disconnect the remote user's session.
Remote PC Access and HDX 3D Pro mode
For Remote PC Access, the VDA is usually congured using the standard VDA option. For Remote PC Access congured
with HDX 3D Pro, monitor blanking is supported with Intel Iris Pro graphics and Intel HD graphics 5300 and above (5th
Generation Intel Core Processors and 6th Generation Intel Core i5 Processors), and NVIDIA Quadro and NVIDIA GRID GPUs.
For more information, see Prepare to install and GPU acceleration for Windows Desktop OS.
Wake on LAN
Remote PC Access supports Wake on LAN, which gives users the ability to turn on physical PCs remotely. T his feature
enables users to keep their ofce PCs turned off when not in use, saving energy costs. It also enables remote access when
a machine has been turned off inadvertently, such as during weather events.
T he Remote PC Access Wake on LAN feature is supported on:
PCs that have the Wake on LAN option enabled in the BIOS. T his support includes wake-up proxy and raw magic
packets, and is available when using Microsoft System Cemter Configuration Manager (ConfigMgr) 2012, ConfigMgr
2012 R2, and ConfigMgr 2016.

PCs that support Intel Active Management T echnology (AMT ). On AMT -capable machines, the Wake on LAN feature
also supports the Force-Shutdown and Force-Restart actions in Studio and Director. Additionally, a Restart action is
available in StoreFront and Citrix Receiver. IMPORTANT: AMT support is available only when using ConfigMgr 2012 or
2012 R2, not ConfigMgr 2016.
Congure CongMgr to use the Wake on LAN feature. T hen, when you use Studio to create a Remote PC Access
deployment (or when you add another power management connection to be used for Remote PC Access), enable the
power management feature and specify CongMgr access information.
For conguration details, see Conguration Manager and Remote PC Access Wake on LAN.
Conguration sequence and considerations

Bef ore you create the Remote PC Access Site:
If you will use the Remote PC Access power management feature (also known as Remote PC Access Wake on LAN),
complete the conguration tasks on the PCs and on Microsoft System Center Conguration Manager (CongMgr) before
creating the Remote PC Access deployment in Studio. See Conguration Manager and Remote PC Access Wake on LAN for
details.
In the Site creation wizard:
Select the Remote PC Access Site type.

On the Power Management page, you can enable or disable power management for the machines in the default
Remote PC Access machine catalog. If you enable power management, specify ConfigMgr connection information.
On the Users and Machine Accounts pages, specify users and machine accounts.
Creating a Remote PC Access Site creates a default machine catalog named Remote PC Access Machines and a default
Delivery Group named Remote PC Access Desktops.
If you create another machine catalog f or use with Remote PC Access:
On the Operating System page, select Remote PC Access and choose a power management connection. You can also
choose not to use power management. If there are no configured power management connections, you can add one
after you finish the machine catalog creation wizard (connection type = Microsoft Configuration Manager Wake on
LAN), and then edit the catalog, specifying that new connection.
On the Machine Accounts page, you can select from the machine accounts or Organizational Units (OUs) displayed, or
add machine accounts and OUs.
Install the VDA on the of ce PCs used f or local and remote access. Typically, you deploy the VDA automatically using
your package management software; however, for proof-of-concept or small deployments, you can install the VDA
manually on each ofce PC. T here are several ways you can install a desktop VDA for a Remote PC Access deployment.
Use the full-product or VDAWorkstationSetup.exe installer
Graphic interface: Select Remote PC Access on the Environment page of the wizard. T he components on the
Additional Components page are not selected by default. T hey are not required for Remote PC Access operation.
Command-line interface: specify the /remotepc option. T his option prevents the installation of the following
components (which are equivalent to the items on the Additional Components page in the wizard):

App-V
Personal vDisk
Alternatively, you can use the /exclude option to exclude each of these components.
Use the VDAWorkstationCoreSetup.exe installer. Neither Citrix Receiver nor any additional components can be installed
with this installer.
After the VDA is installed, the next domain user that logs on to a console session (locally or through RDP) on the ofce PC
is automatically assigned to the Remote PC Access desktop. If additional domain users log on to a console session, they are
also added to the desktop user list, subject to any restrictions you have congured.
To use RDP connections outside of your XenApp or XenDesktop environment, you must add users or groups to the Direct
Access Users group.
Instruct users to download and install Citrix Receiver onto each client device they will use to access the of ce
PC remotely. Citrix Receiver is available from http://www.citrix.com or the application distribution systems for supported
mobile devices.
Congure advanced connection settings

You can edit a power management connection to congure advanced settings. You can enable:
Wake-up proxy delivered by ConfigMgr.

Wake on LAN (magic) packets. If you enable Wake on LAN packets, you can select a Wake on LAN transmission method:
subnet-directed broadcasts or Unicast.
T he PC uses AMT power commands (if they are supported), plus any of the enabled advanced settings. If the PC does not
use AMT power commands, it uses the advanced settings.
Troubleshooting
T he Delivery Controller writes the following diagnostic information about Remote PC Access to the Windows Application
Event log. Informational messages are not throttled. Error messages are throttled by discarding duplicate messages.
3300 (informational) - Machine added to catalog

3301 (informational) - Machine added to delivery group
3302 (informational) - Machine assigned to user
3303 (error) - Exception
When power management for Remote PC Access is enabled, subnet-directed broadcasts might fail to start machines that
are located on a different subnet from the Controller. If you need power management across subnets using subnet-
directed broadcasts, and AMT support is not available, try the Wake-up proxy or Unicast method (ensure those settings are
enabled in the advanced properties for the power management connection).

App-V
May 22, 20 17
Using App-V with XenApp and XenDesktop

Microsoft Application Virtualization (App-V) lets you deploy, update, and support applications as services. Users access
applications without installing them on their own devices. App-V and Microsoft User State Virtualization (USV) provide
access to applications and data, regardless of location and connection to the internet.
T he following table lists supported versions.
App-V XenDesktop and XenApp versions
Delivery Controller VDA
5.0 and 5.0 SP1 XenDesktop 7 through current 7.0 through current
XenApp 7.5 through current
5.0 SP2 XenDesktop 7 through current 7.1 through current
5.0 SP3 and 5.1 XenDesktop 7.6 through current 7.6.300 through current
XenDesktop 7.12 through current

App-V in Windows Server 2016 7.12 through current
T he App-V client does not support ofine access to applications. App-V integration support includes using SMB shares for
applications. T he HT T P protocol is not supported.
If you're not familiar with App-V, see the Microsoft documentation. Here's a recap of the App-V components mentioned in
this article:
Management server. Provides a centralized console to manage App-V infrastructure and delivers virtual applications to
both the App-V Desktop Client and a Remote Desktop Services Client. T he App-V management server authenticates,
requests, and provides the security, metering, monitoring, and data gathering required by the administrator. T he server
uses Active Directory and supporting tools to manage users and applications.
Publishing server. Provides App-V clients with applications for specific users, and hosts the virtual application package
for streaming. It fetches the packages from the management server.

Client. Retrieves virtual applications, publishes the applications on the client, and automatically sets up and manages
virtual environments at runtime on Windows devices. You install the App-V client on the VDA, where it stores user-
specific virtual application settings such as registry and file changes in each user's profile.
Applications are available seamlessly without any pre-conguration or changes to operating system settings. You can
launch App-V applications from Server OS and Desktop OS Delivery Groups:
T hrough Citrix Receiver

From the Start menu
T hrough the App-V client and Citrix Receiver
Simultaneously by multiple users on multiple devices
T hrough Citrix StoreFront
Modied App-V application properties are implemented when the application is started. For example, for applications with a
modied display name or customized icon, the modication appears when users start the application.
Management methods
You can use App-V packages created with the App-V sequencer and then located on either App-V servers or network
shares.
App-V servers: Using applications from packages on App-V servers requires ongoing communication between Studio and
the App-V servers for discovery, configuration, and downloading to the VDAs. T his incurs hardware, infrastructure, and
administration overhead. Studio and the App-V servers must remain synchronized, particularly for user permissions.
T his is called the dual admin management method because App-V package and application access requires both
Studio and the App-V server consoles. T his method works best in closely coupled App-V and Citrix deployments.
Network share: Packages placed on a network share removes Studio's dependence on the App-V server and database
infrastructure, thereby lowering overhead. (You still need to install the Microsoft App-V client on each VDA.)
T his is called the single admin management method because App-V package and application use requires only the
Studio console. You browse to the network share and add one or more App-V packages from that location to the
Site-level Application Library.
Application Library is a Citrix term for a caching repository that stores information about App-V packages. T he
Application Library also stores information about other Citrix application delivery technologies.
You can use one or both management methods simultaneously. In other words, when you add applications to Delivery
Groups, the applications can come from App-V packages located on App-V servers and/or on a network share.
When you select Conguration > App-V Publishing in the Studio navigation pane, the display shows App-V package
names and sources. T he source column indicates whether the packages are located on the App-V server or cached in the
Application Library. When you select a package, the details pane lists the applications in the package.
Isolation groups
When you use the App-V single admin method, creating isolation groups allow you to specify interdependent groups of
applications that must run in the sandbox. T his feature is similar, but not identical to, App-V connection groups. Instead of
the mandatory and optional package terminology used by the App-V management server, Citrix uses automatic and explicit
for package deployment options.

When a user launches an App-V application (the primary application), the isolation groups are searched for other
application packages that are marked for automatic inclusion. T hose packages are downloaded and included in the
isolation group automatically. You do not need to add them to the Delivery Group that contains the primary application.
An application package in the isolation group that is marked for explicit inclusion is downloaded only if you have explicitly
added that application to the same Delivery Group that contains the primary application.
T his allows you to create isolation groups containing a mix of automatically included applications that are available globally
to all users. Plus, the group can contain a set of plug-ins and other applications (that might have specic licensing
constraints), which you can limit to a certain set of users (identied through Delivery Groups) without having to create more
isolation groups.
For example, application "app-a" requires JRE 1.7 to run. You can create an isolation group containing app-a (with an explicit
deployment type) and JRE 1.7 (with an automatic deployment type). T hen, add those App-V packages to one or more
Delivery Groups. When a user launches app-a, JRE 1.7 is automatically deployed with it.
You can add an application to more than one App-V isolation group. However, when a user launches that application, the
rst isolation group to which that application was added is always used. You cannot order or prioritize other isolation
groups containing that application.
Setup
The following table summarizes the sequence of setup tasks for using App-V in XenApp and XenDesktop.
Management method Task
Single admin Dual admin
X X Deploy App-V
X X Packaging and placement
X Congure App-V server addresses in Studio
X X Install software on VDA machines
X Add App-V packages to the Application Library
X Add App-V isolation groups (optional)
X X Add App-V applications to Delivery Groups
Deploy Microsof t App-V

For App-V deployment instructions, see http://technet.microsoft.com/en-us/virtualization/hh710199.
Optionally, change App-V publishing server settings. Citrix recommends using the SDK cmdlets on the Controller. See the
SDK documentation for details.
T o view publishing server settings, enter Get-CtxAppvServerSetting -AppVPublishingServer < pubServer>.

T o ensure that App-V applications launch properly, enter Set-CtxAppvServerSetting UserRef reshonLogon 0.
If you previously used GPO policy settings to manage publishing server settings, the GPO settings override any App-V
integration settings, including cmdlet settings. T his can result in App-V application launch failure. Citrix recommends that
you remove all GPO policy settings and then use the SDK to congure those settings.
Packaging and placement
For either management method, create application packages using the App-V sequencer. See the Microsoft
documentation for details.
For single admin management, make the packages available on a UNC or SMB shared network location. Ensure that the
Studio administrator who adds applications to Delivery Groups has at least read access to that location.
For dual admin management, publish the packages on the App-V management server from a UNC path. (Publishing from
HT T P URLs is not supported.)
Regardless of whether packages are on the App-V server or on a network share, ensure the packages have appropriate
security permissions to allow the Studio administrator to access them. Network shares must be shared with Authenticated
users to ensure that both the VDA and Studio have read access by default.
Congure App-V server addresses in Studio
Important
Citrix recommends using the PowerShell cmdlets on the Controller to specify App-V server addresses if those servers use
nondefault property values. See the SDK documentation for details. If you change App-V server addresses in Studio, some server
connection properties you specify might be reset to default values. T hese properties are used on the VDAs to connect to App-V
publishing servers. If this happens, recongure the nondefault values for any reset properties on the servers.
T his procedure is valid only for the dual admin management method.
Specify App-V management and publishing server addresses for the dual admin management method either during or after
Site creation. You can do this during or after creating the Site.
During Site creation:
On the App-V page of the wizard, enter the URL of the Microsoft App-V management server, and the URL and port
number of the App-V publishing server. Test the connection before continuing with the wizard. If the test fails, see
the Troubleshoot section below.
After Site creation:
1. Select Conf iguration > App-V Publishing in the Studio navigation pane.

2. If you have not previously specified App-V server addresses, select Add Microsof t Server in the Actions pane.
3. T o change App-V server addresses, select Edit Microsof t Server in the Actions pane.
4. Enter the URL of the Microsoft App-V management server, and the URL and port number of the App-V publishing server.
5. T est the connection to those servers before closing the dialog box. If the test fails, see the T roubleshoot section below.
Later, if you want to remove all links to the App-V management and publishing servers and stop Studio from discovering
App-V packages from those servers, select Remove Microsof t Server in the Actions pane. T his action is allowed only if no
applications in packages on those servers are currently published in any Delivery Groups. If they are, you must remove those
applications from the Delivery Groups before you can remove the App-V servers.
Install sof tware on VDA machines
Machines containing VDAs must have two sets of software installed to support App-V: one from Microsoft and the other
from Citrix.
Microsof t App-V client
T his software retrieves virtual applications, publishes the applications on the client, and automatically sets up and
manages virtual environments at runtime on Windows devices. T he App-V client stores user-specic virtual application
settings, such as registry and le changes in each user's prole.
T he App-V client is available from Microsoft. Install a client on each machine containing a VDA, or on the master
image that is used in a machine catalog to create VMs.
T ip: After you install the App-V client, with Administrator permissions, run the PowerShell Get-
AppvClientConguration cmdlet, and ensure that EnablePackageScripts is set to 1. If it is not set to 1, run Set-
AppvClientConguration -EnablePackageScripts $true.
Citrix App-V components
T he Citrix App-V component software is installed and enabled by default when you install a VDA. T hat process also
creates an account with local administrator permissions for accessing the App-V publishing components.
You can control this default action during VDA installation. In the graphical interface, clear the Citrix Personalization
f or App-V - VDA check box on the Additional Components page. In the command line interface, include the
/exclude "Citrix Personalization f or App-V - VDA" option.
If you expressly disable installation of the Citrix App-V components during VDA installation, but later want to use App-
V applications: In the Windows machine's Programs and Features list, right-click the Citrix Virtual Delivery Agent
entry and then select Change. A wizard launches. In the wizard, enable the option that installs and enables App-V
publishing components.
Add or remove App-V packages in the Application Library
T hese procedures are valid only for the single admin management method.
You must have at least read access to the network share containing the App-V packages.
Add an App-V package to the Application Library
2. Select Add Packages in the Actions pane.

3. Browse to the share containing the App-V packages and select one or more packages.
4. Click Add.
Remove an App-V package f rom the Application Library
Removing an App-V package from the Application Library removes it from the Studio App-V Publishing node display.
However, it does not remove its applications from Delivery Groups, and those applications can still be launched. T he
package remains in its physical network location. (T his effect differs from removing an App-V application from a Delivery
Group.)
2. Select one or more packages to be removed.
3. Select Remove Package in the Actions pane.
Add, edit, or remove App-V isolation groups
Add an App-V isolation group
1. Select App-V Publishing in the Studio navigation pane.

2. Select Add Isolation Group in the Actions pane.
3. In the Add Isolation Group Settings dialog box, type a name and description for the isolation group.
4. From the Available Packages list, select the applications you want to add to the isolation group, and then click the right
arrow. T he selected applications should now appear in the Packages in Isolation Group list. In the Deployment drop-
down next to each application, select either Explicit or Automatic. You can also use the up and down arrows to change
the order of applications in the list.
5. When you are done, click OK.
Edit an App-V isolation group
1. Select App-V Publishing from the Studio navigation pane.

2. Select the Isolation Groups tab in the middle pane and then select the isolation group you want to edit.
3. Select Edit Isolation Group in the Actions pane.
4. In the Edit Isolation Group Settings dialog box, change the isolation group name or description, add or remove
applications, change their deployment type, or change the application order.
5. When you are done, click OK.
Remove an App-V isolation group
Removing an isolation group does not remove the application packages. It removes only the grouping.
1. Select App-V Publishing from the Studio navigation pane.

2. Select the Isolation Groups tab in the middle pane and then select the isolation group you want to remove.
3. Select Remove Isolation Group from the Actions pane.
4. Confirm the removal.
Add App-V applications to Delivery Groups
T he following procedure focuses on how to add App-V applications to Delivery Groups. For complete details about creating
a Delivery Group, see Create Delivery Groups.
Step 1: Choose whether you want to create a new Delivery Group or add App-V applications to an existing Delivery Group:

To create a Delivery Group containing App-V applications:

2. Select Create Delivery Group in the Actions pane.
3. On successive pages of the wizard, specify a machine catalog and users.
To add App-V applications to existing Delivery Groups:

2. Select Add Applications in the Actions pane.
3. Select one or more Delivery Groups where the App-V applications will be added.
Step 2: On the Applications page of the wizard, click the Add drop-down to display application sources. Select App-V.
Step 3: On the Add App-V Applications page, choose the App-V source: the App-V server or the Application Library. T he
resulting display includes the application names plus their package names and package versions. Select the check boxes
next to the applications you want to add. T hen click OK.
Step 4 : Complete the wizard.
Good to know:
If you change an App-V application's properties when adding them to a Delivery Group, the changes are made when the
application is started. For example, if you modify an application's display name or icon when adding it to the group, the
change appears when a user starts the application.
If you later edit a Delivery Group containing App-V applications, there is no change in App-V application performance if
you change the group's delivery type from desktops and applications to applications only.
Troubleshoot
Issues that can occur only when using the dual admin method are marked (DUAL).
(DUAL) T here is a PowerShell connection error when you select Conguration > App-V Publishing in the Studio
navigation pane.
Is the Studio administrator also an App-V server administrator? T he Studio administrator must belong to the
"administrators" group on the App-V management server so that they can communicate with it.
(DUAL) T he Test connection operation returns an error when you specify App-V server addresses in Studio.
Is the App-V server powered on? Either send a Ping command or check the IIS Manager; each App-V server should be in a
Started and Running state.
Is PowerShell remoting enabled on the App-V server? If not, see http://technet.microsoft.com/en-
us/magazine/ff700227.aspx.
Is the Studio administrator also an App-V server administrator? T he Studio administrator must belong to the
"administrators" group on the App-V management server so that they can communicate with it.
Is file sharing enabled on the App-V server? Enter \\< App-V server FQDN> in Windows Explorer or with the Run
command.
Does the App-V server have the same file sharing permissions as the App-V administrator? On the App-V server, add an
entry for\\<App-V Server FQDN> in Stored User Names and Passwords, specifying the credentials of the user who has

administrator privileges on the App-V server. For guidance, see http://support.microsoft.com/kb/306541.
Is the App-V server in Active Directory?
If the Studio machine and the App-V server are in different Active Directory domains that do not have a trust
relationship, from the PowerShell console on the Studio machine, run winrm s winrm/Cong/client
@(TrustedHosts="< App-V server FQDN>").
If TrustedHosts is managed by GPO, the following error message will display: "T he cong setting TrustedHosts cannot
be changed because use is controlled by policies. T he policy would need to be set to Not Congured to change the
cong setting." In this case, add an entry for the App-V server name to the TrustedHosts policy in GPO (Administrative
Templates > Windows Components > Windows Remote Management (WinRM) > WinRM Client).
(DUAL) Discovery fails when adding an App-V application to a Delivery Group.
Is the Studio administrator also an App-V management server administrator? T he Studio administrator must belong to
the "administrators" group on the App-V management server so that they can communicate with it.
Is the App-V management server running? Either send a Ping command or check the IIS Manager; each App-V server
should be in a Started and Running state.
Is PowerShell remoting enabled on both App-V servers? If not, see http://technet.microsoft.com/en-
us/magazine/ff700227.aspx.
Do packages have the appropriate security permissions for the Studio administrator to access?
App-V applications do not launch.
(DUAL) Is the publishing server running?

(DUAL) Do the App-V packages have appropriate security permissions so that users can access them?
(DUAL) On the VDA, ensure that T emp is pointing to the correct location, and that there is enough space available in the
T emp directory.
(DUAL) On the App-V publishing server, run Get-AppvPublishingServer * to display the list of publishing servers.
(DUAL) On the App-V publishing server, ensure that UserRefreshonLogon is set to False.
(DUAL) On the App-V publishing server, as an administrator, run Set-AppvPublishingServer and set UserRefreshonLogon
to False.
Is a supported version of the App-V client installed on the VDA? Does the VDA have the "enable package scripts" setting
enabled?
On the machine containing the App-V client and VDA, from the Registry editor (regedit), go to
HKEY_LOCAL_MACHINE\SOFT WARE\Policies\Citrix\AppV. Ensure that the AppVServers key has the following value
format: AppVManagementServer+metadata;PublishingServer (for example: http://xmas-demo-
appv.blrstrm.com+0+0+0+1+1+1+0+1;http://xmas-demo-appv.blrstrm.com:8082).
On the machine or master image containing the App-V client and VDA, check that the PowerShell ExecutionPolicy is set
to RemoteSigned. T he App-V client provided by Microsoft is not signed, and this ExecutionPolicy allows PowerShell to
run unsigned local scripts and cmdlets. Use one of the following two methods to set the ExecutionPolicy: (1) As an
administrator, enter the cmdlet: Set-ExecutionPolicy RemoteSigned, or (2) From Group Policy settings, go to Computer
Configuration > Policies > Administrative T emplates > Windows Components > Windows PowerShell> T urn on Script
Execution.
If these steps do not resolve the issues, enable and examine the logs.
Logs
App-V conguration-related logs are located at C:\CtxAppvLogs. T he application launch logs are located at:

%LOCALAPPDATA%\Citrix\CtxAppvLogs. LOCALAPPDATA resolves to the local folder for the logged-on user. Check the
local folder of the user for whom the application launch failed.
To enable Studio and VDA logs used for App-V, you must have administrator privileges. You will also need a text editor such
as Notepad.
To enable Studio logs:
1. Create the folder C:\CtxAppvLogs.

2. Go to C:\ProgramFiles\Citrix\StudioAppVIntegration\SnapIn\Citrix.Appv.Admin.V1. Open CtxAppvCommon.dll.config in a
text editor and uncomment the line: <add key ="LogFileName" value=C:\CtxAppvLogs\log.txt/>
3. Restart the Broker service to start logging.
To enable VDA logs:
1. Create the folder C:\CtxAppvLogs.

2. Go to C:\ProgramFiles\Citrix\ Virtual Desktop Agent. Open CtxAppvCommon.dll.config in a text editor and uncomment
the following line: <add key ="LogFileName" value="C:\CtxAppvLogs\log.txt"/>
3. Uncomment the line and set the value field to 1: <add key ="EnableLauncherLogs" value="1"/>
4. Restart the machine to start logging.

AppDisks
May 22, 20 17
Overview
Managing applications and managing the images they are installed on can be a challenge. T he Citrix AppDisks feature is a
solution. AppDisks separate applications and groups of applications from the operating system, enabling you to manage
them independently.
You can create different AppDisks containing applications designed for individual user groups, and then assemble the
AppDisks on a master image of your choice. Grouping and managing applications this way gives you ner control of
applications, and reduces the number of master images you maintain. T his simplies IT administration and enables you to be
more responsive to user needs. You deliver the applications in AppDisks through Delivery Groups.
If your deployment also includes Citrix AppDNA, you can integrate the AppDisks feature with it; AppDNA allows XenApp
and XenDesktop to perform automatic analysis of applications on a per-AppDisk basis. Using AppDNA helps make the most
of the AppDisks feature. Without it, application compatibility is not tested or reported.
AppDisks differ from other application-provisioning technologies in two ways: isolation and change management.
Microsoft App-V allows incompatible applications to exist together by isolating them. T he AppDisks feature does not
isolate applications. It separates applications (and supporting files and registry keys) from the OS. T o the OS and the
user, AppDisks look and behave as if they are installed directly on a master image.
Change management (updating master images and testing the compatibility of updates with installed applications) can
be a significant expense. AppDNA reports help identify issues and suggest remediation steps. For example, AppDNA can
identify applications that have common dependencies such as .NET , so you can install them on a single common base
image. AppDNA can also identify applications that load early in the OS startup sequence, so that you can then ensure
they behave as expected.
Good to know:
After updating an image, some applications may fail to work properly due to an ability to verify previously installed
licenses. For example, after an image upgrade, launching Microsoft Office may display an error message similar to:
"Microsoft Ofce Professional Plus 2010 cannot verify the license for this application. A repair attempt failed or was
canceled by the user, the application will not shut down."
T o resolve this issue, uninstall Microsoft Office and install the new version on the base image.
In some cases, downloading Metro apps from the Windows Store to a published catalog's virtual machine fails after a
long time.
Citrix recommends that you always put all Microsoft Office components in the same AppDisk. For example, one AppDisk
with Microsoft Office with Project, and another AppDisk with Microsoft Office with Project and Visio.
On some systems, SCCM crashes when updating an image. T his scenario occurs when updates are made to the base
image, then applied, which results in failure of the SCCM client. T o resolve this issue, install the SCCM client instance in
the base image first.
In some cases, an application installed on the AppDisk may fail to appear in the Windows Start menu after it is assigned

to a Delivery Group and assigned a user's virtual machine. See How applications appear in the Start Menu for more
information.
Users are unaware of the separation of applications and the OS, or any other aspect of the AppDisks feature.
Applications behave as if they are installed on the image. AppDisks containing complex applications may result in a slight
delay in desktop startup.
You may only use AppDisks with Hosted Shared and Pooled desktops.
You can use AppDisks with hosted shared desktops.
You may be able to share AppDisks across master images and OS platforms (on a per-application basis); however, this will
not work for all applications. If you have applications with an install script for a desktop OS that prevents them from
working on a server OS, Citrix recommends packaging the applications separately for the two OSs.
In many cases, AppDisks work on different OSs. For example, you can add an AppDisk that was created on a Windows 7
VM to a Delivery Group containing Windows 2008 R2 machines, as long as both OSs have the same bitness (32 bit or 64
bit) and both support the application. However, Citrix recommends you do not add an AppDisk created on a later OS
version (such as Windows 10) to a Delivery Group containing machines running an earlier OS version (such as Windows 7),
because it might not work correctly.
If you need to provide access to an AppDisk's applications to only a subset of users in a Delivery Group, Citrix
recommends using Group Policy to hide an application in an AppDisk from some users. T hat application's executable file
remains available, but will not run for those users.
In Russian and Chinese environments running the Windows 7 OS, the reboot dialog fails to disappear automatically; in
such cases, after logging on to a delivered desktop the reboot dialog appears and should disappear quickly.
When using the Upload-PvDDiags script tool, log information related to the PVD user layer is missing when the user's
drive designation is not set to 'P'.
In environments set to display Basque language, a Windows 7 OS may fail to properly display the appropriate language
on the reboot prompt screen. When you set the language to Basque, make sure that you have already installed French
or Spanish as the parent language, then install Basque and set it as the current language.
When shutting down a computer, the PVD update reminder pops up even if the PVD disk is set to read-only mode.
During an in-place upgrade, a registry file (DaFsFilter) could be deleted, which causes the upgrade to fail.
Tip
When creating an AppDisk, use a VM with only the OS installed (that is, do not include other apps); the OS should contain all updates
prior to creating the AppDisk.
Deployment overview
T he following list summarizes the steps to deploy AppDisks. Details are provided later in this article.
1. From your hypervisor management console, install a Virtual Delivery Agent (VDA) on a VM.
2. Create an AppDisk, which includes completing steps from your hypervisor management console and in Studio.
3. From your hypervisor management console, install applications on the AppDisk.
4. Seal the AppDisk (from the hypervisor management console or in Studio). Sealing allows XenApp and XenDesktop to
record the AppDisk's applications and supporting files in an Application Library (AppLibrary).
5. In Studio, create or edit a Delivery Group and select the AppDisks to include; this is called assigning the AppDisks (even
though you use the Manage AppDisks action in Studio). When VMs in the Delivery Group start up, XenApp and

XenDesktop coordinate with the AppLibrary, then interact with Creation Services (MCS) or Provisioning Services (PVS),
and the Delivery Controller to stream the boot devices after AppDisks are configured on them.
Requirements
Using AppDisks has requirements in addition to those listed in the System requirements article.
T he AppDisks feature is supported only in deployments containing (at minimum) versions of the Delivery Controller and
Studio provided in the XenApp and XenDesktop 7.8 download, including the prerequisites that the installer automatically
deploys (such as .NET 4.5.2).
AppDisks can be created on the same Windows OS versions that are supported for VDAs. T he machines selected for
Delivery Groups that will use AppDisks must have at least VDA version 7.8 installed.
Citrix recommends that you install or upgrade all machines with the most recent VDA version (and then upgrade
Machine Catalogs and Delivery Groups, if needed). When creating a Delivery Group, if you select machines that have
different VDA versions installed, the Delivery Group will be compatible with the earliest VDA version. (T his is called the
group's functional level.) For more information about functional level, see the Create Delivery Groups article.
To provision VMs that will be used to create AppDisks, you can use:
MCS provided with the 7.8 Controller (minimum).

PVS version provided on the download page with your XenApp and XenDesktop version.
Supported hypervisors:
XenServer
VMware (minimum version 5.1)
Microsoft System Center Virtual Machine Manager
AppDisks cannot be used with other host hypervisors and cloud service types supported for XenApp and XenDesktop.
Creating AppDisks is not supported with machines in MCS catalogs that use caching of temporary data.
Note
You can attach AppDisks to MCS-provisioned machines using write caching, but they cannot be used to create AppDisks.
Remote PC Access catalogs do not support AppDisks.
T he Windows Volume Shadow Service must be enabled on the VM where you are creating an AppDisk. T his service is
enabled by default.
Delivery Groups used with AppDisks can contain machines from pooled random Machine Catalogs containing server OS or
desktop OS machines. You cannot use AppDisks with machines from other catalog types, such as pooled static or
dedicated (assigned).
Machines on which Studio is installed must have .NET Framework 3.5 installed (in addition to any other installed .NET
versions).

AppDisks can affect storage. For details, see Storage and performance considerations.
If you use AppDNA:
Review the AppDNA documentation and the AppDisk FAQ.

T he AppDNA software must be installed on a different server from a Controller. Use the AppDNA version supplied with
this XenApp and XenDesktop release. For other AppDNA requirements, see its documentation.
On the AppDNA server, make sure there is a firewall exception for the default port 8199.
Do not disable an AppDNA connection while creating an AppDisk.
When you create the XenApp or XenDesktop Site, you can enable compatibility analysis with AppDNA on the Additional
Features page of the Site creation wizard. You can also enable/disable it later by selecting Conf iguration > AppDNA in
the Studio navigation pane.
Studio cannot connect to AppDNA 7.8 or 7.9 deployments. As a workaround, upgrade AppDNA to the most recent
version of AppDNA.
Clicking on the View Issue Report link in Studio displays the AppDNA report, however the OS combinations that AppDNA
uses by default are Window 7 64-bit for desktop delivery groups and Windows Server 2012 R2 for server delivery groups.
If your delivery groups contain different versions of Windows, the default image combinations in the reports that Studio
shows will be incorrect. T o work around this issue, manually edit the solution in AppDNA after Studio has created it.
Storage and perf ormance considerations
Separating applications and the OS using two disks, and storing those disks in different areas can affect your storage
strategy. T he following graphic illustrates the MCS and PVS storage architectures. "WC" indicates the write cache, and
"T hin" indicates the thin disk used to store differences between a VM's AppDisk and OS virtual disks.
In MCS environments:
You can continue to balance the size of the AppDisks and OS virtual disks (vDisks) using your organization's existing
sizing guidelines. If AppDisks are shared between multiple Delivery Groups, the overall storage capacity can be reduced.
OS vDisks and AppDisks are located in the same storage areas, so plan your storage capacity requirements carefully
to avoid any negative effect on capacity when you deploy AppDisks. AppDisks incur overhead, so be sure your storage
accommodates that overhead and the applications.
T here is no net effect on IOPS because the OS vDisks and AppDisks are located in the same storage area. T here are
no write cache considerations when using MCS.

In PVS environments:
You must allow for the increased capacity and IOPS as applications move from AppDisk storage to the hypervisor-
attached storage.
With PVS, OS vDisks and AppDisks use different storage areas. T he OS vDisk storage capacity is reduced, but the
hypervisor-attached storage is increased. So, you should size your PVS environments to accommodate those
changes.
AppDisks in the hypervisor-attached storage require more IOPS while the OS vDisks require fewer.
Write cache: PVS uses a dynamic VHDX le on an NT FS formatted drive; when blocks are written to the write cache,
the VHDX le is dynamically extended. When AppDisks are attached to their associated VM, they are merged with
the OS vDisks to provide a unied view of the le system. T his merging typically results in additional data being written
to the write caches, which increases the size of the write cache le. You should account for this in your capacity
planning.
In either MCS or PVS environments, remember to decrease the size of the OS vDisk to take advantage of the AppDisks you
create. If you dont, plan to use more storage.
When many users in a Site turn on their computers simultaneously (for example, at the beginning of the workday), the
multiple startup requests apply pressure on the hypervisor, which can affect performance. For PVS, applications are not
located on the OS vDisk, so fewer requests are made to the PVS server. With the resulting lighter load on each target
device, the PVS server can stream to more targets. However, be aware that the increased target-server density might
negatively affect boot storm performance.
Create an AppDisk
T here are two ways to create an AppDisk, install applications on it, and then seal it. Both methods include steps you
complete from your hypervisor management console and in Studio. T he methods differ in where you complete most the
steps.
Regardless of which method you use:
Allow 30 minutes for AppDisk creation portion.

If you use AppDNA, following the guidance in the Requirements section above. Do not disable an AppDNA connection
while creating an AppDisk.
When you add applications to an AppDisk, be sure to install applications for all users. Re-arm any applications that use
Key Management Server (KMS) activation. For details, see the applications documentation.
Files, folders, and registry entries created in user-specific locations during AppDisk creation are not retained. Also, some
applications run a first-time-use wizard to create user data during installation. Use a profile management solution to
retain this data and prevent the wizard from appearing each time the AppDisk starts.
If you are using AppDNA, analysis starts automatically after the creation process completes. During this interval, the
AppDisk's status in Studio is "Analyzing."
PVS considerations
AppDisks on machines from Machine Catalogs created by Provisioning Services require additional conguration during
AppDisk creation. From the Provisioning Services console:

1. Create a new version of the vDisk associated with the device collection that contains the VM.
2. Place the VM into maintenance mode.
3. During AppDisk creation, select the maintenance version on the boot screen every time the VM restarts.
4. After you seal the AppDisk, place the VM back into production, and delete the vDisk version you created.
Create an AppDisk primarily in Studio
T his procedure includes three tasks: create the AppDisk, create applications on the AppDisk, and then seal the AppDisk.
Create an AppDisk:
1. Select AppDisks in the Studio navigation pane and then select Create AppDisk in the Actions pane.
2. Review the information on the Introduction page of the wizard and then click Next.
3. On the Create AppDisk page, select the Create new AppDisk radio button. Select either a predefined disk size (small,
medium, or large) or specify a disk size in GB; the minimum size is 3 GB. T he disk size should be large enough to hold the
applications you will add. Click Next.
4. On the Preparation Machine page, select a random pooled catalog to be used as the master image on which the
AppDisk will be built. Note: T he display lists all the Machine Catalogs in the Site, separated by type; only those catalogs
that contain at least one available machine can be selected. If you choose a catalog that does not contain random
pooled VMs, the AppDisk creation will fail. After you select a VM from a random pooled catalog, click Next.
5. On the Summary page, type a name and description for the AppDisk. Review the information you specified on previous
wizard pages. Click Finish.
Remember: If you are using PVS, follow the guidance in the PVS considerations section above.
After the wizard closes, the Studio display for the new AppDisk indicates "Creating." After the AppDisk is created, the
display changes to "Ready to install applications."
Install applications on the AppDisk:
From your hypervisor management console, install applications on the AppDisk. (Tip: If you forget the VM name, select
AppDisks in the Studio navigation pane and then select Install Applications in the Actions pane to display its name.) See
the hypervisor documentation for information about installing applications. (Remember: You must install applications on
the AppDisk from your hypervisor management console. Do not use the Install Applications task in the Studio Actions
pane.)
Seal the AppDisk:
1. Select AppDisks in the Studio navigation pane.

2. Select the AppDisk you created, and then select Seal AppDisk in the Actions pane.
After you create the AppDisk, install applications on it, and then seal it, assign it to a Delivery Group.
Canceling AppDisk preparation and sealing

In some cases, an administrator may need to cancel AppDisk creation or sealing:
1. Access the VM.
2. Close the dialog:

3. After closing the dialog, a popup message appears requesting verication to cancel the selected operation; click Yes.
Note
If you cancel AppDisk preparation, rebooting the machine returns it to the initial state, otherwise you need to create a clean VM.
Create an AppDisk on the hypervisor and import it to Studio

In this procedure, you complete the AppDisk creation and preparation tasks from the hypervisor management console and then import AppDisk
into Studio.
Prepare, install applications, and seal an AppDisk on the hypervisor:
1. From the hypervisor management console, create a VM and install a VDA.

2. Power off the machine and take a snapshot of it.
3. Create a new machine from the snapshot and then add a new disk to it. T his disk (which will become the AppDisk) must
be large enough to hold all the applications you will install on it.
4. Start the machine and select Start > Prepare AppDisk. If this Start menu shortcut is not available on the hypervisor,
open a command prompt at C:\Program Files\Citrix\personal vDisk\bin and type: CtxPvD.Exe s LayerCreationBegin.

T he machine restarts and prepares the disk. A second restart occurs after several minutes when the preparation
completes.
5. Install the applications you want to make available to users.
6. Double-click the Package AppDisk shortcut on the machines desktop. T he machine restarts again and the sealing
process starts. When the "in process" dialog closes, power off the VM.
Use Studio to import the AppDisk you created on the hypervisor:
1. Select AppDisks in the Studio navigation pane and then select Create AppDisk in the Actions pane.
2. On the Introduction page, review the information and then click Next.
3. On the Create AppDisk page, select the Import existing AppDisk radio button. Select the resource (network and
storage) where the AppDisk you created resides on the hypervisor. Click Next.
4. On the Preparation Machine page, browse to the machine, select the disk, and then click Next.
5. On the Summary page, type a name and description for the AppDisk. Review the information you specified on previous
wizard pages. Click Finish. Studio imports the AppDisk.
After you import the AppDisk into Studio, assign it to a Delivery Group.
Assign an AppDisk to a Delivery Group

You can assign one or more AppDisks to a Delivery Group when you create the Delivery Group or later. T he AppDisks
information you provide is essentially the same.
If you are adding AppDisks to a Delivery Group that you are creating, use the following guidance for the AppDisks page in
the Create Delivery Group wizard. (For information about other pages in that wizard, see the Create Delivery Groups article.)
To add (or remove) AppDisks in an existing Delivery Group:

2. Select a Delivery Group and then select Manage AppDisks in the Actions pane. See the following guidance for the
AppDisks page.
3. When you change the AppDisk configuration in a Delivery Group, a restart of the machines in the group is required. On
the Rollout Strategy page, follow the guidance in Create a restart schedule.
AppDisks page:
T he AppDisks page (in the Create Delivery Group wizard or in the Manage AppDisks ow) lists the AppDisks already
deployed for the Delivery Group and their priority. (If you are creating the Delivery Group, the list will be empty.) For more
information, see the AppDisk priority section.
1. Click Add. T he Select AppDisks dialog box lists all AppDisks in the left column. AppDisks that are already assigned to this
Delivery Group have enabled checkboxes and cannot be selected.
2. Select one or more checkboxes for available AppDisks in the left column. T he right column lists the applications on the
AppDisk. (Selecting the Applications tab above the right column lists applications in a format similar to a Start menu;
selecting the Installed packages tab lists applications in a format similar to the Programs and Features list.)
3. After selecting one or more available AppDisks, click OK.
4. Click Next on the AppDisks page.
AppDisk priority in a Delivery Group

When a Delivery Group has more than one AppDisk assigned, the AppDisks page (in the Create Delivery Group, Edit Delivery
Group, and Manage AppDisks displays) lists the AppDisks in descending priority. Entries at the top of the list have the higher
priority. Priority indicates the order in which the AppDisks are processed.
You can use the up and down arrows adjacent to the list to change the AppDisk priority. If AppDNA is integrated with your
AppDisk deployment, it automatically analyzes the applications and then sets the priority when the AppDisks are assigned
to the Delivery Group. Later, if you add or remove AppDisks from the group, clicking Auto-Order instructs AppDNA to re-
analyze the current list of AppDisks and then determine the priorities. T he analysis (and priority reordering, if needed) may
take several moments to complete.
Managing AppDisks
After you create and assign AppDisks to Delivery Groups, you can change the AppDisk's properties through the AppDisks
node in the Studio navigation pane. Changes to applications in an AppDisk must be done from the hypervisor management
console.
Important
You can use the Windows Update service to update applications (such as the Ofce suite) on an AppDisk. However, do not use the
Windows Update Service to apply operating system updates to an AppDisk. Apply operating system updates to the master image,
not the AppDisk; otherwise, the AppDisk will not initialize correctly.
When applying patches and other updates to applications in an AppDisk, apply only those that the application requires. Do not
apply updates for other applications.
When installing Windows updates, first deselect all entries and then select the subset required by the applications on the
AppDisks you're updating.
Antivirus considerations for AppDisk creation

In some cases, you may run into problems trying to create an AppDisk due to scenarios where the base VM has an antivirus
(A/V) agent installed. In such cases, AppDisk creation may fail when certain processes are agged by the A/V agent. T hese
processes, CtxPvD.exe and CtxPvDSrv.exe must be added to the exception list for the A/V agent used by the base VM.
T his section provides information about adding exceptions for the following antivirus applications:
Windows Defender (for Windows 10)

OfficeScan (version 11.0)
Symantec (version 12.1.16)
McAfee (version 4.8)
Windows Def ender
If your base VM uses Windows Defender (version 10):
1. Log into your computer with local administrator privileges.

2. Select the Windows Defender icon and right click to display the Open button:
3. In the Windows Defender console, select Settings in the upper right portion of the interface:
4. In the Exclusions portion of the Settings screen, click Add an exclusion:

5. In the Add an exclusion screen, select Exclude a .exe, .com, or .scr process:

6. In the Add exclusion screen, enter the name of the exclusion; both CtxPvD.exe and CtxPvDSvc.exe must be added to
prevent conicts when creating an AppDisk. After entering the exclusion name, click OK:
After adding the exclusions, they appear in the list of excluded processes in the Settings screen:

Of ceScan
If your base VM uses OfceScan (version 11):
1. Launch the OfficeScan console.

2. Click the lock icon in the lower left portion of the interface, and enter your password:

3. Click the Settings icon to display conguration options.
4. In the Settings screen, select the Protection tab.
5. In the Protection tab, scroll down until you locate the Exclusions section.
6. In the Files section, click Add, and enter the following AppDisk processes to the exception list:

command COPY
C:\Program Files\Cit rix\personal vDisk\bin\Ct xPvD.exe
C:\Program Files\Cit rix\personal vDisk\bin\Ct xPvDSvc.exe
7. Click Apply, then OK to add the exclusions.
Symantec
If your base VM uses Symantec (version 12.1.16):
1. Launch the Symantec console.

2. Click Change Settings.
3. In the Exceptions section, click Conf igure Settings:

4. In the Congure Settings screen, click Add.
5. After clicking Add, a context menu appears to allow you to specify the application type. Select Application Exception:

6. In the Exceptions screen, enter the following AppDisk le paths and set the action to Ignore:
command COPY

T he noted exceptions are added to the list. Close the window to apply your changes:
McAf ee
If your base VM uses McAfee (verson 4.8):
1. Right click the McAfee icon, and expand the Quick Settings option.
2. In the expanded menu, select On-Access Scan Properties:

3. In the On-Access Scan Properties screen, click All Processes:
4. Select the Exclusions tab.
5. Click the Exclusions button.
6. In the Set Exclusions screen, click Add:

7. In the Add Exclusion Item screen, select By name/location (can include wildcards * or ?). Click Browse to locate the
exclusion executables:
command COPY
8. Click OK.
9. T he Set Exclusions screen now displays the added exclusions. Click OK to apply the changes:

Note
After conguring these exclusions, create the AppDisk.
How applications appear in the Start menu

If a new AppDisk is created and an app is made available for all users the disk is attached to the desktop and a shortcut
appears for the app in the Start menu. When an AppDisk is created and installed for the current user only and the disk is
attached to the desktop, the shortcut for the app fails to appear in the Start menu.
For example, create a new app and make it available for all users:
1. Install an app on the AppDisk (for example, Beyond Compare is the selected app):

2. Attach the disk to the desktop; the shortcut for the newly installed app (Beyond Compare) appears in the Start menu:
To install an app for the current user only:
1. Install an app on the AppDisk and make it available for the current user:

2. Attach the disk to the desktop; note that the shortcut does not appear in the Start menu:
AppDisk logging updates

T his release provides an enhancement to the AppDisk logging and support paradigm. With this update, AppDisk users can

now obtain diagnostic information and optionally upload it to the Citrix Insight Services (CIS) website.
How does it work?
T his new functionality uses a script-based PowerShell tool which identies all of the log les created by AppDisk/PVD,
collects output from PowerShell commands containing information about the system (and processes), compresses
everything into a single organized le, and nally provides the option to either save the compressed folder locally, or upload
it to CIS (Citrix Insight Services).
Note
CIS gathers anonymous diagnostic information that it uses to improve AppDisk/PVD functionality. Access the Citrix CIS website to
manually upload the diagnostic bundle. You must login with your Citrix credentials to access this site.
Using PowerShell scripts to collect AppDisk/PVD log les

T he AppDisk/PVD installer adds two new scripts for diagnostic data collection:
Upload-AppDDiags.ps1 performs AppDisk diagnostic data collection

Upload-PvDDiags.ps1 performs PvD diagnostic data collection
Note
T hese scripts are added in C:\Program Files\Citrix\personal vDisk\bin\scripts. You must execute these PowerShell scripts as an
administrator.
Upload-AppDDiags.ps1
Use this script to initiate AppDisk diagnostic data collection and optionally manually upload the data to the CIS website.
command COPY

SYNTAX
Upload-AppDDiags [[-Out put File] <st ring>] [-help] [<CommonParamet ers>]
-Out put File
Local pat h for zip le inst ead of uploading t o CIS
EXAMPLES
Upload-AppDDiags
Upload diagnost ic dat a t o Cit rix CIS websit e using credent ials ent ered by int eract ive user.
Upload-AppDDiags -Out put File C:\MyDiags.zip
Save AppDisk diagnost ic dat a t o t he specied zip le. You can access ht t ps://cis.cit rix.com/ t o upload it lat er.
Tip
When there is no OutputFile argument, upload occurs. If OutputFile is specied, the script creates a zip le that the you can
upload manually at a later time.
Upload-PvDDiags.ps1
Use this script to initiate PvD diagnostic data collection and optionally manually upload the data to the CIS website.
command COPY

SYNTAX
Upload-PvDDiags [[-Out put File] <st ring>] [-help] [<CommonParamet ers>]
-Out put File
Local pat h for zip le inst ead of uploading t o CIS
EXAMPLES
Upload-PvDDiags
Upload PvD diagnost ic dat a t o Cit rix CIS websit e using credent ials ent ered by int eract ive user.
Upload-PvDDiags -Out put File C:\MyDiags.zip
Save PvD diagnost ic dat a t o t he specied zip le. You can access ht t ps://cis.cit rix.com/ t o upload it lat er.
Tip
When there is no OutputFile argument, upload occurs. If OutputFile is specied, the script creates a zip le that the you can
upload manually at a later time.

Local App Access and URL redirection
May 22, 20 17
In this article:
Introduction
Requirements, considerations, and limitations
Interaction with Windows
Configure Local App Access and URL redirection
Introduction
Local App Access seamlessly integrates locally installed Windows applications into a hosted desktop environment without
changing from one computer to another. With Local App Access, you can:
Access applications installed locally on a physical laptop, PC, or other device directly from the virtual desktop.
Provide a flexible application delivery solution. If users have local applications that you cannot virtualize or that IT does
not maintain, those applications still behave as though they are installed on a virtual desktop.
Eliminate double-hop latency when applications are hosted separately from the virtual desktop, by putting a shortcut to
the published application on the user's Windows device.
Use applications such as:
Video conferencing software such as GoT oMeeting.
Specialty or niche applications that are not yet virtualized.
Applications and peripherals that would otherwise transfer large amounts of data from a user device to a server and
back to the user device, such as DVD burners and T V tuners.
In XenApp and XenDesktop, hosted desktop sessions use URL redirection to launch Local App Access applications. URL
redirection makes the application available under more than one URL address. It launches a local browser (based on the
browser's URL blacklist) by selecting embedded links within a browser in a desktop session. If you navigate to a URL that is
not present in the blacklist, the URL is opened in the desktop session again.
URL redirection works only for desktop sessions, not application sessions. T he only redirection feature you can use for
application sessions is host-to-client content redirection, which is a type of server FTA (File Type Association) redirection.
T his FTA redirects certain protocols to the client, such as http, https, rtsp, or mms. For example, if you only open embedded
links with http, the links directly open with the client application. T here is no URL blacklist or whitelist support.
When Local App Access is enabled, URLs that are displayed to users as links from locally-running applications, from user-
hosted applications, or as shortcuts on the desktop are redirected in one of the following ways:
From the user's computer to the hosted desktop
From the XenApp or XenDesktop server to the user's computer
Rendered in the environment in which they are launched (not redirected)
To specify the redirection path of content from specic Web sites, congure the URL whitelist and URL blacklist on the
Virtual Delivery Agent. T hose lists contain multi-string registry keys that specify the URL redirection policy settings; for more
information, see the Local App Access policy settings.
URLs can be rendered on the VDA with the following exceptions:

Geo/Locale information Web sites that require locale information, such as msn.com or news.google.com (opens a

country specific page based on the Geo). For example, if the VDA is provisioned from a data center in the UK and the
client is connecting from India, the user expects to see in.msn.com but instead sees uk.msn.com.
Multimedia content Web sites containing rich media content, when rendered on the client device, give the end users a
native experience and also save bandwidth even in high latency networks. Although there is Flash redirection feature, this
complements by redirecting sites with other media types such as Silverlight. T his is in a very secure environment. T hat is,
the URLs that are approved by the administrator are run on the client while the rest of the URLs are redirected to the
VDA.
In addition to URL redirection, you can use FTA redirection. FTA launches local applications when a le is encountered in the
session. If the local app is launched, the local app must have access to the le to open it. T herefore, you can only open les
that reside on network shares or on client drives (using client drive mapping) using local applications. For example, when
opening a PDF le, if a PDF reader is a local app, then the le opens using that PDF reader. Because the local app can
access the le directly, there is no network transfer of the le through ICA to open the le.
Requirements, considerations, and limitations

Local App Access is supported on the valid operating systems for VDAs for Windows Server OS and VDAs for Windows
Desktop OS, and requires Citrix Receiver for Windows version 4.1 (minimum). T he following browsers are supported:
Internet Explorer 11. You can use Internet Explorer 8, 9, or 10, but Microsoft supports (and Citrix recommends using)
version 11.
Firefox 3.5 through 21.0
Chrome 10
Review the following considerations and limitations when using Local App Access and URL redirection.
Local App Access is designed for full-screen, virtual desktops spanning all monitors:
T he user experience can be confusing if Local App Access is used with a virtual desktop that runs in windowed mode
or does not cover all monitors.
For multiple monitors, when one monitor is maximized it becomes the default desktop for all applications launched in
that session, even if subsequent applications typically launch on another monitor.
T he feature supports one VDA; there is no integration with multiple concurrent VDAs.
Some applications can behave unexpectedly, affecting users:
Users might be confused with drive letters, such as local C: rather than virtual desktop C: drive.
Available printers in the virtual desktop are not available to local applications.
Applications that require elevated permissions cannot be launched as client-hosted applications.
T here is no special handling for single-instance applications (such as Windows Media Player).
Local applications appear with the Windows theme of the local machine.
Full-screen applications are not supported. T his includes applications that open to full screen, such as PowerPoint
slide shows or photo viewers that cover the entire desktop.
Local App Access copies the properties of the local application (such as the shortcuts on the client's desktop and
Start menu) on the VDA; however, it does not copy other properties such as shortcut keys and read-only attributes.
Applications that customize how overlapping window order is handled can have unpredictable results. For example,
some windows might be hidden.
Shortcuts are not supported, including My Computer, Recycle Bin, Control Panel, Network Drive shortcuts, and folder
shortcuts.
T he following file types and files are not supported: custom file types, files with no associated programs, zip files, and

hidden files.
T askbar grouping is not supported for mixed 32-bit and 64-bit client-hosted or VDA applications, such as grouping 32-
bit local applications with 64-bit VDA applications.
Applications cannot be launched using COM. For example, if you click an embedded Office document from within an
Office application, the process launch cannot be detected, and the local application integration fails.
URL redirection supports only explicit URLs (that is, those appearing in the browser's address bar or found using the in-
browser navigation, depending on the browser).
URL redirection works only with desktop sessions, not with application sessions.
T he local desktop folder in a VDA session does not allow users to create new files.
Multiple instances of a locally-running application behave according to the taskbar settings established for the virtual
desktop. However, shortcuts to locally-running applications are not grouped with running instances of those
applications. T hey are also not grouped with running instances of hosted applications or pinned shortcuts to hosted
applications. Users can close only windows of locally-running applications from the T askbar. Although users can pin local
application windows to the desktop T askbar and Start menu, the applications might not launch consistently when using
these shortcuts.
Interaction with Windows

T he Local App Access interaction with Windows includes the following behaviors.
Windows 8 and Windows Server 2012 shortcut behavior

Windows Store applications installed on the client are not enumerated as part of Local App Access shortcuts.
Image and video files are usually opened by default using Windows store applications. However, Local App Access
enumerates the Windows store applications and opens shortcuts with desktop applications.
Local Programs
For Windows 7, the folder is available in the Start menu.
For Windows 8, Local Programs is available only when the user chooses All Apps as a category from the Start screen.
Not all subfolders are displayed in Local Programs.
Windows 8 graphics features for applications
Desktop applications are restricted to the desktop area and are covered by the Start screen and Windows 8 style
applications.
Local App Access applications do not behave like desktop applications in multi-monitor mode. In multi-monitor mode,
the Start screen and the desktop display on different monitors.
Windows 8 and Local App Access URL Redirection
Because Windows 8 Internet Explorer has no add-ons enabled, use desktop Internet Explorer to enable URL
redirection.
In Windows Server 2012, Internet Explorer disables add-ons by default. T o implement URL Redirection, disable Internet
Explorer enhanced configuration. T hen reset the Internet Explorer options and restart to ensure that add-ons are
enabled for standard users.
Congure Local App Access and URL redirection

To use Local App Access and URL redirection with Citrix Receiver:
Install Citrix Receiver on the local client machine. You can enable both features during Citrix Receiver installation or you

can enable Local App Access template using the Group Policy editor.
Set the Allow local app access policy setting to Enabled. You can also configure URL whitelist and blacklist policy
settings for URL redirection. For more information, see the Local App Access policy settings.
Enable Local App Access and URL redirection during Citrix Receiver installation
To enable Local App Access and URL redirection for all local applications:
1. Set the Allow local app access policy setting to Enabled. When this setting is enabled, the VDA allows the client to
decide whether administrator-published applications and Local App Access shortcuts are enabled in the session. (When
this setting is disabled, both administrator-published applications and Local App Access shortcuts do not work for the
VDA.) T his policy setting applies to the entire machine, as well as the URL redirection policy.
2. Enable Local App Access and URL redirection when you install Citrix Receiver for all users on a machine. T his action also
registers the browser add-ons required for URL redirection. From the command prompt, run the appropriate command to
install the Receiver with the following option:
CitrixReceiver.exe /ALLOW_CLIENTHOSTEDAPPSURL=1
CitrixReceiverWeb.exe /ALLOW_CLIENTHOSTEDAPPSURL=1
Enable the Local App Access template using the Group Policy editor
1. Run gpedit.msc.
2. Select Computer Conf iguration. Right-click Administrative Templates and select Add/Remote Templates > Add.
3. Add the icaclient.adm template located in the Citrix Receiver Configuration folder (usually in c:\Program Files
(x86)\Citrix\Online Plugin\Configuration). (After the icaclient.adm template is added to Computer Configuration, it is also
available in User Configuration.)
4. Expand Administrative Templates > Classic Administrative Templates (ADM) > Citrix Components > Citrix
Receiver > User Experience.
5. Select Local App Access settings.
6. Select Enabled and then select Allow URL Redirection. For URL redirection, register browser add-ons using the
command line, as described below.
Provide access to only published applications
To provide access to only published applications:
1. On the server where the Delivery Controller is installed, run regedit.exe.

1. Navigate to HKLM\Software\Wow6432Node\Citrix\DesktopStudio.
2. Add the REG_DWORD entry ClientHostedAppsEnabled with a value of 1. (A 0 value disables Local App Access.)
2. Restart the Delivery Controller server and then restart Studio.
3. Publish Local App Access applications.
1. Select Delivery Groups in the Studio navigation pane and then select the Applications tab.
2. Select Create Local Access Application in the Actions pane.
3. Select the desktop Delivery Group.
4. Enter the full executable path of the application on the user's local machine.
5. Indicate if the shortcut to the local application on the virtual desktop will be visible on the Start menu, the desktop, or
both.
6. Accept the default values on the Name page and then review the settings.
4. Enable Local App Access and URL redirection when you install Citrix Receiver for all users on a machine. T his action also

registers the browser add-ons required for URL redirection. From the command prompt, run the command to install Citrix
Receiver with the following option:
CitrixReceiver.exe /ALLOW_CLIENTHOSTEDAPPSURL=1
CitrixReceiverWeb.exe /ALLOW_CLIENTHOSTEDAPPSURL=1
5. Set the Allow local app access policy setting to Enabled. When this setting is enabled, the VDA allows the client to
decide whether administrator-published applications and Local App Access shortcuts are enabled in the session. (When
this setting is disabled, both administrator-published applications and Local App Access shortcuts do not work for the
VDA.)
Register browser add-ons
Note: T he browser add-ons required for URL redirection are registered automatically when you install Citrix Receiver from
the command line with the /ALLOW_CLIENT HOST EDAPPSURL=1 option.
You can use the following commands to register and unregister one or all add-ons:
T o register add-ons on a client device: <client-installation-folder>\redirector.exe /reg<browser>

T o unregister add-ons on a client device: <client-installation-folder>\redirector.exe /unreg<browser>
T o register add-ons on a VDA: <VDAinstallation-folder>\VDARedirector.exe /reg<browser>
T o unregister add-ons on a VDA: <VDAinstallation-folder>\VDARedirector.exe /unreg<browser>
where <browser> is IE, FF, Chrome, or All.
For example, the following command registers Internet Explorer add-ons on a device running Citrix Receiver.
C:\Program Files\Citrix\ICA Client\redirector.exe/regIE
T he following command registers all add-ons on a Windows Server OS VDA.
C:\Program Files (x86)\Citrix\System32\VDARedirector.exe /regAll
URL interception across browsers
By default, Internet Explorer redirects the URL entered. If the URL is not in the blacklist but is redirected to another URL
by the browser or website, the final URL is not redirected, even if it is on the blacklist.
For URL redirection to work correctly, enable the add-on when prompted by the browser. If the add-ons that are
using Internet options or the add-ons in the prompt are disabled, URL redirection does not work correctly.
T he Firefox add-ons always redirect the URLs.
When an add-on is installed, Firefox prompts to allow/prevent installing the add-on on a new tab page. You must
allow the add-on for the feature to work.
T he Chrome add-on always redirects the final URL that is navigated, and not the entered URLs.
T he extensions have been installed externally. If you disable the extension, the URL redirection feature does not work
in Chrome. If the URL redirection is required in Incognito mode, allow the extension to run in that mode in the browser
settings.
Congure local application behavior on logof f and disconnect
1. On the hosted desktop, run regedit.msc.

2. Navigate to HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\Client Hosted Apps\Policies\Session State. For a 64-bit system,
navigate to HKEY_LOCAL_MACHINE\SOFT WARE\wow6432node\Citrix\Client Hosted Apps\Policies\Session State.
3. Add the REG_DWORD entry T erminate with one of the values:
1 - Local applications continue to run when a user logs off or disconnects from the virtual desktop. Upon
reconnection, local applications are reintegrated if they are available in the virtual desktop.
3 - Local applications close when a user logs off or disconnects from the virtual desktop.

XenApp Secure Browser
May 22, 20 17
As applications are ported to the web, users must rely on multiple browser vendors and versions in order to achieve
compatibility with web-based apps. If the application is an internally hosted application, organizations are often required
to install and congure complex VPN solutions in order to provide access to remote users. Typical VPN solutions require a
client-side agent that must also be maintained across numerous operating systems.
With the XenApp Secure Browser, users can have a seamless web-based application experience where a hosted web-based
application simply appears within the users preferred local browser. For example, a users preferred browser is Mozilla
Firefox but the application is only compatible with Microsoft Internet Explorer. XenApp Secure Browser will display the
Internet Explorer compatible application as a tab within the Firefox browser.
Deploying XenApp Secure Browser Edition

Citrix recommends that you leverage the Citrix Smart Tools blueprint for the XenApp Secure Browser to simplify the
deployment.
T he XenApp Secure Browser blueprint includes scripts to automate the following tasks:
Install XenApp, including the Citrix License Server and StoreFront

Create a XenApp delivery site
Join the provisioned machines to your existing domain
Using the Citrix Smart Tools blueprint
To use the Citrix Smart Tools blueprint:
1. From the Citrix Cloud home page, navigate to Services; click Request T rial for Citrix Smart T ools. Once you request the
trial, youll receive an email notifying you when the trial service is available. T his generally takes 5-10 minutes.
2. Click Manage in the email you received when you requested the trail to display the Citrix Smart T ools home page.
3. Download the Citrix XenApp Secure Browser Edition ISO from the Citrix download site.
Consider the following after downloading the Secure Browser Edition ISO:
Start using the XenApp Secure Browser blueprint by following the instructions specified in XenApp Secure Installation
with a Citrix Smart T ools blueprint.
After completing the installation, further optimize your environment for webapp delivery by using the configuration
steps specified in the XenApp Secure Browser Deployment Guide.
Manually installing XenApp Secure Browser
To manually install XenApp Secure Browser version:
1. Download the Citrix XenApp Secure Browser Edition ISO from the Citrix download site.
2. Follow the install instructions for various components of XenApp.
3. Configure the edition and license mode for the Secure Browser edition after installation, by perfoming the following
additional steps:

a. On the Delivery Controller, start a PowerShell session by clicking the blue icon on the taskbar, or by browsing
to Start > All Programs > Accessories >Windows PowerShell > Windows PowerShell.
Note: On 64-bit systems, this starts the 64-bit version. Both the 32-bit or 64-bit versions are supported.
b. Type Asnp Citrix* and press Enter to load the Citrix-specic PowerShell modules.
Note: "Asnp" represents Add-PSSnapin.
c. Check the current site settings and license mode, by running the Get-CongSite cmdlet.
d. Set the license mode to XenApp Secure Browser edition by running the Set-CongSite -ProductCode XDT -
ProductEdition BAS.
e. Conrm that the XenApp Secure Browser edition and license mode is set properly by running the Get-
BrokerSite cmdlet.
Note
After completing the installation, further optimize your environment for webapp delivery by using the conguration steps specied
in the XenApp Secure Browser Deployment Guide.

Publish content
May 22, 20 17
You can publish an application that is simply a URL or UNC path to a resource, such as a Microsoft Word document or a web
link. T his feature is known as published content. T he ability to publish content adds exibility to how you deliver content to
users. You benet from the existing access control and management of applications. And, you can specify what to use to
open the content: local or published applications.
T he published content appears just like other applications in StoreFront and Citrix Receiver. Users access it in the same way
they access applications. On the client, the resource opens as usual.
If a locally installed application is appropriate, it is launched to open the resource.

If a File T ype Association has been defined, a published application launches to open the resource.
You publish content using the PowerShell SDK. (You cannot use Studio to publish content. However, you can use Studio to
edit application properties later, after they are published.)
Conguration overview and preparation

Publishing content uses the New-BrokerApplication cmdlet with the following key properties. (See the cmdlet help for
descriptions of all cmdlet properties.)
New-BrokerApplication ApplicationType PublishedContent

-CommandLineExecutable < location> -Name < app-name>
-DesktopGroup < delivery-group-name>
T he ApplicationType property must be PublishedContent.
T he CommandLineExecutable property species the location of the published content. T he following formats are
supported, with a limit of 255 characters.
HT ML website address (for example, http://www.citrix.com)

Document file on a web server (for example, https://www.citrix.com/press/pressrelease.doc)
Directory on an FT P server (for example, ftp://ftp.citrix.com/code)
Document file on an FT P server (for example, ftp://ftp.citrix.com/code/Readme.txt)
UNC directory path (for example, file://myServer/myShare or \\myServer\myShare)
UNC file path (for example, file://myServer/myShare/myFile.asf or \\myServer\myShare\myFile.asf)
Ensure that you have the correct SDK.
For XenApp and XenDesktop Service deployments, download and install the XenApp and XenDesktop Remote
PowerShell SDK.
For on-premises XenApp and XenDesktop deployments, use the PowerShell SDK that is installed with the Delivery
Controller. Adding a published content application requires a minimum version 7.11 Delivery Controller.
T he following procedures use examples. In the examples:
A machine catalog has been created.

A Delivery Group named PublishedContentApps has been created. T he group uses a Server OS machine from the catalog.
T he WordPad application has been added to the group.
Assignments are made for the Delivery Group name, the CommandLineExecutable location, and the application name.
Get started
On the machine containing the PowerShell SDK, open PowerShell.
T he following cmdlet adds the appropriate PowerShell SDK snap-in, and assigns the returned Delivery Group record.
Add-PsSnapin Citrix*
$dg = Get-BrokerDesktopGroup Name PublishedContentApps
If you are using the XenApp and XenDesktop Service, authenticate by entering your Citrix Cloud credentials. If there is more
than one customer, choose one.
Publish a URL
After assigning the location and application name, the following cmdlet publishes the Citrix home page as an application.
$citrixUrl = "https://www.citrix.com/"
$appName = "Citrix Home Page"

CommandLineExecutable $citrixURL Name $appName
DesktopGroup $dg.Uid
Verify success:
Open StoreFront and log on as a user who can access applications in the PublishedContentApps Delivery Group. T he
display includes the newly created application with the default icon. T o learn about customizing the icon, see
https://www.citrix.com/blogs/2013/08/21/xd-tipster-changing-delivery-group-icons-revisited-xd7/.
Click the Citrix Home Page application. T he URL launches in a new tab in a locally running instance of your default
browser.

Publish resources located at UNC paths
In this example, the administrator has already created a share named PublishedResources. After assigning the locations and
application names, the following cmdlets publish an RT F and a DOCX le in that share as a resource.
$rtfUNC = "\\GMSXJ-EDGE0.xd.local\PublishedResources\PublishedRT F.rtf "

$rtfAppName = "PublishedRT F"

CommandLineExecutable $rtfUNC -Name $rtfAppName
-DesktopGroup $dg.Uid
$docxUNC = "\\GMSXJ-EDGE0.xd.local\PublishedResources\PublishedDOCX.docx"
$docxAppName = "PublishedDOCX"

CommandLineExecutable $docxUNC -Name $docxAppName
-DesktopGroup $dg.Uid
Verify success:
Refresh your StoreFront window to see the newly published documents.

Click the PublishedRT F and PublishedDOCX applications. Each document opens in a locally running WordPad.
View and edit PublishedContent applications

You manage published content using the same methods that you use for other application types. T he published content
items appear in the Applications list in Studio and can be edited in Studio.
Application properties (such as user visibility, group association, and shortcut) apply to the published content. However, you
cannot change the command-line argument or working directory properties on the Location page. To change the resource,
modify the "Path to the executable le" eld on that page.
To use a published application to open a PublishedContent application (rather than a local application), edit the published
application's File Type Association property. In this example, the published WordPad application was edited to create a File
Type Association for .rtf les.
Important: Turn on maintenance mode for the Delivery Group before editing the File Type Association. Remember to turn
off maintenance mode when you're done.

Refresh StoreFront to load the File Type Association changes, and then click the PublishedRT F and PublishedDOCX
applications. Notice the difference. PublishedDOCX still opens in the local WordPad. However, PublishedRT F now opens in
the published WordPad due to the le type association.

For more information
Change application properties

Server VDI
May 30 , 20 17
Use the Server VDI (Virtual Desktop Infrastructure) feature to deliver a desktop from a server operating system for a single
user.
Enterprise administrators can deliver server operating systems as VDI desktops, which can be valuable for users such as
engineers and designers.
Service Providers can offer desktops from the cloud; those desktops comply with the Microsoft Services Provider License
Agreement (SPLA).
You can use the Enhanced Desktop Experience Citrix policy setting to make the server operating system look like a
Windows 7 operating system.
T he following features cannot be used with Server VDI:
Personal vDisks
Hosted applications
Local App Access
Direct (non-brokered) desktop connections
Remote PC Access
For Server VDI to work with T WAIN devices such as scanners, the Windows Server Desktop Experience feature must be
installed. In Windows Server 2012, this is an optional feature which you install from Administrative Tools > Server Manager >
Features > Add features > Desktop Experience.
Server VDI is supported on the same server operating systems as the VDA for Windows Server OS.
To install server VDI:
Step 1. Prepare the Windows server for installation.
Use Windows Server Manager to ensure that the Remote Desktop Services role services are not installed. If they were
previously installed, remove them. (T he VDA installation fails if these role services are installed.)
Ensure that the Restrict each user to a single session property is enabled.
On Windows Server 2008 R2, access this property through Administrative Tools > Remote Desktop Services > Remote
Desktop Session Host Conguration. In the Edit settings > General section, the Restrict each user to a single
session setting should indicate Yes.
On Windows Server 2012R2 or Windows Server 2016, edit the registry to set the Terminal Server setting. In registry key
HKEY_LOCAL_MACHINE\SYST EM\CurrentControlSet\Control\TerminalServer to set
DWORD fSingleSessionPerUser to 1.
Step 2. For Windows Server 2008 R2, install Microsoft .NET Framework 3.5 SP1 on the server before installing the VDA.
Step 3. Use the command line interface of the full-product installer to install a VDA on a supported server or server master
image, specifying the /quiet and /servervdi options. (By default, the installer blocks the Windows Desktop OS VDA on a
server operating system; using the command line overrides this behavior.)

XenDesktopVdaSetup.exe /quiet /servervdi
You can specify the Delivery Controller or Controllers while installing the VDA using the command line, using
the /controllers option.
Use the /enable_hdx_ports option to open ports in the rewall, unless the rewall is to be congured manually.
Add the /masterimage option if you are installing the VDA on an image, and will use MCS to create server VMs from that
image.
Do not include options for features that are not supported with Server VDI, such as /baseimage.
Step 4 . Create a Machine Catalog for Server VDI.
On the Operating System page, select Desktop OS.
On the Summary page, specify a machine catalog name and description for administrators that clearly identies it as Server
VDI; this will be the only indicator in Studio that the catalog supports Server VDI.
When using Search in Studio, the Server VDI catalog you created is displayed on the Desktop OS Machines tab, even
though the VDA was installed on a server.
Step 5. Create a Delivery Group and assign the Server VDI catalog you created in the previous step.
If you did not specify the Delivery Controllers while installing the VDA, specify them afterward using the Citrix policy setting,
Active Directory, or by editing the VDA machine's registry values.

Personal vDisk
May 22, 20 17
T he personal vDisk feature retains the single image management of pooled and streamed desktops while allowing users to
install applications and change their desktop settings. Unlike traditional Virtual Desktop Infrastructure (VDI) deployments
involving pooled desktops, where users lose their customization and personal applications when the administrator changes
the master image, deployments using personal vDisks retain those changes. T his means administrators can easily and
centrally manage their master images while providing users with a customized and personalized desktop experience.
Personal vDisks provide this separation by redirecting all changes made on the user's VM to a separate disk (the personal
vDisk), which is attached to the user's VM. T he content of the personal vDisk is blended at runtime with the content from
the master image to provide a unied experience. In this way, users can still access applications provisioned by their
administrator in the master image.
Personal vDisks have two parts, which use different drive letters and are by default equally sized:
User profile - T his contains user data, documents, and the user profile. By default this uses drive P: but you can choose a
different drive letter when you create a catalog with machines using personal vDisks. T he drive used also depends on the
EnableUserProfileRedirection setting.
Virtual Hard Disk (.vhd) file - T his contains all other items, for example applications installed in C:\Program Files. T his part is
not displayed in Windows Explorer and, since Version 5.6.7, does not require a drive letter.
Personal vDisks support the provisioning of department-level applications, as well as applications downloaded and installed
by users, including those that require drivers (except phase 1 drivers), databases, and machine management software. If a
user's change conicts with an administrator's change, the personal vDisk provides a simple and automatic way to reconcile
the changes.
In addition, locally administered applications (such as those provisioned and managed by local IT departments) can also be
provisioned into the user's environment. T he user experiences no difference in usability; personal vDisks ensure all changes
made and all applications installed are stored on the vDisk. Where an application on a personal vDisk exactly matches one
on a master image, the copy on the personal vDisk is discarded to save space without the user losing access to the
application.
Physically, you store personal vDisks on the hypervisor but they do not have to be in the same location as other disks
attached to the virtual desktop. T his can lower the cost of personal vDisk storage.
During Site creation, when you create a connection, you dene storage locations for disks that are used by VMs. You can
separate the Personal vDisks from the disks used by the operating system. Each VM must have access to a storage location
for both disks. If you use local storage for both, they must be accessible from the same hypervisor. To ensure this
requirement is met, Studio offers only compatible storage locations. Later, you can also add personal vDisks and storage for
them to existing hosts (but not machine catalogs) from Conguration > Hosting in Studio.
Back up personal vDisks regularly using any preferred method. T he vDisks are standard volumes in a hypervisor's storage tier,
so you can back them up, just like any other volume.
What's new in personal vDisk 7.6.1
T he following improvements are included in this release:
T his version of personal vDisk contains performance improvements that reduce the amount of time it takes to apply an

image update to a personal vDisk catalog.
T he following known issues are xed in this release:
Attempting an in-place upgrade of a base virtual machine from Microsoft Office 2010 to Microsoft Office 2013 resulted
in the user seeing a reconfiguration window followed by an error message; "Error 25004. T he product key you entered
cannot be used on this machine." In the past, it was recommended that Office 2010 be uninstalled in the base virtual
machine before installing Office 2013. Now, it is no longer necessary to uninstall Office 2010 when performing an in-
place upgrade to the base virtual machine (#391225).
During the image update process, if a higher version of Microsoft .NET exists on the user's personal vDisk, it was
overwritten by a lower version from the base image. T his caused issues for users running certain applications installed on
personal vDisk which required the higher version, such as Visual Studio (#439009).
A Provisioning Services imaged disk with personal vDisk installed and enabled, cannot be used to create a non-personal
vdisk machine catalog. T his restriction has been removed (#485189).
About Personal vDisk 7.6
New in version 7.6:

Improved personal vDisk error handling and reporting. In Studio, when you display PvD-enabled machines in a catalog, a
"PvD" tab provides monitoring status during image updates, plus estimated completion time and progress. Enhanced
state displays are also provided.
A personal vDisk Image Update Monitoring T ool for earlier releases is available from the ISO media
(ISO\Support\T ools\Scripts\PvdT ool). Monitoring capabilities are supported for previous releases, however the reporting
capabilities will not be as robust compared to the current release.
Provisioning Services test mode allows you to boot machines with an updated image in a test catalog. After you verify
its stability, you can promote the test version of the personal vDisk to production.
A new feature enables you to calculate the delta between two inventories during an inventory, instead of calculating it
for each PvD desktop. New commands are provided to export and import a previous inventory for MCS catalogs.
(Provisioning Services master vDisks already have the previous inventory.)
Known issues from 7.1.3 fixed in version 7.6:

Interrupting a personal vDisk installation upgrade can result in corrupting an existing personal vDisk installation.
[#424878]
A virtual desktop may become unresponsive if the personal vDisk runs for an extended period of time and a non-page
memory leak occurs. [#473170]
New known issues in version 7.6:

T he presence of antivirus products can affect how long it takes to run the inventory or perform an update. Performance
can improve if you add CtxPvD.exe and CtxPvDSvc.exe to the PROCESS exclusion list of your antivirus product. T hese
files are located in C:\Program Files\Citrix\personal vDisk\bin. [#326735]
Hard links between files inherited from the master image are not preserved in personal vDisk catalogs. [#368678]
After upgrading from Office 2010 to 2013 on the Personal vDisk master image, Office might fail to launch on virtual
machines because the Office KMS licensing product key was removed during the upgrade. As a workaround, uninstall
Office 2010 and reinstall Office 2013 on the master image. [#391225]
Personal vDisk catalogs do not support VMware Paravirtual SCSI (PVSCSI) controllers. T o prevent this issue, use the
default controller. [#394039]
For virtual desktops that were created with Personal vDisk version 5.6.0 and are upgraded to 7, users who logged on to
the master virtual machine (VM) previously might not find all their files in their pooled VM. T his issue occurs because a
new user profile is created when they log on to their pooled VM. T here is no workaround for this issue. [#392459]

Personal vDisks running Windows 7 cannot use the Backup and Restore feature when the Windows system protection
feature is enabled. If system protection is disabled, the user profile is backed up, but the userdata.v2.vhd file is not. Citrix
recommends disabling system protection and using Backup and Restore to back up the user profile. [#360582]
When you create a VHD file on the base VM using the Disk Management tool, you might be unable to mount the VHD.
As a workaround, copy the VHD to the PvD volume. [#355576]
Office 2010 shortcuts remain on virtual desktops after this software is removed. T o work around this issue, delete the
shortcuts. [#402889]
When using Microsoft Hyper-V, you cannot create a catalog of machines with personal vDisks when the machines are
stored locally and the vDisks are stored on Cluster Shared Volumes (CSVs); catalog creation fails with an error. T o work
around this issue, use an alternative storage setup for the vDisks. [#423969]
When you log on for the first time to a virtual desktop that is created from a Provisioning Services catalog, the desktop
prompts for a restart if the personal vDisk has been reset (using the command ctxpvd.exe -s reset). T o work around this
issue, restart the desktop as prompted. T his is a once-only reset that is not required when you log on again. [#340186]
If you install .NET 4.5 on a personal vDisk and a later image update installs or modifies .NET 4.0, applications that are
dependent on .NET 4.5 fail. T o work around this issue, distribute .NET 4.5 from the base image as an image update.
See also the
Known Issues
documentation for the XenApp and XenDesktop 7.6 release.
About Personal vDisk 7.1.3
Known issues from 7.1.1 fixed in version 7.1.3:

Direct upgrades from personal vDisk 5.6.0 to personal vDisk 7.x may cause the personal vDisk to fail. [#432992]
Users might only be able to connect intermittently to virtual desktops with personal vDisks. [#437203]
If a personal vDisk image update operation is interrupted while personal vDisk 5.6.5 or later is upgraded to personal vDisk
7.0 or later, subsequent update operations can fail. [#436145]
Known issues from 7.1 fixed in version 7.1.1:

Upgrading to Symantec Endpoint Protection 12.1.3 through an image update causes symhelp.exe to report corrupt
antivirus definitions. [#423429]
Personal vDisk can cause pooled desktops to restart if Service Control Manager (services.exe) crashes. [#0365351]
New known issues in version 7.1.1: none
About Personal vDisk 7.1
New in version 7.1:

You can now use Personal vDisk with desktops running Windows 8.1, and event logging has been improved.
Copy-on-Write (CoW) is no longer supported. When upgrading from Version 7.0 to 7.1 of Personal vDisk, all changes to
data managed by CoW are lost. T his was a feature for evaluation in XenDesktop 7 and was disabled by default, so if you
did not enable it, you are not affected.
Known issues from 7.0.1 fixed in version 7.1:

If the value of the Personal vDisk registry key EnableProfileRedirection is set to 1 or ON, and later, while updating the
image, you change it to 0 or OFF, the entire Personal vDisk space might get allocated to user-installed applications,
leaving no space for user profiles, which remain on the vDisk. If this profile redirection is disabled for a catalog and you
enable it during an image update, users might not be able to log on to their virtual desktop. [#381921]
T he Desktop Service does not log the correct error in the Event Viewer when a Personal vDisk inventory update fails.

[#383331]
When upgrading to Personal vDisk 7.x, modified rules are not preserved. T his issue has been fixed for upgrades from
Version 7.0 to Version 7.1. When upgrading from Version 5.6.5 to Version 7.1, you must first save the rule file and then
apply the rules again after the upgrade. [#388664]
Personal vDisks running Windows 8 cannot install applications from the Windows Store. An error message stating, "Your
purchase couldn't be completed," appears. Enabling the Windows Update Service does not resolve this issue, which has
now been fixed. However, user-installed applications must be reinstalled after the system restarts. [#361513]
Some symbolic links are missing in Windows 7 pooled desktops with personal vDisks. As a result, applications that store
icons in C:\Users\All Users do not display these icons in the Start menu. [#418710]
A personal vDisk does not start if an Update Sequence Number (USN) journal overflow occurs due to a large number of
changes made to the system after an inventory update. [#369846]
A personal vDisk does not start with status code 0x20 and error code 0x20000028. [#393627]
Symantec Endpoint Protection 12.1.3 displays the message "Proactive T hreat Protection is malfunctioning" and this
component's Live Update Status is not available. [#390204]
New known issues in version 7.1: See the

Known Issues
documentation for the XenDesktop 7.1 release.
New in version 7.0.1: Personal vDisk is now more robust to environment changes. Virtual desktops with personal vDisks now
register with the Delivery Controller even if image updates fail, and unsafe system shutdowns no longer put the vDisks into
a permanently disabled state. In addition, using rules les you can now exclude les and folders from the vDisks during a
deployment.
Known issues from 5.6.13 fixed in version 7.0.1:

Changes to a group's membership made by users on a pooled virtual desktop might be lost after an image update.
[#286227]
Image updates might fail with a low disk space error even if the personal vDisk has enough space. [#325125]
Some applications fail to install on virtual desktops with a personal vDisk, and a message is displayed that a restart is
required. T his is due to a pending rename operation. [#351520]
Symbolic links created inside the master image do not work on virtual desktops with personal vDisks. [#352585]
In environments that use Citrix Profile management and personal vDisk, applications that examine user profiles on a
system volume might not function properly if profile redirection is enabled. [#353661]
T he inventory update process fails on master images when the inventory is bigger than 2GB. [#359768]
Image updates fail with error code 112 and personal vDisks are corrupted even if the vDisks have enough free space for
the update. [#363003]
T he resizing script fails for catalogs with more than 250 desktops. [#363365]
Changes made by users to an environment variable are lost when an image update is performed. [#372295]
Local users created on a virtual desktop with a personal vDisk are lost when an image update is performed. [#377964]
A personal vDisk may fail to start if an Update Sequence Number (USN) journal overflow occurred due to a large number
of changes made to the system after an inventory update. T o avoid this, increase the USN journal size to a minimum of
32 MB in the master image and perform an image update. [#369846]
An issue has been identified with Personal vDisk that prevents the correct functioning of AppSense Environment
Manager registry hiving actions when AppSense is used in Replace Mode. Citrix and AppSense are working together to
resolve the issue, which is related to the behavior of the RegRestoreKey API when Personal vDisk is installed.[#0353936]

Release-independent known issues
When an application installed on a personal vDisk (PvD) is related to another application of the same version that is
installed on the master image, the application on the PvD could stop working after an image update. T his occurs if you
uninstall the application from the master image or upgrade it to a later version, because that action removes the files
needed by the application on the PvD from the master image. T o prevent this, keep the application containing the files
needed by the application on the PvD on the master image.
For example, the master image contains Ofce 2007, and a user installs Visio 2007 on the PvD; the Ofce applications
and Visio work correctly. Later, the administrator replaces Ofce 2007 with Ofce 2010 on the master image, and then
updates all affected machines with the updated image. Visio 2007 no longer works. To avoid this, keep Ofce 2007 in
the master image. [#320915]
When deploying McAfee Virus Scan Enterprise (VSE), use version 8.8 Patch 4 or later on a master image if you use
personal vDisk. [#303472]
If a shortcut created to a file in the master image stops working (because the shortcut target is renamed within PvD),
recreate the shortcut. [#367602]
Do not use absolute/hard links in a master image. [#368678]
T he Windows 7 backup and restore feature is not supported on the personal vDisk. [#360582]
After an updated master image is applied, the local user and group console becomes inaccessible or shows inconsistent
data. T o resolve the issue, reset the user accounts on the VM, which requires resetting the security hive. T his issue was
fixed in the 7.1.2 release (and works for VMs created in later releases), but the fix does not work for VMs that were
created with an earlier version and then upgraded. [#488044]
When using a pooled VM in an ESX hypervisor environment, users see a restart prompt if the selected SCSI controller
type is VMware Paravirtual. For a workaround, use an LSI SCSI controller type. [#394039]
After a PvD reset on a desktop created through Provisioning Services, users may receive a restart prompt after logging
on to the VM. As a workaround, restart the desktop. [#340186]
Windows 8.1 desktop users might be unable to log on to their PvD. An administrator might see message "PvD was
disabled due to unsafe shutdown" and the PvDActivation log might contain the message "Failed to load reg hive
[\Device\IvmVhdDisk00000001\CitrixPvD\Settings\RingCube.dat]." T his occurs when a users VM shuts down unsafely. As
a workaround, reset the personal vDisk. [#474071]

Install and upgrade
May 22, 20 17
Personal vDisk 7.x is supported on XenDesktop version 5.6 through the current version. T he "System requirements"
documentation for each XenDesktop version lists the supported operating systems for Virtual Delivery Agents (VDAs), and
the supported versions of hosts (virtualization resources), and Provisioning Services. For details about Provisioning Services
tasks, see the current Provisioning Services documentation.
Install and enable PvD
You can install and then enable PvD components when you install or upgrade a VDA for Desktop OS on a machine. T hese
actions are selected on the Additional Components and Features pages of the installation wizard, respectively. For more
information, see Install VDAs.
If you update the PvD software after installing the VDA, use the PvD MSI provided on the XenApp or XenDesktop
installation media.
Enabling PvD:
If you are using Machine Creation Services (MCS), PvD is enabled automatically when you create a machine catalog of
desktop OS machines that will use a personal vDisk.
If you are using Provisioning Services (PVS), PvD is enabled automatically when you run the inventory during the master
(base) image creation process, or when auto-update runs the inventory for you.
T herefore, if you install the PvD components but do not enable them during VDA installation, you can use the same image
to create both PvD desktops and non-PvD desktops, because PvD is enabled during the catalog creation process.
Add personal vDisks
You add personal vDisks to hosts when you congure a Site. You can choose to use the same storage on the host for VMs
and personal vDisks, or you can use different storage for personal vDisks.
Later, you can also add personal vDisks and their storage to existing hosts (connections), but not machine catalogs.
1. Select Configuration > Hosting in the Studio navigation pane.
2. Select Add Personal vDisk storage in the Actions pane, and specify the storage location.
Upgrade PvD
T he easiest way to upgrade personal vDisk from an earlier 7.x version is to simply upgrade your desktop OS VDAs to the
version provided with the most recent XenDesktop version. T hen, run the PvD inventory.
Uninstall PvD
You can use one of two ways to remove the PvD software:
Uninstall the VDA; this removes the PvD software as well.
If you updated PvD using the PvD MSI, then you can uninstall it from the Programs list.
If you uninstall PvD and then want to reinstall the same or a newer version, rst back up the registry key
HKLM\Software\Citrix\personal vDisk\cong, which contains environment conguration settings that might have changed.
T hen, after installing PvD, reset the registry values that might have changed, by comparing them with the backed-up
version.

Congure and manage
May 22, 20 17
T his topic covers items you should consider when conguring and managing a personal vDisk (PvD) environment. It also
covers best practice guidelines and task descriptions.
For procedures that include working in the Windows registry:

Considerations: personal vDisk size
T he following factors affect the size of the main personal vDisk volume:
Size of the applications that users will install on their PvDs
At restarts, PvD determines the free space remaining in the application area (UserData.v2.vhd). If this falls below 10%, the
application area is expanded into any unused prole area space (by default, the space available on the P: drive). T he
space added to the application area is approximately 50% of the combined free space remaining in both the application
area and the prole area.
For example, if the application area on a 10 GB PvD (which by default is 5 GB) reaches 4.7 GB and the prole area has 3
GB free, the increased space that is added to the application area is calculated as follows:
increased space = (5.0-4.7)/2 + 3.0/2 = 1.65 GB
T he space added to the application area is only approximate because a small allowance is made for storing logs and for
overhead. T he calculation and the possible resizing is performed on each restart.
Size of users' prof iles (if a separate prof ile management solution is not used)
In addition to the space required for applications, ensure there is sufcient space available on personal vDisks to store
users' proles. Include any non-redirected special folders (such as My Documents and My Music) when calculating space
requirements. Existing prole sizes are available from the Control Panel (sysdm.cpl).
Some prole redirection solutions store stub les (sentinel les) instead of real prole data. T hese prole solutions might
appear to store no data initially but actually consume one le directory entry in the le system per stub le; generally,
approximately 4 KB per le. If you use such a solution, estimate the size based on the real prole data, not the stub les.
Enterprise le sharing applications (such as ShareFile and Dropbox) might synchronize or download data to users' prole
areas on the personal vDisks. If you use such applications, include enough space in your sizing estimates for this data.
Overhead consumed by the template VHD containing the PvD inventory

T he template VHD contains the PvD inventory data (sentinel les corresponding to the master image content). T he PvD
application area is created from this VHD. Because each sentinel le or folder comprises a le directory entry in the le
system, the template VHD content consumes PvD application space even before any applications are installed by the
end user. You can determine the template VHD size by browsing the master image after an inventory is taken.
Alternatively, use the following equation for an approximately calculation:
template VHD size = (number of les on base image) x 4 KB
Determine the number of les and folders by right-clicking the C: drive on the base VM image and selecting Properties.

For example, an image with 250,000 les results in a template VHD of approximately 1,024,000,000 bytes (just under 1
GB). T his space will be unavailable for application installations in the PvD application area.
Overhead f or PvD image update operations

During PvD image update operations, enough space must be available at the root of the PvD (by default, P:) to merge
the changes from the two image versions and the changes the user has made to their PvD. Typically, PVD reserves a few
hundred megabytes for this purpose, but extra data that was written to the P: drive might consume this reserved space,
leaving insufcient space for the image update to complete successfully. T he PvD pool statistics script (located on the
XenDesktop installation media in the Support/Tools/Scripts folder) or the PvD Image Update Monitoring Tool (in the
Support/Tools/Scripts\PvdTool folder) can help identify any PvD disks in a catalog that are undergoing an update and
that are nearly full.
T he presence of antivirus products can affect how long it takes to run the inventory or perform an update. Performance
can improve if you add CtxPvD.exe and CtxPvDSvc.exe to the exclusion list of your antivirus product. T hese les are
located in C:\Program Files\Citrix\personal vDisk\bin. Excluding these executables from scanning by the antivirus
software can improve inventory and image update performance by up to a factor of ten.
Overhead f or unexpected growth (unexpected application installations, and so on)

Consider allowing extra (either a xed amount or a percentage of the vDisk size) to the total size to accommodate
unexpected application installations that the user performs during deployment.
How-to: Congure the personal vDisk size and allocation
You can manually adjust the automatic resizing algorithm that determines the size of the VHD relative to the P: drive, by
setting the initial size of the VHD. T his can be useful if, for example, you know users will install a number of applications
that are too big to t on the VHD even after it is resized by the algorithm. In this case, you can increase the initial size of
the application space to accommodate the user-installed applications.
Preferably, adjust the initial size of the VHD on a master image. Alternatively, you can adjust the size of the VHD on a
virtual desktop when a user does not have sufcient space to install an application. However, you must repeat that
operation on each affected virtual desktop; you cannot adjust the VHD initial size in a catalog that is already created.
Ensure the VHD is big enough to store antivirus denition les, which are typically large.
Locate and set the following registry keys in HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\personal vDisk\Config. (Do not
modify other settings in this registry key.) All settings must be specified on the master image (except for
MinimumVHDSizeInMB, which can be changed on an individual machine); settings specified on the master image are applied
during the next image update.
MinimumVHDSizeMB
Species the minimum size (in megabytes) of the application part (C:) of the personal vDisk. T he new size must be greater
than the existing size but less than the size of the disk minus PvDReservedSpaceMB.
Increasing this value allocates free space from the prole part on the vDisk to C:. T his setting is ignored if a lower value
than the current size of the C: drive is used, or if EnableDynamicResizeOfAppContainer is set to 0.
Default = 2048
EnableDynamicResizeOf AppContainer
Enables or disables the dynamic resizing algorithm.
When set to 1, the application space (on C:) is resized automatically when the free space on C: falls below 10%.
Allowed values are 1 and 0. A restart is required to effect the resize.

When set to 0, the VHD size is determined according to the method used in XenDesktop versions earlier than 7.x
Default = 1
EnableUserProf ileRedirection
Enables or disables redirecting the user's profile to the vDisk.
When set to 1, PvD redirects users' profiles to the personal vDisk drive (P: by default). Profiles are generally redirected
to P:\Users, corresponding to a standard Windows profile. T his redirection preserves the profiles in case the PvD
desktop must be reset.
When set to 0, all of the space on the vDisk minus PvDReservedSpaceMB is allocated to C:, the application part of
the vDisk, and the vDisk drive (P:) is hidden in Windows Explorer. Citrix recommends disabling redirection by setting the
value to 0, when using Citrix Profile management or another roaming profile solution.
T his setting retains the proles in C:\Users instead of redirecting them to the vDisk, and lets the roaming prole
solution handle the proles.
T his value ensures that all of the space on P: is allocated to applications.
It is assumed that if this value is set to 0, a prole management solution is in place. Disabling prole redirection
without a roaming prole solution in place is not recommended because subsequent PvD reset operations result in
the proles being deleted.
Do not change this setting when the image is updated because it does not change the location of existing proles, but
it will allocate all the space on the Personal vDisk to C: and hide the PvD.
Congure this value before deploying a catalog. You cannot change it after the catalog is deployed.
Important: Beginning with XenDesktop 7.1, changes to this value are not honored when you perform an image update.
Set the key's value when you first create the catalogs from which the profiles will originate. You cannot modify the
redirection behavior later.
Default = 1
PercentOf PvDForApps
Sets the split between the application part (C:) and the prole part of the vDisk. T his value is used when creating new
VMs, and during image updates when EnableDynamicResizeOfAppContainer is set to 0.
Changing PercentOfPvDForApps makes a difference only when EnableDynamicResizeOfAppContainer is set to 0. By

default, EnableDynamicResizeOfAppContainer is set to 1 (enabled), which means is that the AppContainer (which you
see as the C drive) only expands when it is close to being full (that is, dynamic) - when less than 10% free space remains.
Increasing PercentOfPvDForApps only increases the maximum space for which the Apps portion is allowed to expand. It
does not provision that space for you immediately. You must also congure the split allocation in the master image,
where it will be applied during the next image update.
If you have already generated a catalog of machines with EnableDynamicResizeOfAppContainer set to 1, then change
that setting to 0 in the master image for the next update, and congure an appropriate allocation split. T he requested
split size will be honored as long as it is larger than the current allocated size for the C drive.
If you want to maintain complete control over the space split, set this value to 0. T his allows full control over the C drive
size, and does not rely on a user consuming space below the threshold to expand the drive.
Default = 50% (allocates equal space to both parts)

PvDReservedSpaceMB
Species the size of the reserved space (in megabytes) on the vDisk for storing Personal vDisk logs and other data.
If your deployment includes XenApp 6.5 (or an earlier version) and uses application streaming, increase this value by the
size of the Rade Cache.
Default = 512
PvDResetUserGroup
Valid only for XenDesktop 5.6 - Allows the specied group of users to reset a Personal vDisk. Later XenDesktop releases
use Delegated Administration for this.
Other settings:
Windows Update Service - Ensure that you set Windows updates to Never Check for Update and the Windows update
service to Disabled in the master image. In the event Windows Update Service needs to run on the PvD, setting it to
Never Check for Update helps prevent the updates from being installed on the associated machines.
Windows 8 Store needs this service to run to install any Modern-style application.
Windows updates - T hese include Internet Explorer updates and must be applied on the master image.
Updates requiring restarts - Windows updates applied to the master image might require multiple restarts to fully
install, depending on the type of patches delivered in those updates. Ensure you restart the master image properly to
fully complete the installation of any Windows updates applied to it before taking the PvD inventory.
Application updates - Update applications installed on the master image to conserve space on users' vDisks. T his also
avoids the duplicate effort of updating the applications on each user's vDisk.
Considerations: Applications on the master image
Some software might conict with the way that PvD composites the user's environment, so you must install it on the
master image (rather than on the individual machine) to avoid these conicts. In addition, although some other software
might not conict with the operation of PvD, Citrix recommends installing it on the master image.
Applications that must be installed on the master image:

Agents and clients (for example, System Center Configuration Manager Agent, App-V client, Citrix Receiver)
Applications that install or modify early-boot drivers
Applications that install printer or scanner software or drivers
Applications that modify the Windows network stack
VM tools such as VMware T ools and XenServer T ools
Applications that should be installed on the master image:

Applications that are distributed to a large number of users. In each case, turn off application updates before
deployment:
Enterprise applications using volume licensing, such as Microsoft Office, Microsoft SQL Server
Common applications, such as Adobe Reader, Firefox, and Chrome
Large applications such as SQL Server, Visual Studio, and application frameworks such as .NET
T he following recommendations and restrictions apply to applications installed by users on machines with personal vDisks.
Some of these cannot be enforced if users have administrative privileges:
Users should not uninstall an application from the master image and reinstall the same application on their personal
vDisk.
T ake care when updating or uninstalling applications on the master image. After you install a version of an application on

the image, a user might install an add-on application (for example, a plug-in) that requires this version. If such a
dependency exists, updating or uninstalling the application on the image might make the add-on malfunction. For
example, with Microsoft Office 2010 installed on a master image, a user installs Visio 2010 on their personal vDisk. A later
upgrade of Office on the master image might make the locally-installed Visio unusable.
Software with hardware-dependent licenses (either through a dongle or signature-based hardware) is unsupported.
Considerations: Provisioning Services
When using Provisioning Services with PvD:

T he Soap Service account must be added to the Administrator node of Studio and must have the Machine Administrator
or higher role. T his ensures that the PvD desktops are put into the Preparing state when the Provisioning Services (PVS)
vDisk is promoted to production.
T he Provisioning Service versioning feature must be used to update the personal vDisk. When the version is promoted to
production, the Soap Service puts the PvD desktops into the Preparing state.
T he personal vDisk size should always be larger than the Provisioning Services write cache disk (otherwise, Provisioning
Services might erroneously select the personal vDisk for use as its write cache).
After you create a Delivery Group, you can monitor the personal vDisk using the PvD Image Update Monitoring T ool or
the Resize and poolstats scripts (personal-vdisk-poolstats.ps1).
Size the write cache disk correctly. During normal operation, PvD captures most user writes (changes) and redirects them to
the personal vDisk. T his implies that you can reduce the size of the Provisioning Services write cache disk. However, when
PvD is not active (such as during image update operations), a small Provisioning Services write cache disk can ll up, resulting
in machine crashes.
Citrix recommends that you size Provisioning Services write cache disks according to Provisioning Services best practice and
add space equal to twice the size of the template VHD on the master image (to accommodate merge requirements). It is
extremely unlikely that a merge operation will require all of this space, but it is possible.
When using Provisioning Services to deploy a catalog with PvD-enabled machines:

Follow the guidance in the Provisioning Services documentation.
You can change the power action throttling settings by editing the connection in Studio; see below.
If you update the Provisioning Services vDisk, after you install/update applications and other software and restart the
vDisk, run the PvD inventory and then shut down the VM. T hen, promote the new version to Production. T he PvD
desktops in the catalog should automatically enter the Preparing state. If they do not, check that the Soap Service
account has machine administrator or higher privileges on the Controller.
T he Provisioning Services test mode feature enables you to create a test catalog containing machines using an updated
master image. If tests conrm the test catalog's viability, you can promote it to production.
Considerations: Machine Creation Services
When using Machine Creation Services (MCS) to deploy a catalog with PvD-enabled machines:
Follow the guidance in the XenDesktop documentation.
Run a PvD inventory after you create the master image and then power off the VM (PvD will not function correctly if
you do not power off the VM). T hen, take a snapshot of the master image.
In the Create Machine Catalog wizard, specify the personal vDisk size and drive letter.
After you create a Delivery Group, you can monitor the personal vDisk using the PvD Image Update Monitoring T ool or
the Resize and poolstats scripts (personal-vdisk-poolstats.ps1).
You can change the power action throttling settings by editing the connection in Studio; see below.

If you update the master image, run the PvD inventory after you update the applications and other software on the
image, and then power off the VM. T hen, take a snapshot of the master image.
Use the PvD Image Update Monitoring T ool or the personal-vdisk-poolstats.ps1 script to validate that there is sufficient
space on each PvD-enabled VM that will use the updated master image.
After you update the machine catalog, the PvD desktops enter the Preparing state as they individually process the
changes in the new master image. T he desktops are updated according to the rollout strategy specified during the
machine update.
Use the PvD Image Update Monitoring T ool or the personal-vdisk-poolstats.ps1 script to monitor the PvD in the
Preparing state.
How-to: Exclude les and f olders f rom vDisks
Use the rules les to exclude les and folders from the vDisks. You can do this when the personal vDisks are in deployment.
T he rules les are named custom_*_rules.template.txt and are located in the \cong folder. Comments in each le provide
additional documentation.
How-to: Run the inventory when updating a master image
When you enable PvD and after any update to the master image after installation, it is important to refresh the disk's
inventory (called "run the inventory") and create a new snapshot.
Because administrators, not users, manage master images, if you install an application that places binary les in the
administrator's user prole, the application is not available to users of shared virtual desktops (including those based on
pooled machine catalogs and pooled with PvD machine catalogs). Users must install such applications themselves.
It is best practice to take a snapshot of the image after each step in this procedure.
1. Update the master image by installing any applications or operating system updates, and performing any system
configuration on the machine.
For master images based on Windows XP that you plan to deploy with Personal vDisks, check that no dialog boxes are
open (for example, messages conrming software installations or prompts to use unsigned drivers). Open dialog boxes on
master images in this environment prevent the VDA from registering with the Delivery Controller. You can prevent
prompts for unsigned drivers using the Control Panel. For example, navigate to System > Hardware > Driver Signing, and
select the option to ignore warnings.
2. Shut down the machine. For Windows 7 machines, click Cancel when Citrix Personal vDisk blocks the shutdown.
3. In the Citrix Personal vDisk dialog box, click Update Inventory. T his step may take several minutes to complete.
Important: If you interrupt the following shutdown (even to make a minor update to the image), the Personal vDisk's
inventory no longer matches the master image. T his causes the Personal vDisk feature to stop working. If you interrupt
the shutdown, you must restart the machine, shut it down, and when prompted click Update Inventory again.
4. When the inventory operation shuts down the machine, take a snapshot of the master image.
You can export an inventory to a network share and then import that inventory to a master image. For details, see Export
and import a PvD inventory.
How-to: Congure connection throttling settings
T he Citrix Broker Service controls the power state of the machines that provide desktops and applications. T he Broker
Service can control several hypervisors through a Delivery Controller. Broker power actions control the interaction between
a Controller and the hypervisor. To avoid overloading the hypervisor, actions that change a machines power state are
assigned a priority and sent to the hypervisor using a throttling mechanism. T he following settings affect the throttling. You

specify these values by editing a connection (Advanced page) in Studio.
T o configure connection throttling values:

2. Select the connection and then select Edit Connection in the Actions pane.
3. You can change the following values:
Simultaneous actions (all types) - T he maximum number of simultaneous in-progress power actions allowed. T his
setting is specified as both an absolute value and as a percentage of the connection to the hypervisor. T he lower of
the two values is used.
Default = 100 absolute, 20%
Simultaneous Personal vDisk inventory updates - T he maximum number of simultaneous Personal vDisk power
actions allowed. T his setting is specified as both an absolute value and a percentage of the connection. T he lower of
the two values is used.
Default = 50 absolute, 25%
To calculate the absolute value: determine the total IOPS (T IOPS) supported by the end-user storage (this should be
specied by the manufacturer or calculated). Using 350 IOPS per VM (IOPS/VM), determine the number of VMs that
should be active at any given time on the storage. Calculate this value by dividing total IOPS by IOPS/VM.
For example, if the end-user storage is 14000 IPS, the number of active VMs is 14000 IOPS / 350 IOPS/VM = 40.
Maximum new actions per minute - T he maximum number of new power actions that can be sent to the
hypervisor per minute. Specified as an absolute value.
Default = 10
T o help identify optimal values for these settings in your deployment:

1. Using the default values, measure the total response time for an image update of a test catalog. T his is the difference
between the start of an image update (T 1) and when the VDA on the last machine in the catalog registers with the
Controller (T 2). T otal response time = T 2 - T 1.
2. Measure the input/output operations per second ( IOPS) of the hypervisor storage during the image update. T his data
can serve as a benchmark for optimization. (T he default values may be the best setting; alternatively, the system might
max out of IOPS, which will require lowering the setting values.)
3. Change the Simultaneous Personal vDisk inventory updates value as described below (keeping all other settings
unchanged).
1. Increase the value by 10 and measure the total response time after each change. Continue to increase the value by
10 and test the result, until deterioration or no change in the total response time occurs.
2. If the previous step resulted in no improvement by increasing the value, decrease the value in increments of 10 and
measure the total response time after each decrease. Repeat this process until the total response time remains
unchanged or does not improve further. T his is likely the optimal PvD power action value.
4. After obtaining the PvD power action setting value, tweak the simultaneous actions (all types) and maximum new
actions per minute values, one at a time. Follow the procedure described above (increasing or decreasing in increments)
to test different values.
How-to: System Center Conguration Manager 2007 with PvD
System Center Conguration Manager (Conguration Manager) 2012 requires no special conguration and can be installed
in the same way as any other master image application. T he following information applies only to System Center
Conguration Manager 2007. Conguration Manager versions earlier than Conguration Manager 2007 are not supported.

Complete the following to use Configuration Manager 2007 agent software in a PvD environment.
1. Install the Client Agent on the master image.
1. Install the Configuration Manager client on the master image.
2. Stop the ccmexec service (SMS Agent) and disable it.
3. Delete SMS or client certificates from the local computer certificate store as follows:
Mixed mode: Certificates (Local Computer)\SMS\Certificates
Native mode
Certificates (Local Computer)\Personal\Certificates
Delete the client certificate that was issued by your certificate authority (usually, an internal Public Key
Infrastructure)
4. Delete or rename C:\Windows\smscfg.ini.
2. Remove information that uniquely identifies the client.
1. (Optional) Delete or move log files from C:\Windows\System32\CCM\Logs.
2. Install the Virtual Delivery Agent (if not installed previously), and take the PvD inventory.
3. Shut down the master image, take a snapshot, and create a machine catalog using this snapshot.
3. Validate personal vDisk and start services. Complete these steps once on each PvD desktop, after it has been started for
the first time. T his can be done using a domain GPO, for example.
Confirm that PvD is active by checking for the presence of the registry key HKLM\Software\Citrix\personal
vDisk\config\virtual.
Set the ccmexec service (SMS agent) to Automatic and start the service. T he Configuration Manager client contacts
the Configuration Manager server, and retrieves new unique certificates and GUIDs.

Tools
May 22, 20 17
You can use the following tools and utilities to tailor, expedite, and monitor PvD operations.
Custom rules les
T he custom rule files provided with PvD let you modify the default behavior of PvD image updates in the following ways:
T he visibility of files on the PvD
How changes made to the files are merged
Whether the files are writable
For detailed instructions on the custom rules les and the CoW feature, refer to the comments in the les located in
C:\ProgramData\Citrix\personal vDisk\Cong on the machine where PvD is installed. T he les named "custom_*" describe
the rules and how to enable them.
Resize and poolstats scripts
Two scripts are provided to monitor and manage the size of PvDs; they are located in the Support\Tools\Scripts folder on
the XenDesktop installation media. You can also use the PvD Image Update Monitoring Tool, which is located in the
Support\Tools\Scripts\PvdTool folder; see http://blogs.citrix.com/2014/06/02/introducing-the-pvd-image-update-
monitoring-tool/ for details.
Use resize-personalvdisk-pool.ps1 to increase the size of the PvDs in all of the desktops in a catalog. T he following snap-ins
or modules for your hypervisor must be installed on the machine running Studio:
XenServer requires XenServerPSSnapin
vCenter requires vSphere PowerCli
System Center Virtual Machine Manager requires the VMM console
Use personal-vdisk-poolstats.ps1 to check the status of image updates and to check the space for applications and user
proles in a group of PvDs. Run this script before updating an image to check whether any desktop is running out of space,
which helps prevent failures during the update. T he script requires that Windows Management Instrumentation (WMI-In)
rewall is enabled on the PvD desktops. You can enable it on the master image or through GPO.
If an image update fails, the entry in the Update column gives the reason.
Reset the application area
If a desktop becomes damaged or corrupted (by installing a broken application or some other cause), you can revert the
application area of the PvD to a factory-default (empty) state. T he reset operation leaves user prole data intact.
T o reset the application area of the PvD, use one of the following methods:
Log on to the user's desktop as Administrator. Launch a command prompt, and run the command C:\Program
Files\Citrix\Personal vDisk\bin\CtxPvD.exe -s Reset.
Locate the user's desktop in Citrix Director. Click Reset Personal vDisk and then click OK.
Export and import a PvD inventory
T he image update process is an integral part of rolling out new images to PvD desktops; it includes adjusting the existing
Personal vDisk to work with the new base image. For deployments that use Machine Creations Services (MCS), you can

export an inventory from an active VM to a network share, and then import it into a master image. A differential is
calculated using this inventory in the master image. Although using the export/import inventory feature is not mandatory, it
can improve the performance of the overall image update process.
T o use the export/import inventory feature, you must be an administrator. If required, authenticate to the file share used
for the export/import with net use. T he user context must be able to access any file shares used for the export/import.
T o export an inventory, run the export command as an administrator on a machine containing a VDA with PvD enabled
(minimum version 7.6):
Ctxpvdsvc.exe exportinventory <path-to-export-location>
T he software detects the current inventorys location and exports the inventory to a folder named
ExportedPvdInventory to the specified location. Heres an excerpt from the command output:
C:\Program Files\Citrix\personal vDisk\bin> .\CtxPvDSvc.exe exportinventory
\\share location\ExportedInventory
Current inventory source location C:\CitrixPvD\Settings\Inventory\VER-LAS
...
Exporting current inventory to location \\ .
...
Deleting any pre-existing inventory folder at \\ .
.Successfully exported current inventory to location \\ . Error code = OPS
T o import a previously-exported inventory, run the import command as an administrator on the master image:
To import
Run the import command as an administrator on the master image.
Ctxpvdsvc.exe importinventory <path-to-exported-inventory>
T he <path to exported inventory> should be the full path to the inventory les, which is usually <network
location\ExportedPvdInventory>.
T he inventory is obtained from the import location (where it was previously exported using the exportinventory option) and
imports the inventory to the inventory store on the master image. Heres an excerpt of the command output:
C:\Program Files\Citrix\personal vDisk\bin> .\CtxPvDSvc.exe importinventory
\\share location\ExportedInventory\ExportedPvdInventory
Importing inventory \\share location\ExportedInventory\ExportedPvdInventory

Successfully added inventory \\share location\ExportedInventory\ExportedPvdInventory to the
store at c:\ProgramData\Citrix\personal vDisk\InventoryStore
After the export, the network share should include the following filenames. After the import, the inventory store on the
master image should include the same file names.
Components.DAT
files_rules
folders_rules
regkey_rules
RINGT HREE.DAT
S-1-5-18.DAT
SAM.DAT
SECURIT Y.DAT

SNAPSHOT .DAT
SOFT WARE.DAT
SYST EM.CurrentControlSet.DAT
VDCAT ALOG.DAT
vDiskJournalData

Displays, messages, and troubleshooting
May 22, 20 17
Monitor PvD through reports

You can use a diagnostic tool to monitor the changes made by users to both parts of their Personal vDisks (the user data
and the application parts). T hese changes include applications that users have installed and les they have modied. T he
changes are stored in a set of reports.
1. On the machine you want to monitor, run C:\Program Files\Citrix\personal vDisk\bin\CtxPvdDiag.exe.

2. Browse to a location where you want to store the reports and logs, select the reports to generate, and then
click OK. T he available reports are listed below.
Sof tware hive report: T his report generates two les: Software.Dat.Report.txt and Software.Dat.delta.txt.
T he Software.Dat.Report.txt le records the changes made by the user to the HKEY_LOCAL_MACHINE\Software hive. It
contains the following sections:
List of Applications installed on the base Applications that were installed in Layer 0.
List of user installed software Applications the user installed on the application part of the personal vDisk.
List of software uninstalled by user Applications the user removed that were originally in Layer 0.
See the hive delta report for information about the Software.Dat.delta.txt.
System hive report: T he generated SYST EM.CurrentControlSet.DAT.Report.txt le records changes the user made to the
HKEY_LOCAL_MACHINE\System hive. It contains the following sections:
List of user installed services services and drivers the user installed.
Startup of following services were changed services and drivers whose start type the user modified.
Security hive report: T he generated SECURIT Y.DAT.Report.txt le monitors all changes that the user makes in the
HKEY_LOCAL_MACHINE\Security hive.
Security Account Manager (SAM) hive report: T he generated SAM.DAT.Report.txt le monitors all changes that the user
makes in the HKEY_LOCAL_MACHINE\SAM hive.
Hive delta report: T he generated Software.Dat.delta.txt le records all registry keys and values added or removed, and all
values the user modied in the HKEY_LOCAL_MACHINE\Software hive.
Personal vDisk logs: T he log les Pud-IvmSupervisor.log, PvDActivation.log, PvDSvc.log, PvDWMI.log, SysVol-
IvmSupervisor.log, and vDeskService-<#>.log are generated by default in P:\Users\<user
account>\AppData\Local\Temp\PVDLOGS, but are moved to the selected location.
Windows operating system logs:
EvtLog_App.xml and EvtLog_System.xml are the application and system event logs in XML format from the personal
vDisk volume.
Setupapi.app.log and setuperr.log contain log messages from when msiexec.exe was run during personal vDisk
installation.

Setupapi.dev.log contains device installation log messages.
Msinfo.txt contains the output of msinfo32.exe. For information, see the Microsoft documentation.
File system report: T he generated FileSystemReport.txt le records changes the user made to the le system in the
following sections:
Files Relocated Files in Layer 0 that the user moved to the vDisk. Layer 0 files are inherited from the master image by
the machine to which the personal vDisk is attached.
Files Removed Files in Layer 0 that were hidden by a user's action (for example, removing an application).
Files Added (MOF,INF,SYS) Files with .mof, .inf, or .sys extensions that the user added to the personal vDisk (for
example, when they installed an application such as Visual Studio 2010 that registers a .mof file for autorecovery).
Files Added Other Other files that the user added to the vDisk (for example, when installing an application).
Base Files Modified But Not Relocated Files in Layer 0 that the user modified but that the personal vDisk Kernel-
Mode drivers did not capture in the vDisk.
Image updates
In Studio, when you choose a PvD-enabled machine in a machine catalog, the "PvD" tab provides monitoring status during
image updates, plus estimated completion time and progress. T he possible state displays during an image update are: Ready,
Preparing, Waiting, Failed, and Requested.
An image update can fail for different reasons, including lack of space or a desktop not nding the PvD in sufcient time.
When Studio indicates that an image update failed, an error code with descriptive text is provided to help troubleshooting.
Use the Personal vDisk Image Update Monitoring Tool or the personal-vdisk-poolstats.ps1 script to monitor image update
progress and obtain error codes associated with the failure.
If an image update fails, the following log files can provide further troubleshooting information:
PvD service log - C:\ProgramData\Citrix\personal vDisk\Logs\PvDSvc.log.txt
PvD activation log i- P:\PVDLOGS\PvDActivation.log.txt
T he most recent content is at the end of the log le.
Error messages: 7.6 and later
T he following errors are valid for PvD version 7.6 and later:
An internal error occurred. Review the Personal vDisk logs f or f urther details. Error code %d (%s)
T his is a catch-all for uncategorized errors, so it has no numeric value. All unexpected errors encountered during inventory
creation or Personal vDisk update are indicated by this error code.
Collect logs and contact Citrix support.
If this error occurs during catalog update, roll back the catalog to the previous version of the master image.
There are syntax errors in the rule f iles. Review the logs f or f urther details.
Error code 2. T he rule le contains syntax errors. T he Personal vDisk log le contains the name of the rule le and line
number where the syntax error was found. Fix the syntax error in the rule le and retry the operation.
The inventory stored in the Personal vDisk corresponding to the previous version of the master image is
corrupt or unreadable.
Error code 3. T he last inventory is stored in UserData.V2.vhd in \ProgramData\CitrixPvD\Settings\Inventory\VER-
LAST . Restore the inventory corresponding to the last version of the master image by importing the VER-LAST folder

from a known working PvD machine associated with the previous version of the master image.
The inventory stored in the Personal vDisk corresponding to the previous version of the master image is
higher version.
Error code 4. T his is caused by personal vDisk version incompatibility between the last master image and the current
master image. Retry updating the catalog after installing the latest version of personal vDisk in the master image.
Change journal overf low was detected.

Error code 5. A USN journal overow was caused by a large number of changes made to the master image while creating
the inventory. If this continues to occur after multiple attempts, use procmon to determine if third party software is
creating/deleting a large number of les during inventory creation.
The Personal vDisk could not f ind a disk attached to the system f or storing user data.
Error code 6. First, verify that the PvD disk is attached to the VM through the hypervisor console. T his error typically
happens due to Data Leak Prevention software preventing access to the PvD disk. If the PvD disk is attached to the
VM, try adding an exception for attached disk in the Data Leak Prevention software conguration.
The system has not been rebooted post-installation. Reboot to implement the changes.
Error code 7. Restart the desktop and retry the operation.
Corrupt installation. Try re-installing Personal vDisk.

Error code 8. Install personal vDisk and try again.
Personal vDisk inventory is not up to date. Update the inventory in the master image, and then try again.
Error code 9. T he personal vDisk inventory was not updated in the master image before shutting down the desktop.
Restart the master image and shut down the desktop through the Update personal vDisk option, and then create a
new snapshot; use that snapshot to update the catalog.
An internal error occurred while starting the Personal vDisk. Review the Personal vDisk logs f or f urther details.
Error code 10. T his could be caused by the PvD driver failing to start a virtualization session due to an internal error or
personal vDisk corruption. Try restarting the desktop through the Controller. If the problem persists, collect the logs and
contact Citrix Support.
The Personal vDisk timed out while trying to f ind a storage disk f or users' personalization settings.
Error code 11. T his error occurs when the PvD driver fails to nd the PvD disk within 30 seconds after restart. T his is
usually caused by an unsupported SCSI controller type or storage latency. If this occurs with all desktops in the catalog,
change the SCSI controller type associated with the Template VM / Master VM to a type supported by personal
vDisk technology. If this occurs with only some desktops in the catalog, it might be due to spikes in storage latency due
to a large number of desktops starting at the same time. Try limiting the maximum active power actions setting
associated with the host connection.
The Personal vDisk has been de-activated because an unsaf e system shutdown was detected. Restart the
machine.
Error code 12. T his could be due to a desktop failing to complete the boot process with PvD enabled. Try restarting the
desktop. If the problem persists, watch the desktop startup through the hypervisor console and check if the desktop is
crashing. If a desktop crashes during startup, restore the PvD from backup (if you maintain one) or reset the PvD.
The drive letter specif ied f or mounting the Personal vDisk is not available.
Error code 13. T his could be caused by PvD failing to mount the PvD disk at the mount specied by the administrator.
T he PvD disk will fail to mount if the drive letter is already used by other hardware. Select a different letter as the mount

point for the personal vDisk.
Personal vDisk kernel mode drivers f ailed to install.

Error code 14. Personal vDisk installs drivers during the rst inventory update after installation. Some antivirus products
prevent installation of the driver when attempted outside the context of an installer. Temporarily disable the antivirus
real time scan or add exceptions in the antivirus for PvD drivers during the rst time inventory creation.
Cannot create a snapshot of the system volume. Make sure that the Volume Shadow Copy service is enabled.
Error code 15. T his could occur because the Volume Shadow Copy service is disabled. Enable the Volume Shadow Copy
service and retry taking an inventory.
The change journal f ailed to activate. Try again af ter waiting f or f ew minutes.
Error code 16. Personal vDisk uses change journal for tracking changes made to master image. During an inventory
update, if PvD detects that the change journal is disabled, it attempts to enable it; this error occurs when that attempt
fails. Wait for few minutes and retry.
There is not enough f ree space in the system volume.

Error code 17. T here is not enough free space available on the C drive of the desktop for the image update operation.
Expand the system volume or remove unused les to free space in the system volume. T he image update should begin
again after the next restart.
There is not enough f ree space in the Personal vDisk storage. Expand Personal vDisk storage to provide more
space.
Error code 18. T here is not enough free space available on the personal vDisk drive when performing an image update
operation. Expand personal vDisk storage or remove unused les to free space in the personal vDisk storage. T he image
update should restart after next reboot.
Personal vDisk storage is over-committed. Expand Personal vDisk storage to provide more space.
Error code 19. T here is not enough free space available on the personal vDisk drive to fully accommodate thick
provisioned UserData.V2.vhd. Expand the personal vDisk storage or remove unused les to free space in the personal
vDisk storage.
Corrupt system registry.

Error code 20. T he system registry is corrupt, damaged, missing, or unreadable. Reset the personal vDisk or restore it from
an earlier backup.
An internal error occurred while resetting the Personal vDisk. Check Personal vDisk logs f or f urther details.
Error code 21. T his is a catch-all for all the errors encountered during a personal vDisk reset. Collect the logs and contact
Citrix Support.
Failed to reset the Personal vDisk because there is not enough f ree space in the personal vDisk storage.
Error code 22. T here is not enough free space available on the Personal vDisk drive when performing a reset operation.
Expand the personal vDisk storage or remove unused les to free space in the personal vDisk storage.
Error messages: earlier than 7.6
T he following errors are valid for PvD 7.x versions earlier than 7.6:
Startup f ailed. Personal vDisk was unable to f ind a storage disk f or user personalization settings.
T he PvD software could not find the Personal vDisk (by default, the P: drive) or could not mount it as the mount point
selected by the administrator when they created the catalog.

Check the PvD service log for following entry: "PvD 1 status --> 18:183".
If you are using a version of PvD earlier than Version 5.6.12, upgrading to the latest version resolves this issue.
If you are using Version 5.6.12 or later, use the disk management tool (diskmgmt.msc) to determine whether the P:
drive is present as an unmounted volume. If present, run chkdsk on the volume to determine if it is corrupt, and try to
recover it using chkdsk.
Startup f ailed. Citrix Personal vDisk f ailed to start. For f urther assistance .... Status code: 7, Error code: 0x70
Status code 7 implies that an error was encountered while trying to update the PvD. T he error could be one of the
following:
Error code Description
0x20000001 Failed to save the diff package, most likely due to lack of free disk space inside the VHD.
0x20000004 Failed to acquire required privileges for updating the PvD.
0x20000006 Failed to load hive from the PvD image or from PvD inventory, most likely due to corrupt PvD image or
inventory.
0x20000007 Failed to load the file system inventory, most likely due to a corrupt PvD image or inventory.
0x20000009 Failed to open the file containing file system inventory, most likely due to a corrupt PvD image or
inventory.
0x2000000B Failed to save the diff package, most likely due to lack of free disk space inside the VHD.
0x20000010 Failed to load the diff package.
0x20000011 Missing rule files.
0x20000021 Corrupt PvD inventory.
0x20000027 T he catalog "MojoControl.dat" is corrupt.
0x2000002B Corrupt or missing PvD inventory.
0x2000002F Failed to register user installed MOF on image update, upgrade to 5.6.12 to fix the issue.
0x20000032 Check the PvDactivation.log.txt for the last log entry with a Win32 error code.
0x20 Failed to mount application container for image update, upgrade to 5.6.12 to fix the issue.
0x70 T here is not enough space on the disk.

Startup f ailed. Citrix Personal vDisk f ailed to start [or Personal vDisk encountered an internal error]. For
f urther assistance ... Status code: 20, Error code 0x20000028
T he personal vDisk was found but a PvD session could not be created.
Collect the logs and check SysVol-IvmSupervisor.log for session creation failures:
1. Check for the following log entry " IvmpNativeSessionCreate: failed to create native session, status XXXXX".
2. If the status is 0xc00002cf, fix the problem by adding a new version of the master image to the catalog. T his status
code implies that the USN Journal overflowed due to a large number of changes after an inventory update.
3. Restart the affected virtual desktop. If the problem persists, contact Citrix T echnical Support.
Startup f ailed. Citrix Personal vDisk has been deactivated because an unsaf e system shutdown was detected.
To retry, select Try again. If the problem continues, contact your system administrator.
T he pooled VM cannot complete its startup with the PvD enabled. First determine why startup cannot be completed.
Possible reasons are that a blue screen appears because:
An incompatible antivirus product is present, for example old versions of T rend Micro, in the master image.
T he user has installed software that is incompatible with PvD. T his is unlikely, but you can check it by adding a new
machine to the catalog and seeing whether it restarts successfully.
T he PvD image is corrupt. T his has been observed in Version 5.6.5.
T o check if the pooled VM is displaying a blue screen, or is restarting prematurely:
Log on to the machine through the hypervisor console.
Click T ry Again and wait for the machine to shut down.
Start the machine through Studio.
Use the hypervisor console to watch the machine console as it starts.
Other troubleshooting:
Collect the memory dump from the machine displaying the blue screen, and send it for further analysis to Citrix
T echnical Support.
Check for errors in the event logs associated with the PvD:
1. Mount UserData.V2.vhd from the root of the P: drive using DiskMgmt.msc by clicking Action > Attach VHD.
2. Launch Eventvwr.msc.
3. Open the system event log (Windows\System32\winevt\logs\system.evtx) from UserData.V2.vhd by clicking Action
> Open saved logs.
4. Open the application event log (Windows\System32\winevt\logs\application.evtx) from UserData.V2.vhd by clicking
Action > Open saved logs.
The Personal vDisk cannot start. The Personal vDisk could not start because the inventory has not been
updated. Update the inventory in the master image, then try again. Status code: 15, Error code: 0x0
T he administrator selected an incorrect snapshot while creating or updating the PvD catalog (that is, the master image
was not shut down using Update Personal vDisk when creating the snapshot).
Events logged by Personal vDisk
If Personal vDisk is not enabled, you can view the following events in Windows Event Viewer. Select the Applications node
in the left pane; the Source of the events in the right pane is Citrix Personal vDisk. If Personal vDisk is enabled, none of
these events are displayed.
An Event ID of 1 signifies an information message, an ID of 2 signifies an error. Not all events may be used in every version
of Personal vDisk.
Event ID Description
1 Personal vDisk Status: Update Inventory Started.

Event ID Description
1 Personal vDisk Status: Update Inventory completed. GUID: %s.
1 Personal vDisk Status: Image Update Started.
1 Personal vDisk Status: Image Update completed.
1 Reset in progress.
1 OK.
2 Personal vDisk Status: Update Inventory Failed with: %s.
2 Personal vDisk Status: Image Update Failed with: %s.
2 Personal vDisk Status: Image Update Failed with Internal Error.
2 Personal vDisk Status: Update Inventory Failed with: Internal Error.
2 Personal vDisk has been disabled because of an improper shutdown.
2 Image update failed. Error code %d.
2 Personal vDisk encountered an internal error. Status code[%d] Error code[0x%X].
2 Personal vDisk reset failed.
2 Unable to find disk for storing user personalization settings.
2 T here is not enough space available on the storage disk to create a Personal vDisk container.

Remove components
May 22, 20 17
To remove components, Citrix recommends using the Windows feature for removing or changing programs. Alternatively,
you can remove components using the command line, or a script on the installation media.
When you remove components, prerequisites are not removed, and rewall settings are not changed. When you remove a
Controller, the SQL Server software and the databases are not removed.
Before removing a Controller, remove it from the Site. Before removing Studio or Director, Citrix recommends closing them.
If you upgraded a Controller from an earlier deployment that included Web Interface, you must remove the Web Interface
component separately; you cannot use the installer to remove Web Interface.
When you remove a VDA, the machine restarts automatically after the removal, by default.
Remove components using the Windows feature for

removing or changing programs
From the Windows feature for removing or changing programs:
T o remove a Controller, Studio, Director, License Server, or StoreFront, select Citrix XenApp <version> or Citrix
XenDesktop <version>, then right-click and select Uninstall. T he installer launches, and you can select the components
to be removed. Alternatively, you can remove StoreFront by right-clicking Citrix StoreFront and selecting Uninstall.
T o remove a VDA, select Citrix Virtual Delivery Agent <version>, then right-click and select Uninstall. T he installer
launches and you can select the components to be removed.
T o remove the Universal Print Server, select Citrix Universal Print Server, then right-click and select Uninstall.
Remove core components using the command line

From the \x64\XenDesktop Setup directory on the installation media, run the XenDesktopServerSetup.exe command.
T o remove one or more components, use the /remove and /components options.
T o remove all components, use the /removeall option.
For command and parameter details, see Install using the command line.
For example, the following command removes Studio.
\x64\XenDesktop Setup\XenDesktopServerSetup.exe /remove /components studio
Remove a VDA using the command line

From the \x64\XenDesktop Setup directory on the installation media, run the XenDesktopVdaSetup.exe command.

T o remove one or more components, use the /remove and /components options.
T o remove all components, use the /removeall option.
For command and parameter details, see Install using the command line.
For example, the following command removes the VDA and Citrix Receiver.
\x64\XenDesktop Setup\XenDesktopVdaSetup.exe /removeall
To remove VDAs using a script in Active Directory; see Install or remove Virtual Delivery Agents using scripts.

Upgrade and migrate
May 22, 20 17
Upgrade
Upgrading changes deployments to the newest component versions without having to set up new machines or Sites; this is
known as an in-place upgrade. You can upgrade to the current version from:
XenDesktop 5.6
XenDesktop 7.0
XenDesktop 7.1
XenApp/XenDesktop 7.5
XenApp/XenDesktop 7.6 LT SR*
* Upgrading from XenApp/XenDesktop 7.6 LT SR to the current release will break LT SR compliancy.
You can also upgrade a XenApp 6.5 worker server to a curent VDA for Windows Server OS. T his is a supplementary activity
to migrating XenApp 6.5.
To upgrade a XenDesktop 5.6 (or later) farm or a XenApp 7.5 (or later) Site:
1. Run the installer on the machines where the core components and VDAs are installed. T he software determines if an
upgrade is available and installs the newer version.
2. Use the newly upgraded Studio to upgrade the database and the Site.
For more information, see Upgrade a deployment.
For information about installing Controller hotxes, see CT X201988.
To upgrade a XenApp 6.5 worker server to a current VDA:
1. Run the product installer on the XenApp 6.5 worker server. T he software removes the server from the XenApp 6.5 farm,
removes the XenApp 6.5 software, and installs a current VDA for Windows Server OS.
2. After upgrading the server, add it to Machine Catalogs and Delivery Groups in the current Site.
For more information, see Upgrade a XenApp 6.5 worker to a new VDA for Windows Server OS.
Migrate

Migrating moves data from an earlier deployment to the newest version. You can migrate a XenApp 6 deployment.
Migrating includes installing current components and creating a new Site, exporting data from the older farm, and then
importing the data to the new Site.
T ip: For information about architecture, component, and feature changes that were introduced with the 7.x releases,
see Changes in 7.x.
To migrate from XenApp 6.5:
1. Install core components and create a new XenApp Site.

2. From the XenApp 6.5 controller, use PowerShell cmdlets to export policy and/or farm data to XML files. You can edit the
XML file content to tailor the information you will import.
3. From the new Site, use PowerShell cmdlets and the XML files to import policy and/or application data to the new Site.
4. Complete post-migration tasks on the new Site.
For more information, see Migrate XenApp 6.x.

Changes in 7.x
May 22, 20 17
XenApp and XenDesktop architecture, terminology, and features changed, beginning with the 7.x releases. If you are
familiar with only earlier (pre-7.x) versions, this article can acquaint you with the changes.
Tip: After you have moved to a 7.x version, changes to later versions are listed in What's new.
Unless specically noted, 7.x refers to XenApp version 7.5 or later, and XenDesktop version 7 or later.
T his article provides an overview. For comprehensive information about moving from pre-7.x to the latest version, see
Upgrade to XenApp 7.
Element differences between XenApp 6 and the

current XenApp version
Although they are not exact equivalents, the following table helps map functional elements from XenApp 6.5 and previous
versions to XenApp and XenDesktop versions, beginning with 7.x. Descriptions of architectural differences follow.
Instead of this in XenApp < 6.5: T hink of this, in XenApp and XenDesktop > 7.x:
Independent Management Architecture (IMA) FlexCast Management Architecture (FMA)
Farm Site
Worker Group Machine Catalog
Delivery Group
Worker Virtual Delivery Agent (VDA)
Server OS machine, Server OS VDA
Desktop OS machine, Desktop OS VDA
Remote Desktop Services (RDS) or Terminal Services Server OS machine, Server OS VDA
machine
Zone and Data Collector Delivery Controller
Delivery Services Console Citrix Studio and Citrix Director

Publishing applications Delivering applications
Data store Database
Load Evaluator Load Management Policy
Administrator Delegated Administrator
Role
Scope
Architecture differences
Beginning with 7.x versions, XenApp and XenDesktop are based on FlexCast Management Architecture (FMA). FMA is a
service-oriented architecture that allows interoperability and management modularity across Citrix technologies. FMA
provides a platform for application delivery, mobility, services, exible provisioning, and cloud management.
FMA replaces the Independent Management Architecture (IMA) used in XenApp 6.5 and previous versions.
T hese are the key elements of FMA in terms of how they relate to elements of XenApp 6.5 and previous versions:
Delivery Sites: Farms were the top-level objects in XenApp 6.5 and previous versions. In XenApp 7.x and XenDesktop 7.x,
the Site is the highest level item. Sites offer applications and desktops to groups of users. FMA requires that you must
be in a domain to deploy a Site. For example, to install the servers, your account must have local administrator privileges
and be a domain user in the Active Directory.
Machine Catalogs and Delivery Groups: Machines hosting applications in XenApp 6.5 and previous versions belonged
to Worker Groups for efficient management of the applications and server software. Administrators could manage all
machines in a Worker Group as a single unit for their application management and load-balancing needs. Folders were
used to organize applications and machines. In XenApp 7.x and XenDesktop 7.x, you use a combination of Machine
Catalogs, Delivery Groups, and Application Groups to manage machines, load balancing, and hosted applications or
desktops. You can also use application folders.
VDAs: In XenApp 6.5 and previous versions, worker machines in Worker Groups ran applications for the user and
communicated with data collectors. In XenApp 7.x and XenDesktop 7.x, the VDA communicates with Delivery Controllers
that manage the user connections.
Delivery Controllers: In XenApp 6.5 and previous versions there was a zone master responsible for user connection
requests and communication with hypervisors. In XenApp 7.x and XenDesktop 7.x, Controllers in the Site distribute and
handle connection requests. In XenApp 6.5 and previous versions, zones provided a way to aggregate servers and
replicate data across WAN connections. Although zones have no exact equivalent in XenApp 7.x and XenDesktop 7.x,
the 7.x zones and zone preference functionality enables you to help users in remote regions connect to resources
without necessarily forcing their connections to traverse large segments of a WAN.
Studio and Director: Use the Studio console to configure your environments and provide users with access to
applications and desktops. Studio replaces the Delivery Services Console in XenApp 6.5 and previous versions.

Administrators use Director to monitor the environment, shadow user devices, and troubleshoot IT issues. T o shadow
users, Windows Remote Assistance must be enabled; it is enabled by default when the VDA is installed.
Delivering applications: XenApp 6.5 and previous versions used the Publish Application wizard to prepare applications
and deliver them to users. In XenApp 7.x and XenDesktop 7.x, you use Studio to create and add applications to make
them available to users who are included in a Delivery Group and optionally, Application Groups. Using Studio, you first
configure a Site, create and specify Machine Catalogs, and then create Delivery Groups that use machines from those
catalogs. T he Delivery Groups determine which users have access to the applications you deliver. You can optionally
choose to create Application Groups as an alternative to multiple Delivery Groups.
Database: XenApp 7.x and XenDesktop 7.x do not use the IMA data store for configuration information. T hey use a
Microsoft SQL Server database to store configuration and session information.
Load Management Policy: In XenApp 6.5 and previous versions, load evaluators use predefined measurements to
determine the load on a machine. User connections can be matched to the machines with a lower load. In XenApp 7.x
and XenDesktop 7.x, use load management policies for balancing loads across machines.
Delegated Administration: In XenApp 6.5 and previous versions, you created custom administrators and assigned them
permissions based on folders and objects. In XenApp 7.x and XenDesktop 7.x, custom administrators are based on role
and scope pairs. A role represents a job function and has defined permissions associated with it to allow delegation. A
scope represents a collection of objects. Built-in administrator roles have specific permissions sets, such as help desk,
applications, hosting, and catalog. For example, help desk administrators can work only with individual users on specified
sites, while full administrators can monitor the entire deployment and resolve system-wide IT issues.
Feature comparison
T he transition to FMA also means some features available in XenApp 6.5 and previous versions may be implemented
differently or may require you to substitute other features, components, or tools to achieve the same goals.
Instead of this in XenApp 6.5 and

Use this, beginning with XenApp and XenDesktop 7.x:
bef ore:
Session prelaunch and session linger Session prelaunch and session linger congured by editing Delivery Group
congured with policy settings settings.
As in XenApp 6.5, these features help users connect to applications quickly,

by starting sessions before they are requested (session prelaunch) and
keeping sessions active after a user closes all applications (session linger). In
XenApp and XenDesktop 7.x, you enable these features for specied users
by conguring these settings for existing Delivery groups. See Congure
session prelaunch and session linger.
Support for unauthenticated Support for unauthenticated (anonymous) users is provided by conguring
(anonymous) users provided by granting this option when setting user properties of a Delivery Group. See Users.
rights to anonymous user when setting
the properties of published applications
Local host cache permits a worker Local Host Cache allows connection brokering operations to continue when

servers to function even when a the connection between a Controller and the Site database fails. T his
connection to the data store is not implementation is more robust and requires less maintenance. See Local Host
available Cache.
As an alternative to using Local Host Cache, connection leasing enables users

to connect and reconnect to their most recently used applications and
desktops, even when the Site database is not available. See Connection
leasing.
Application streaming Citrix App-V delivers streamed applications, which are managed using Studio.
Web Interface Citrix recommends you transition to StoreFront.
SmartAuditor to record on-screen Beginning with 7.6 Feature Pack 1, this functionality is provided by Session
activity of a user's session. Recording. You can also use Conguration Logging to log all session activities
from an administrative perspective.
Power and Capacity Management to Use the Microsoft Conguration Manager.

help reduce power consumption and
manage server capacity
Feature support and changes

T he following features are not currently provided, no longer supported, or have changed signicantly in XenApp or
XenDesktop, beginning with 7.x versions.
Secure ICA encryption below 128-bit: In releases earlier than 7.x, Secure ICA could encrypt client connections for basic,
40-bit, 56-bit, and 128-bit encryption. In 7.x releases, Secure ICA encryption is available only for 128-bit encryption.
Legacy printing: T he following printing features are not supported in 7.x releases:
Backward compatibility for DOS clients and 16-bit printers, including legacy client printer name.
Support for printers connected to Windows 95 and Windows NT operating systems, including enhanced extended
printer properties and Win32FavorRetainedSetting.
Ability to enable or disable auto-retained and auto-restored printers.
DefaultPrnFlag, a registry setting for servers that is used to enable or disable auto-retained and auto-restored printers,
which store in user profiles on the server.
Secure Gateway: In releases earlier than 7.x, Secure Gateway was an option to provide secure connections between the
server and user devices. NetScaler Gateway is the replacement option for securing external connections.
Shadowing users: In releases earlier than 7.x, administrators set policies to control user-to-user shadowing. In 7.x releases,
shadowing end-users is an integrated feature of the Director component, which uses Windows Remote Assistance to

allow administrators to shadow and troubleshoot issues for delivered seamless applications and virtual desktops.
Flash v1 Redirection: Clients that do not support second generation Flash Redirection (including Citrix Receiver for
Windows earlier than 3.0, Citrix Receiver for Linux earlier than 11.100, and Citrix Online Plug-in 12.1) will fall back to server-
side rendering for legacy Flash Redirection features. VDAs included with 7.x releases support second generation Flash
Redirection features.
Local Text Echo: T his feature was used with earlier Windows application technologies to accelerate the display of input
text on user devices on high latency connections. It is not included in 7.x releases due to improvements to the graphics
subsystem and HDX SuperCodec.
Single Sign-on: T his feature, which provides password security, is not supported for Windows 8, Windows Server 2012, and
newer supported Windows operating systems versions. It is still supported for Windows 2008 R2 and Windows 7
environments, but is not included with 7.x releases. You can locate it on the Citrix download website:
http://citrix.com/downloads.
Oracle database support: 7.x releases require a SQL Server database.
Health Monitoring and Recovery (HMR): In releases earlier than 7.x, HMR could run tests on the servers in a server farm
to monitor their state and discover any health risks. In 7.x releases, Director offers a centralized view of system health by
presenting monitoring and alerting for the entire infrastructure from within the Director console.
Custom ICA les: Custom ICA les were used to enable direct connection from user devices (with the ICA le) to a specic
machine. In 7.x releases, this feature is disabled by default, but can be enabled for normal usage using a local group or can
be used in high-availability mode if the Controller becomes unavailable.
Management Pack f or System Center Operations Manager (SCOM) 2007: T he management pack, which monitored
the activity of XenApp farms using SCOM, does not support 7.x releases. See the current Citrix SCOM Management Pack
for XenApp and XenDesktop.
CNAME f unction: T he CNAME function was enabled by default in releases earlier than 7.x. Deployments depending on
CNAME records for FQDN rerouting and the use of NET BIOS names might fail. In 7.x releases, the Delivery Controller auto-
update feature dynamically updates the list of Controllers and automatically noties VDAs when Controllers are added to
and removed from the Site. T he Controller auto-update feature is enabled by default in Citrix policies, but can be disabled.
Alternatively, you can re-enable the CNAME function in the registry to continue with your existing deployment and allow
FQDN rerouting and the use of NET BIOS names. For more information, see CT X137960.
Quick Deploy wizard: In XenDesktop releases earlier than 7.x, this Studio option allowed a fast deployment of a fully
installed XenDesktop deployment. T he new simplied installation and conguration workow in 7.x releases eliminates the
need for the Quick Deploy wizard option.
Remote PC Service conguration le and PowerShell script f or automatic administration: Remote PC Access is now
integrated into Studio and the Controller.
Workow Studio: In releases earlier than 7.x, Workow Studio was the graphical interface for workow composition for
XenDesktop. T he feature is not supported in 7.x releases.
Launching of non-published programs during client connection: In releases earlier than 7.x, this Citrix policy setting
specied whether to launch initial applications or published applications through ICA or RDP on the server. In 7.x releases,
this setting species only whether to launch initial applications or published applications through RDP on the server.

Desktop launches: In releases earlier than 7.x, this Citrix policy setting specied whether non-administrative users can
connect to a desktop session. In 7.x releases, non-administrative users must be in a VDA machine's Direct Access Users
group to connect to sessions on that VDA. T he Desktop launches setting enables non-administrative users in a VDA's
Direct Access Users group to connect to the VDA using an ICA connection. T he Desktop launches setting has no effect on
RDP connections; users an VDA's Direct Access Users group can connect to the VDA using an RDP connection whether or
not this setting is enabled.
Color depth: In Studio releases earlier than 7.6, you specied color depth in a Delivery Group's User Settings. Beginning in
version 7.6, color depth for the Delivery Group can be set using the New-BrokerDesktopGroup or Set-BrokerDesktopGroup
PowerShell cmdlet.
Launch touch-optimized desktop: T his setting is disabled and not available for Windows 10 and Windows Server 2016
machines. For more information, see Mobile experience policy settings.
Features not in Citrix Receiver or that have dif f erent def ault values
COM Port Mapping: COM Port Mapping allowed or prevented access to COM ports on the user device. COM Port
Mapping was previously enabled by default. In 7.x releases of XenDesktop and XenApp, COM Port Mapping is disabled by
default. For details, see Congure COM Port and LPT Port Redirection settings using the registry.
LPT Port Mapping: LPT Port Mapping controls the access of legacy applications to LPT ports. LPT Port Mapping was
previously enabled by default. In 7.x releases, LPT Port Mapping is disabled by default.
PCM Audio Codec: Only HT ML5 clients support the PCM Audio Codec in 7.x releases.
Support f or Microsof t ActiveSync.
Proxy support f or older versions: T his includes:
Microsoft Internet Security and Acceleration (ISA) 2006 (Windows Server 2003)
Oracle iPlanet Proxy Server 4.0.14 (Windows Server 2003)
Squid Proxy Server 3.1.14 (Ubuntu Linux Server 11.10)
For more information, see the Citrix Receiver documentation for your version.

Upgrade a deployment
Jun 0 8 , 20 17
In this article:
Introduction
Upgrade sequence
Which product component versions can be upgraded
Preparation and limits
Mixed environment considerations
VDAs on machines running Windows XP or Windows Vista
VDAs on machines running Windows 8.x and Windows 7
Mixed VDA support
Upgrade procedure
Upgrade the databases and the Site
Important
Introduction
You can upgrade certain deployments to newer versions without having to rst set up new machines or Sites. T hat process
is called an in-place upgrade. See Upgrade for a list of the versions you can upgrade.
You can also use the current XenApp installer to upgrade a XenApp 6.5 worker server to a current VDA for Windows Server
OS. T his is a supplementary activity to migrating XenApp 6.5. See Upgrade a XenApp 6.5 worker to a new VDA for Windows
Server OS.
To start an upgrade, you run the installer from the new version to upgrade previously installed core components (Delivery
Controller, Citrix Studio, Citrix Director, Citrix License Server) and VDAs. T hen you upgrade the databases and the Site.
Be sure to review all the information in this article before beginning the upgrade.
Upgrade sequence
T he following diagram summarizes the upgrade sequence. Details are provided in Upgrade procedure below. For example, if
you have more than one core component installed on a server, running the installer on that machine will upgrade all
components that have new versions. You might want to upgrade the VDA used in a master image, and then update the
image. T hen, update the catalog that uses that image and the Delivery Group that uses that catalog. Details also cover
how to upgrade the Site databases and the Site automatically or manually.

Which product component versions can be upgraded
Using the product installer, you can upgrade:
Citrix License Server, Studio, and StoreFront

Delivery Controllers 5.6 or later
VDA 5.6 or later
Unlike earlier VDA releases, you must use the product installer to upgrade VDAs; you cannot use MSIs.
If the installer detects Receiver for Windows (Receiver.exe) on the machine, it is upgraded to the Receiver version
included on the product installation media.
VDA 5.6 through VDA 7.8: If the installer detects Receiver for Windows Enterprise (CitrixReceiverEnterprise.exe) on the
machine, it is upgraded to Receiver for Windows Enterprise 3.4.
Director 1 or later
Database: T his Studio action upgrades the schema and migrates data for the Site database (plus the Configuration
Logging and Monitoring databases, if you're upgrading from an earlier 7.x version)
Personal vDisk
Using the guidance in the feature/product documentation, upgrade the following if needed:
Provisioning Services (for XenApp 7.x and XenDesktop 7.x, Citrix recommends using the latest released version; the
minimum supported version is Provisioning Services 7.0).
Upgrade the Provisioning Services server using the server rolling upgrade, and the clients using vDisk versioning.

Provisioning Services 7.x does not support creating new desktops with XenDesktop 5 versions. So, although existing
desktops will continue to work, you cannot use Provisioning Services 7.x to create new desktops until you upgrade
XenDesktop. T herefore, if you plan a mixed environment of XenDesktop 5.6 and 7.x Sites, do not upgrade Provisioning
Services to version 7.
Host hypervisor version.
StoreFront.
Profile Management.
Limits
T he following limits apply to upgrades:
Selective component install
If you install or upgrade any components to the new version but choose not to upgrade other components (on
different machines) that require upgrade, Studio will remind you. For example, let's say an upgrade includes new
versions of the Controller and Studio. You upgrade the Controller but you do not run the installer on the machine
where Studio is installed. Studio will not let you continue to manage the Site until you upgrade Studio.
You do not have to upgrade VDAs, but Citrix recommends upgrading all VDAs to enable you to use all available
features.
XenApp version earlier than 7.5
You cannot upgrade from a XenApp version earlier than 7.5. You can migrate from XenApp 6.x; see Migrate XenApp
6.x.
Although you cannot upgrade a XenApp 6.5 farm, you can replace the XenApp 6.5 software on a Windows Server
2008 R2 machine with a current VDA for Server OS. See Upgrade a XenApp 6.5 worker to a new VDA.
XenDesktop version earlier than 5.6
You cannot upgrade from a XenDesktop version earlier than 5.6.
XenDesktop Express Edition
You cannot upgrade XenDesktop Express edition. Obtain and install a license for a currently supported edition, and
then upgrade it.
Early Release or Technology Preview versions
You cannot upgrade from a XenApp or XenDesktop Early Release or Technology Preview version.
Windows XP/Vista
If you have VDAs installed on Windows XP or Windows Vista machines, see VDAs on machines running Windows XP or
Windows Vista.
Product selection
When you upgrade from an earlier 7.x version, you do not choose or specify the product (XenApp or XenDesktop)

that was set during the initial installation.
Mixed environments/sites
If you must continue to run earlier version Sites and current version Sites, see Mixed environment considerations.
Preparation
Before beginning an upgrade:
Decide which installer and interf ace to use
Use the full-product installer from the XenApp or XenDesktop ISO to upgrade core components. You can upgrade
VDAs using the full-product installer or one of the standalone VDA installers. All installers offer graphical and
command line interfaces. For more information, see Installers.
You cannot upgrade by importing or migrating data from a version that can be upgraded. (Note: Some much earlier
versions must be migrated instead of upgraded; see Upgrade and migrate for a list of which versions can be upgraded.)
If you originally installed a desktop VDA with the VDAWorkstationCoreSetup.exe installer, Citrix recommends using
that installer to upgrade it. If you use the full-product VDA installer or the VDAWorkstationSetup.exe installer to
upgrade the VDA, the components that were originally excluded might be be installed, unless you expressly
omit/exclude them from the upgrade.
For example, if you installed a version 7.13 VDA using VDAWorkstationCoreSetup.exe, and then used the full-product
installer to upgrade that VDA to version 7.14, the components that were excluded from the original installation (such
as Prole management or Personal vDisk) might be installed during the upgrade, if you accept the default settings or
do not use the /exclude command-line option.
Check your Site's health
Ensure the Site is in a stable and functional state before starting an upgrade. If a Site has issues, upgrading will not x
them, and can leave the Site in a complex state that is difcult to recover from. To test the Site, select the Site entry
in the Studio navigation pane. In the Site conguration portion of the middle pane, click Test site.
Back up the Site, monitoring, and Conguration Logging databases
Follow the instructions in CT X135207. If any issues are discovered after the upgrade, you can restore the backup.
Optionally, back up templates and upgrade hypervisors, if needed.
Complete any other preparation tasks dictated by your business continuity plan.
Ensure your Citrix licensing is up to date
Before upgrading the Citrix License Server, be sure your Subscription Advantage date is valid for the new product
version. If you are upgrading from an earlier 7.x product version, the date must be at least 2017.0517.
Close applications and consoles
Before starting an upgrade, close all programs that might potentially cause le locks, including administration consoles

and PowerShell sessions. (Restarting the machine ensures that any le locks are cleared, and that there are no
Windows updates pending.)
Important: Before starting an upgrade, stop and disable any third-party monitoring agent services.
Ensure you have proper permissions
In addition to being a domain user, you must be a local administrator on the machines where you are upgrading
product components.
T he Site database and the Site can be upgraded automatically or manually. For an automatic database upgrade, the
Studio user's permissions must include the ability to update the SQL Server database schema (for example, the
db_securityadmin or db_owner database role). For details, see the Databases article. If the Studio user does not have
those permissions, initiating a manual database upgrade will generate scripts. T he Studio user runs some of the scripts
from Studio; the database administrator runs other scripts using a tool such as SQL Server Management Studio.
Mixed environment considerations

When your environment contains Sites/farms with different product versions (a mixed environment), Citrix recommends
using StoreFront to aggregate applications and desktops from different product versions (for example, if you have a
XenDesktop 7.13 Site and a XenDesktop 7.14 Site). For details, see the StoreFront documentation.
In a mixed environment, continue using the Studio and Director versions for each release, but ensure that different
versions are installed on separate machines.
If you plan to run XenDesktop 5.6 and 7.x Sites simultaneously and use Provisioning Services for both, either deploy a
new Provisioning Services for use with the 7.x Site, or upgrade the current Provisioning Services and be unable to
provision new workloads in the XenDesktop 5.6 Site.
Within each Site, Citrix recommends upgrading all components. Although you can use earlier versions of some components,
all the features in the latest version might not be available. For example, although you can use current VDAs in deployments
containing earlier Controller versions, new features in the current release may not be available. VDA registration issues can
also occur when using non-current versions.
Sites with Controllers at version 5.x and VDAs at version 7.x should remain in that state only temporarily. Ideally, you
should complete the upgrade of all components as soon as possible.
Do not upgrade a standalone Studio version until you are ready to use the new version.
VDAs on machines running Windows XP or Windows

Vista
You cannot upgrade VDAs installed on machines running Windows XP or Windows Vista to a 7.x version. You must use VDA
5.6 FP1 with certain hotxes; see CT X140941 for instructions. Although earlier-version VDAs will run in a 7.x Site, they
cannot use many of its features, including:
Features noted in Studio that require a newer VDA version.

Configuring App-V applications from Studio.

Configuring StoreFront addresses from Studio.
Automatic support for Microsoft Windows KMS licensing when using Machine Creation Services. See CT X128580.
Information in Director:
Logon times and logon end events impacting the logon duration times in the Dashboard, T rends, and User Detail
views.
Logon duration breakdown details for HDX connection and authentication time, plus duration details for profile load,
GPO load, logon script, and interactive session establishment.
Several categories of machine and connection failure rates.
Activity Manager in the Help Desk and User Details views.
Citrix recommends reimaging Windows XP and Windows Vista machines to a supported operating system version and then
installing the latest VDA.
VDAs on machines running Windows 8.x and

Windows 7
To upgrade VDAs installed on machines running Windows 8.x or Window 7 to Windows 10, Citrix recommends reimaging
Windows 7 and Windows 8.x machines to Windows 10 and then installing the supported VDA for Windows 10. If reimaging
is not an option, uninstall the VDA before upgrading the operating system; otherwise, the VDA will be in an unsupported
state.
Mixed VDA support

When you upgrade the product to a later version, Citrix recommends you upgrade all the core components and VDAs so
you can access all the new and enhanced features in your edition.
In some environments, you may not be able to upgrade all VDAs to the most current version. In this scenario, when you
create a machine catalog, you can specify the VDA version installed on the machines. By default, this setting species the
latest recommended VDA version; you need to consider changing this setting only if the machine catalog contains
machines with earlier VDA versions. However, mixing VDA versions in a machine catalog is not recommended.
If a machine catalog is created with the default recommended VDA version setting, and any of the machines in the catalog
has an earlier VDA version installed, those machines will not be able to register with the Controller and will not work.
For more information, see VDA versions and functional levels.
Upgrade procedure
To run the product installer graphical interface, log on to the machine and then insert the media or mount the ISO drive for
the new release. Double-click AutoSelect. To use the command-line interface, see Install using the command line.
Step 1. If more than one core component is installed on the same server (for example, the Controller, Studio, and License
Server) and several of those components have new versions available, they will all be upgraded when you run the installer on
that server.

If any core components are installed on machines other than the Controller, run the installer on each of those machines.
T he recommended order is: License Server, StoreFront, and then Director.
Step 2. If you use Provisioning Services, upgrade the PVS servers and target devices, using the guidance in the Provisioning
Services documentation.
Step 3. Run the product installer on machines containing VDAs. (See Step 12 if you use master images and Machine
Creation Services.)
Step 4 . Run the product installer on half of the Controllers. (T his also upgrades any other core components installed on
those servers.) For example, if your Site has four Controllers, run the installer on two of them.
Leaving half of the Controllers active allows users to access the Site. VDAs can register with the remaining Controllers.
T here may be times when the Site has reduced capacity because fewer Controllers are available. T he upgrade causes
only a brief interruption in establishing new client connections during the final database upgrade steps. T he upgraded
Controllers cannot process requests until the entire Site is upgraded.
If your Site has only one Controller, the Site is inoperable during the upgrade.
Step 5. If Studio is installed on a different machine than one you've already upgraded, run the installer on the machine
where Studio is installed.
Step 6. From the newly upgraded Studio, upgrade the Site database. For details, see Upgrade the databases and the Site.
Step 7. From the newly upgraded Studio, select Citrix Studio site-name in the navigation pane. Select the Common Tasks
tab. Select Upgrade remaining Delivery Controllers.
Step 8. After completing the upgrade and conrming completion, close and then reopen Studio.
Step 9. In the Site Conguration section of the Common Tasks page, select Perf orm registration. Registering the
Controllers makes them available to the Site.
Step 10. After you select Finish when the upgrade completes, you are offered the opportunity to enroll in the Citrix
telemetry programs, which collect information about your deployment. T hat information is used to improve product quality,
reliability, and performance.
Step 11. After upgrading components, the database, and the Site, test the newly-upgraded Site. From Studio, select Citrix
Studio site-name in the navigation pane. Select the Common Tasks tab and then select Test Site. T hese tests were run
automatically after you upgraded the database, but you can run them again at any time.
T he Test Site functionality might fail for a Controller installed on Windows Server 2016, when a local SQL Server
Express is used for the Site database, if the SQL Server Browser service is not started. To avoid this, complete the
following tasks.
1. Enable the SQL Server Browser service (if required) and then start it.
2. Restart the SQL Server (SQLEXPRESS) service.
Step 12. If you use Machine Creation Services and want to use upgraded VDAs: After you upgrade and test the
deployment, update the VDA used in the master images (if you haven't done that already). Update master images that use
those VDAs. See Update or create a new master image. T hen update machine catalogs that use those master images, and
upgrade Delivery Groups that use those catalogs.

Upgrade the databases and the Site
After upgrading the core components and VDAs, use the newly upgraded Studio to initiate an automatic or manual
database and Site upgrade.
Remember: Check the Preparation section above for permission requirements.
For an automatic database upgrade, the Studio user's permissions must include the ability to update the SQL Server
database schema.
For a manual upgrade, the Studio user runs some of the generated scripts from Studio. T he database administrator runs
other scripts, using either the SQLCMD utility or the SQL Server Management Studio in SQLCMD mode. Otherwise,
inaccurate errors can result.
Important: Citrix strongly recommends that you back up the database before upgrading. See CT X135207.
During a database upgrade, product services are disabled. During that time, Controllers cannot broker new connections for
the Site, so plan carefully.
After the database upgrade completes and product services are enabled, Studio tests the environment and conguration,
and then generates an HT ML report. If problems are identied, you can restore the database backup. After resolving issues,
you can upgrade the database again.
Upgrade the database and Site automatically:
Launch the newly upgraded Studio. After you choose to start the Site upgrade automatically and conrm that you are
ready, the database and Site upgrade proceeds.
Upgrade the database and Site manually:
Step 1. Launch the newly-upgraded Studio. After you choose to manually upgrade the Site, the wizard checks for License
Server compatibility and requests conrmation. After you conrm that you have backed up the database, the wizard
generates and displays the scripts and a checklist of upgrade steps.
Step 2. Run the following scripts in the order shown.
Script Description
DisableServices.ps1 PowerShell script to be run by the Studio user on a Controller to disable product
services.
UpgradeSiteDatabase.sql SQL script to be run by the database administrator on the server containing the
Site database.
UpgradeMonitorDatabase.sql SQL script to be run by the database administrator on the server containing the
Monitor database.
UpgradeLoggingDatabase.sql SQL script to be run by the database administrator on the server containing the
Conguration Logging database. Run this script only if this database changes (for
example, after applying a hotx).

EnableServices.ps1 PowerShell script to be run by the Studio user on a Controller to enable product
services.
Step 3. After completing the checklist tasks. click Finish upgrade.

Upgrade a XenApp 6.5 worker to a new VDA
May 22, 20 17
When you run the current product installer on a XenApp 6.5 worker server, it:
Removes the server from the XenApp 6.5 farm (this task automatically invokes the XenApp 6.5 installer's command-line interface)
Removes the XenApp 6.5 software
Installs a new (XenApp 7.6 or later supported release) VDA for Windows Server OS
When you use the installer's graphical interface, you are guided through the same wizard that you used when installing VDAs for Windows
Server OS in your new XenApp Site. Similarly, the command-line interface uses the same commands and parameters you use to install other
VDAs in your new Site.
NOT E: Although you can upgrade a XenApp 6.5 worker server, installing the current VDA software on a clean machine provides better security.
You are probably already familiar with using the installer from installing your XenApp core components and other VDAs. Launch the installer on
the XenApp 6.5 worker server.
Good to know:
This upgrade is valid on XenApp 6.5 servers that are configured in session-host only mode (also called session-only or worker servers).
Uninstalling XenApp 6.5 requires several server restarts. When using the command-line interface, you can use the /noreboot option to inhibit
that automatic action; however, you must restart the server for the uninstallation and subsequent installation to proceed.
If an error occurs during the XenApp uninstallation process, check the uninstall error log referenced in the error message. Uninstall log files
reside in the folder "%TEMP%\Citrix\XenDesktop Installation\XenApp 6.5 Uninstall Log Files\."
After the upgrade, review IMA-specific settings and registry entries, plus HDX-related system settings and registries. Some settings may no
longer apply or might not work in the same way.
After you upgrade the XenApp 6.5 worker servers, from Studio in the new XenApp Site, create Machine Catalogs (or edit existing catalogs)
for the upgraded workers.
If you migrated policy and application settings from a XenApp 6.5 controller server (see Migrate XenApp 6.x), assign the Delivery Groups
containing the migrated published applications to the machine catalog that hosted those applications in XenApp 6.5.
Troubleshooting
Symptoms: Removal of the XenApp 6.5 software fails. T he uninstall log contains the message: "Error 25703. An error
occurred while plugging XML into Internet Information Server. Setup cannot copy files to your IIS Scripts directory. Please
make sure that your IIS installation is correct."
Cause: T he issue occurs on systems where (1) during the initial XenApp 6.5 installation, you indicated that the Citrix XML
Service (CtxHttp.exe) should not share a port with IIS, and (2) .NET Framework 3.5.1 is installed.
Resolution:
1. Remove the Web Server (IIS) role using the Windows Remove Server Roles wizard. (You can reinstall the Web Server
(IIS) role later.)
2. Restart the server.
3. Using Add/Remove Programs, uninstall the following:
1. Citrix XenApp 6.5
2. Microsoft Visual C++ 2005 Redistributable (x64), version 8.0.56336
4. Restart the server.
5. Run the XenApp installer to install the VDA for Windows Server OS.

Migrate XenApp 6.x
May 22, 20 17
Migrate using Citrix Smart Tools

You can use Citrix Smart Migrate as a streamlined alternative to manually using the XenApp 6.x Migration Tool described in this article. (Smart Migrate is a part of Citrix Smart
Tools. See the Smart Migrate documentation.)
T he three-part video series shown below demonstrates the process of using Citrix Smart T ools to migrate from XenApp 6.x to XenApp 7.x.
1 - Create a Migration Project

video length - 2:09 minutes
2 - Connect to Destinations
3 - Analyze the XenApp Farm Settings

XenApp 6.x Migration Tool
T he XenApp 6.x Migration Tool is a collection of PowerShell scripts containing cmdlets that migrate XenApp 6.x (6.0 or 6.5) policy and farm data. On the XenApp 6.x controller
server, you run export cmdlets that gather that data into XML les. T hen, from the XenApp 7.6 Controller, you run import cmdlets that create objects using the data gathered
during the export.
A video overview of the migration tool is available here.

T he following sequence summarizes the migration process; details are provided later.
1. On a XenApp 6.0 or 6.5 controller:
1. Import the PowerShell export modules.
2. Run the export cmdlets to export policy and/or farm data to XML files.
2. Copy the XML files (and icons folder if you chose not to embed them in the XML files during the export) to the XenApp 7.6 Controller.
3. On the XenApp 7.6 Controller:
1. Import the PowerShell import modules.
2. Run the import cmdlets to import policy and/or farm data (applications), using the XML files as input.
4. Complete post-migration steps.
Before you run an actual migration, you can export your XenApp 6.x settings and then perform a preview import on the XenApp 7.6 site. T he preview identies possible failure
points so you can resolve issues before running the actual import. For example, a preview might detect that an application with the same name already exists in the new
XenApp 7.6 site. You can also use the log les generated from the preview as a migration guide.
Unless otherwise noted, the term 6.x refers to XenApp 6.0 or 6.5.
New in this release
T his December 2014 release (version 20141125) contains the following updates:
If you encounter issues using the migration tool on a XenApp 6.x farm, report them to the support forum http://discussions.citrix.com/forum/1411-xenapp-7x/, so that
Citrix can investigate them for potential improvements to the tool.
New packaging - the XAMigration.zip file now contains two separate, independent packages: ReadIMA.zip and ImportFMA.zip. T o export from a XenApp 6.x server, you
need only ReadIMA.zip. T o import to a XenApp 7.6 server, you need only ImportFMA.zip.
T he Export-XAFarm cmdlet supports a new parameter (EmbedIconData) that eliminates the need to copy icon data to separate files.
T he Import-XAFarm cmdlet supports three new parameters:
MatchServer - import applications from servers whose names match an expression
NotMatchServer - import applications from servers whose names do not match an expression
IncludeDisabledApps - import disabled applications
Prelaunched applications are not imported.
T he Export-Policy cmdlet works on XenDesktop 7.x.
Migration Tool package
T he migration tool is available under the XenApp 7.6 Citrix download site. T he XAMigration.zip file contains two separate, independent packages:
ReadIMA.zip - contains the files used to export data from your XenApp 6.x farm, plus shared modules.
Module or f ile Description
ExportPolicy.psm1 PowerShell script module for exporting XenApp 6.x policies to an XML file.
ExportXAFarm.psm1 PowerShell script module for exporting XenApp 6.x farm settings to an XML file.
ExportPolicy.psd1 PowerShell manifest file for script module ExportPolicy.psm1.
ExportXAFarm.psd1 PowerShell manifest file for script module ExportXAFarm.psm1.
LogUtilities.psm1 Shared PowerShell script module that contains logging functions.
XmlUtilities.psd1 PowerShell manifest file for script module XmlUtilities.psm1.
XmlUtilities.psm1 Shared PowerShell script module that contains XML functions.
ImportFMA.zip - contains the files used to import data to your XenApp 7.6 farm, plus shared modules.

Module or f ile Description
ImportPolicy.psm1 PowerShell script module for importing policies to XenApp 7.6.
ImportXAFarm.psm1 PowerShell script module for importing applications to XenApp 7.6
ImportPolicy.psd1 PowerShell manifest file for script module ImportPolicy.psm1.
ImportXAFarm.psd1 PowerShell manifest file for script module ImportXAFarm.psm1.
PolicyData.xsd XML schema for policy data.
XAFarmData.xsd XML schema for XenApp farm data.
LogUtilities.psm1 Shared PowerShell script module that contains logging functions.
XmlUtilities.psd1 PowerShell manifest file for script module XmlUtilities.psm1.
XmlUtilities.psm1 Shared PowerShell script module that contains XML functions.
Limitations
Not all policies settings are imported; see Policy settings not imported. Settings that are not supported are ignored and noted in the log file.
While all application details are collected in the output XML file during the export operation, only server-installed applications are imported into the XenApp 7.6 site.
Published desktops, content, and most streamed applications are not supported (see the Import-XAFarm cmdlet parameters in Step-by-step: import data for exceptions).
Application servers are not imported.
Many application properties are not imported because of differences between the XenApp 6.x Independent Management Architecture (IMA) and the XenApp 7.6 FlexCast
Management Architecture (FMA) technologies; see Application property mapping.
A Delivery Group is created during the import. See Advanced use for details about using parameters to filter what is imported.
Only Citrix policy settings created with the AppCenter management console are imported; Citrix policy settings created with Windows Group Policy Objects (GPOs) are not
imported.
T he migration scripts are intended for migrations from XenApp 6.x to XenApp 7.6 only.
Nested folders greater than five levels deep are not supported by Studio and will not be imported. If your application folder structure includes folders more than five levels
deep, consider reducing the number of nested folder levels before importing.
Security considerations
T he XML les created by the export scripts can contain sensitive information about your environment and organization, such as user names, server names, and other XenApp
farm, application, and policy conguration data. Store and handle these les in secure environments.
Carefully review the XML les before using them as input when importing policies and applications, to ensure they contain no unauthorized modications.
Policy object assignments (previously known as policy lters) control how policies are applied. After importing the policies, carefully review the object assignments for each
policy to ensure that there are no security vulnerabilities resulting from the import. Different sets of users, IP addresses, or client names may be applied to the policy after the
import. T he allow/deny settings may have different meanings after the import.
Logging and error handling
T he scripts provide extensive logging that tracks all cmdlet executions, informative messages, cmdlet execution results, warnings, and errors.
Most Citrix PowerShell cmdlet use is logged. All PowerShell cmdlets in the import scripts that create new site objects are logged.
Script execution progress is logged, including the objects being processed.
Major actions that affect the state of the flow are logged, including flows directed from the command line.
All messages printed to the console are logged, including warnings and errors.
Each line is time-stamped to the millisecond.
Citrix recommends specifying a log le when you run each of the export and import cmdlets.
If you do not specify a log le name, the log le is stored in the current user's home folder (specied in the PowerShell $HOME variable) if that folder exists; otherwise, it is
placed in the script's current execution folder. T he default log name is "XFarmYYYYMMDDHHmmSS-xxxxxx" where the last six digits constitute a random number.
By default, all progress information is displayed. To suppress the display, specify the NoDetails parameter in the export and import cmdlet.
Generally, a script stops execution when an error is encountered, and you can run the cmdlet again after clearing the error conditions.
Conditions that are not considered errors are logged; many are reported as warnings, and script execution continues. For example, unsupported application types are reported
as warnings and are not imported. Applications that already exist in the XenApp 7.6 site are not imported. Policy settings that are deprecated in XenApp 7.6 are not imported.

T he migration scripts use many PowerShell cmdlets, and all possible errors might not be logged. For additional logging coverage, use the PowerShell logging features. For
example, PowerShell transcripts log everything that is printed to the screen. For more information, see the help for the Start-Transcript and Stop-Transcript cmdlets.
Requirements, preparation, and best practices

To migrate, you must use the Citrix XenApp 6.5 SDK. Download that SDK from https://www.citrix.com/downloads/xenapp/sdks/powershell-sdk.html.
Important: Remember to review this entire article before beginning a migration.

You should understand basic PowerShell concepts about execution policy, modules, cmdlets, and scripts. Although extensive scripting expertise is not required, you should understand the cmdlets you
execute. Use the Get-Help cmdlet to review each migration cmdlet's help before executing it. For example:
Get-Help -full Import-XAFarm
Specify a log le on the command line and always review the log le after running a cmdlet. If a script fails, check and x the error identied in the log le and then run the cmdlet again.
Good t o know:
To facilitate application delivery while two deployments are running (the XenApp 6.x farm and the new XenApp 7.6 site), you can aggregate both deployments in StoreFront or Web Interface. See the
eDocs documentation for your StoreFront or Web Interface release (Manage > Create a store).
Application icon data is handled in one of two ways:
If you specify the EmbedIconData parameter in the Export-XAFarm cmdlet, exported application icon data is embedded in the output XML file.
If you do not specify the EmbedIconData parameter in the Export-XAFarm cmdlet, exported application icon data is stored under a folder named by appending the string "-icons" to the base name
of the output XML file. For example, if the XmlOutputFile parameter is "FarmData.xml" then the folder "FarmData-icons" is created to store the application icons.
The icon data les in this folder are .txt les that are named using the browser name of the published application (although the les are .txt les, the stored data is encoded binary icon data,
which can be read by the import script to re-create the application icon). During the import operation, if the icon folder is not found in the same location as the import XML le, generic icons are
used for each imported application.
The names of the script modules, manifest files, shared module, and cmdlets are similar. Use tab completion with care to avoid errors. For example, Export-XAFarm is a cmdlet. ExportXAFarm.psd1
and ExportXAFarm.psm1 are files that cannot be executed.
In the step-by-step sections below, most <string> parameter values show surrounding quotation marks. These are optional for single-word strings.
For export ing f rom t he XenApp 6.x server:

The export must be run on a XenApp 6.x server configured with the controller and session-host (commonly known as controller) server mode.
To run the export cmdlets, you must be a XenApp administrator with permission to read objects. You must also have sufficient Windows permission to run PowerShell scripts; the step-by-step
procedures below contain instructions.
Ensure the XenApp 6.x farm is in a healthy state before beginning an export. Back up the farm database. Verify the farm's integrity using the Citrix IMA Helper utility (CTX133983): from the IMA
Datastore tab, run a Master Check (and then use the DSCheck option to resolve invalid entries). Repairing issues before the migration helps prevent export failures. For example, if a server was
removed improperly from the farm, its data might remain in the database; that could cause cmdlets in the export script to fail (for example, Get-XAServer -ZoneName). If the cmdlets fail, the script
fails.
You can run the export cmdlets on a live farm that has active user connections; the export scripts read only the static farm configuration and policy data.
For import ing t o t he XenApp 7.6 server:

You can import data to XenApp 7.6 deployments (and later supported versions). You must install a XenApp 7.6 Controller and Studio, and create a site before importing the data you exported from
the XenApp 6.x farm. Although VDAs are not required to import settings, they allow application file types to be made available.
To run the import cmdlets, you must be a XenApp administrator with permission to read and create objects. A Full Administrator has these permissions. You must also have sufficient Windows
permission to run PowerShell scripts; the step-by-step procedures below contain instructions.
No other user connections should be active during an import. The import scripts create many new objects, and disruptions may occur if other users are changing the configuration at the same time.
Remember that you can export data and then use the -Preview parameter with the import cmdlets to see what would happen during an actual import, but without actually importing anything. The logs
will indicate exactly what would happen during an actual import; if errors occur, you can resolve them before starting an actual import.
Step-by-step: export data
A video of an export walk-through is available here.
Complete the following steps to export data from a XenApp 6.x controller to XML files.
1. Download the XAMigration.zip migration tool package from the Citrix download site. For convenience, place it on a network file share that can be accessed by both the
XenApp 6.x farm and the XenApp 7.6 site. Unzip XAMigration.zip on the network file share. T here should be two zip files: ReadIMA.zip and ImportFMA.zip.
2. Log on to the XenApp 6.x controller as a XenApp administrator with at least read-only permission and Windows permission to run PowerShell scripts.
3. Copy ReadIMA.zip from the network file share to the XenApp 6.x controller. Unzip and extract ReadIMA.zip on the controller to a folder (for example: C:\XAMigration).
4. Open a PowerShell console and set the current directory to the script location. For example:
cd C:\XAMigration
5. Check the script execution policy by running Get-ExecutionPolicy.
6. Set the script execution policy to at least RemoteSigned to allow the scripts to be executed. For example:
Set-ExecutionPolicy RemoteSigned
7. Import the module definition files ExportPolicy.psd1 and ExportXAFarm.psd1:
Import-Module .\ExportPolicy.psd1
Import-Module .\ExportXAFarm.psd1
Good to know:
If you intend to export only policy data, you can import only the ExportPolicy.psd1 module definition file. Similarly, if you intend to export only farm data, import only
ExportXAFarm.psd1.
Importing the module definition files also adds the required PowerShell snap-ins.
Do not import the .psm1 script files.
8. T o export policy data, run the Export-Policy cmdlet.
Parameter Description
- XML output le name; this le will hold the exported data. Must have an .xml extension. T he le must not exist, but if a path is specied, the parent
XmlOutputFile path must exist.
"<string>.xml"
Default: None; this parameter is required.

-LogFile " Log le name. An extension is optional. T he le is created if it does not exist. If the le exists and the NoClobber parameter is also specied, an error is
<string>" generated; otherwise, the le's content is overwritten.
Default: See Logging and error handling
-NoLog Do not generate log output. T his overrides the LogFile parameter if it is also specied.
Default: False; log output is generated
-NoClobber Do not overwrite an existing log le specied in the LogFile parameter. If the log le does not exist, this parameter has no effect.
Default: False; an existing log le is overwritten
-NoDetails Do not send detailed reports about script execution to the console.
Default: False; detailed reports are sent to the console
-SuppressLogo Do not print the message "XenApp 6.x to XenApp/XenDesktop 7.6 Migration Tool Version #yyyyMMdd-hhmm#" to the console. T his message, which
identies the script version, can be helpful during troubleshooting; therefore, Citrix recommends omitting this parameter.
Default: False; the message is printed to the console
Example: T he following cmdlet exports policy information to the XML file named MyPolicies.xml. T he operation is logged to the file named MyPolicies.log.
Export-Policy -XmlOutputFile " .\MyPolicies.XML"
-LogFile " .\MyPolicies.Log"
9. T o export farm data, run the Export-XAFarm cmdlet, specifying a log file and an XML file.
-XmlOutputFile XML output le name; this le will hold the exported data. Must have an .xml extension. T he le must not exist, but if a path is specied, the parent
"<string>.xml" path must exist.
-LogFile " Log le name. An extension is optional. T he le is created if it does not exist. If the le exists and the NoClobber parameter is also specied, an error
<string>" is generated; otherwise, the le's content is overwritten.
-NoLog Do not generate log output. T his overrides the LogFile parameter if it is also specied.
-SuppressLogo Do not print the message "XenApp 6.x to XenApp/XenDesktop 7.6 Migration Tool Version #yyyyMMdd-hhmm#" to the console. T his message,
which identies the script version, can be helpful during troubleshooting; therefore, Citrix recommends omitting this parameter.
-IgnoreAdmins Do not export administrator information. See Advanced use for how-to-use information.
Default: False; administrator information is exported
-IgnoreApps Do not export application information. See Advanced use for how-to-use information.
Default: False; application information is exported

-IgnoreServers Do not export server information.
Default: False: server information is exported
-IgnoreZones Do not export zone information.
Default: False; zone information is exported.
-IgnoreOthers Do not export information such as conguration logging, load evaluators, load balancing policies, printer drivers, and worker groups.
Default: False; other information is exported
Note: T he purpose of the -IgnoreOthers switch is to allow you to proceed with an export when an error exists that would not affect the actual
data being used for the exporting or importing process.
-AppLimit Number of applications to be exported. See Advanced use for how-to-use information.
<integer>
Default: All applications are exported
- Embed application icon data in the same XML le as the other objects.
EmbedIconData
Default: Icons are stored separately. See Requirements, preparation, and best practices for details
-SkipApps Number of applications to skip. See Advanced use for how-to-use information.
<integer>
Default: No applications are skipped
Example: T he following cmdlet exports farm information to the XML file named MyFarm.xml. T he operation is logged to the file MyFarm.log. A folder named "MyFarm-
icons" is created to store the application icon data files; this folder is at the same location as MyFarm.XML.
Export-XAFarm -XmlOutputFile " .\MyFarm.XML" -LogFile " .\MyFarm.Log"
After the export scripts complete, the XML les specied on the command lines contain the policy and XenApp farm data. T he application icon les contain icon data les, and
the log le indicate what occurred during the export.
Step-by-step: import data
A video of an import walk-through is available here.
Remember that you can run a preview import (by issuing the Import-Policy or Import-XAFarm cmdlet with the Preview parameter) and review the log les before performing an
actual import.
Complete the following steps to import data to a XenApp 7.6 site, using the XML files generating from the export.
1. Log on to the XenApp 7.6 controller as an administrator with read-write permission and Windows permission to run PowerShell scripts.
2. If you have not unzipped the migration tool package XAMigration on the network file share, do so now. Copy ImportFMA.zip from the network file share to the XenApp
7.6 Controller. Unzip and extract ImportFMA.zip on the Controller to a folder (for example: C:\XAMigration).
3. Copy the XML files (the output files generated during the export) from the XenApp 6.x controller to the same location on the XenApp 7.6 Controller where you extracted
the ImportFMA.zip files.
If you chose not to embed the application icon data in the XML output le when you ran the Export-XAFarm cmdlet, be sure to copy the icon data folder and les to the
same location on the XenApp 7.6 controller as the output XML le containing the application data and the extracted ImportFMA.zip les.
4. Open a PowerShell console and set the current directory to the script location.
cd C:\XAMigration
5. Check the script execution policy by running Get-ExecutionPolicy.
6. Set the script execution policy to at least RemoteSigned to allow the scripts to be executed. For example:
7. Import the PowerShell module definition files ImportPolicy.psd1 and ImportXAFarm.psd1:
Import-Module .\ImportPolicy.psd1
Import-Module .\ImportXAFarm.psd1
Good to know:
If you intend to import only policy data, you can import only the ImportPolicy.psd1 module definition file. Similarly, if you intend to import only farm data, import only
ImportXAFarm.psd1.
Importing the module definition files also adds the required PowerShell snap-ins.
Do not import the .psm1 script files.
8. T o import policy data, run the Import-Policy cmdlet, specifying the XML file containing the exported policy data.
-XmlInputFile XML input le name; this le contains data collected from running the Export-Policy cmdlet. Must have an .xml extension.

"<string>.xml" Default: None; this parameter is required.
-XsdFile " XSD le name. T he import scripts use this le to validate the syntax of the XML input le. See Advanced use for how-to-use information.
<string>"
Default: PolicyData.XSD
-LogFile " Log le name. If you copied the export log les to this server, consider using a different log le name with the import cmdlet.
<string>"
-NoLog Do not generate log output. T his overrides the LogFile parameter, if it is also specied.
- Do not print the message "XenApp 6.x to XenApp/XenDesktop 7.6 Migration Tool Version #yyyyMMdd-hhmm#" to the console. T his message, which
SuppressLogo identies the script version, can be helpful during troubleshooting; therefore, Citrix recommends omitting this parameter.
-Preview Perform a preview import: read data from the XML input le, but do not import objects to the site. T he log le and console indicate what occurred
during the preview import. A preview shows administrators what would happen during a real import.
Default: False; a real import occurs
Example: T he folowing cmdlet imports policy data from the XML file named MyPolcies.xml. T he operation is logged to the file named MyPolicies.log.
Import-Policy -XmlInputFile " .\MyPolicies.XML"
-LogFile " .\MyPolicies.Log"
9. T o import applications, run the Import-XAFarm cmdlet, specifying a log file and the XML file containing the exported farm data.
-XmlInputFile " XML input le name; this le contains data collected from running the Export-XAFarm cmdlet. Must have an .xml extension.
<string>.xml"
-XsdFile "<string>" XSD le name. T he import scripts use this le to validate the syntax of the XML input le. See Advanced use for how-to-use information.
Default: XAFarmData.XSD
-LogFile "<string>" Log le name. If you copied the export log les to this server, consider using a different log le name with the import cmdlet.
-NoLog Do not generate log output. T his overrides the LogFile parameter, if it is also specied.
-SuppressLogo Do not print the message "XenApp 6.x to XenApp/XenDesktop 7.6 Migration Tool Version #yyyyMMdd-hhmm#" to the console. T his

message, which identies the script version, can be helpful during troubleshooting; therefore, Citrix recommends omitting this parameter.
-Preview Perform a preview import: read data from the XML input le, but do not import objects to the site. T he log le and console indicate what
occurred during the preview import. A preview shows administrators what would happen during a real import.
Default: False; a real import occurs
-DeliveryGroupName " Delivery Group name for all imported applications. See Advanced use for how-to-use information.
<string>"
Default: "<xenapp-farm-name> - Delivery Group"
-MatchFolder "<string>" Import only those applications in folders with names that match the string. See Advanced use for how-to-use information.
Default: No matching occurs
-NotMatchFolder " Import only those applications in folders with names that do not match the string. See Advanced use for how-to-use information.
<string>"
-MatchServer "<string>" Import only those applications from servers whose names match the string. See Advanced use for how-to-use information.
-NotMatchServer " Import only those applications from servers whose names do not match the string. See Advanced use for how-to-use information.
<string>"
-MatchWorkerGroup " Import only those applications published to worker groups with names that match the string. See Advanced use for how-to-use information.
<string>"
- Import only those applications published to worker groups with names that do not match the string. See Advanced use for how-to-use
NotMatchWorkerGroup information.
"<string>"
-MatchAccount " Import only those applications published to user accounts with names that match the string. See Advanced use for how-to-use information.
<string>"
-NotMatchAccount " Import only those applications published to user accounts with names that do not match the string. See Advanced use for how-to-use
<string>" information.
-IncludeStreamedApps Import applications of type "StreamedToClientOrServerInstalled" . (No other streamed applications are imported.)
Default: Streamed applications are not imported
-IncludeDisabledApps Import applications that have been marked as disabled.
Default: Disabled applications are not imported
Example: T he following cmdlet imports applications from the XML file named MyFarm.xml. T he operation is logged to the file named MyFarm.log.
Import-XAFarm -XmlInputFile " .\MyFarm.XML"
-LogFile " .\MyFarm.Log"
10. After the import completes successfully, complete the post-migration tasks.
Post-migration tasks
After successfully importing XenApp 6.x policies and farm settings into a XenApp 7.6 site, use the following guidance to ensure that the data has been imported correctly.
Policies and policy settings
Importing policies is essentially a copy operation, with the exception of deprecated settings and policies, which are not imported. T he post-migration check essentially
involves comparing the two sides.

1. T he log file lists all the policies and settings imported and ignored. First, review the log file and identify which settings and policies were not imported.
2. Compare the XenApp 6.x policies with the policies imported to XenApp 7.6. T he values of the settings should remain the same (except for deprecated policy settings, as
noted in the next step).
If you have a small number of policies, you can perform a side-by-side visual comparison of the policies displayed in the XenApp 6.x AppCenter and the policies
displayed in the XenApp 7.6 Studio.
If you have a large number of policies, a visual comparison might not be feasible. In such cases, use the policy export cmdlet (Export-Policy) to export the XenApp 7.6
policies to a different XML file, and then use a text diff tool (such as windiff) to compare that files data to the data in the XML file used during the policy export
from XenApp 6.x.
3. Use the information in the Policy settings not imported section to determine what might have changed during the import. If a XenApp 6.x policy contains only
deprecated settings, as a whole policy, it is not imported. For example, if a XenApp 6.x policy contains only HMR test settings, that policy is completely ignored because
there is no equivalent setting supported in XenApp 7.6.
Some XenApp 6.x policy settings are no longer supported, but the equivalent functionality is implemented in XenApp 7.6. For example, in XenApp 7.6, you can congure a
restart schedule for Server OS machines by editing a Delivery Group; this functionality was previously implemented through policy settings.
4. Review and confirm how filters will apply to your XenApp 7.6 site versus their use in XenApp 6.x; significant differences between the XenApp 6.x farm and the XenApp 7.6
site could change the effect of filters.
Filters
Carefully examine the filters for each policy. Changes may be required to ensure they still work in XenApp 7.6 as originally intended in XenApp 6.x.
Filter Considerations
Access Access Control Should contain the same values as the original XenApp 6.x lters and should work without requiring changes.
Control
Citrix A simple Boolean; should work without requiring changes. (T his product is now known as NetScaler SD-WAN.)
CloudBridge
Client IP Lists client IP address ranges; each range is either allowed or denied. T he import script preserves the values, but they may require changes if different
Address clients connect to the XenApp 7.6 VDA machines.
Client Name Similar to the Client IP Address lter, the import script preserves the values, but they may require changes if different clients connect to the XenApp
7.6 VDA machines.
Organizational Values might be preserved, depending on whether or not the OUs can be resolved at the time they are imported. Review this lter closely, particularly if
Unit the XenApp 6.x and XenApp 7.6 machines reside in different domains. If you do not congure the lter values correctly, the policy may be applied to
an incorrect set of OUs.
T he OUs are represented by names only, so there is a small chance that an OU name will be resolved to an OU containing different members from the
OUs in the XenApp 6.x domain. Even if some of the values of the OU lter are preserved, you should carefully review the values.
User or Group Values might be preserved, depending on whether or not the accounts can be resolved at the time they are imported.
Similar to OUs, the accounts are resolved using names only, so if the XenApp 7.6 site has a domain with the same domain and user names, but are
actually two different domains and users, the resolved accounts could be different from the XenApp 6.x domain users. If you do not properly review
and modify the lter values, incorrect policy applications can occur.
Worker Group Worker groups are not supported in XenApp 7.6. Consider using the Delivery Group, Delivery Group T ype, and T ag filters, which are supported in
XenApp 7.6 (not in XenApp 6.x).
Delivery Group: Allows policies to be applied based on Delivery Groups. Each filter entry specifies a Delivery Group and can be allowed or denied.
Delivery Group T ype: Allows policies to be applied based on the Delivery Group types. Each filter specifies a Delivery Group type that can be allowed
or denied.
T ag: Specifies policy application based on tags created for the VDA machines. Each tag can be allowed or denied.
To recap, lters that involve domain user changes require the most attention if the XenApp 6.x farm and the XenApp 7.6 site are in different domains. Because the import
script uses only strings of domain and user names to resolve users in the new domain, some of the accounts might be resolved and others might not. While there is only a
small chance that different domains and users have the same name, you should carefully review these lters to ensure they contain correct values.
Applications
T he application importing scripts do not just import applications; they also create objects such as Delivery Groups. If the application import involves multiple iterations, the
original application folder hierarchies can change significantly.
1. First, read the migration log files that contain details about which applications were imported, which applications were ignored, and the cmdlets that were used to
create the applications.
2. For each application:
Visually check to ensure the basic properties were preserved during the import. Use the information in the Application property mapping section to determine which

properties were imported without change, not imported, or initialized using the XenApp 6.x application data.
Check the user list. T he import script automatically imports the explicit list of users into the application's limit visibility list in XenApp 7.6. Check to ensure that the list
remains the same.
3. Application servers are not imported. T his means that none of the imported applications can be accessed yet. T he Delivery Groups that contain these applications must
be assigned machine catalogs that contain the machines that have the published applications executable images. For each application:
Ensure that the executable name and the working directory point to an executable that exists in the machines assigned to the Delivery Group (through the machine
catalogs).
Check a command line parameter (which may be anything, such as file name, environment variable, or executable name). Verify that the parameter is valid for all the
machines in the machine catalogs assigned to the Delivery Group.
Log f iles
T he log les are the most important reference resources for an import and export. T his is why existing log les are not overwritten by default, and default log le names are
unique.
As noted in the Logging and error handling section, if you chose to use additional logging coverage with the PowerShell Start-Transcript and Stop-Transcript cmdlets
(which record everything typed and printed to the console), that output, together with the log le, provides a complete reference of import and export activity.
Using the time stamps in the log les, you can diagnose certain problems. For example, if an export or import ran for a very long time, you could determine if a faulty
database connection or resolving user accounts took most of the time.
T he commands recorded in the log les also tell you how some objects are read or created. For example, to create a Delivery Group, several commands are executed to not
only create the Delivery Group object itself, but also other objects such as access policy rules that allow application objects to be assigned to the Delivery Group.
T he log le can also be used to diagnose a failed export or import. Typically, the last lines of the log le indicate what caused the failure; the failure error message is also
saved in the log le. Together with the XML le, the log le can be used to determine which object was involved in the failure.
After reviewing and testing the migration, you can:

1. Upgrade your XenApp 6.5 worker servers to current Virtual Delivery Agents (VDAs) by running the 7.6 installer on the server, which removes the XenApp 6.5 software and
then automatically installs a current VDA. See Upgrade a XenApp 6.5 worker to a new VDA for Windows Server OS for instructions.
For XenApp 6.0 worker servers, you must manually uninstall the XenApp 6.0 software from the server. You can then use the 7.6 installer to install the current VDA. You
cannot use the 7.6 installer to automatically remove the XenApp 6.0 software.
2. From Studio in the new XenApp site, create machine catalogs (or edit existing catalogs) for the upgraded workers.
3. Add the upgraded machines from the machine catalog to the Delivery Groups that contain the applications installed on those VDAs for Windows Server OS.
Advanced use
By default, the Export-Policy cmdlet exports all policy data to an XML file. Similarly, Export-XAFarm exports all farm data to an XML file. You can use command line parameters
to more finely control what is exported and imported.
Export applications partially - If you have a large number of applications and want to control how many are exported to the XML file, use the following parameters:
AppLimit - Specifies the number of applications to export.
SkipApps - Specifies the number of applications to skip before exporting subsequent applications.
You can use both of these parameters to export large quantities of applications in manageable chunks. For example, the first time you run Export-XAFarm, you want to
export only the first 200 applications, so you specify that value in the AppLimit parameter.
Export-XAFarm -XmlOutputFile " Apps1-200.xml"
-AppLimit " 200"
T he next time you run Export-XAFarm, you want to export the next 100 applications, so you use the SkipApps parameter to disregard the applications you've already
exported (the first 200), and the AppLimit parameter to export the next 100 applications.
Export-XAFarm -XmlOutputFile " Apps201-300.xml"
-AppLimit " 100" -SkipApps " 200"
Do not export certain objects - Some objects can be ignored and thus do not need to be exported, particularly those objects that are not imported; see Policy settings
not imported and Application property mapping. Use the following parameters to prevent exporting unneeded objects:
IgnoreAdmins - Do not export administrator objects
IgnoreServers - Do not export server objects
IgnoreZones - Do not export zone objects
IgnoreOthers - Do not export configuration logging, load evaluator, load balancing policy, printer driver, and worker group objects
IgnoreApps - Do not export applications; this allows you to export other data to an XML output file and then run the export again to export applications to a different
XML output file.
You can also use these parameters to work around issues that could cause the export to fail. For example, if you have a bad server in a zone, the zone export might fail; if
you include the IgnoreZones parameter, the export continues with other objects.
Delivery Group names - If you do not want to put all of your applications into one Delivery Group (for example, because they are accessed by different sets of users and
published to different sets of servers), you can run Import-XAFarm multiple times, specifying different applications and a different Delivery Group each time. Although you
can use PowerShell cmdlets to move applications from one Delivery Group to another after the migration, importing selectively to unique Delivery Groups can reduce or
eliminate the effort of moving the applications later.
1. Use the DeliveryGroupName parameter with the Import-XAFarm cmdlet. T he script creates the specified Delivery Group if it doesn't exist.
2. Use the following parameters with regular expressions to filter the applications to be imported into the Delivery Group, based on folder, worker group, user account,
and/or server names. Enclosing the regular expression in single or double quotation marks is recommended. For information about regular expressions, see
http://msdn.microsoft.com/en-us/library/hs600312(v=vs.110).aspx.
MatchWorkerGroup and NotMatchWorkerGroup - For example, for applications published to worker groups, the following cmdlet imports applications in the worker

group named "Productivity Apps" to a XenApp 7.6 Delivery Group of the same name:
Import-XAFarm XmlInputFile XAFarm.xml LogFile XAFarmImport.log
MatchWorkerGroup Productivity Apps DeliveryGroupName Productivity Apps
MatchFolder and NotMatchFolder - For example, for applications organized in application folders, the following cmdlet imports applications in the folder named
"Productivity Apps" to a XenApp 7.6 Delivery Group of the same name.
Import-XAFarm XmlInputFile XAFarm.xml LogFile XAFarmImport.log MatchFolder Productivity Apps DeliveryGroupName Productivity Apps
For example, the following cmdlet imports applications in any folder whose name contains "MS Office Apps" to the default Delivery Group.
Import-XAFarm -XmlInputFile .\THeFarmApps.XML -MatchFolder " .*/MS Office Apps/.*"
MatchAccount and NotMatchAccount - For example, for applications published to Active Directory users or user groups, the following cmdlet imports applications
published to the user group named "Finance Group" to a XenApp 7.6 Delivery Group named "Finance."
Import-XAFarm XmlInputFile XAFarm.xml LogFile XAFarmImport.log
MatchAccount DOMAIN\\Finance Group DeliveryGroupName Finance
MatchServer and NotMatchServer - For example, for applications organized on servers, the following cmdlet imports applications associated with the server not
named "Current" to a XenApp Delivery Group named "Legacy."
Import-XAFarm -XmlInputFile XAFarm.xml -LogFile XAFarmImport.log
-NotMatchServer ' Current' -DeliveryGroupName ' Legacy'
Customization - PowerShell programmers can create their own tools. For example, you can use the export script as an inventory tool to keep track of changes in a
XenApp 6.x farm. You can also modify the XSD files or (create your own XSD files) to store additional data or data in different formats in the XML files. You can specify a
nondefault XSD file with each of the import cmdlets.
Note: Although you can modify script files to meet specific or advanced migration requirements, support is limited to the scripts in their unmodified state. Citrix T echnical
Support will recommend reverting to the unmodified scripts to determine expected behavior and provide support, if necessary.
Troubleshooting
If you are using PowerShell version 2.0 and you added the Citrix Group Policy PowerShell Provider snap-in or the Citrix Common Commands snap-in using the Add-PSSnapIn
cmdlet, you might see the error message "Object reference not set to an instance of an object" when you run the export or import cmdlets. T his error does not affect
script execution and can be safely ignored.
Avoid adding or removing the Citrix Group Policy PowerShell Provider snap-in in the same console session where the export and import script modules are used, because
those script modules automatically add the snap-in. If you add or remove the snap-in separately, you might see one of the following errors:
"A drive with the name 'LocalGpo' already exists." T his error appears when the snap-in is added twice; the snap-in attempts to mount the drive LocalGpo when it's
loaded, and then reports the error.
"A parameter cannot be found that matches parameter name 'Controller'." T his error appears when the snap-in has not been added but the script attempts to mount
the drive. T he script is not aware that the snap-in was removed. Close the console and launch a new session. In the new session, import the script modules; do not add or
remove the snap-in separately.
When importing the modules, if you right-click a .psd1 file and select Open or Open with PowerShell, the PowerShell console window will rapidly open and close until you
stop the process. T o avoid this error, enter the complete PowerShell script module name directly in the PowerShell console window (for example, Import-Module
.\ExportPolicy.psd1).
If you receive a permission error when running an export or import, ensure you are a XenApp administrator with permission to read objects (for export) or read and create
objects (for import). You must also have sufficient Windows permission to run PowerShell scripts.
If an export fails, check that the XenApp 6.x farm is in a healthy state by running the DSMAINT and DSCHECK utilities on the XenApp 6.x controller server.
If you run a preview import and then later run the import cmdlets again for an actual migration, but discover that nothing was imported, verify that you removed the
Preview parameter from the import cmdlets.
Policy settings not imported
T he following computer and user policy settings are not imported because they are no longer supported. Please note, unltered policies are never imported. T he features and
components that support these settings have either been replaced by new technologies/components or the settings do not apply because of architectural and platform
changes.
Computer policy settings not imported

Connection access control
CPU management server level
DNS address resolution
Farm name
Full icon caching
Health monitoring, Health monitoring tests
License server host name, License server port
Limit user sessions, Limits on administrator sessions
Load evaluator name
Logging of logon limit events
Maximum percent of servers with logon control
Memory optimization, Memory optimization application exclusion list, Memory optimization interval, Memory optimization schedule: day of month, Memory optimization
schedule: day of week, Memory optimization schedule: time
Offline app client trust, Offline app event logging, Offline app license period, Offline app users
Prompt for password
Reboot custom warning, Reboot custom warning text, Reboot logon disable time, Reboot schedule frequency, Reboot schedule randomization interval, Reboot schedule
start date, Reboot schedule time, Reboot warning interval, Reboot warning start time, Reboot warning to users, Scheduled reboots

Shadowing *
T rust XML requests (configured in StoreFront)
Virtual IP adapter address filtering, Virtual IP compatibility programs list, Virtual IP enhanced compatibility, Virtual IP filter adapter addresses programs list
Workload name
XenApp product edition, XenApp product model
XML service port
* Replaced with Windows Remote Assistance
User policy settings not imported

Auto connect client COM ports, Auto connect client LPT ports
Client COM port redirection, Client LPT port redirection
Client printer names
Concurrent logon limit
Input from shadow connections *
Linger disconnect timer interval, Linger terminate timer interval
Log shadow attempts *
Notify user of pending shadow connections *
Pre-launch disconnect timer interval, Pre-launch terminate timer interval
Session importance
Single Sign-On, Single Sign-On central store
Users who can shadow other users, Users who cannot shadow other users *
* Replaced with Windows Remote Assistance
Application types not imported
T he following application types are not imported.

Server desktops
Content
Streamed applications (App-V is the new method used for streaming applications)
Application property mapping
T he farm data import script imports only applications. T he following application properties are imported without change.
IMA Property FMA Property
AddT oClientDesktop ShortcutAddedT oDesktop
AddT oClientStartMenu ShortcutAddedT oStartMenu
ClientFolder ClientFolder
CommandLineExecutable CommandLineExecutable
CpuPriorityLevel CpuPriorityLevel
Description Description
DisplayName PublishedName
Enabled Enabled
StartMenuFolder StartMenuFolder
WaitOnPrinterCreation WaitForPrinterCreation
WorkingDirectory WorkingDirectory
FolderPath AdminFolderName
Note: IMA and FMA have different restrictions on folder name length. In IMA, the folder name limit is 256 characters; the FMA limit is 64 characters. When importing,
applications with a folder path containing a folder name of more than 64 characters are skipped. T he limit applies only to the folder name in the folder path; the entire folder

path can be longer than the limits noted. T o avoid applications from being skipped during the import, Citrix recommends checking the application folder name length and
shortening it, if needed, before exporting.
T he following application properties are initialized or uninitialized by default, or set to values provided in the XenApp 6.x data:
FMA Property Value
Name Initialized to the full path name, which contains the IMA properties FolderPath and DisplayName, but stripped of the leading string
"Applications\"
ApplicationT ype HostedOnDesktop
CommandLineArguments Initialized using the XenApp 6.x command line arguments
IconFromClient Uninitialized; defaults to false
IconUid Initialized to an icon object created using XenApp 6.x icon data
SecureCmdLineArgumentsEnabled Uninitialized; defaults to true
UserFilterEnabled Uninitialized; defaults to false
UUID Read-only, assigned by the Controller
Visible Uninitialized; defaults to true
T he following application properties are partially migrated:
IMA Comments
Property
FileT ypes Only the file types that exist on the new XenApp site are migrated. File types that do not exist on the new site are ignored. File types are imported only after
the file types on the new site are updated.
IconData New icon objects are created if the icon data has been provided for the exported applications.
Accounts T he user accounts of an application are split between the user list for the Delivery Group and the application. Explicit users are used to initialize the user list
for the application. In addition, the "Domain Users" account for the domain of the user accounts is added to the user list for the Delivery Group.
T he following XenApp 6.x properties are not imported:
IMA Property Comments
ApplicationT ype Ignored.
HideWhenDisabled Ignored.
AccessSessionConditions Replaced by Delivery Group access policies.
AccessSessionConditionsEnabled Replaced by Delivery Group access policies.
ConnectionsT hroughAccessGatewayAllowed Replaced by Delivery Group access policies.
OtherConnectionsAllowed Replaced by Delivery Group access policies.
AlternateProfiles FMA does not support streamed applications.
OfflineAccessAllowed FMA does not support streamed applications.
ProfileLocation FMA does not support streamed applications.
ProfileProgramArguments FMA does not support streamed applications.

IMA Property Comments
ProfileProgramName FMA does not support streamed applications.
RunAsLeastPrivilegedUser FMA does not support streamed applications.
AnonymousConnectionsAllowed FMA uses a different technology to support unauthenticated (anonymous) connections.
ApplicationId, SequenceNumber IMA-unique data.
AudioT ype FMA does not support advanced client connection options.
EncryptionLevel SecureICA is enabled/disabled in Delivery Groups.
EncryptionRequired SecureICA is enabled/disabled in Delivery Groups.
SslConnectionEnabled FMA uses a different T LS implementation.
ContentAddress FMA does not support published content.
ColorDepth FMA does not support advanced window appearances.
MaximizedOnStartup FMA does not support advanced window appearances.
T itleBarHidden FMA does not support advanced window appearances.
WindowsT ype FMA does not support advanced window appearances.
InstanceLimit FMA does not support application limits.
MultipleInstancesPerUserAllowed FMA does not support application limits.
LoadBalancingApplicationCheckEnabled FMA uses a different technology to support load balancing.
PreLaunch FMA uses a different technology to support session prelaunch.
CachingOption FMA uses a different technology to support session prelaunch.
ServerNames FMA uses a different technology.
WorkerGroupNames FMA does not support worker groups.

Secure
May 22, 20 17
XenApp and XenDesktop offer a secure-by-design solution that allows you to tailor your environment to your security
needs.
One security concern IT faces with mobile workers is lost or stolen data. By hosting applications and desktops, XenApp and
XenDesktop securely separate sensitive data and intellectual property from end-point devices by keeping all data in a data
center. When policies are enabled to allow data transfer, all data is encrypted.
T he XenDesktop and XenApp data centers also make incident response easier with a centralized monitoring and
management service. Director allows IT to monitor and analyze data that is being accessed around the network, and
Studio allows IT to patch and remedy most vulnerabilities in the data center instead of xing the problems locally on each
end-user device.
XenApp and XenDesktop also simplify audits and regulatory compliance because investigators can use a centralized audit
trail to determine who accessed what applications and data. Director gathers historical data regarding updates to the
system and user data usage by accessing Conguration Logging and OData API.
Delegated Administration allows you to set up administrator roles to control access to XenDesktop and XenApp at a
granular level. T his allows exibility in your organization to give certain administrators full access to tasks, operations, and
scopes while other administrators have limited access.
XenApp and XenDesktop give administrators granular control over users by applying policies at different levels of the
network - from the local level to the Organizational Unit level. T his control of policies determines if a user, device, or groups
of users and devices can connect, print, copy/paste, or map local drives, which could minimize security concerns with third-
party contingency workers. Administrators can also use the Desktop Lock feature so end users can only use the virtual
desktop while preventing any access to the local operating system of the end-user device.
Administrators can increase security on XenApp or XenDesktop by conguring the Site to use the Transport Layer Security
(T LS) protocol of the Controller or between end users and Virtual Delivery Agents (VDA). T he protocol can also be enabled
on a Site to provide server authentication, data stream encryption, and message integrity checks for a TCP/IP connection.
XenApp and XenDesktop also support multifactor authentication for Windows or a specic application. Multifactor
authentication could also be used to manage all resources delivered by XenApp and XenDesktop. T hese methods include:
T okens
Smart cards
RADIUS
Kerberos
Biometrics
XenDesktop can be integrated with many third-party security solutions, ranging from identity management to antivirus
software. A list of supported products can be found at http://www.citrix.com/ready.
Select releases of XenApp and XenDesktop are certied for Common Criteria standard. For a list of those standards, go to
http://www.commoncriteriaportal.org/cc/.

Security considerations and best practices
May 25, 20 17
T his document describes:
General security best practices when using this release, and any security-related differences between this release and a
conventional computer environment
Manage user accounts
Manage user privileges
Manage logon rights
Configure user rights
Configure service settings
Deployment scenarios and their security implications
Remote PC Access security considerations
Your organization may need to meet specic security standards to satisfy regulatory requirements. T his document does not
cover this subject, because such security standards change over time. For up-to-date information on security standards and
Citrix products, consult http://www.citrix.com/security/.
Security best practices

Keep all machines in your environment up to date with security patches. One advantage is that you can use thin clients as
terminals, which simplies this task.
Protect all machines in your environment with antivirus software.
Consider using platform-specic anti-malware software such as the Microsoft Enhanced Mitigation Experience Toolkit
(EMET ) for Windows machines. Some authorities recommend using the latest Microsoft-supported version of EMET within
their regulated environments. Note that, according to Microsoft, EMET may not be compatible with some software, so it
should be thoroughly tested with your applications before deployment in a production environment. XenApp and
XenDesktop have been tested with EMET 5.5 in its default conguration. Currently, EMET is not recommended for use on a
machine that has a Virtual Delivery Agent (VDA) installed.
Protect all machines in your environment with perimeter rewalls, including at enclave boundaries as appropriate.
If you are migrating a conventional environment to this release, you may need to reposition an existing perimeter rewall or
add new perimeter rewalls. For example, suppose there is a perimeter rewall between a conventional client and database
server in the data center. When this release is used, that perimeter rewall must be placed so that the virtual desktop and
user device are on one side, and the database servers and Delivery Controllers in the data center are on the other side.
T herefore, consider creating an enclave within your data center to contain the database servers and Controllers. Also
consider having protection between the user device and the virtual desktop.
All machines in your environment should be protected by a personal rewall. When you install core components and VDAs,
you can choose to have the ports required for component and feature communication opened automatically if the
Windows Firewall Service is detected (even if the rewall is not enabled). You can also choose to congure those rewall
ports manually. If you use a different rewall, you must congure the rewall manually.

Note: TCP ports 1494 and 2598 are used for ICA and CGP and are therefore likely to be open at rewalls so that users
outside the data center can access them. Citrix recommends that you do not use these ports for anything else, to avoid
the possibility of inadvertently leaving administrative interfaces open to attack. Ports 1494 and 2598 are ofcially
registered with the Internet Assigned Number Authority (http://www.iana.org/).
All network communications should be appropriately secured and encrypted to match your security policy. You can secure
all communication between Microsoft Windows computers using IPSec; refer to your operating system documentation for
details about how to do this. In addition, communication between user devices and desktops is secured through Citrix
SecureICA, which is congured by default to 128-bit encryption. You can congure SecureICA when you are creating or
updating a Delivery Group.
Apply Windows best practice for account management. Do not create an account on a template or image before it is
duplicated by Machine Creation Services or Provisioning Services. Do not schedule tasks using stored privileged domain
accounts. Do not manually create shared Active Directory machine accounts. T hese practices will help prevent a machine
attack from obtaining local persistent account passwords and then using them to log on to MCS/PVS shared images
belonging to others.
Manage user privileges

Grant users only the capabilities they require. Microsoft Windows privileges continue to be applied to desktops in the usual
way: congure privileges through User Rights Assignment and group memberships through Group Policy. One advantage of
this release is that it is possible to grant a user administrative rights to a desktop without also granting physical control over
the computer on which the desktop is stored.
Note the following when planning for desktop privileges:
By default, when non-privileged users connect to a desktop, they see the time zone of the system running the desktop
instead of the time zone of their own user device. For information on how to allow users to see their local time when
using desktops, see the Manage Delivery Groups article.
A user who is an administrator on a desktop has full control over that desktop. If a desktop is a pooled desktop rather
than a dedicated desktop, the user must be trusted in respect of all other users of that desktop, including future users.
All users of the desktop need to be aware of the potential permanent risk to their data security posed by this situation.
T his consideration does not apply to dedicated desktops, which have only a single user; that user should not be an
administrator on any other desktop.
A user who is an administrator on a desktop can generally install software on that desktop, including potentially
malicious software. T he user can also potentially monitor or control traffic on any network connected to the desktop.
Manage logon rights

Logon rights are required for both user accounts and computer accounts. As with Microsoft Windows privileges, logon
rights continue to be applied to desktops in the usual way: congure logon rights through User Rights Assignment and
group memberships through Group Policy.
T he Windows logon rights are: log on locally, log on through Remote Desktop Services, log on over the network (access this
computer from the network), log on as a batch job, and log on as a service.

For computer accounts, grant computers only the logon rights they require. T he logon right "Access this computer from the
network" is required:
At VDAs, for the computer accounts of Delivery Controllers

At Delivery Controllers, for the computer accounts of VDAs. See Active Directory OU-based Controller discovery.
At StoreFront servers, for the computer accounts of other servers in the same StoreFront server group
For user accounts, grant users only the logon rights they require.
According to Microsoft, by default the group Remote Desktop Users is granted the logon right "Allow log on through
Remote Desktop Services" (except on domain controllers).
Your organization's security policy may state explicitly that this group should be removed from that logon right. Consider
the following approach:
T he Virtual Delivery Agent (VDA) for Server OS uses Microsoft Remote Desktop Services. You can configure the Remote
Desktop Users group as a restricted group, and control membership of the group via Active Directory group policies.
Refer to Microsoft documentation for more information.
For other components of XenApp and XenDesktop, including the VDA for Desktop OS, the group Remote Desktop
Users is not required. So, for those components, the group Remote Desktop Users does not require the logon right
"Allow log on through Remote Desktop Services"; you can remove it. Additionally:
If you administer those computers via Remote Desktop Services, ensure that all such administrators are already
members of the Administrators group.
If you do not administer those computers via Remote Desktop Services, consider disabling Remote Desktop Services
itself on those computers.
Although it is possible to add users and groups to the login right "Deny logon through Remote Desktop Services", the use
of deny logon rights is not generally recommended. Refer to Microsoft documentation for more information.
Congure user rights

Delivery Controller installation creates the following Windows services:
Citrix AD Identity Service (NT SERVICE\CitrixADIdentityService): Manages Microsoft Active Directory computer accounts
for VMs.
Citrix Analytics (NT SERVICE\CitrixAnalytics): Collects site configuration usage information for use by Citrix, if this
collection been approved by the site administrator. It then submits this information to Citrix, to help improve the
product.
Citrix App Library (NT SERVICE\CitrixAppLibrary): Supports management and provisioning of AppDisks, AppDNA
integration, and management of App-V.
Citrix Broker Service (NT SERVICE\CitrixBrokerService): Selects the virtual desktops or applications that are available to
users.
Citrix Configuration Logging Service (NT SERVICE\CitrixConfigurationLogging): Records all configuration changes and
other state changes made by administrators to the site.
Citrix Configuration Service (NT SERVICE\CitrixConfigurationService): Site-wide repository for shared configuration.
Citrix Delegated Administration Service (NT SERVICE\CitrixDelegatedAdmin): Manages the permissions granted to
administrators.
Citrix Environment T est Service (NT SERVICE\CitrixEnvT est): Manages self-tests of the other Delivery Controller services.

Citrix Host Service (NT SERVICE\CitrixHostService): Stores information about the hypervisor infrastructures used in a
XenApp or XenDesktop deployment, and also offers functionality used by the console to enumerate resources in a
hypervisor pool.
Citrix Machine Creation Service (NT SERVICE\CitrixMachineCreationService): Orchestrates the creation of desktop VMs.
Citrix Monitor Service (NT SERVICE\CitrixMonitor): Collects metrics for XenApp or XenDesktop, stores historical
information, and provides a query interface for troubleshooting and reporting tools.
Citrix Storefront Service (NT SERVICE\ CitrixStorefront): Supports management of StoreFront. (It is not part of the
StoreFront component itself.)
Citrix Storefront Privileged Administration Service (NT SERVICE\CitrixPrivilegedService): Supports privileged management
operations of StoreFront. (It is not part of the StoreFront component itself.)
Citrix Config Synchronizer Service (NT SERVICE\CitrixConfigSyncService): Propagates configuration data from the main
site databse to the Local Host Cache.
Citrix High Availability Service (NT SERVICE\CitrixHighAvailabilityService): Selects the virtual desktops or applications that
are available to users, when the main site database is unavailable.
Delivery Controller installation also creates the following Windows services. T hese are also created when installed with
other Citrix components:
Citrix Diagnostic Facility COM Server (NT SERVICE\CdfSvc): Supports the collection of diagnostic information for use by
Citrix Support.
Citrix T elemetry Service (NT SERVICE\CitrixT elemetryService): Collects diagnostic information for analysis by Citrix, such
that the analysis results and recommendations can be viewed by administrators to help diagnose issues with the site.
Delivery Controller installation also creates the following Windows service. T his is not currently used. If it has been enabled,
disable it.
Citrix Remote Broker Provider (NT SERVICE\XaXdCloudProxy)
Delivery Controller installation also creates these following Windows services. T hese are not currently used, but must be
enabled. Do not disable them.
Citrix Orchestration Service (NT SERVICE\CitrixOrchestration)

Citrix T rust Service (NT SERVICE\CitrixT rust)
Except for the Citrix Storefront Privileged Administration Service, these services are granted the logon right Log on as a
service and the privileges Adjust memory quotas for a process, Generate security audits, and Replace a process level token.
You do not need to change these user rights. T hese privileges are not used by the Delivery Controller and are automatically
disabled.
Congure service settings

Except for the Citrix Storefront Privileged Administration service and the Citrix Telemetry Service, the Delivery Controller
Windows services listed above in the Congure user rights section are congured to log on as the NET WORK SERVICE
identity. Do not alter these service settings.
T he Citrix Storefront Privileged Administration service is congured to log on Local System (NT AUT HORIT Y\SYST EM). T his
is required for Delivery Controller StoreFront operations that are not normally available to services (including creating
Microsoft IIS sites). Do not alter its service settings.

T he Citrix Telemetry Service is congured to log on as its own service-specic identity.
You can disable the Citrix Telemetry Service. Apart from this service, and services that are already disabled, do not disable
any other of these Delivery Controller Windows services.
Congure registry settings

It is no longer necessary to enable creation of 8.3 le names and folders on the VDA le system. T he registry key
Ntf sDisable8dot3NameCreation can be congured to disable creation of 8.3 le names and folders. You can also
congure this using the f sutil.exe behavior set disable8dot3 command.
Deployment scenario security implications

Your user environment can contain either user devices that are unmanaged by your organization and completely under the
control of the user, or user devices that are managed and administered by your organization. T he security considerations
for these two environments are generally different.
Managed user devices
Managed user devices are under administrative control; they are either under your own control, or the control of another
organization that you trust. You may congure and supply user devices directly to users; alternatively, you may provide
terminals on which a single desktop runs in full-screen-only mode. Follow the general security best practices described
above for all managed user devices. T his release has the advantage that minimal software is required on a user device.
A managed user device can be congured to be used in full-screen-only mode or in window mode:
Full-screen-only mode: Users log on to it with the usual Log On T o Windows screen. T he same user credentials are then
used to log on automatically to this release.
Users see their desktop in a window: Users first log on to the user device, then log on to this release through a web site
supplied with the release.
Unmanaged user devices
User devices that are not managed and administered by a trusted organization cannot be assumed to be under
administrative control. For example, you might permit users to obtain and congure their own devices, but users might not
follow the general security best practices described above. T his release has the advantage that it is possible to deliver
desktops securely to unmanaged user devices. T hese devices should still have basic antivirus protection that will defeat
keylogger and similar input attacks.
Data storage considerations
When using this release, you can prevent users from storing data on user devices that are under their physical control.
However, you must still consider the implications of users storing data on desktops. It is not good practice for users to
store data on desktops; data should be held on le servers, database servers, or other repositories where it can be
appropriately protected.
Your desktop environment may consist of various types of desktops, such as pooled and dedicated desktops. Users should
never store data on desktops that are shared amongst users, such as pooled desktops. If users store data on dedicated

desktops, that data should be removed if the desktop is later made available to other users.
Mixed-version environments
Mixed-version environments are inevitable during some upgrades. Follow best-practice and minimize the time that Citrix
components of different versions co-exist. In mixed-version environments, security policy, for example, may not be
uniformly enforced.
Note: T his is typical of other software products; the use of an earlier version of Active Directory only partially enforces
Group Policy with later versions of Windows.
T he following scenario describes a security issue that can occur in a specic mixed-version Citrix environment. When Citrix
Receiver 1.7 is used to connect to a virtual desktop running the VDA in XenApp and XenDesktop 7.6 Feature Pack 2, the
policy setting Allow le transf er between desktop and client is enabled in the Site but cannot be disabled by a Delivery
Controller running XenApp and XenDesktop 7.1. It does not recognize the policy setting, which was released in the later
version of the product. T his policy setting allows users to upload and download les to their virtual desktop, which is the
security issue. To work around this, upgrade the Delivery Controller (or a standalone instance of Studio) to version 7.6
Feature Pack 2 and then use Group Policy to disable the policy setting. Alternatively, use local policy on all affected virtual
desktops.
Remote PC Access security considerations

Remote PC Access implements the following security features:
Smart card use is supported.

When a remote session connects, the office PC's monitor appears as blank.
Remote PC Access redirects all keyboard and mouse input to the remote session, except CT RL+ALT +DEL and USB-
enabled smart cards and biometric devices.
SmoothRoaming is supported for a single user only.
When a user has a remote session connected to an office PC, only that user can resume local access of the office PC.
T o resume local access, the user presses Ctrl-Alt-Del on the local PC and then logs on with the same credentials used by
the remote session. T he user can also resume local access by inserting a smart card or leveraging biometrics, if your
system has appropriate third-party Credential Provider integration. T his default behavior can be overridden by enabling
Fast User Switching via Group Policy Objects (GPOs) or by editing the registry.
Note: Citrix recommends that you do not assign VDA administrator privileges to general session users.
Automatic assignments
By default, Remote PC Access supports automatic assignment of multiple users to a VDA. In XenDesktop 5.6 Feature Pack
1, administrators could override this behavior using the RemotePCAccess.ps1 PowerShell script. T his release uses a registry
entry to allow or prohibit multiple automatic remote PC assignments; this setting applies to the entire Site.
To restrict automatic assignments to a single user:

On each Controller in the Site, set the following registry entry:
HKEY_LOCAL_MACHINE\Software\Citrix|DesktopServer
Name: AllowMultipleRemotePCAssignments
Type: REG_DWORD
Data: 0 = Disable multiple user assignment, 1 = (Default) Enable multiple user assignment.
If there are any existing user assignments, remove them using SDK commands for the VDA to subsequently be eligible for a
single automatic assignment.
Remove all assigned users from the VDA: $machine.AssociatedUserNames | %{ Remove-BrokerUser-Name $_ -Machine
$machine
Remove the VDA from the Delivery Group: $machine | Remove-BrokerMachine -DesktopGroup $desktopGroup
Restart the physical ofce PC.

Integrate XenApp and XenDesktop with NetScaler
Gateway
May 22, 20 17
StoreFront servers are deployed and congured to manage access to published resources and data. For remote access,
adding NetScaler Gateway in front of StoreFront is recommended.
Note
For detailed conguration steps on how to integrate XenApp and XenDesktop with NetScaler Gateway, see the StoreFront
documentation.
T he following diagram illustrates an example of a Citrix simplied Citrix deployment that includes NetScaler Gateway.
NetScaler Gateway communicates with StoreFront to protect apps and data delivered by XenApp and XenDesktop. T he
user devices run Citrix Receiver to create a secure connection and access their apps, desktops, and les.
Users log on and authenticate using NetScaler Gateway. NetScaler Gateway is deployed and secured in the DMZ. Two-
factor authentication is congured. Based on the user credentials, users are provided with the relevant resources and
applications. Applications and data are on appropriate servers (not shown on the diagram). Separate servers used for
security sensitive applications and data.

May 22, 20 17
T he Delegated Administration model offers the flexibility to match how your organization wants to delegate
administration activities, using role and object-based control. Delegated Administration accommodates deployments of all
sizes, and allows you to configure more permission granularity as your deployment grows in complexity. Delegated
Administration uses three concepts: administrators, roles, and scopes.
Administrators An administrator represents an individual person or a group of people identified by their Active
Directory account. Each administrator is associated with one or more role and scope pairs.
Roles A role represents a job function, and has defined permissions associated with it. For example, the Delivery Group
Administrator role has permissions such as 'Create Delivery Group' and 'Remove Desktop from Delivery Group.' An
administrator can have multiple roles for a Site, so a person could be a Delivery Group Administrator and a Machine
Catalog Administrator. Roles can be built-in or custom.
T he built-in roles are:
Role Permissions
Full Can perform all tasks and operations. A Full Administrator is always combined with the All scope.
Administrator
Read Only Can see all objects in specified scopes as well as global information, but cannot change anything. For
Administrator example, a Read Only Administrator with Scope=London can see all global objects (such as
Configuration Logging) and any London-scoped objects (for example, London Delivery Groups).
However, that administrator cannot see objects in the New York scope (assuming that the London
and New York scopes do not overlap).
Help Desk Can view Delivery Groups, and manage the sessions and machines associated with those groups. Can
Administrator see the Machine Catalog and host information for the Delivery Groups being monitored, and can
also perform session management and machine power management operations for the machines in
those Delivery Groups.
Machine Can create and manage Machine Catalogs and provision the machines into them. Can build Machine
Catalog Catalogs from the virtualization infrastructure, Provisioning Services, and physical machines. T his role
Administrator can manage base images and install software, but cannot assign applications or desktops to users.
Delivery Can deliver applications, desktops, and machines; can also manage the associated sessions. Can also
Group manage application and desktop configurations such as policies and power management settings.
Administrator
Host Can manage host connections and their associated resource settings. Cannot deliver machines,
Administrator applications, or desktops to users.
In certain product editions, you can create custom roles to match the requirements of your organization, and delegate
permissions with more detail. You can use custom roles to allocate permissions at the granularity of an action or task in a
console.
Scopes A scope represents a collection of objects. Scopes are used to group objects in a way that is relevant to your

organization (for example, the set of Delivery Groups used by the Sales team). Objects can be in more than one scope;
you can think of objects being labeled with one or more scopes. T here is one built-in scope: 'All,' which contains all
objects. T he Full Administrator role is always paired with the All scope.
Example
Company XYZ decided to manage applications and desktops based on their department (Accounts, Sales, and Warehouse)
and their desktop operating system (Windows 7 or Windows 8). T he administrator created ve scopes, then labeled each
Delivery Group with two scopes: one for the department where they are used and one for the operating system they use.
T he following administrators were created:
Administrator Roles Scopes
domain/fred Full Administrator All (the Full Administrator role always has the All scope)
domain/rob Read Only Administrator All
domain/heidi Read Only Administrator All
Help Desk Administrator Sales
domain/warehouseadmin Help Desk Administrator Warehouse
domain/peter Delivery Group Administrator Win7
Machine Catalog Administrator
Fred is a Full Administrator and can view, edit, and delete all objects in the system.
Rob can view all objects in the Site but cannot edit or delete them.
Heidi can view all objects and can perform help desk tasks on Delivery Groups in the Sales scope. T his allows her to
manage the sessions and machines associated with those groups; she cannot make changes to the Delivery Group, such
as adding or removing machines.
Anyone who is a member of the warehouseadmin Active Directory security group can view and perform help desk tasks
on machines in the Warehouse scope.
Peter is a Windows 7 specialist and can manage all Windows 7 Machine Catalogs and can deliver Windows 7
applications, desktops, and machines, regardless of which department scope they are in. T he administrator considered
making Peter a Full Administrator for the Win7 scope; however, she decided against this, because a Full Administrator
also has full rights over all objects that are not scoped, such as 'Site' and 'Administrator.'
How to use Delegated Administration
Generally, the number of administrators and the granularity of their permissions depends on the size and complexity of the
deployment.
In small or proof-of-concept deployments, one or a few administrators do everything; there is no delegation. In this case,
create each administrator with the built-in Full Administrator role, which has the All scope.
In larger deployments with more machines, applications, and desktops, more delegation is needed. Several administrators

might have more specific functional responsibilities (roles). For example, two are Full Administrators, and others are Help
Desk Administrators. Additionally, an administrator might manage only certain groups of objects (scopes), such as
machine catalogs. In this case, create new scopes, plus administrators with one of the built-in roles and the appropriate
scopes.
Even larger deployments might require more (or more specific) scopes, plus different administrators with unconventional
roles. In this case, edit or create additional scopes, create custom roles, and create each administrator with a built-in or
custom role, plus existing and new scopes.
For exibility and ease of conguration, you can create new scopes when you create an administrator. You can also specify
scopes when creating or editing Machine Catalogs or connections.
Create and manage administrators
When you create a Site as a local administrator, your user account automatically becomes a Full Administrator with full
permissions over all objects. After a Site is created, local administrators have no special privileges.
T he Full Administrator role always has the All scope; you cannot change this.
By default, an administrator is enabled. Disabling an administrator might be necessary if you are creating the new
administrator now, but that person will not begin administration duties until later. For existing enabled administrators, you
might want to disable several of them while you are reorganizing your object/scopes, then re-enable them when you are
ready to go live with the updated conguration. You cannot disable a Full Administrator if it will result in there being no
enabled Full Administrator. T he enable/disable check box is available when you create, copy, or edit an administrator.
When you delete a role/scope pair while copying, editing, or deleting an administrator, it deletes only the relationship
between the role and the scope for that administrator; it does not delete either the role or the scope, nor does it affect
any other administrator who is congured with that role/scope pair.
T o manage administrators, click Configuration > Administrators in the Studio navigation pane, and then click the
Administrators tab in the upper middle pane.
T o create an administrator, click Create new Administrator in the Actions pane. T ype or browse to the user account
name, select or create a scope, and select a role. T he new administrator is enabled by default; you can change this.
T o copy an administrator, select the administrator in the middle pane and then click Copy Administrator in the Actions
pane. T ype or browse to the user account name. You can select and then edit or delete any of the role/scope pairs, and
add new ones. T he new administrator is enabled by default; you can change this.
T o edit an administrator, select the administrator in the middle pane and then click Edit Administrator in the Actions
pane. You can edit or delete any of the role/scope pairs, and add new ones.
T o delete an administrator, select the administrator in the middle pane and then click Delete Administrator in the Actions
pane. You cannot delete a Full Administrator if it will result in there being no enabled Full Administrator.
Create and manage roles
Role names can contain up to 64 Unicode characters; they cannot contain the following characters: \ (backslash), /
(forward slash), ; (semicolon), : (colon), # (pound sign) , (comma), * (asterisk), ? (question mark), = (equal sign), < (left arrow), >
(right arrow), | (pipe), [ ] (left or right bracket), ( ) (left or right parenthesis), " (quotation marks), and ' (apostrophe).
Descriptions can contain up to 256 Unicode characters.
You cannot edit or delete a built-in role. You cannot delete a custom role if any administrator is using it.
Note: Only certain product editions support custom roles. Editions that do not support custom roles do not have related
entries in the Actions pane.

T o manage roles, click Configuration > Administrators in the Studio navigation pane, and then click the Roles tab in the
upper middle pane.
T o view role details, select the role in the middle pane. T he lower portion of the middle pane lists the object types and
associated permissions for the role. Click the Administrators tab in the lower pane to display a list of administrators who
currently have this role.
T o create a custom role, click Create new Role in the Actions pane. Enter a name and description. Select the object
types and permissions.
T o copy a role, select the role in the middle pane and then click Copy Role in the Actions pane. Change the name,
description, object types, and permissions, as needed.
T o edit a custom role, select the role in the middle pane and then click Edit Role in the Actions pane. Change the name,
description, object types, and permissions, as needed.
T o delete a custom role, select the role in the middle pane and then click Delete Role in the Actions pane. When
prompted, confirm the deletion.
Create and manage scopes
When you create a Site, the only available scope is the 'All' scope, which cannot be deleted.
You can create scopes using the procedure below. You can also create scopes when you create an administrator; each
administrator must be associated with at least one role and scope pair. When you are creating or editing desktops, machine
catalogs, applications, or hosts, you can add them to an existing scope; if you do not add them to a scope, they remain part
of the 'All' scope.
Site creation cannot be scoped, nor can Delegated Administration objects (scopes and roles). However, objects you cannot
scope are included in the 'All' scope. (Full Administrators always have the All scope.) Machines, power actions, desktops, and
sessions are not directly scoped; administrators can be allocated permissions over these objects through the associated
machine catalogs or Delivery Groups.
Scope names can contain up to 64 Unicode characters; they cannot include the following characters: \ (backslash), /
(forward slash), ; (semicolon), : (colon), # (pound sign) , (comma), * (asterisk), ? (question mark), = (equal sign), < (left arrow), >
(right arrow), | (pipe), [ ] (left or right bracket), ( ) (left or right parenthesis), " (quotation marks), and ' (apostrophe).
Descriptions can contain up to 256 Unicode characters.
When you copy or edit a scope, keep in mind that removing objects from the scope can make those objects inaccessible to
the administrator. If the edited scope is paired with one or more roles, ensure that the scope updates you make do not
make any role/scope pair unusable.
T o manage scopes, click Configuration > Administrators in the Studio navigation pane, and then click the Scopes tab in the
upper middle pane.
T o create a scope, click Create new Scope in the Actions pane. Enter a name and description. T o include all objects of a
particular type (for example, Delivery Groups), select the object type. T o include specific objects, expand the type and
then select individual objects (for example, Delivery Groups used by the Sales team).
T o copy a scope, select the scope in the middle pane and then click Copy Scope in the Actions pane. Enter a name and
description. Change the object types and objects, as needed.
T o edit a scope, select the scope in the middle pane and then click Edit Scope in the Actions pane. Change the name,
description, object types, and objects, as needed.
T o delete a scope, select the scope in the middle pane and then click Delete Scope in the Actions pane. When prompted,
confirm the deletion.

Create reports
You can create two types of Delegated Administration reports:

An HT ML report that lists the role/scope pairs associated with an administrator, plus the individual permissions for each
type of object (for example, Delivery Groups and Machine Catalogs). You generate this report from Studio.
To create this report, click Conguration > Administrators in the navigation pane. Select an administrator in the middle
pane and then click Create Report in the Actions pane.
You can also request this report when creating, copying, or editing an administrator.
An HT ML or CSV report that maps all built-in and custom roles to permissions. You generate this report by running a
PowerShell script named OutputPermissionMapping.ps1.
To run this script, you must be a Full Administrator, a Read Only Administrator, or a custom administrator with permission
to read roles. T he script is located in: Program
Files\Citrix\DelegatedAdmin\SnapIn\Citrix.DelegatedAdmin.Admin.V1\Scripts\.
Syntax:
OutputPermissionMapping.ps1 [-Help] [-Csv] [-Path <string>] [-AdminAddress <string>] [-Show] [<CommonParameters>]
-Help Displays script help.
-Csv Specifies CSV output. Default = HT ML
-Path <string> Where to write the output. Default = stdout
-AdminAddress IP address or host name of the Delivery Controller to connect to. Default = localhost
<string>
-Show (Valid only when the -Path parameter is also specified) When you write the output to a file,
-Show causes the output to be opened in an appropriate program, such as a web browser.
<CommonParameters> Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer,

and OutVariable. For details, see the Microsoft documentation.
T he following example writes an HT ML table to a file named Roles.html and opens the table in a web browser.
& " $env:ProgramFiles\Citrix\DelegatedAdmin\SnapIn\
Citrix.DelegatedAdmin.Admin.V1\Scripts\OutputPermissionMapping.ps1"
-Path Roles.html Show
T he following example writes a CSV table to a file named Roles.csv. T he table is not displayed.
& " $env:ProgramFiles\Citrix\DelegatedAdmin\SnapIn\
Citrix.DelegatedAdmin.Admin.V1\Scripts\OutputPermissionMapping.ps1"
CSV -Path Roles.csv
From a Windows command prompt, the preceding example command is:
powershell -command " & ' %ProgramFiles%\Citrix\DelegatedAdmin\SnapIn\
Citrix.DelegatedAdmin.Admin.V1\Scripts\OutputPermissionMapping.ps1'

-CSV -Path Roles.csv"

Smart cards
May 22, 20 17
Smart cards and equivalent technologies are supported within the guidelines described in this article. To use smart cards
with XenApp or XenDesktop:
Understand your organizations security policy concerning the use of smart cards. T hese policies might, for example,
state how smart cards are issued and how users should safeguard them. Some aspects of these policies might need to
be reassessed in a XenApp or XenDesktop environment.
Determine which user device types, operating systems, and published applications are to be used with smart cards.
Familiarize yourself with smart card technology and your selected smart card vendor hardware and software.
Know how to deploy digital certificates in a distributed environment.
Types of smart cards

Enterprise and consumer smart cards have the same dimensions, electrical connectors, and t the same smart card readers.
Smart cards for enterprise use contain digital certicates. T hese smart cards support Windows logon, and can also be used
with applications for digital signing and encryption of documents and e-mail. XenApp and XenDesktop support these uses.
Smart cards for consumer use do not contain digital certicates; they contain a shared secret. T hese smart cards can
support payments (such as a chip-and-signature or chip-and-PIN credit card). T hey do not support Windows logon or typical
Windows applications. Specialized Windows applications and a suitable software infrastructure (including, for example, a
connection to a payment card network) are needed for use with these smart cards. Contact your Citrix representative for
information on supporting these specialized applications on XenApp or XenDesktop.
For enterprise smart cards, there are compatible equivalents that can be used in a similar way.
A smart card-equivalent USB token connects directly to a USB port. T hese USB tokens are usually the size of a USB flash
drive, but can be as small as a SIM card used in a mobile phone. T hey appear as the combination of a smart card plus a
USB smart card reader.
A virtual smart card using a Windows T rusted Platform Module (T PM) appears as a smart card. T hese virtual smart cards
are supported for Windows 8 and Windows 10, using Citrix Receiver minimum 4.3.
Versions of XenApp and XenDesktop earlier than 7.6 FP3 do not support virtual smart cards.
For more information on virtual smart cards, see Virtual Smart Card Overview.
Note: T he term virtual smart card is also used to describe a digital certicate simply stored on the user computer.
T hese digital certicates are not strictly equivalent to smart cards.
XenApp and XenDesktop smart card support is based on the Microsoft Personal Computer/Smart Card (PC/SC) standard
specications. A minimum requirement is that smart cards and smart card devices must be supported by the underlying
Windows operating system and must be approved by the Microsoft Windows Hardware Quality Labs (WHQL) to be used
on computers running qualifying Windows operating systems. See the Microsoft documentation for additional information
about hardware PC/SC compliance. Other types of user devices may comply with the PS/SC standard. For more
information, refer to the Citrix Ready program at http://www.citrix.com/ready/.
Usually, a separate device driver is needed for each vendors smart card or equivalent. However, if smart cards conform to a

standard such as the NIST Personal Identity Verication (PIV) standard, it may be possible to use a single device driver for a
range of smart cards. T he device driver must be installed on both the user device and the Virtual Delivery Agent (VDA). T he
device driver is often supplied as part of a smart card middleware package available from a Citrix partner; the smart card
middleware package will offer advanced features. T he device driver may also be described as a Cryptographic Service
Provider (CSP), Key Storage Provider (KSP), or minidriver.
T he following smart card and middleware combinations for Windows systems have been tested by Citrix as representative
examples of their type. However, other smart cards and middleware can also be used. For more information about Citrix-
compatible smart cards and middleware, see http://www.citrix.com/ready.
Middleware Matching cards
ActivClient 7.0 (DoD mode enabled) DoD CAC card
ActivClient 7.0 in PIV mode NIST PIV card
Microsoft mini driver NIST PIV card
GemAlto Mini Driver for .NET card GemAlto .NET v2+
Microsoft native driver Virtual Smart Cards (T PM)
For information about smart card usage with other types of devices, see the Citrix Receiver documentation for that device.
For more information about PIV usage with XenDesktop, see Conguring Citrix XenDesktop 7.6 and NetScaler Gateway
10.5 with PIV Smart Card Authentication.
For information about smart card usage with other types of devices, see the Citrix Receiver documentation for that device.
Remote PC Access
Smart cards are supported only for remote access to physical ofce PCs running Windows 10, Windows 8 or Windows 7;
smart cards are not supported for ofce PCs running Windows XP.
T he following smart cards were tested with Remote PC Access:
Middleware Matching cards
Gemalto .NET minidriver Gemalto .NET v2+
ActivIdentity ActivClient 6.2 NIST PIV
ActivIdentity ActivClient 6.2 CAC

Microsoft minidriver NIST PIV
Microsoft native driver Virtual smart cards
Types of smart card readers

A smart card reader may be built in to the user device, or be separately attached to the user device (usually via USB or
Bluetooth). Contact card readers that comply with the USB Chip/Smart Card Interface Devices (CCID) specication are
supported. T hey contain a slot or swipe into which the user inserts the smart card. T he Deutsche Kreditwirtschaft
(DK) standard denes four classes of contact card readers.
Class 1 smart card readers are the most common, and usually just contain a slot. Class 1 smart card readers are supported,
usually with a standard CCID device driver supplied with the operating system.
Class 2 smart card readers also contain a secure keypad that cannot be accessed by the user device. Class 2 smart card
readers may be built into a keyboard with an integrated secure keypad. For class 2 smart card readers, contact your Citrix
representative; a reader-specific device driver may be required to enable the secure keypad capability.
Class 3 smart card readers also contain a secure display. Class 3 smart card readers are not supported.
Class 4 smart card readers also contain a secure transaction module. Class 4 smart card readers are not supported.
Note: T he smart card reader class is unrelated to the USB device class.
Smart card readers must be installed with a corresponding device driver on the user device.
For information about supported smart card readers, see the documentation for the Citrix Receiver you are using. In the
Citrix Receiver documentation, supported versions are usually listed in a smart card article or in the system requirements
article.
User experience
Smart card support is integrated into XenApp and XenDesktop, using a specic ICA/HDX smart card virtual channel that is
enabled by default.
Important: Do not use generic USB redirection for smart card readers. T his is disabled by default for smart card readers, and
is not supported if enabled.
Multiple smart cards and multiple readers can be used on the same user device, but if pass-through authentication is in use,
only one smart card must be inserted when the user starts a virtual desktop or application. When a smart card is used within
an application (for example, for digital signing or encryption functions), there might be additional prompts to insert a smart
card or enter a PIN. T his can occur if more than one smart card has been inserted at the same time.
If users are prompted to insert a smart card when the smart card is already in the reader, they should select Cancel.
If users are prompted for the PIN, they should enter the PIN again.
If you are using hosted applications running on Windows Server 2008 or 2008 R2 and with smart cards requiring the
Microsoft Base Smart Card Cryptographic Service Provider, you might nd that if a user runs a smart card transaction, all

other users who use a smart card in the logon process are blocked. For further details and a hotx for this issue,
see http://support.microsoft.com/kb/949538.
You can reset PINs using a card management system or vendor utility.
Before deploying smart cards

Obtain a device driver for the smart card reader and install it on the user device. Many smart card readers can use the
CCID device driver supplied by Microsoft.
Obtain a device driver and cryptographic service provider (CSP) software from your smart card vendor, and install them on
both user devices and virtual desktops. T he driver and CSP software must be compatible with XenApp and XenDesktop;
check the vendor documentation for compatibility. For virtual desktops using smart cards that support and use the
minidriver model, smart card minidrivers should download automatically, but you can obtain them
from http://catalog.update.microsoft.com or from your vendor. Additionally, if PKCS#11 middleware is required, obtain it
from the card vendor.
Important: Citrix recommends that you install and test the drivers and CSP software on a physical computer before
installing Citrix software.
Add the Citrix Receiver for Web URL to the T rusted Sites list for users who work with smart cards in Internet Explorer
with Windows 10. In Windows 10, Internet Explorer does not run in protected mode by default for trusted sites.
Ensure that your public key infrastructure (PKI) is configured appropriately. T his includes ensuring that certificate-to-
account mapping is correctly configured for Active Directory environment and that user certificate validation can be
performed successfully.
Ensure your deployment meets the system requirements of the other Citrix components used with smart cards, including
Citrix Receiver and StoreFront.
Ensure access to the following servers in your Site:
T he Active Directory domain controller for the user account that is associated with a logon certificate on the smart
card
Delivery Controller
Citrix StoreFront
Citrix NetScaler Gateway/Citrix Access Gateway 10.x
VDA
(Optional for Remote PC Access): Microsoft Exchange Server
Enable smart card use

Step 1. Issue smart cards to users according to your card issuance policy.
Step 2. (Optional) Set up the smart cards to enable users for Remote PC Access.
Step 3. Install and congure the Delivery Controller and StoreFront (if not already installed) for smart card remoting.
Step 4 . Enable StoreFront for smart card use. For details, see Congure smart card authentication in
the StoreFront documentation.
Step 5. Enable NetScaler Gateway/Access Gateway for smart card use. For details, see Conguring Authentication and
Authorization and Conguring Smart Card Access with the Web Interface in the NetScaler documentation.

Step 6. Enable VDAs for smart card use.
Ensure the VDA has the required applications and updates.

Install the middleware.
Set up smart card remoting, enabling the communication of smart card data between Citrix Receiver on a user device
and a virtual desktop session.
Step 7. Enable user devices (including domain-joined or non-domain-joined machines) for smart card use. See Congure
smart card authentication in the StoreFront documentation for details.
Import the certificate authority root certificate and the issuing certificate authority certificate into the
device's keystore.
Install your vendor's smart card middleware.
Install and configure Citrix Receiver for Windows, being sure to import icaclient.adm using the Group Policy Management
Console and enable smart card authentication.
Step 8. Test the deployment. Ensure that the deployment is congured correctly by launching a virtual desktop with a test
user's smart card. Test all possible access mechanisms (for example, accessing the desktop through Internet Explorer and
Citrix Receiver).

Smart card deployments
May 22, 20 17
T he following types of smart card deployments are supported by this product version and by mixed environments
containing this version. Other congurations might work but are not supported.
Type StoreFront connectivity
Local domain-joined computers Directly connected
Remote access from domain-joined computers Connected through NetScaler

Gateway
Non-domain-joined computers Directly connected
Remote access from non-domain-joined computers Connected through NetScaler

Gateway
Non-domain-joined computers and thin clients accessing the Desktop Appliance Connected through Desktop
site Appliance sites
Domain-joined computers and thin clients accessing StoreFront through the Connected through XenApp
XenApp Services URL Services URLs
T he deployment types are defined by the characteristics of the user device to which the smart card reader is connected:
Whether the device is domain-joined or non-domain-joined.
How the device is connected to StoreFront.
What software is used to view virtual desktops and applications.
In addition, smart card-enabled applications such as Microsoft Word, and Microsoft Excel can be used in these
deployments. T hose applications allow users to digitally sign or encrypt documents.
Bimodal authentication
Where possible in each of these deployments, Receiver supports bimodal authentication by offering the user a choice
between using a smart card and entering their user name and password. T his is useful if the smart card cannot be used (for
example, the user has left it at home or the logon certicate has expired).
Because users of non-domain-joined devices log on to Receiver for Windows directly, you can enable users to fall back to
explicit authentication. If you congure bimodal authentication, users are initially prompted to log on using their smart
cards and PINs but have the option to select explicit authentication if they experience any issues with their smart cards.
If you deploy NetScaler Gateway, users log on to their devices and are prompted by Receiver for Windows to authenticate
to NetScaler Gateway. T his applies to both domain-joined and non-domain-joined devices. Users can log on to NetScaler
Gateway using either their smart cards and PINs, or with explicit credentials. T his enables you to provide users with bimodal
authentication for NetScaler Gateway logons. Congure pass-through authentication from NetScaler Gateway to
StoreFront and delegate credential validation to NetScaler Gateway for smart card users so that users are silently

authenticated to StoreFront.
Multiple Active Directory f orest considerations
In a Citrix environment, smart cards are supported within a single forest. Smart card logons across forests require a direct
two-way forest trust to all user accounts. More complex multi-forest deployments involving smart cards (that is, where
trusts are only one-way or of different types) are not supported.
You can use smart cards in a Citrix environment that includes remote desktops. T his feature can be installed locally (on the
user device that the smart card is connected to) or remotely (on the remote desktop that the user device connects to).
Smart card removal policy
T he smart card removal policy set on the product determines what happens if you remove the smart card from the reader
during a session. T he smart card removal policy is configured through and handled by the Windows operating system.
Policy setting Desktop behavior
No action No action.
Lock workstation T he desktop session is disconnected and the virtual desktop is locked.
Force logoff T he user is forced to log off. If the network connection is lost and this setting is
enabled, the session may be logged off and the user may lose data.
Disconnect if a remote T he session is disconnected and the virtual desktop is locked.

Terminal Services session
Certicate revocation checking
If certicate revocation checking is enabled and a user inserts a smart card with an invalid certicate into a card reader, the
user cannot authenticate or access the desktop or application related to the certicate. For example, if the invalid
certicate is used for email decryption, the email remains encrypted. If other certicates on the card, such as ones used for
authentication, are still valid, those functions remain active.
Deployment example: domain-joined computers
T his deployment involves domain-joined user devices that run the Desktop Viewer and connect directly to StoreFront.

A user logs on to a device using a smart card and PIN. Receiver authenticates the user to a Storefront server using
Integrated Windows Authentication (IWA). StoreFront passes the user security identiers (SIDs) to XenApp or XenDesktop.
When the user starts a virtual desktop or application, the user is not prompted for a PIN again because the single sign-on
feature is congured on Receiver.
T his deployment can be extended to a double-hop with the addition of a second StoreFront server and a server hosting
applications. A Receiver from the virtual desktop authenticates to the second StoreFront server. Any authentication
method can be used for this second connection. T he conguration shown for the rst hop can be reused in the second
hop or used in the second hop only.
Deployment example: remote access f rom domain-joined computers
T his deployment involves domain-joined user devices that run the Desktop Viewer and connect to StoreFront through
NetScaler Gateway/Access Gateway.
A user logs on to a device using a smart card and PIN, and then logs on again to NetScaler Gateway/Access Gateway. T his
second logon can be with either the smart card and PIN or a user name and password because Receiver allows bimodal
authentication in this deployment.
T he user is automatically logged on to StoreFront, which passes the user security identiers (SIDs) to XenApp or
XenDesktop. When the user starts a virtual desktop or application, the user is not prompted again for a PIN because the
single sign-on feature is congured on Receiver.

Deployment example: non-domain-joined computers
T his deployment involves non-domain-joined user devices that run the Desktop Viewer and connect directly to StoreFront.
A user logs on to a device. Typically, the user enters a user name and password but, since the device is not joined to a
domain, credentials for this logon are optional. Because bimodal authentication is possible in this deployment, Receiver
prompts the user either for a smart card and PIN or a user name and password. Receiver then authenticates to Storefront.
StoreFront passes the user security identiers (SIDs) to XenApp or XenDesktop. When the user starts a virtual desktop or
application, the user is prompted for a PIN again because the single sign-on feature is not available in this deployment.
Deployment example: remote access f rom non-domain-joined computers
T his deployment involves non-domain-joined user devices that run the Desktop Viewer and connect directly to StoreFront.

A user logs on to a device. Typically, the user enters a user name and password but, since the device is not joined to a
domain, credentials for this logon are optional. Because bimodal authentication is possible in this deployment, Receiver
prompts the user either for a smart card and PIN or a user name and password. Receiver then authenticates to Storefront.
StoreFront passes the user security identiers (SIDs) to XenApp or XenDesktop. When the user starts a virtual desktop or
application, the user is prompted for a PIN again because the single sign-on feature is not available in this deployment.
Deployment example: non-domain-joined computers and thin clients accessing the Desktop Appliance site
T his deployment involves non-domain-joined user devices that may run the Desktop Lock and connect to StoreFront
through Desktop Appliance sites.
T he Desktop Lock is a separate component that is released with XenApp, XenDesktop, and VDI-in-a-Box. It is an
alternative to the Desktop Viewer and is designed mainly for repurposed Windows computers and Windows thin clients.
T he Desktop Lock replaces the Windows shell and Task Manager in these user devices, preventing users from accessing the
underlying devices. With the Desktop Lock, users can access Windows Server Machine desktops and Windows Desktop
Machine desktops. Installation of Desktop Lock is optional.
A user logs on to a device with a smart card. If Desktop Lock is running on the device, the device is congured to launch a
Desktop Appliance site through Internet Explorer running in Kiosk Mode. An ActiveX control on the site prompts the user
for a PIN, and sends it to StoreFront. StoreFront passes the user security identiers (SIDs) to XenApp or XenDesktop. T he
rst available desktop in the alphabetical list in an assigned Desktop Group starts.
Deployment example: domain-joined computers and thin clients accessing StoreFront through the XenApp
Services URL
T his deployment involves domain-joined user devices that run the Desktop Lock and connect to StoreFront through

XenApp Services URLs.
T he Desktop Lock is a separate component that is released with XenApp, XenDesktop, and VDI-in-a-Box. It is an
alternative to the Desktop Viewer and is designed mainly for repurposed Windows computers and Windows thin clients.
T he Desktop Lock replaces the Windows shell and Task Manager in these user devices, preventing users from accessing the
underlying devices. With the Desktop Lock, users can access Windows Server Machine desktops and Windows Desktop
Machine desktops. Installation of Desktop Lock is optional.
A user logs on to a device using a smart card and PIN. If Desktop Lock is running on the device, it authenticates the user to
a Storefront server using Integrated Windows Authentication (IWA). StoreFront passes the user security identiers (SIDs) to
XenApp or XenDesktop. When the user starts a virtual desktop, the user is not prompted for a PIN again because the single
sign-on feature is congured on Receiver.

Pass-through authentication and single sign-on with
smart cards
May 22, 20 17
Pass-through authentication
Pass-through authentication with smart cards to virtual desktops is supported on user devices running Windows 10,
Windows 8, and Windows 7 SP1 Enterprise and Professional Editions.
Pass-through authentication with smart cards to hosted applications is supported on servers running Windows Server 2016,
Windows Server 2012 R2, Windows Server 2012, and Windows Server 2008 R2 SP1.
To use pass-through authentication with smart cards hosted applications, ensure you enable the use of Kerberos when you
congure Pass-through with smartcard as the authentication method for the site.
Note: T he availability of pass-through authentication with smart cards depends on many factors including, but not limited
to:
Your organization's security policies regarding pass-through authentication.
Middleware type and configuration.
Smart card reader types.
Middleware PIN caching policy.
Pass-through authentication with smart cards is congured on Citrix StoreFront. See

Congure the authentication service
in the StoreFront documentation for details.
Single sign-on
Single sign-on is a Citrix feature that implements pass-through authentication with virtual desktop and application
launches. You can use this feature in domain-joined, direct-to-StoreFront and domain-joined, NetScaler-to-StoreFront
smart card deployments to reduce the number of times that users enter their PIN. To use single sign-on in these
deployment types, edit the following parameters in the default.ica le, which is located on the StoreFront server:
Domain-joined, direct-to-StoreFront smart card deployments Set DisableCtrlAltDel to Off

Domain-joined, NetScaler-to-StoreFront smart card deployments Set UseLocalUserAndPassword to On
For more instructions on setting these parameters, see the StoreFront or NetScaler Gateway documentation.
T he availability of single sign-on functionality depends on many factors including, but not limited to:
Your organization's security policies regarding single sign-on.

Middleware type and configuration.
Smart card reader types.
Middleware PIN caching policy.
Note: When the user logs on to the Virtual Delivery Agent (VDA) on a machine with an attached smart card reader, a
Windows tile may appear representing the previous successful mode of authentication, such as smart card or password. As
a result, when single sign-on is enabled, the single sign-on tile may appear. T o log on, the user must select Switch Users to
select another tile because the single sign-on tile will not work.

Transport Layer Security (TLS)
May 22, 20 17
Configuring a XenApp or XenDesktop Site to use the T ransport Layer Security (T LS) protocol includes the following
procedures:
Obtain, install, and register a server certificate on all Delivery Controllers, and configure a port with the SSL certificate.
For details, see Install T LS server certificates on Controllers.
Optionally, you can change the ports the Controller uses to listen for HT T P and HT T PS trafc.
Enable T LS connections between users and Virtual Delivery Agents (VDAs) by completing the following tasks:
Configure T LS on the machines where the VDAs are installed. (For convenience, further references to machines where
VDAs are installed are simply called "VDAs.") You can use a PowerShell script supplied by Citrix, or configure it manually.
For general information, see About T LS settings on VDAs. For details, see Configure T LS on a VDA using the
PowerShell script and Manually configure T LS on a VDA.
Configure T LS in the Delivery Groups containing the VDAs by running a set of PowerShell cmdlets in Studio. For
details, see Configure T LS on Delivery Groups.
Requirements and considerations:
Enabling T LS connections between users and VDAs is valid only for XenApp 7.6 and XenDesktop 7.6 Sites, plus later
supported releases.
Configure T LS in the Delivery Groups and on the VDAs after you install components, create a Site, create Machine
Catalogs, and create Delivery Groups.
T o configure T LS in the Delivery Groups, you must have permission to change Controller access rules; a Full
Administrator has this permission.
T o configure T LS on the VDAs, you must be a Windows administrator on the machine where the VDA is installed.
If you intend to configure T LS on VDAs that have been upgraded from earlier versions, uninstall any SSL relay
software on those machines before upgrading them.
T he PowerShell script configures T LS on static VDAs; it does not configure T LS on pooled VDAs that are provisioned
by Machine Creation Services or Provisioning Services, where the machine image resets on each restart.
For tasks that include working in the Windows registry:

For information about enabling T LS to the Site database, see CT X137556.
Note
If both T LS and UDT are enabled at the VDA:
For direct access to the VDA, Citrix Receiver always uses T LS over T CP (not UDP and UDT ).
For indirect access to the VDA using NetScaler Gateway, Citrix Receiver uses DT LS over UDP for communication with NetScaler
Gateway. T he communication between NetScaler Gateway and the VDA uses UDP without DT LS. UDT is used.
Install TLS server certicates on Controllers

For HT T PS, the XML Service supports T LS features through the use of server certicates, not client certicates. To obtain,
install, and register a certicate on a Controller, and to congure a port with the SSL certicate:
If the Controller has IIS installed, follow the guidance in https://technet.microsoft.com/en-

us/library/cc771438%28v=ws.10%29.aspx.
If the Controller does not have IIS installed, one method of conguring the certicate is:
1. Obtain an SSL server certificate and install it on the Controller using the guidance
inhttp://blogs.technet.com/b/pki/archive/2009/08/05/how-to-create-a-web-server-ssl-certificate-manually.aspx. For
information on the certreq tool, see http://technet.microsoft.com/en-us/library/cc736326(WS.10).aspx.
If you intend to use the PowerShell script to congure T LS on VDAs, and unless you intend on specifying the SSL
certicates thumbprint, make sure the certicate is located in the Local Computer > Personal > Certicates area of the
certicate store. If more than one certicate resides in that location, the rst one found will be used.
2. Configure a port with the certificate; see http://msdn.microsoft.com/en-us/library/ms733791%28v=vs.110%29.aspx.
If the Controller is installed on Windows Server 2016, and StoreFront is installed on Windows Server 2012, a conguration
change is needed at the Controller, to change the order of T LS cipher suites.
Note: T his conguration change is not needed for Controller and StoreFront with other combinations of Windows Server
versions.
T he cipher suite order list should include the T LS_ECDHE_RSA_WIT H_AES_256_CBC_SHA384, or

T LS_ECDHE_RSA_WIT H_AES_128_CBC_SHA256 cipher suites (or both); and these cipher suites must precede any
T LS_DHE_ cipher suites.
Note: Windows Server 2012 does not support the GCM ciphersuites T LS_ECDHE_RSA_WIT H_AES_256_GCM_SHA384 or
T LS_ECDHE_RSA_WIT H_AES_128_GCM _SHA256.
Reference - Microsoft MSDN - Prioritizing Schannel Cipher Suites
1. Using the Microsoft Group Policy Editor, browse to Computer Configuration > Administrative T emplates > Network > SSL
Configuration Settings.
2. Edit the policy SSL Cipher Suite Order. By default, this policy is set to Not Configured. Set this policy to Enabled.
3. Arrange suites in the correct order; remove any ciphersuites suites you do not want to use.
Ensure that either T LS_ECDHE_RSA_WIT H_AES_256_CBC_SHA384, or T LS_ECDHE_RSA_WIT H_AES_128_CBC_SHA256

precedes any T LS_DHE_ cipher suites.
Change HTTP or HTTPS ports

By default, the XML Service on the Controller listens on port 80 for HT T P trafc and port 443 for HT T PS trafc. Although
you can use non-default ports, be aware of the security risks of exposing a Controller to untrusted networks. Deploying a
standalone StoreFront server is preferable to changing the defaults.
To change the default HT T P or HT T PS ports used by the Controller, run the following command from Studio:
BrokerService.exe -WIPORT < http-port > -WISSLPORT < https-port >

where <http-port > is the port number for HT T P trafc and <https-port > is the port number for HT T PS trafc.
Note: After changing a port, Studio might display a message about license compatibility and upgrading. To resolve the issue,
re-register service instances using the following PowerShell cmdlet sequence:
Get-CongRegisteredServiceInstance -ServiceType Broker

-Binding XML_HT T PS |
Unregister-CongRegisteredServiceInstance
Get-BrokerServiceInstance | where Binding -eq "XML_HT T PS" |

Register-CongServiceInstance
Enf orce HTTPS traf c only
If you want the XML Service to ignore HT T P trafc, create the following registry setting in
HKLM\Software\Citrix\DesktopServer\ on the Controller and then restart the Broker Service.
To ignore HT T P trafc, create DWORD XmlServicesEnableNonSsl and set it to 0.
T here is a corresponding registry DWORD value you can create to ignore HT T PS trafc: DWORD XmlServicesEnableSsl.
Ensure that it is not set to 0.
TLS settings on VDAs

A Delivery Group cannot have a mixture of some VDAs with T LS congured and some VDAs without T LS congured. When
you congure T LS for a Delivery Group, you should have already congured T LS for all of the VDAs in that Delivery Group
When you congure T LS on VDAs, permissions on the installed SSL certicate are changed, giving the ICA Service read
access to the certicates private key, and informing the ICA Service of the following:
Which certif icate in the certif icate store to use f or TLS.

Which TCP port number to use f or TLS connections.
T he Windows Firewall (if enabled) must be congured to allow incoming connection on this TCP port. T his
conguration is done for you when you use the PowerShell script.
Which versions of the T LS protocol to allow.
Important: Citrix recommends that you review your use of SSLv3, and recongure those deployments to remove
support for SSLv3 where appropriate. See CT X200238.
T he supported T LS protocol versions follow a hierarchy (lowest to highest): SSL 3.0, T LS 1.0, T LS 1.1, and T LS 1.2. You
specify the minimum allowed version; all protocol connections using that version or a higher version are allowed.
For example, if you specify T LS 1.1 as the minimum version, then T LS 1.1 and T LS 1.2 protocol connections are allowed.
If you specify SSL 3.0 as the minimum version, then connections for all the supported versions are allowed. If you
specify T LS 1.2 as the minimum version, only T LS 1.2 connections are allowed.
Which TLS cipher suites to allow.
A cipher suite selects the encryption that will be used for a connection. Clients and VDAs can support different sets

of cipher suites. When a client (Citrix Receiver or StoreFront) connects and sends a list of supported T LS cipher suites,
the VDA matches one of the clients cipher suites with one of the cipher suites in its own list of congured cipher
suites, and accepts the connection. If there is no matching cipher suite, the VDA rejects the connection.
T hree sets of cipher suites (also known as compliance modes) are supported by the VDA: GOV(ernment), COM(mercial),
and ALL. T he acceptable cipher suites also depend on the Windows FIPS mode; see
http://support.microsoft.com/kb/811833 for information about Windows FIPS mode. T he following table lists the
cipher suites in each set:
T LS cipher suite GOV COM ALL GOV COM ALL
FIPS mode Off Off Off On On On
T LS_ECDHE_RSA_WIT H_AES_256_GCM_SHA384 x x x x
T LS_ECDHE_RSA_WIT H_AES_256_CBC_SHA384 x x x x
T LS_RSA_WIT H_AES_256_GCM_SHA384 x x x x
T LS_RSA_WIT H_AES_128_GCM_SHA256 x x x x x x
T LS_RSA_WIT H_AES_256_CBC_SHA256 x x x x
T LS_RSA_WIT H_AES_256_CBC_SHA x x x x
T LS_RSA_WIT H_AES_128_CBC_SHA x x x x
T LS_RSA_WIT H_RC4_128_SHA x x
T LS_RSA_WIT H_RC4_128_MD5 x x
T LS_RSA_WIT H_3DES_EDE_CBC_SHA x x x x
Important: An additional step is necessary when the VDA is on Windows Server 2012 R2, Windows Server 2016, or Windows
10 Anniversary Edition or later supported release. T his affects connections from Citrix Receiver for Windows 4.6 and 4.7.
On the VDA (Windows Server 2016 or Windows 10 Anniversary Edition or later), using the Group Policy Editor, go to
Computer Conguration > Administrative Templates > Network > SSL Conguration Settings > SSL Cipher Suite Order.
Select the following order:

T LS_ECDHE_RSA_WIT H_AES_256_GCM_SHA384_P384
T LS_ECDHE_RSA_WIT H_AES_256_GCM_SHA384_P256
T LS_ECDHE_RSA_WIT H_AES_256_CBC_SHA384_P384
T LS_ECDHE_RSA_WIT H_AES_256_CBC_SHA384_P256
T LS_RSA_WIT H_AES_256_GCM_SHA384
T LS_RSA_WIT H_AES_128_GCM_SHA256
T LS_RSA_WIT H_AES_256_CBC_SHA256
T LS_RSA_WIT H_AES_256_CBC_SHA
T LS_RSA_WIT H_AES_128_CBC_SHA
T LS_RSA_WIT H_RC4_128_SHA
T LS_RSA_WIT H_3DES_EDE_CBC_SHA
Note: T he rst four items also specify the elliptic curve, P384 or P256. Ensure that "curve25519" is not selected. FIPS
Mode does not prevent the use of "curve25519".
When this Group Policy setting is congured, the VDA will select a cipher suite only if appears in both lists: the Group
Policy list and the list for the selected compliance mode (COM, GOV, or ALL). T he cipher suite must also appear in the
list sent by the client (Citrix Receiver or StoreFront).
T his Group Policy conguration also affects other T LS applications and services on the VDA. If your applications
require specic cipher suites, you may need to add them to this Group Policy list.
Congure TLS on a VDA using the PowerShell script
T he Enable-VdaSSL.ps1 script enables or disables the T LS listener on a VDA. T his script is available in the Support >Tools >
SslSupport folder on the installation media.
When you enable T LS, the script disables all existing Windows Firewall rules for the specified T CP port before adding a new
rule that allows the ICA Service to accept incoming connections only on the T LS T CP port. It also disables the Windows
Firewall rules for:
Citrix ICA (default: 1494)
Citrix CGP (default: 2598)
Citrix WebSocket (default: 8008)
T he result is that users can connect only over T LS; they cannot use raw ICA, CGP, or WebSocket to connect.
T he script contains the following syntax descriptions, plus additional examples; you can use a tool such as Notepad++ to
review this information.
You must specify either the Enable or Disable parameter; all other parameters are optional.
Syntax
Enable-VdaSSL {-Enable | -Disable} [ SSLPort <port>] [-SSLMinVersion "<min-ssl-version>"] [-SSLCipherSuite"<suite>"] [-

CerticateT humbPrint "<thumbprint>"]
-Enable Installs and enables the T LS listener on the VDA. Either this parameter or the Disable
parameter is required.

-Disable Disables the T LS listener on the VDA. Either this parameter or the Enable parameter is
required. If you specify this parameter, no other parameters are valid.
SSLPort <port> T LS port. Default: 443
-SSLMinVersion " Minimum T LS protocol version, enclosed in quotation marks. Valid values: "SSL_3.0", "T LS_1.0",
<min-ssl-version>" "T LS_1.1", and "T LS_1.2". Default: "T LS_1.0"
Important: Citrix recommends that customers review their usage of SSLv3 and take steps to
recongure their deployments to remove support for SSLv3 where appropriate. See
CT X200238.
-SSLCipherSuite " T LS cipher suite, enclosed in quotation marks. Valid values: "GOV", "COM", and "ALL". Default:
<suite>" "ALL"
- T humbprint of the SSL certificate in the certificate store, enclosed in quotation marks. T his
CertificateT humbPrint parameter is generally used when the certificate store has multiple certificates; the script uses
"<thumbprint>" the thumbprint to select the certificate you want to use. Default: the first available
certificate found in the Local Computer > Personal > Certificates area of the certificate store.
Examples
T he following script installs and enables the T LS 1.2 protocol version value.
Enable-VdaSSL Enable
T he following script installs and enables the T LS listener, and specifies T LS port 400, the GOV cipher suite, and a minimum
T LS 1.2 protocol value.
Enable-VdaSSL Enable SSLPort 400 ' SSLMinVersion " TLS_1.2"
SSLCipherSuite " GOV"
T he following script disables the T LS listener on the VDA.
Enable-VdaSSL Disable
Manually congure TLS on a VDA
When configuring T LS on a VDA manually, you grant generic read access to the T LS certificate's private key for the
appropriate service on each VDA: NT SERVICE\PorticaService for a VDA for Windows Desktop OS, or NT
SERVICE\T ermService for a VDA for Windows Server OS. On the machine where the VDA is installed:
1. Launch the Microsoft Management Console (MMC): Start > Run > mmc.exe.
2. Add the Certificates snap-in to the MMC:
1. Select File > Add/Remove Snap-in.
2. Select Certificates and then click Add.
3. When prompted with "T his snap-in will always manage certificates for:" choose "Computer account" and then click
Next.
4. When prompted with "Select the computer you want this snap-in to manage" choose "Local computer" and then click
Finish.
3. Under Certificates (Local Computer) > Personal > Certificates, right click the certificate and then select All T asks >
Manage Private Keys.
4. T he Access Control List Editor displays "Permissions for (FriendlyName) private keys" where (FriendlyName) is the name of
your SSL certificate. Add one of the following services and give it Read access:
For a VDA for Windows Desktop OS, "PORT ICASERVICE"

For a VDA for Windows Server OS, "T ERMSERVICE"
5. Double-click the installed SSL certificate. In the certificate dialog, select the Details tab and then scroll to the bottom.
Click T humbprint.
6. Run regedit and go to HKLM\SYST EM\CurrentControlSet\Control\T erminal Server\Wds\icawd.
1. Edit the SSL T humbprint key and copy the value of the SSL certificates thumbprint into this binary value. You can
safely ignore unknown items in the Edit Binary Value dialog box (such as '0000' and special characters).
2. Edit the SSLEnabled key and change the DWORD value to 1. (T o disable SSL later, change the DWORD value to 0.)
3. If you want to change the default settings (optional), use the following in the same registry path:
SSLPort DWORD SSL port number. Default: 443.
SSLMinVersion DWORD 1 = SSL 3.0, 2 = T LS 1.0, 3 = T LS 1.1, 4 = T LS 1.2. Default: 2 (T LS 1.0).
SSLCipherSuite DWORD 1 = GOV, 2 = COM, 3 = ALL. Default: 3 (ALL).
7. Ensure the T LS T CP port is open in the Windows Firewall if it is not the default 443. (When you create the inbound rule
in Windows Firewall, make sure its properties have the "Allow the connection" and "Enabled" entries selected.)
8. Ensure that no other applications or services (such as IIS) are using the T LS T CP port.
9. For VDAs for Windows Server OS, restart the machine for the changes to take effect. (You do not need to restart
machines containing VDAs for Windows Desktop OS.)
Congure TLS on Delivery Groups
Complete this procedure for each Delivery Group that contains VDAs you have configured for T LS connections.
1. From Studio, open the PowerShell console.
2. Run asnp Citrix.* to load the Citrix product cmdlets.
3. Run Get-BrokerAccessPolicyRule -DesktopGroupName '<delivery-group-name>' | Set-BrokerAccessPolicyRule -
HdxSslEnabled $true.
where <delivery-group-name> is the name of the Delivery Group containing VDAs.
4. Run Set-BrokerSite -DnsResolutionEnabled $true.
Troubleshooting
If a connection error occurs, check the VDA's system event log.
When using Receiver for Windows, if you receive a connection error (such as 1030) that indicates an T LS error, disable
Desktop Viewer and then try connecting again; although the connection will still fail, an explanation of the underlying T LS
issue might be provided (for example, you specied an incorrect template when requesting a certicate from the certicate
authority).
Communication between Controller and VDA

Communication between the Controller and the VDA is secured by Windows Communication Framework (WCF) message-
level protection. Additional transport-level protection using T LS is not required. T he WCF conguration uses Kerberos for
mutual authentication between the Controller and VDA. Encryption uses AES in CBC mode with a 256-bit key. Message
integrity uses SHA-1.
According to Microsoft, the Security protocols used by WCF conform to standards from OASIS (Organization for the
Advancement of Structured Information Standards), including WS-SecurityPolicy 1.2. Additionally, Microsoft states that
WCF supports all algorithm suites listed in Security Policy 1.2.

Communication between the Controller and VDA uses the basic256 algorithm suite, whose algorithms are as stated above.
TLS and HTML5 video redirection
HT ML5 video redirection includes support for video content over T LS (HT T PS). To achieve this, custom certicates are
placed in the computer's certicate store on the VDA.
HT ML5 video redirection is disabled by default.
If you do not intend to use HT ML5 video redirection with video content over T LS, Citrix recommends that you delete the
two certicates from the Trusted Root Certicates store on the VDA. T hese certicates are Issued to "Citrix HDX"/Issued
by "Citrix HDX", and Issued to "127.0.0.1"/Issued by "Citrix HDX".
Citrix recommends deleting the les libeay32.dll and ssleay32.dll from the HT ML5 Video Redirection installation folder. T his is
recommended practice even if you do not intend to use HT ML5 video content.
For more information on HT ML5 video redirection, see Multimedia policy settings.

May 22, 20 17
T he Citrix Federated Authentication Service is a privileged component designed to integrate with Active Directory
Certicate Services. It dynamically issues certicates for users, allowing them to log on to an Active Directory environment
as if they had a smart card. T his allows StoreFront to use a broader range of authentication options, such as SAML
(Security Assertion Markup Language) assertions. SAML is commonly used as an alternative to traditional Windows user
accounts on the Internet.
T he following diagram shows the Federated Authentication Service integrating with a Microsoft Certication Authority
and providing support services to StoreFront and XenApp and XenDesktop Virtual Delivery Agents (VDAs).
Trusted StoreFront servers contact the Federated Authentication Service (FAS) as users request access to the Citrix
environment. T he FAS grants a ticket that allows a single XenApp or XenDesktop session to authenticate with a certicate
for that session. When a VDA needs to authenticate a user, it connects to the FAS and redeems the ticket. Only the FAS
has access to the user certicates private key; the VDA must send each signing and decryption operation that it needs to
perform with the certicate to the FAS.
Requirements
T he Federated Authentication Service is supported on Windows servers (Windows Server 2008 R2 or later).
Citrix recommends installing the FAS on a server that does not contain other Citrix components.
T he Windows Server should be secured. It will have access to a registration authority certificate and private key that
allows it to automatically issue certificates for domain users, and it will have access to those user certificates and private

keys.
In the XenApp or XenDesktop Site:
T he Delivery Controllers must be minimum version 7.9.

T he VDAs must be minimum version 7.9. Check that the Federated Authentication Service Group Policy configuration has
been applied correctly to the VDAs before creating the Machine Catalog in the usual way; see the Configure Group
Policy section for details.
T he StoreFront server must be minimum version 3.6 (this is the version provided with the XenApp and XenDesktop 7.9
ISO).
When planning your deployment of this service, review the Security considerations section.
References:
Active Directory Certificate Services
https://technet.microsoft.com/en-us/library/hh831740.aspx
Configuring Windows for Certificate Logon
http://support.citrix.com/article/CT X206156
Install and setup sequence

1. Install the Federated Authentication Service
2. Enable the Federated Authentication Service plug-in on StoreFront servers
3. Configure Group Policy
4. Use the Federated Authentication Service administration console to: (a) Deploy the provided templates, (b) Set up
certificate authorities, and (c) Authorize the Federated Authentication Service to use your certificate authority
5. Configure user rules

For security, Citrix recommends that the FAS be installed on a dedicated server that is secured in a similar way to a domain
controller or certicate authority. T he FAS can be installed from the Federated Authentication Service button on the
autorun splash screen when the ISO is inserted.
T his will install the following components:

PowerShell snap-in cmdlets to remotely configure the Federated Authentication Service
Federated Authentication Service administration console
Federated Authentication Service Group Policy templates (CitrixFederatedAuthenticationService.admx/adml)
Certificate template files for simple certificate authority configuration
Performance counters and event logs

Enable the Federated Authentication Service plug-in
on a StoreFront store
To enable Federated Authentication Service integration on a StoreFront Store, run the following PowerShell cmdlets as an
Administrator account. If you have more than one store, or if the store has a different name, the path text below may
differ.
command COPY
Get -Module "Cit rix.St oreFront .*" -List Available | Import -Module
$St oreVirt ualPat h = "/Cit rix/St ore"
$st ore = Get -STFSt oreService -Virt ualPat h $St oreVirt ualPat h
$aut h = Get -STFAut hent icat ionService -St oreService $st ore
Set -STFClaimsFact oryNames -Aut hent icat ionService $aut h -ClaimsFact oryName "FASClaimsFact ory"
Set -STFSt oreLaunchOpt ions -St oreService $st ore -VdaLogonDat aProvider "FASLogonDat aProvider"
To stop using the FAS, use the following PowerShell script:
command COPY
Get -Module "Cit rix.St oreFront .*" -List Available | Import -Module
$St oreVirt ualPat h = "/Cit rix/St ore"
$st ore = Get -STFSt oreService -Virt ualPat h $St oreVirt ualPat h
$aut h = Get -STFAut hent icat ionService -St oreService $st ore
Set -STFClaimsFact oryNames -Aut hent icat ionService $aut h -ClaimsFact oryName "st andardClaimsFact ory"
Set -STFSt oreLaunchOpt ions -St oreService $st ore -VdaLogonDat aProvider ""
Congure the Delivery Controller

To use the Federated Authentication Service, congure the XenApp or XenDesktop Delivery Controller to trust the
StoreFront servers that can connect to it: run the Set-BrokerSite -TrustRequestsSentToTheXmlServicePort $true
PowerShell cmdlet.
Congure Group Policy

After you install the Federated Authentication Service, you must specify the full DNS addresses of the FAS servers in Group
Policy using the Group Policy templates provided in the installation.
Important: Ensure that the StoreFront servers requesting tickets and the VDAs redeeming tickets have identical
conguration of DNS addresses, including the automatic server numbering applied by the Group Policy object.
For simplicity, the following examples congure a single policy at the domain level that applies to all machines; however, that
is not required. T he FAS will function as long as the StoreFront servers, VDAs, and the machine running the FAS
administration console see the same list of DNS addresses. Note that the Group Policy object adds an index number to
each entry, which must also match if multiple objects are used.
Step 1. On the server where you installed the FAS, locate the C:\Program Files\Citrix\Federated Authentication
Service\PolicyDenitions\CitrixFederatedAuthenticationService.admx le and the en-US folder.
Step 2. Copy these to your domain controller and place them in the C:\Windows\PolicyDenitions and en-US subfolder.
Step 3. Run the Microsoft Management Console (mmc.exe from the command line). From the menu bar, select File >
Add/Remove Snap-in. Add the Group Policy Management Editor.
When prompted for a Group Policy Object, select Browse and then select Def ault Domain Policy. Alternatively, you can
create and select an appropriate policy object for your environment, using the tools of your choice. T he policy must be
applied to all machines running affected Citrix software (VDAs, StoreFront servers, administration tools).

Step 4 . Navigate to the Federated Authentication Service policy located in Computer Conguration/Policies/Administrative
Templates/Citrix Components/Authentication.

Step 5. Open the Federated Authentication Service policy and select Enabled. T his allows you to select the Show button,
where you congure the DNS addresses of your FAS servers.

Step 6. Enter the DNS addresses of the servers hosting your Federated Authentication Service.
Remember: If you enter multiple addresses, the order of the list must be consistent between StoreFront servers and VDAs.
T his includes blank or unused list entries.
Step 7. Click OK to exit the Group Policy wizard and apply the group policy changes. You may need to restart your
machines (or run gpupdate /f orce from the command line) for the change to take effect.
Enable in-session certicate support
T he Group Policy template includes support for conguring the system for in-session certicates. T his places certicates in
the users personal certicate store after logon for application use. For example, if you require T LS authentication to web
servers within the VDA session, the certicate can be used by Internet Explorer. By default, VDAs will not allow access to
certicates after logon.
Using the Federated Authentication Service

administration console
T he Federated Authentication Service administration console is installed as part of the Federated Authentication Service.
An icon (Citrix Federated Authentication Service) is placed in the Start Menu.
T he console attempts to automatically locate the FAS servers in your environment using the Group Policy conguration. If
this fails, see the Congure Group Policy section.

If your user account is not a member of the Administrators group on the machine running the Federated Authentication
Service, you will be prompted for credentials.
T he rst time the administration console is used, it guides you through a three-step process that deploys certicate
templates, sets up the certicate authority, and authorizes the Federated Authentication Service to use the certicate
authority. Some of the steps can alternatively be completed manually using OS conguration tools.

Deploy certicate templates
To avoid interoperability issues with other software, the Federated Authentication Service provides three Citrix certicate
templates for its own use.
Citrix_RegistrationAuthority_ManualAuthorization
Citrix_RegistrationAuthority
Citrix_SmartcardLogon
T hese templates must be registered with Active Directory. If the console cannot locate them, the Deploy certicate
templates tool can install them. T his tool must be run as an account that has permissions to administer your Enterprise
forest.
T he conguration of the templates can be found in the XML les with extension .certicatetemplate that are installed

with the Federated Authentication Service in:
C:\Program Files\Citrix\Federated Authentication Service\CerticateTemplates
If you do not have permission to install these template les, give them to your Active Directory Administrator.
To manually install the templates, you can use the following PowerShell commands:
command COPY
$t emplat e = [Syst em.IO.File]::ReadAllByt es("$Pwd\Cit rix_Smart cardLogon.cert icat et emplat e")
$Cert Enrol = New-Object -ComObject X509Enrollment .CX509Enrollment PolicyWebService
$Cert Enrol.Init ializeImport ($t emplat e)
$comt emplat e = $Cert Enrol.Get Templat es().It emByIndex(0)
$writ ablet emplat e = New-Object -ComObject X509Enrollment .CX509Cert icat eTemplat eADWrit able
$writ ablet emplat e.Init ialize($comt emplat e)
$writ ablet emplat e.Commit (1, $NULL)
Set up Active Directory Certicate Services

After installing the Citrix certicate templates, they must be published on one or more Microsoft Certication Authority
servers. Refer to the Microsoft documentation on how to deploy Active Directory Certicate Services.
If the templates are not published on at least one server, the Setup certicate authority tool offers to publish them. You
must run this tool as a user that has permissions to administer the certicate authority.
(Certicate templates can also be published using the Microsoft Certication Authority console.)

Authorize the Federated Authentication Service
T he nal setup step in the console initiates the authorization of the Federated Authentication Service. T he administration
console uses the Citrix_RegistrationAuthority_ManualAuthorization template to generate a certicate request, and then
sends it to one of the certicate authorities that publish that template.
After the request is sent, it appears in the Pending Requests list of the Microsoft Certication Authority console. T he
certicate authority administrator must choose to Issue or Deny the request before conguration of the Federated
Authentication Service can continue. Note that the authorization request appears as a Pending Request from the FAS
machine account.

Right-click All Tasks and then select Issue or Deny for the certicate request. T he Federated Authentication Service
administration console automatically detects when this process completes. T his can take a couple of minutes.
Congure user rules

A user rule authorizes the issuance of certicates for VDA logon and in-session use, as directed by StoreFront. Each rule
species the StoreFront servers that are trusted to request certicates, the set of users for which they can be requested,
and the set of VDA machines permitted to use them.
To complete the setup of the Federated Authentication Service, the administrator must dene the default rule by

switching to the User Rules tab of the FAS administration console, selecting a certicate authority to which the
Citrix_SmartcardLogon template is published, and editing the list of StoreFront servers. T he list of VDAs defaults to Domain
Computers and the list of users defaults to Domain Users; these can be changed if the defaults are inappropriate.
Fields:
Certicate Authority and Certicate Template: T he certicate template and certicate authority that will be used to
issue user certicates. T his should be the Citrix_SmartcardLogon template, or a modied copy of it, on one of the
certicate authorities that the template is published to.
T he FAS supports adding multiple certicate authorities for failover and load balancing, using PowerShell commands.
Similarly, more advanced certicate generation options can be congured using the command line and conguration les.
See the PowerShell and Hardware security modules sections.
In-Session Certicates: T he Available af ter logon check box controls whether a certicate can also be used as an in-
session certicate. If this check box is not selected, the certicate will be used only for logon or reconnection, and the user
will not have access to the certicate after authenticating.
List of StoreFront servers that can use this rule: T he list of trusted StoreFront server machines that are authorized to
request certicates for logon or reconnection of users. Note that this setting is security critical, and must be managed
carefully.

List of VDA desktops and servers that can be logged into by this rule: T he list of VDA machines that can log users on
using the Federated Authentication Service system.
List of users that StoreFront can log in using this rule: T he list of users who can be issued certicates through the
Federated Authentication Service.

Advanced use
You can create additional rules to reference different certicate templates and authorities, which may be congured to
have different properties and permissions. T hese rules can be congured for use by different StoreFront servers, which will
need to be congured to request the new rule by name. By default, StoreFront requests def ault when contacting the
Federated Authentication Service. T his can be changed using the Group Policy Conguration options.
To create a new certicate template, duplicate the Citrix_SmartcardLogon template in the Microsoft Certication
Authority console, rename it (for example, Citrix_SmartcardLogon2), and modify it as required. Create a new user rule by
clicking Add to reference the new certicate template.
T he Federated Authentication Service has a registration authority certicate that allows it to issue certicates
autonomously on behalf of your domain users. As such, it is important to develop and implement a security policy to
protect the the FAS servers, and to constrain their permissions.
Delegated Enrollment Agents
T he Microsoft Certication Authority allows control of which templates the FAS server can use, as well as limiting which
users the FAS server can issue certicates for.

Citrix strongly recommends conguring these options so that the Federated Authentication Service can only issue
certicates for the intended users. For example, it is good practice to prevent the Federated Authentication Service from
issuing certicates to users in an Administration or Protected Users group.
Access Control List conguration
As described in the Congure user roles section, you must congure a list of StoreFront servers that are trusted to assert
user identities to the Federated Authentication Service when certicates are issued. Similarly, you can restrict which users
will be issued certicates, and which VDA machines they can authenticate to. T his is in addition to any standard Active
Directory or certicate authority security features you congure.
Firewall settings
All communication to FAS servers uses mutually authenticated Windows Communication Foundation (WCF) Kerberos
network connections over port 80.
Event log monitoring
T he Federated Authentication Service and the VDA write information to the Windows Event Log. T his can be used for
monitoring and auditing information. T he Event logs section lists event log entries that may be generated.
Hardware security modules
All private keys, including those of user certicates issued by the Federated Authentication Service, are stored as non-
exportable private keys by the Network Service account. T he Federated Authentication Service supports the use of a
cryptographic hardware security module, if your security policy requires it.
Low-level cryptographic conguration is available in the FederatedAuthenticationService.exe.cong le. T hese settings

apply when private keys are rst created. T herefore, different settings can be used for registration authority private keys
(for example, 4096 bit, T PM protected) and runtime user certicates.

ProviderLegacyCsp When set to true, FAS will use the Microsoft CryptoAPI (CAPI). Otherwise, FAS will use
the Microsoft Cryptography Next Generation API (CNG).
ProviderName Name of the CAPI or CNG provider to use.
ProviderType Refers to Microsoft KeyContainerPermissionAccessEntry.ProviderType Property

PROV_RSA_AES 24. Should always be 24 unless you are using an HSM with CAPI and
the HSM vendor species otherwise.
KeyProtection Controls the Exportable ag of private keys. Also allows the use of Trusted Platform
Module (T PM) key storage, if supported by the hardware.
KeyLength Key length for RSA private keys. Supported values are 1024, 2048 and 4096 (default:
2048).
PowerShell SDK
Although the Federated Authentication Service administration console is suitable for simple deployments, the PowerShell
interface offers more advanced options. When you are using options that are not available in the console, Citrix
recommends using only PowerShell for conguration.
T he following command adds the PowerShell cmdlets:
Add-PSSnapin Citrix.Authentication.FederatedAuthenticationService.V1
Use Get-Help <cmdlet name> to display cmdlet help. T he following table lists several commands where * represents a
standard PowerShell verb (such as New, Get, Set, Remove).
Commands Overview
*-FasServer Lists and recongures the FAS servers in the current environment.
*-FasAuthorizationCerticate Manages the Registration Authority certicate.
*-FasCerticateDenition Controls the parameters that the FAS uses to generate certicates.
*-FasRule Manages User Rules congured on the Federated Authentication Service.
*-FasUserCerticate Lists and manages certicates cached by the Federated Authentication Service.

PowerShell cmdlets can be used remotely by specifying the address of a FAS server.
You can also download a zip le containing all the FAS PowerShell cmdlet help les; see the PowerShell SDK article.
Performance counters
T he Federated Authentication Service includes a set of performance counters for load tracking purposes.
T he following table lists the available counters. Most counters are rolling averages over ve minutes.
Name Description
Active Sessions Number of connections tracked by the Federated Authentication Service.
Concurrent CSRs Number of certicate requests processed at the same time.
Private Key ops Number of private key operations performed per minute.

Request time Length of time to generate and sign a certicate.
Certicate Count Number of certicates cached in the Federated Authentication Service.
CSR per minute Number of CSRs processed per minute.
Low/Medium/High Estimates of the load that the Federated Authentication Service can accept in terms of
CSRs per minute. Exceeding the High Load threshold may result in session launches
failing.
Event logs
T he following tables list the event log entries generated by the Federated Authentication Service.
Administration events
[Event Source: Citrix.Authentication.FederatedAuthenticationService]
T hese events are logged in response to a conguration change in the Federated Authentication Service server.
Log Codes
[S001] ACCESS DENIED: User [{0}] is not a member of Administrators group
[S002] ACCESS DENIED: User [{0}] is not an Administrator of Role [{1}]
[S003] Administrator [{0}] setting Maintenance Mode to [{1}]
[S004] Administrator [{0}] enrolling with CA [{1}] templates [{2} and {3}]
[S005] Administrator [{0}] de-authorizing CA [{1}]
[S006] Administrator [{0}] creating new Certicate Denition [{1}]
[S007] Administrator [{0}] updating Certicate Denition [{1}]
[S008] Administrator [{0}] deleting Certicate Denition [{1}]
[S009] Administrator [{0}] creating new Role [{1}]

[S010] Administrator [{0}] updating Role [{1}]
[S011] Administrator [{0}] deleting Role [{1}]
[S012] Administrator [{0}] creating certicate [upn: {0} sid: {1} role: {2}][Certicate Denition: {3}]
[S013] Administrator [{0}] deleting certicates [upn: {0} role: {1} Certicate Denition: {2}]
Log Codes
[S401] Performing conguration upgrade -- [From version {0}][to version {1}]
[S402] ERROR: T he Citrix Federated Authentication Service must be run as Network Service [currently running as: {0}]
Creating identity assertions [Federated Authentication Service]
T hese events are logged at runtime on the Federated Authentication Service server when a trusted server asserts a user
logon.
Log Codes
[S101] Server [{0}] is not authorized to assert identities in role [{1}]
[S102] Server [{0}] failed to assert UPN [{1}] (Exception: {2}{3})
[S103] Server [{0}] requested UPN [{1}] SID {2}, but lookup returned SID {3}
[S104] Server [{0}] failed to assert UPN [{1}] (UPN not allowed by role [{2}])
[S105] Server [{0}] issued identity assertion [upn: {0}, role {1}, Security Context: [{2}]
[S120] Issuing certicate to [upn: {0} role: {1} Security Context: [{2}]]
[S121] Issuing certicate to [upn: {0} role: {1}] on behalf of account {2}

[S122] Warning: Server is overloaded [upn: {0} role: {1}][Requests per minute {2}].
Acting as a relying party [Federated Authentication Service]
T hese events are logged at runtime on the Federated Authentication Service server when a VDA logs on a user.
Log Codes
[S201] Relying party [{0}] does not have access to a password.
[S202] Relying party [{0}] does not have access to a certicate.
[S203] Relying party [{0}] does not have access to the Logon CSP
[S204] Relying party [{0}] accessing the Logon CSP [Operation: {1}]
[S205] Calling account [{0}] is not a relying party in role [{1}]
[S206] Calling account [{0}] is not a relying party
[S207] Relying party [{0}] asserting identity [upn: {1}] in role: [{2}]
[S208] Private Key operation failed [Operation: {0}][upn: {1} role: {2} certicateDenition {3}][Error {4} {5}].
In-session certicate server [Federated Authentication Service]
T hese events are logged on the Federated Authentication Service server when a user uses an in-session certicate.
Log Codes
[S301] Access Denied: User [{0}] does not have access to a Virtual Smart Card
[S302] User [{0}] requested unknown Virtual Smart Card [thumbprint: {1}]
[S303] User [{0}] does not match Virtual Smart Card [upn: {1}]

[S304] User [{1}] running program [{2}] on computer [{3}] using Virtual Smart Card [upn: {4} role: {5}] for private key
operation: [{6}]
[S305] Private Key operation failed [Operation: {0}][upn: {1} role: {2} containerName {3}][Error {4} {5}].
Log on [VDA]
[Event Source: Citrix.Authentication.IdentityAssertion]
T hese events are logged on the VDA during the logon stage.
Log Codes
[S101] Identity Assertion Logon failed. Unrecognised Federated Authentication Service [id: {0}]
[S102] Identity Assertion Logon failed. Could not lookup SID for {0} [Exception: {1}{2}]
[S103] Identity Assertion Logon failed. User {0} has SID {1}, expected SID {2}
[S104] Identity Assertion Logon failed. Failed to connect to Federated Authentication Service: {0} [Error: {1} {2}]
[S105] Identity Assertion Logon. Logging in [Username: {0}][Domain: {1}]
[S106] Identity Assertion Logon. Logging in [Certicate: {0}]
[S107] Identity Assertion Logon failed. [Exception: {1}{2}]
[S108] Identity Assertion Subsystem. ACCESS_DENIED [Caller: {0}]
In-session certicates [VDA]
T hese events are logged on the VDA when a user attempts to use an in-session certicate.
Log Codes
[S201] Virtual Smart Card Authorized [User: {0}][PID: {1} Name:{2}][Certicate {3}]

[S202] Virtual Smart Card Subsystem. No smart cards available in session {0}
[S203] Virtual Smart Card Subsystem. Access Denied [caller: {0}, session {1}, expected: {2}]
[S204] Virtual Smart Card Subsystem. Smart card support disabled.
Certicate request and generation codes [Federated Authentication Service]
[Event Source: Citrix.TrustFabric]
T hese low-level events are logged when the Federated Authentication Service server performs log-level cryptographic
operations.
Log Codes
[S0001]TrustArea::TrustArea: Installed certicate chain
[S0002]TrustArea::Join: Callback has authorized an untrusted certicate
[S0003]TrustArea::Join: Joining to a trusted server
[S0004]TrustArea::Maintain: Renewed certicate
[S0005]TrustArea::Maintain: Retrieved new certicate chain
[S0006]TrustArea::Export: Exporting private key
[S0007]TrustArea::Import: Importing Trust Area
[S0008]TrustArea::Leave: Leaving Trust Area
[S0009]TrustArea::SecurityDescriptor: Setting Security Descriptor
[S0010]CerticateVerication: Installing new trusted certicate
[S0011]CerticateVerication: Uninstalling expired trusted certicate
[S0012]TrustFabricHttpClient: Attempting single sign-on to {0}

[S0013]TrustFabricHttpClient: Explicit credentials entered for {0}
[S0014]Pkcs10Request::Create: Created PKCS10 request
[S0015]Pkcs10Request::Renew: Created PKCS10 request
[S0016]PrivateKey::Create
[S0017]PrivateKey::Delete
[S0018]TrustArea::TrustArea: Waiting for Approval
[S0019]TrustArea::Join: Delayed Join
[S0020]TrustArea::Join: Delayed Join
[S0021]TrustArea::Maintain: Installed certicate chain
Log Codes
[S0101]TrustAreaServer::Create root certicate
[S0102]TrustAreaServer::Subordinate: Join succeeded
[S0103]TrustAreaServer::PeerJoin: Join succeeded
[S0104]MicrosoftCerticateAuthority::GetCredentials: Authorized to use {0}
[S0104]MicrosoftCerticateAuthority::SubmitCerticateRequest Error {0}
[S0105]MicrosoftCerticateAuthority::SubmitCerticateRequest Issued cert {0}
[S0106]MicrosoftCerticateAuthority::PublishCRL: Published CRL
[S0107]MicrosoftCerticateAuthority::ReissueCerticate Error {0}

[S0108]MicrosoftCerticateAuthority::ReissueCerticate Issued Cert {0}
[S0109]MicrosoftCerticateAuthority::CompleteCerticateRequest - Still waiting for approval
[S0110]MicrosoftCerticateAuthority::CompleteCerticateRequest - Pending certicate refused
[S0111]MicrosoftCerticateAuthority::CompleteCerticateRequest Issued certicate
[S0112]MicrosoftCerticateAuthority::SubmitCerticateRequest - Waiting for approval
[S0120]NativeCerticateAuthority::SubmitCerticateRequest Issued cert {0}
[S0121]NativeCerticateAuthority::SubmitCerticateRequest Error
[S0122]NativeCerticateAuthority::RootCARollover New root certicate
[S0123]NativeCerticateAuthority::ReissueCerticate New certicate
[S0124]NativeCerticateAuthority::RevokeCerticate
[S0125]NativeCerticateAuthority::PublishCRL
Related information
T he common FAS deployments are summarized in the Federated Authentication Service architectures overview article.
"How-to" articles are introduced in the Federated Authentication Service configuration and management article.

Federated Authentication Service architectures
overview
May 22, 20 17
Introduction
T he Federated Authentication Service (FAS) is a Citrix component that integrates with your Active Directory certicate
authority (CA), allowing users to be seamlessly authenticated within a Citrix environment. T his document describes various
authentication architectures that may be appropriate for your deployment.
When enabled, the FAS delegates user authentication decisions to trusted StoreFront servers. StoreFront has a
comprehensive set of built-in authentication options built around modern web technologies, and is easily extensible using
the StoreFront SDK or third-party IIS plugins. T he basic design goal is that any authentication technology that can
authenticate a user to a web site can now be used to log in to a Citrix XenApp or XenDesktop deployment.
T his document covers some example top-level deployment architectures, in increasing complexity.
Internal deployment
NetScaler Gateway deployment
ADFS SAML
B2B account mapping
Windows 10 Azure AD join
Links are provided to related FAS articles. For all architectures, the Federated Authentication Service article is the primary
reference for setting up the FAS.
How it works
T he FAS is authorized to issue smart card class certicates automatically on behalf of Active Directory users who are
authenticated by StoreFront. T his uses similar APIs to tools that allow administrators to provision physical smart cards.
When a user is brokered to a Citrix XenApp or XenDesktop Virtual Delivery Agent (VDA), the certicate is attached to the
machine, and the Windows domain sees the logon as a standard smart card authentication.
Internal deployment
T he FAS allows users to securely authenticate to StoreFront using a variety of authentication options (including Kerberos
single sign-on) and connect through to a fully authenticated Citrix HDX session.
T his allows Windows authentication without prompts to enter user credentials or smart card PINs, and without using
saved password management features such as the Single Sign-on Service. T his can be used to replace the Kerberos
Constrained Delegation logon features available in earlier versions of XenApp.
All users have access to public key infrastructure (PKI) certicates within their session, regardless of whether or not they log
on to the endpoint devices with a smart card. T his allows a smooth migration to two-factor authentication models, even

from devices such as smartphones and tablets that do not have a smart card reader.
T his deployment adds a new server running the FAS, which is authorized to issue smart card class certicates on behalf of
users. T hese certicates are then used to log on to user sessions in a Citrix HDX environment as if a smart card logon was
used.

T he XenApp or XenDesktop environment must be congured in a similar manner as smart card logon, which is documented
in CT X206156.
In an existing deployment, this usually involves only ensuring that a domain-joined Microsoft certicate authority (CA) is
available, and that domain controllers have been assigned domain controller certicates. (See the "Issuing Domain
Controller Certicates" section in CT X206156.)
Related information:
Keys can be stored in a Hardware Security Module (HSM) or built-in T rusted Platform Module (T PM). For details, see the
Federated Authentication Service private key protection article.
T he Federated Authentication Service article describes how to install and configure the FAS.
NetScaler Gateway deployment

T he NetScaler deployment is similar to the internal deployment, but adds Citrix NetScaler Gateway paired with StoreFront,
moving the primary point of authentication to NetScaler itself. Citrix NetScaler includes sophisticated authentication and
authorization options that can be used to secure remote access to a company's web sites.
T his deployment can be used to avoid multiple PIN prompts that occur when authenticating rst to NetScaler and then
logging in to a user session. It also allows use of advanced NetScaler authentication technologies without additionally
requiring AD passwords or smart cards.

T he XenApp or XenDesktop environment must be congured in a similar manner as smart card logon, which is documented
in CT X206156.
In an existing deployment, this usually involves only ensuring that a domain-joined Microsoft certicate authority (CA) is
available, and that domain controllers have been assigned Domain Controller certicates. (See the Issuing Domain
Controller Certicates section in CT X206156).
When conguring NetScaler as the primary authentication system, ensure that all connections between NetScaler and
StoreFront are secured with T LS. In particular, ensure that the Callback Url is correctly congured to point to the NetScaler
server, as this can be used to authenticate the NetScaler server in this deployment.
T o configure NetScaler Gateway, see How to Configure NetScaler Gateway 10.5 to use with StoreFront 3.6 and
XenDesktop 7.6."
T he Federated Authentication Service article describes how to install and configure the FAS.
ADFS SAML deployment

A key NetScaler authentication technology allows integration with Microsoft ADFS, which can act as a SAML Identity
Provider (IdP). A SAML assertion is a cryptographically-signed XML block issued by a trusted IdP that authorizes a user to
log on to a computer system. T his means that the FAS server now allows the authentication of a user to be delegated to
the Microsoft ADFS server (or other SAML-aware IdP).

ADFS is commonly used to securely authenticate users to corporate resources remotely over the Internet; for example, it is
often used for Ofce 365 integration.
T he Federated Authentication Service ADFS deployment article contains details.

T he Federated Authentication Service article describes how to install and configure FAS.
T he NetScaler Gateway deployment section in this article cntains configuration considerations.
B2B account mapping

If two companies want to use each others computer systems, a common option is to set up an Active Directory
Federation Service (ADFS) server with a trust relation. T his allows users in one company to seamlessly authenticate into
another companys Active Directory (AD) environment. When logging on, each user uses their own company logon
credentials; ADFS automatically maps this to a shadow account in the peer companys AD environment.

Windows 10 Azure AD Join

Windows 10 introduced the concept of Azure AD Join, which is conceptually similar to traditional Windows domain join but

targeted at over the internet scenarios. T his works well with laptops and tablets. As with traditional Windows domain
join, Azure AD has functionality to allow single sign-on models for company websites and resources. T hese are all Internet
aware, so will work from any Internet connected location, not just the ofce LAN.
T his deployment is an example where there is effectively no concept of end users in the ofce. Laptops are enrolled and
authenticate entirely over the Internet using modern Azure AD features.
Note that the infrastructure in this deployment can run anywhere an IP address is available: on-premises, hosted provider,
Azure, or another cloud provider. T he Azure AD Connect synchronizer will automatically connect to Azure AD. T he example
graphic uses Azure VMs for simplicity.
T he Federated Authentication Service Azure AD integration article contains details.

Federated Authentication Service ADFS deployment
May 22, 20 17
Introduction
T his document describes how to integrate a Citrix environment with Microsoft ADFS.
Many organizations use ADFS to manage secure user access to web sites that require a single point of authentication. For
example, a company may have additional content and downloads that are available to employees; those locations need to
be protected with standard Windows logon credentials.
T he Federated Authentication Service (FAS) also allows Citrix NetScaler and Citrix StoreFront to be integrated with the
ADFS logon system, reducing potential confusion for the companys staff.
T his deployment integrates NetScaler as a relying party to Microsoft ADFS.

SAML overview

Security Assertion Markup Language (SAML) is a simple redirect to a logon page web browser logon system.
Conguration includes the following items:
Redirect URL [Single Sign-on Service Url]
When NetScaler discovers that a user needs to be authenticated, it instructs the users web browser to do a HT T P POST
to a SAML logon webpage on the ADFS server. T his is usually an https:// address of the form:
https://adfs.mycompany.com/adfs/ls.
T his web page POST includes other information, including the return address where ADFS will return the user when logon
is complete.
Identier [Issuer Name/EntityID]
T he EntityId is a unique identier that NetScaler includes in its POST data to ADFS. T his informs ADFS which service the
user is trying to log on to, and to apply different authentication policies as appropriate. If issued, the SAML authentication
XML will only be suitable for logging on to the service identied by the EntityId.
Usually, the EntityID is the URL of the NetScaler server logon page, but it can generally be anything, as long as NetScaler
and ADFS agree on it: https://ns.mycompany.com/application/logonpage.
Return address [Reply URL]
If authentication is successful, ADFS instructs the users web browser to POST a SAML authentication XML back to one of
the Reply URLs that are congured for the EntityId. T his is usually an https:// address on the original NetScaler server in the
form: https://ns.mycompany.com/cgi/samlauth
If there is more than one Reply URL address congured, NetScaler can choose one in its original POST to ADFS.
Signing certicate [IDP Certicate]
ADFS cryptographically signs SAML authentication XML blobs using its private key. To validate this signature, NetScaler
must be congured to check these signatures using the public key included in a certicate le. T he certicate le will usually
be a text le obtained from the ADFS server.
Single sign-out Url [Single Logout URL]
ADFS and NetScaler support a central logout system. T his is a URL that NetScaler polls occasionally to check that the
SAML authentication XML blob still represents a currently logged-on session.
T his is an optional feature that does not need to be congured. It is usually an https:// address in the form
https://adfs.mycompany.com/adfs/logout. (Note that it can be the same as the Single Logon URL.)
Conguration
T he NetScaler Gateway deployment section in the Federated Authentication Services architectures article describes how
to set up NetScaler Gateway to handle standard LDAP authentication options, using the XenApp and XenDesktop
NetScaler setup wizard. After that completes successfully, you can create a new authentication policy on NetScaler that
allows SAML authentication. T his can then replace the default LDAP policy used by the NetScaler setup wizard.

Fill in the SAML policy
Congure the new SAML IdP server using information taken from the ADFS management console earlier. When this policy is
applied, NetScaler redirects the user to ADFS for logon, and accepts an ADFS-signed SAML authentication token in return.
Related information
T he Federated Authentication Service article is the primary reference for FAS installation and configuration.

Federated Authentication Service Azure AD integration
May 22, 20 17
In this article:
Introduction
Architecture
Create a DNS zone
Create a Cloud Service
Create Windows virtual machines
Configure an internal DNS
Configure an external DNS address
Configure security groups
Create an ADFS certificate
Set up Azure AD
Enable Azure AD Join
Install XenApp or XenDesktop
Configure a new Azure AD application for Single Sign-on to StoreFront
Install and configure NetScaler Gateway
Configure the StoreFront address
Enable NetScaler SAML authentication support
Verify the end-to-end system
Appendix
Introduction
T his document describes how to integrate a Citrix environment with the Windows 10 Azure AD feature.
Windows 10 introduced Azure AD, which is a new domain join model where roaming laptops can be joined to a corporate
domain over the Internet for the purposes of management and single sign-on.
T he example deployment in this document describes a system where IT provides new users with a corporate email address
and enrollment code for their personal Windows 10 laptops. Users access this code through the System > About > Join
Azure AD option in the Settings panel.

After the laptop is enrolled, the Microsoft Edge web browser automatically signs on to company web sites and Citrix
published applications through the Azure SaaS applications web page, with other Azure applications such as Ofce 365.

Architecture
T his architecture replicates a traditional company network completely within Azure, integrating with modern cloud
technologies such as Azure AD and Ofce 365. End users are all considered remote workers, with no concept of being on
an ofce intranet.
T he model can be applied to companies with existing on premises systems, because the Azure AD Connect Synchronization
can bridge to Azure over the Internet.
Secure connections and single sign-on, which would traditionally have been rewalled-LAN and Kerberos/NT LM
authentication, are replaced in this architecture by T LS connections to Azure and SAML. New services are built as Azure
applications joined to Azure AD. Existing applications that require Active Directory (such as a SQL Server database) can be
run using a standard Active Directory Server VM in the IAAS portion of the Azure Cloud Service.
When a user launches a traditional application, they are accessed using XenApp and XenDesktop published applications.
T he different types of applications are collated through the users Azure Applications page, using the Microsoft Edge
Single sign-on features. Microsoft also supplies Android and iOS apps that can enumerate and launch Azure applications.
Create a DNS zone

Azure AD requires that the administrator has registered a public DNS address and controls the delegation zone for the
domain name sufx. To do this, the administrator can use the Azure DNS zone feature.
T his example uses the DNS zone name citrixsamldemo.net.
T he console shows the names of the Azure DNS name servers. T hese should be referenced in the DNS registrars NS
entries for the zone (for example, citrixsamldemo.net. NS n1-01.azure-dns.com)
When adding references to VMs running in Azure, it is easiest to use a CNAME pointer to the Azure-managed DNS record
for the VM. If the IP address of the VM changes, you will not need to manually update the DNS zone le.
Both internal and external DNS address sufxes will match for this deployment. T he domain is citrixsamldemo.net, and uses
a split DNS (10.0.0.* internally).
Add an fs.citrixsamldemo.net entry that references the Web Application Proxy server. T his is the Federation Service for
this zone.
Create a Cloud Service

T his example congures a Citrix environment, including an AD environment with an ADFS server running in Azure. A Cloud
Service is created, named "citrixsamldemo."
Create Windows virtual machines

Create ve Windows VMs running in the Cloud Service:
Domain controller (domaincontrol)

Azure Connect ADFS server (adfs)
ADFS web access proxy (Web Application Proxy, not domain joined)
Citrix XenDesktop Delivery Controller (ddc)
Citrix XenDesktop Virtual Delivery Agent (vda)

Domain Controller
Add the DNS Server and Active Directory Domain Services roles to create a standard Active Directory deployment (in
this example, citrixsamldemo. net). After domain promotion completes, add the Active Directory Certif ication Services
role.
Create a normal user account for testing (for example, [email protected]).
Since this server will be running internal DNS, all servers should refer to this server for DNS resolution. T his can be done
through the Azure DNS settings page. (For more information, see the Appendix in this document.)
ADFS controller and Web Application Proxy server
Join the ADFS server to the citrixsamldemo domain. T he Web Application Proxy server should remain in an isolated
workgroup, so manually register a DNS address with the AD DNS.
Run the Enable-PSRemoting Force cmdlet on these servers, to allow PS remoting through firewalls from the AzureAD
Connect tool.
XenDesktop Delivery Controller and VDA
Install the XenApp or XenDesktop Delivery Controller and VDA on the remaining two Windows servers joined to
citrixsamldemo.
Congure an internal DNS

After the domain controller is installed, congure the DNS server to handle the internal view of citrixsamldemo.net, and act
as a forwarder to an external DNS server (for example: 8.8.8.8).
Add a static record for:
wap.citrixsamldemo.net [the Web Application Proxy VM will not be domain joined]

fs.citrixsamldemo.net [internal federation server address]
enterpriseregistration.citrixsaml.net [same as fs.citrixsamldemo.net]
All VMs running in Azure should be congured to use only this DNS server. You can do this through the Network Interface
GUI.

By default, the internal IP (10.0.0.9) address is dynamically allocated. You can use the IP addresses setting to permanently
assign the IP address. T his should be done for the Web Application Proxy server and the domain controller.
Congure an external DNS address

When a VM is running, Azure maintains its own DNS zone server that points to the current public IP address assigned to the
VM. T his is a useful feature to enable because Azure assigns IP addresses when each VM starts, by default.
T his example assigns a DNS address of domaincontrol-citrixsamldemo.westeurope.cloudapp.azure.com to the domain

controller.
Note that when remote conguration is complete, only the Web Application Proxy and NetScaler VMs should have public
IP addresses enabled. (During conguration, the public IP address is used for RDP access to the environment).
Congure security groups

T he Azure cloud manages rewall rules for TCP/UDP access into VMs from the Internet using security groups. By default,
all VMs allow RDP access. T he NetScaler and Web Application Proxy servers should also allow T LS on port 443.

Create an ADFS certicate
Enable the Web Server certicate template on the Microsoft certicate authority (CA). T his allows creation of a
certicate with custom DNS addresses that can be exported (including private key) to a pfx le. You must install this
certicate on both the ADFS and Web Application Proxy servers, so the PFX le is the preferred option.
Issue a Web Server certicate with the following subject names:
Commonname:
adfs.citrixsamldemo.net [name of computer]
SubjectAltname:
*.citrixsamldemo.net [name of zone]
fs.citrixsamldemo. net [entry in DNS]
enterpriseregistration.citrixsamldemo.net

Export the certicate to a pfx le, including a password-protected private key.
Set up Azure AD
T his section details the process of setting up a new Azure AD instance and creating user identities that can be used to join
Windows 10 to Azure AD.
Create a new directory
Log on to the classic Azure portal and create a new directory.
When complete, a summary page appears.

Create a global administrator user (AzureAdmin)
Create a global administrator in Azure (in this example, [email protected]) and log on with the
new account to set up a password.

Register your domain with Azure AD
By default, users are identied with an email address in the form: <user.name>@<company>.onmicrosoft.com.
Although this works without further conguration, a standard format email address is better, preferably one that matches
the email account of the end user: <user.name>@<company>.com
T he Add domain action congures a redirect from your real company domain. T he example uses citrixsamldemo.net.
If you are setting up ADFS for single sign-on, enable the check box.

Install Azure AD Connect
Step 2 of the Azure AD conguration GUI redirects to the Microsoft download page for Azure AD Connect. Install this on
the ADFS VM. Use Custom install, rather than Express Settings, so that ADFS options are available.

Select the Federation with AD FS Single sign-On option.
Connect to Azure with the administrator account you created earlier.

Select the internal AD forest.
Synchronize all legacy Active Directory objects with Azure AD.

If the directory structure is simple, you can rely on the usernames being sufciently unique to identify a user who logs on.
Accept the default ltering options, or restrict users and devices to a particular set of groups.

If desired, you can synchronize the Azure AD passwords with Active Directory. T his is usually not required for ADFS-based
authentication.
Select the certicate PFX le to use in AD FS, specifying fs.citrixsamldemo.net as the DNS name.

When prompted to select a proxy server, enter the address of the wap.citrixsamldemo.net server. You may need to run the
Enable-PSRemoting Force cmdlet as an administrator on the Web Application Proxy server, so that Azure AD Connect can
congure it.

Note: If this step fails due to Remote PowerShell trust problems, try joining the Web Application Proxy server to the
domain.
For the remaining steps of the wizard, use the standard administrator passwords, and create a service account for ADFS.
Azure AD Connect will then prompt to validate the ownership of the DNS zone.
Add the T XT and MX records to the DNS address records in Azure.
Click Verif y in the Azure Management Console.

Note: If this step fails, you can verify the domain before running Azure AD Connect.
When complete, the external address fs.citrixsamldemo.net is contacted over port 443.
Enable Azure AD Join

When a user enters an email address so that Windows 10 can perform Azure AD join, the DNS sufx is used to construct a
CNAME DNS record that should point to ADFS: enterpriseregistration.<upnsufx>.
In the example, this is fs.citrixsamldemo.net.

If you are not using a public CA, ensure that the ADFS root certicate is installed on the Windows 10 computer so that
Windows trusts the ADFS server. Perform an Azure AD domain join using the standard user account generated earlier.
Note that the UPN must match the UPN recognized by the ADFS domain controller.

Verify that the Azure AD join was successful by restarting the machine and logging on, using the users email address. When
logged on, launch Microsoft Edge and connect to http://myapps.microsoft.com. T he web site should use single sign-on
automatically.
Install XenApp or XenDesktop

You can install the Delivery Controller and VDA virtual machines in Azure directly from the XenApp or XenDesktop ISO in the
usual way.
In this example, StoreFront is installed on the same server as the Delivery Controller. T he VDA is installed as a standalone
Windows 2012 R2 RDS worker, without integrating with Machine Creation Services (although that can optionally be
congured). Check that the user [email protected] can authenticate with a password, before continuing.

Run the Set-BrokerSite TrustRequestsSentToTheXmlServicePort $true PowerShell cmdlet on the Controller to allow
StoreFront to authenticate without the users credentials.
Install the Federated Authentication Service (FAS) component on the ADFS server and congure a rule for the Controller to
act as a trusted StoreFront.

Congure StoreFront
Request a computer certicate for the Delivery Controller, and congure IIS and StoreFront to use HT T PS by setting an IIS
binding for port 443, and changing the StoreFront base address to https:.
Congure StoreFront to use the FAS server (use the PowerShell script in the Federated Authentication Service article), and

test internally within Azure, ensuring that the logon uses the FAS by checking the event viewer on the FAS server.
Congure StoreFront to use NetScaler
Using the Manage Authentication Methods GUI in the StoreFront management console, congure StoreFront to use
NetScaler to perform authentication.
To integrate NetScaler authentication options, congure a Secure T icket Authority (STA) and congure the NetScaler
Gateway address.

Congure a new Azure AD application for Single Sign-
on to StoreFront
T his section uses the Azure AD SAML 2.0 Single Sign-on features, which currently require an Azure Active Directory Premium
subscription. In the Azure AD management tool, select New Application, choosing Add an application f rom the Gallery.
Select CUSTOM > Add an unlisted application my organization is using to create a new custom application for your
users.
Congure an icon
Create an image 215 by 215 pixels in size and upload it on the CONFIGURE page to use as an icon for the application.

Congure SAML authentication
Return to the Application dashboard overview page and select Congure Single sign-on.
T his deployment will use SAML 2.0 authentication, which corresponds to Microsof t Azure AD Single Sign-On.

T he Identier can be an arbitrary string (it must match the conguration provided to NetScaler); in this example, the Reply
URL is /cgi/samlauth on the NetScaler server.
T he next page contains information that is used to congure NetScaler as a relying party to Azure AD.
Download the base 64 trusted signing certicate and copy the sign-on and sign-out URLs. You will paste these in NetScaler
conguration screens later.
Assign the application to users
T he nal step is to enable the application so that it appears on users myapps.microsoft.com control page. T his is done on

the USERS AND GROUPS page. Assign access for the domain users accounts synchronized by Azure AD Connect. Other
accounts can also be used, but they must be explicitly mapped because they do not conform to the <user>@<domain>
pattern.
MyApps page
When the application has been congured, it appears on the users lists of Azure applications when they visit
https://myapps.microsoft.com.
When it is Azure AD joined, Windows 10 supports single sign-on to Azure applications for the user who logs on. Clicking the
icon takes the browser to the SAML cgi/samlauth web page that was congured earlier.
Single sign-on URL

Return to the application in the Azure AD dashboard. T here is now a single sign-on URL available for the application. T his
URL is used to provide web browser links or to create Start menu shortcuts that take users directly into StoreFront.
Paste this URL into a web browser to ensure that you are redirected by Azure AD to the NetScaler cgi/samlauth web page
congured earlier. T his works only for users who have been assigned, and will provide single sign-on only for Windows 10
Azure AD-joined logon sessions. (Other users will be prompted for Azure AD credentials.)
Install and congure NetScaler Gateway

To remotely access the deployment, this example uses a separate VM running NetScaler. T his can be purchased from the
Azure Store. T his example uses the Bring your own License version of NetScaler 11.0.
Log on to the NetScaler VM, pointing a web browser to the internal IP address, using the credentials specied when the
user authenticated. Note that you must change the password of the nsroot user in an Azure AD VM.

Add licenses, selecting reboot after each license le is added, and point the DNS resolver to the Microsoft domain
controller.
Run the XenApp and XenDesktop setup wizard
T his example starts by conguring a simple StoreFront integration without SAML. After that deployment is working, it adds
a SAML logon policy.
Select the standard NetScaler StoreFront settings. For use in Microsoft Azure, this example congures port 4433, rather
than port 443. Alternatively, you can port-forward or remap the NetScaler administrative web site.
For simplicity, the example uploads an existing server certicate and private key stored in a le.

Congure the domain controller f or AD account management
T he domain controller will be used for account resolution, so add its IP address into the primary authentication method.
Note the formats expected in each eld in the dialog box.
Congure the StoreFront address

In this example, StoreFront has been congured using HT T PS, so select the SSL protocol options.

Verif y the NetScaler deployment
Connect to NetScaler and check that authentication and launch are successful with the username and password.
Enable NetScaler SAML authentication support

Using SAML with StoreFront is similar to using SAMl with other web sites. Add a new SAML policy, with an expression of
NS_TRUE.

Congure the new SAML IdP server, using information obtained from Azure AD earlier.
Verify the end-to-end system

Log on to an Azure AD Joined Windows 10 desktop, using an account registered in Azure AD. Launch Microsoft Edge and
connect to: https://myapps.microsoft.com.
T he web browser should display the Azure AD applications for the user.
Verify that clicking the icon redirects you to an authenticated StoreFront server.
Similarly, verify that direct connections using the Single Sign-on URL and a direct connection to the NetScaler site redirect
you to Microsoft Azure and back.
Finally, verify that non-Azure AD joined machines also function with the same URLs (although there will be a single explicit
sign-on to Azure AD for the rst connection).
Appendix
Several standard options should be congured when setting up a VM in Azure.
Provide a public IP address and DNS address

Azure gives all VMs an IP address on the internal subnet (10.*.*.* in this example). By default a public IP address is also
supplied, which can be referenced by a dynamically updated DNS label.
Select Conguration of the Public IP address/DNS name label. Choose a public DNS address for the VM. T his can be
used for CNAME references in other DNS zone les, ensuring that all DNS records remain correctly pointing to the VM, even
if the IP address is reallocated.
Set up rewall rules (security group)
Each VM in a cloud has a set of rewall rules applied automatically, known as the security group. T he security group
controls trafc forwarded from the public to the private IP address. By default, Azure allows RDP to be forwarded to all
VMs. T he NetScaler and ADFS servers must also need to forward T LS trafc (443).

Open Network Interf aces for a VM, and then click the Network Security Group label. Congure the Inbound security
rules to allow appropriate network trafc.
Related information

Federated Authentication System how-to:
conguration and management
May 22, 20 17
T he following "how-to" articles provide advanced conguration and management guidance for the Federated
Authentication System (FAS):
Private key protection

Certificate authority configuration
Security and network management
T roubleshoot Windows logon issues
PowerShell SDK cmdlet help files
T he primary reference for FAS installation and initial setup is the Federated Authentication Service article.
T he Federated Authentication Service architectures overview article provides summaries of the major FAS architectures,
plus links to other articles about the more complex architectures.

Federated Authentication Service certicate authority
conguration
May 31, 20 17
T his article describes the advanced conguration of the Citrix Federated Authentication Service (FAS) to integrate with
certicate authority (CA) servers that are not supported by the FAS administration console. T he instructions use PowerShell
APIs provided by FAS. You should have a basic knowledge of PowerShell before executing any instructions in this article.
Set up multiple CA servers for use in FAS

T his section describes how to set up a single FAS server to use multiple CA servers to issue certicates. T his allows load
balancing and failover of the CA servers.
Step 1: Find out how many CA servers FAS is able to locate
Use the Get-FASMsCerticateAuthority cmdlet to determine which CA servers FAS can connect to. T he following example
shows that FAS can connect to three CA servers.
Step 2: Modif y the existing certicate denition
Citrix recommends that you create a role using the FAS administration console, rather than using PowerShell to create the
role. T his avoids the complication of having to add the SDL manually later. In the following example, a role named default is
created, with the access rule congured:

To add multiple CAs to the certicate authority eld (which is not supported from the administration console in this release),
you must congure the certicate denition. First, you need the certicate denition name. T he name cannot be
determined from the administration console; use the Get-FASCerticateDenition cmdlet.
T he UI equivalent is:
After you have the certicate denition name, modify the certicate denition to have a list of CerticateAuthorities,
rather than just one:

T he Get-FASCerticateDenition cmdlet now returns:
Note: Your FAS administration console will not be functional after doing this. You will see an empty eld in both Certicate
Authority and Certicate Template upon loading:
Functionally, FAS is still ne. If you use the console to modify the access rule, just repeat step 2 to display all the certicate
authorities.
Expected behavior changes
After you congure the FAS server with multiple CA servers, user certicate generation is distributed among all the
congured CA servers. Also, if one of the congured CA servers fails, the FAS server will switch to another available CA server.
Congure the Microsoft CA for TCP access

By default the Microsoft CA uses DCOM for access. T his can result in complexities when implementing rewall security, so
Microsoft has a provision to switch to a static TCP port. On the Microsoft CA, open the DCOM conguration panel and
edit the properties of the CertSrv Request DCOM application:

Change the Endpoints to select a static endpoint and specify a TCP port number (900 in the graphic above).
Restart the Microsoft CA and submit a certicate request. If you run netstat a n b you should see that certsvr is now
listening on port 900:
T here is no need to congure the FAS server (or any other machines using the CA), because DCOM has a negotiation stage
using the RPC port. When a client needs to use DCOM, it connects to the DCOM RPC Service on the certicate server and
requests access to a particular DCOM server. T his triggers port 900 to be opened, and the DCOM server instructs the FAS
server how to connect.
Pre-generate user certicates

T he logon time for users will signicantly improve when user certicates are pre-generated within the FAS server. T he
following sections describe how it can be done, either for single or multiple FAS servers.
Get a list of Active Directory users

You can improve certicate generation by querying the AD and storing the list of users into a le (for example, a .csv le), as
shown in the following example.
Get-ADUser is a standard cmdlet to query for a list of users. T he example above contains a lter argument to list only users
with a UserPrincipalName and an account status of enabled.'
T he SearchBase argument narrows which part of the AD to search for users. You can omit this if you want to include all
users in AD. Note: T his query might return a large number of users.
T he CSV looks something like this:
FAS server
T he following PowerShell script takes the previously-generated user list and creates a list of user certicates.

If you have more than one FAS server, a particular users certicate will be generated twice: one in the main server, and the
other in the failover server.
T he script above is catered for a rule named default. If you have a different rule name (for example, hello), just change the
$rule variable in the script.
Renew registration authority certicates

If more than one FAS server is in use, you can renew a FAS authorization certicate without affecting logged-on users.
Note: Although you can also use the GUI to deauthorize and reauthorize FAS, that has the effect of resetting FAS

conguration options.
Complete the following sequence:
1. Create a new authorization certicate:
New-FasAuthorizationCerticate
2. Note the GUID of the new authorization certicate, as returned by:
Get-FasAuthorizationCerticate
3. Place the FAS server into maintenance mode:
Set-FasServer Address <FAS server> -MaintenanceMode $true
4. Swap the new authorization certicate:
Set-FasCerticateDenition AuthorizationCerticate <GUID>
5. Take the FAS server out of maintenance mode:
Set-FasServer Address <FAS server> -MaintenanceMode $false
6. Delete the old authorization certicate:
Remove-FasAuthorizationCerticate
Related information
Other "how-to" articles are introduced in the Federated Authentication Service configuration and management article.

Federated Authentication Service private key
protection
May 22, 20 17
Introduction
Private keys are stored by means of the Network Service account and marked as non-exportable by default.
T here are two types of private keys:
T he private key associated with the registration authority (RA) certificate, from the Citrix_RegistrationAuthority
certificate template.
T he private keys associated with the user certificates, from the Citrix_SmartcardLogon certificate template.
T here are actually two RA certicates: Citrix_RegistrationAuthority_ManualAuthorization (valid for 24 hours by default) and
Citrix_RegistrationAuthority (valid for two years by default).
During step 3 of the Initial Setup in the FAS administration console, when the administrator clicks Authorize the FAS
server generates a keypair and sends a Certicate Signing Request (CSR) to the CA for the
Citrix_RegistrationAuthority_ManualAuthorization certicate. T his is a temporary certicate, valid for 24 hours by
default. T he CA does not automatically issue this certicate; its issuance must be manually authorised on the CA by an
administrator. Once the certicate is issued to the FAS server, FAS uses the
Citrix_RegistrationAuthority_ManualAuthorization certicate to automatically obtain the
Citrix_RegistrationAuthority certicate (valid for two years by default). T he FAS server deletes the certicate and key
for Citrix_RegistrationAuthority_ManualAuthorization as soon as it obtains the Citrix_RegistrationAuthority
certicate.
T he private key associated with the RA certicate is particularly sensitive, because the RA certicate policy allows whoever
possesses the private key to issue certicate requests for the set of users congured in the template. As a consequence,
whoever controls this key can connect to the environment as any of the users in the set.
You can congure the FAS server to protect private keys in a way that ts your organizations security requirements, using
one of the following:
Microsoft Enhanced RSA and AES Cryptographic Provider or Microsoft Software Key Storage Provider for both the RA
certificate and the user certificates private keys.
Microsoft Platform Key Storage Provider with a T rusted Platform Module (T PM) chip for the RA certificates private key,
and Microsoft Enhanced RSA and AES Cryptographic Provider or Microsoft Software Key Storage Provider for the user
certificates private keys.
A Hardware Security Module (HSM) vendors Cryptographic Service or Key Storage Provider with the HSM device for
both the RA certificate and the user certificates private keys.
Private key conguration settings

Congure FAS to use one of the three options. Use a text editor to edit the
Citrix.Authentication.FederatedAuthenticationService.exe.cong le. T he default location of the le is in the Program
Files\Citrix\Federated Authentication Service folder on the FAS server.
T he FAS reads the cong le only when the service starts. If any values are changed, the FAS must be restarted before it
reects the new settings.
Set the relevant values in the Citrix.Authentication.FederatedAuthenticationService.exe.cong le as follows:
Citrix.TrustFabric.ClientSDK.TrustAreaJoinParameters.ProviderLegacyCsp (switch between CAPI and CNG APIs)
Value Comment
true Use CAPI APIs
false (default) Use CNG APIs
Citrix.TrustFabric.ClientSDK.TrustAreaJoinParameters.ProviderName (name of the provider to use)
Value Comment
Microsoft Enhanced RSA and AES Default CAPI provider

Cryptographic Provider
Microsoft Software Key Storage Default CNG Provider

Provider

Microsoft Platform Key Storage Default TPM provider. Note that TPM is not recommended for user keys. Use TPM for the RA key
Provider only. If you plan to run your FAS server in a virtualized environment, check with your TPM and
hypervisor vendor whether virtualization is supported.
HSM_Vendor CSP/Key Storage Supplied by HSM vendor. The value diers between vendors. If you plan to run your FAS server in
Provider a virtualized environment, check with your HSM vendor whether virtualization is supported.
Citrix.TrustFabric.ClientSDK.TrustAreaJoinParameters.ProviderType (Required only in case of CAPI API)
Value Comment
24 Default. Refers to Microsoft KeyContainerPermissionAccessEntry.ProviderType Property

PROV_RSA_AES 24. Should always be 24 unless you are using an HSM with CAPI and the HSM
vendor species otherwise.
Citrix.TrustFabric.ClientSDK.TrustAreaJoinParameters.KeyProtection (When FAS needs to perform a private key operation, it

uses the value specied here) Controls the "exportable ag of private keys. Allows the use of T PM key storage, if
supported by the hardware.
Value Comment
NoProtection Private key can be exported.
GenerateNonExportableKey Default. Private key cannot be exported.
GenerateTPMProtectedKey Private key will be managed using the TPM. Private key is stored via the ProviderName you
specied in ProviderName (for example, Microsoft Platform Key Storage Provider)
Citrix.TrustFabric.ClientSDK.TrustAreaJoinParameters.KeyLength (Specify size of private key in bits)
Value Comment
2048 Default. 1024 or 4096 can also be used.
T he cong le settings are represented graphically as follows (installation defaults are shown in red):

Conguration scenario examples
Example 1
T his example covers the RA certicate private key and user certicates private keys stored using the Microsoft Software
Key Storage Provider
T his is the default post-install conguration. No additional private key conguration is required.
Example 2
T his example shows the RA certicate private key stored in the FAS server motherboards hardware T PM via the Microsoft
Platform Key Storage Provider, and user certicates private keys stored using the Microsoft Software Key Storage
Provider.
T his scenario assumes that the T PM on your FAS server motherboard has been enabled in the BIOS according to the T PM
manufacturers documentation and then initialized in Windows; see https://technet.microsoft.com/en-
gb/library/cc749022(v=ws.10).aspx.
Using PowerShell (recommended)

T he RA certicate can be requested ofine using PowerShell. T his is recommended for organizations that do not want

their CA to issue a RA certicate through an online CSR. An ofine RA CSR cannot be made using the FAS administration
console.
Step 1: During the initial setup of the FAS conguration using the administration console, complete only the rst two
steps: Deploy certicate templates and Setup Certicate Authority.
Step 2: On your CA server, add the Certicate Templates MMC snap-in. Right-click the
Citrix_RegistrationAuthority_ManualAuthorization template and select Duplicate Template.
Select the General tab. Change the name and validity period. In this example, the name is Ofine_RA and the validity period
is 2 years:

Step 3: On your CA server, add the CA MMC snap-in. Right-click Certicate Templates. Select New, then click Certicate
Template to Issue. Choose the template you just created.
Step 4 : Load the following PowerShell cmdlets on the FAS server:
Step 5: Generate the RSA keypair inside the FAS servers T PM and create the CSR by entering the following PowerShell
cmdlet on the FAS server. Note: Some T PMs restrict key length. T he default is key length is 2048 bits. Be sure to specify a
key length supported by your hardware.
New-FasAuthorizationCerticateRequest -UseT PM $true -address <FQDN of FAS Server>
For example:
New-FasAuthorizationCerticateRequest -UseT PM $true -address fashsm.auth.net
T he following is displayed:

Notes:
T he Id GUID (in this example, 5ac3d8bd-b484-4ebe-abf8-4b2cfd62ca39) is required in a subsequent step.

T hink of this PowerShell cmdlet as a one-time override that is used to generate the private key for the RA certificate.
When running this cmdlet, the values that are read from the config file when the FAS service started are checked to
determine the key length to use (the default is 2048).
Because -UseT PM is set to $true in this manual PowerShell-initiated RA certificate private key operation, the system
ignores values from the file that do not match the settings required to use a T PM.
Running this cmdlet does not change any settings in the config file.
During subsequent automatic FAS-initiated user certificate private key operations, the values that were read from the
file when the FAS service started will be used.
It is also possible to set the KeyProtection value in the config file to GenerateT PMProtectedKey when the FAS server is
issuing user certificates to generate user certificate private keys protected by the T PM.
To verify that the T PM was used to generate the keypair, look in the application log in the Windows Event viewer on the
FAS server, at the time that the keypair is generated.
Note [T PM: True]
Followed by:

Note Provider: [CNG] Microsoft Platform Crypto Provider
Step 6: Copy the certicate request section into a text editor and save it to disk as a text le.
Step 7: Submit the CSR to your CA by typing the following into PowerShell on the FAS server:
certreq -submit -attrib "certicatetemplate:<certicate template from step 2>" <certicate request le from step 6>
For example:
certreq -submit -attrib "certicatetemplate:Ofine_RA" C:\Users\Administrator.AUT H\Desktop\usmcertreq.txt

At this point a Certication Authority List window might appear. T he CA in this example has both http (top) and DCOM
(bottom) enrolment enabled. Select the DCOM option, if available:
After the CA has been specied, PowerShell displays the RequestID:
Step 8: On the CA server, in the CA MMC snap-in, click Pending Requests. Note the Request ID. T hen right-click the
request and choose Issue.
Step 9: Select the Issued Certicates node. Find the certicate that was just issued (the Request ID should match).
Double-click to open the certicate. Select the Details tab. Click Copy to File. T he Certicate Export Wizard launches. Click
Next . Choose the following options for the le format:

T he format must be Cryptographic Message Syntax Standard PKCS #7 Certicates (.P7B) and Include all
certicates in the certication path if possible must be checked.
Step 10: Copy the exported certicate le onto the FAS server.
Step 11: Import the RA certicate into the FAS server registry by entering the following PowerShell cmdlet on the FAS
server:
For example:

Step 12: Close the FAS administration console and then restart it.
Note that the step Authorize this Service has turned green, and now displays Deauthorize this Service. T he entry below
indicates Authorized by: Ofine CSR
Step 13: Select the User Roles tab in the FAS administration console and edit the settings described in the main FAS article.
Note: Deauthorizing the FAS through the administration console will delete the User Rule.
Using the FAS management console

T he FAS management console cannot do ofine CSR, so using it is not recommended unless your organization allows online
CSR for RA certicates.
When performing the FAS initial setup steps, after deploying certicate templates and setting up the CA, but before
authorizing the service (step 3 in the conguration sequence):
Step 1: Edit the cong le by changing the following line as follows:

T he le should now appear as follows:
Some T PMs restrict key length. T he default key length is 2048 bits. Be sure to specify a key length supported by your
hardware.
Step 2: Authorize the service.
Step 3: Manually issue the pending certicate request from the CA server. After the RA certicate is obtained, step 3 in the
setup sequence in the management console will be green. At this point, the RA certicates private key will have generated
in the T PM. T he certicate will be valid for 2 years by default.
Step 4 : Edit the cong le back to the following:
Note: Although FAS can generate user certicates with T PM protected keys, the T PM hardware may be too slow for large
deployments.
Step 5: Restart the Citrix Federated Authentication Service. T his forces the service to re-read the cong le and reect the
changed values. T he subsequent automatic private key operations will affect user certicate keys; those operations will not
store the private keys in the T PM, but use the Microsoft Software Key Storage Provider.
Step 6: Select the User Roles tab in the FAS administration console and edit the settings as described in the main FAS
article.
Example 3
T his example covers an RA certicate private key and user certicates private keys stored in an HSM. T his example assumes

a congured HSM. Your HSM will have a provider name, for example HSM_Vendors Key Storage Provider.
If you plan to run your FAS server in a virtualized environment, check with your HSM vendor about hypervisor support.
Step 1. During the initial setup of the FAS conguration using the administration console, complete only the rst two
steps: Deploy certicate templates and Setup Certicate Authority.
Step 2: Consult your HSM vendors documentation to determine what your HSMs ProviderName value should be. If your
HSM uses CAPI, the provider might be referred to in the documentation as a Cryptographic Service Provider (CSP). If your
HSM uses CNG, the provider might be referred to as a Key Storage Provider (KSP).
Step 3: Edit the cong le as follows:
T he le should now appear as follows:

T his scenario assumes that your HSM uses CNG, so the ProviderLegacyCsp value is set to false. If your HSM uses CAPI,
ProviderLegacyCsp value should be set to true. Consult your HSM vendors documentation to determine whether your HSM
uses CAPI or CNG. Also consult your HSM vendors documentation on supported key lengths for asymmetric RSA key
generation. In this example, the key length is set to the default of 2048 bits. Ensure that the key length you specify is
supported by your hardware.
Step 4 : Restart the Citrix Federated Authentication Service to read the values from the cong le.
Step 5: Generate the RSA keypair inside the HSM and create the CSR by clicking Authorize in the Initial Setup tab of the
FAS administration console.
Step 6: To verify that the keypair was generated in the HSM, check the application entries in the Windows Event log:
Note: [Provider: [CNG] HSM_Vendors Key Storage Provider]
Step 7: On the CA server, in the CA MMC, select the Pending Requests node:
Right-click the request and select Issue.
Note that the step Authorize this Service has turned green, and now displays Deauthorize this Service. T he entry below
indicates Authorized by: [<CA Name>]

Step 8: Select the User Roles tab in the FAS administration console and edit the settings as described in the main FAS
article.
FAS certicate storage

FAS does not use the Microsoft certicate store on the FAS server to store its certicates. It uses the registry.
Note: When using an HSM to store private keys, HSM containers are identied with a GUID. T he GUID for the private key in
the HSM matches the GUID for the equivalent certicate in the registry.
To determine the GUID for the RA certicate, enter the following PowerShell cmdlets on the FAS server:
Add-pssnapin Citrix.a*
Get-FasAuthorizationCerticate address <FAS server FQDN>
For example:
Get-FasAuthorizationCerticate address cg-fas-2.auth.net

To obtain a list of user certicates, enter:
Get-FasUserCerticate address <FAS server FQDN>
For example:
Get-FasUserCerticate address cg-fas-2.auth.net
Related information
T he common FAS deployments are summarized in the Federated Authentication Services architectures overview article.

Federated Authentication Service security and
network conguration
May 22, 20 17
T he Citrix Federated Authentication Service (FAS) is tightly integrated with Microsoft Active Directory and the Microsoft
certication authority (CA). It is essential to ensure that the system is managed and secured appropriately, developing a
security policy as you would for a domain controller or other critical infrastructure.
T his document provides an overview of security issues to consider when deploying the FAS. It also provides an overview of
features available that may assist in securing your infrastructure.
Network architecture
T he following diagram shows the main components and security boundaries used in an FAS deployment.
T he FAS server should be treated as part of the security-critical infrastructure, along with the CA and domain controller. In
a federated environment, Citrix NetScaler and Citrix Storefront are components that are trusted to perform user
authentication; other XenApp and XenDesktop components are unaffected by introducing the FAS.

Firewall and network security
Communication between NetScaler, StoreFront and the Delivery Controller components should be protected by T LS over
port 443. T he StoreFront server performs only outgoing connections, and the NetScaler Gateway should accept only
connections over the Internet using HT T PS port 443.
T he StoreFront server contacts the FAS server over port 80 using mutually authenticated Kerberos. Authentication uses
the Kerberos HOST /fqdn identity of the FAS server, and the Kerberos machine account identity of the StoreFront server.
T his generates a single use credential handle needed by the Citrix Virtual Delivery Agent (VDA) to log on the user.
When an HDX session is connected to the VDA, the VDA also contacts the FAS server over port 80. Authentication uses
the Kerberos HOST /fqdn identity of the FAS server, and the Kerberos machine identity of the VDA. Additionally, the VDA
must supply the credential handle to access the certicate and private key.

T he Microsoft CA accepts communication using Kerberos authenticated DCOM, which can be congured to use a xed
TCP port. T he CA additionally requires that the FAS server supply a CMC packet signed by a trusted enrollment agent
certicate.
Server Firewall Ports
Federated Authentication Service [in] Kerberos over HT T P from StoreFront and VDAs
[out] DCOM to Microsoft CA
Netscaler [in] HT T PS from client machines
[in/out] HT T PS to/from StoreFront server
[out] HDX to VDA
StoreFront [in] HT T PS from NetScaler
[out] HT T PS to Delivery Controller
[out] Kerberos HT T P to FAS
Delivery Controller [in] HT T PS from StoreFront server
[in/out] Kerberos over HT T P from VDAs
VDA [in/out] Kerberos over HT T P from Delivery Controller
[in] HDX from NetScaler Gateway
[out] Kerberos HT T P to FAS
Microsoft CA [in] DCOM & signed from FAS
Administration responsibilities
Administration of the environment can be divided into the following groups:
Name Responsibility
Enterprise Administrator Install and secure certicate templates in the forest

Domain Administrator Congure Group Policy settings
CA Administrator Congure the certicate authority
FAS Administrator Install and congure the FAS server
StoreFront/Netscaler Admin Congure user authentication
XenDesktop Administrator Congure VDAs and Controllers
Each administrator controls different aspects of the overall security model, allowing a defense-in-depth approach to
securing the system.
Group Policy settings

Trusted FAS machines are identied by a lookup table of index number -> FQDN congured through Group Policy. When
contacting an FAS server, clients verify the FAS servers HOST \<fqdn> Kerberos identity. All servers that access the FAS
server must have identical FQDN congurations for the same index; otherwise, StoreFront and VDAs may contact different
FAS servers.
To avoid misconguration, Citrix recommends that a single policy be applied to all machines in the environment. Take care
when modifying the list of FAS servers, especially when removing or reordering entries.
Control of this GPO should be limited to FAS administrators (and/or domain administrators) who install and decommission
FAS servers. Take care to avoid reusing a machine FQDN name shortly after decommissioning an FAS server.
Certicate templates
If you do not want to use the Citrix_SmartcardLogon certicate template supplied with the FAS, you can modify a copy of
it. T he following modications are supported.
Rename a certicate template
If you want to rename the Citrix_SmartcardLogon to match your organizational template naming standard, you must:
Create a copy of the certificate template and rename it to match your organizational template naming standard.
Use FAS PowerShell commands to administer FAS, rather than the administrative user interface. (T he administrative user
interface is only intended for use with the Citrix default template names.)
Either use the Microsoft MMC Certificate T emplates snap-in or the Publish-FasMsT emplate command to publish your
template, and
Use the New-FasCertificateDefinition command to configure FAS with the name of your template.
Modif y General properties

You can modify the Validity period in the certicate template.
Do not modify the Renewal period. FAS ignores this setting in the certicate template. FAS automatically renews the
certicate halfway through its validity period.
Modif y Request Handling properties
Do not modify these properties. FAS ignores these settings in the certicate template. FAS always deselects Allow private
key to be exported and deselects Renew with same key.
Modif y Cryptography properties
Do not modify these properties. FAS ignores these settings in the certicate template.
Refer to Federated Authentication Service private key protection for equivalent settings that FAS provides.
Modif y Key Attestation properties
Do not modify these properties. FAS does not support key attestation.
Modif y Superseded Templates properties
Do not modify these properties. FAS does not support superseding templates.
Modif y Extensions properties
You can modify these settings to match your organizational policy.
Note: Inappropriate Extension settings may cause security issues, or result in unusable certicates.
Modif y Security properties
Citrix recommends that you modify these settings to Allow the Enroll permission for only the machine accounts of the FAS
servers. As for other services, also Allow the Full Control permission for SYST EM. No other permissions are required. You
may want to Allow other permissions, for example to allow FAS administrators to view a modied template for
troubleshooting purposes.

Modif y Subject Name properties
You can modify these settings to match your organizational policy, if needed.
Modif y Server properties
Although Citrix does not recommend it, you can modify these settings to match your organizational policy, if needed.
Modif y Issuance requirements properties
Do not modify these settings. T hese settings should be as shown:

Modif y Compatibility properties
You can modify these settings. T he setting must be at least Windows Server 2003 CAs (schema version 2). However, FAS
supports only Windows Server 2008 and later CAs. Also, as explained above, FAS ignores the additional settings available by
selecting Windows Server 2008 CAs (schema version 3) or Windows Server 2012 CAs (schema version 4).
Certicate authority administration

T he CA administrator is responsible for the conguration of the CA server and the issuing certicate private key that it uses.
Publishing templates
For a certicate authority to issue certicates based on a template supplied by the enterprise administrator, the CA
administrator must choose to publish that template.
A simple security practice is to publish only the RA certicate templates when the FAS servers are being installed, or to insist
on a completely ofine issuance process. In either case, the CA administrator should maintain complete control over
authorizing RA certicate requests, and have a policy for authorizing FAS servers.
Firewall settings
Generally, the CA administrator will also have control of the network rewall settings of the CA, allowing control over
incoming connections. T he CA administrator can congure DCOM TCP and rewall rules so that only FAS servers can
request certicates.
Restricted enrollment
By default any holder of an RA certicate can issue certicates to any user, using any certicate template that allows

access. T his should be restricted to a group of non-privileged users using the Restrict enrollment agents CA property.
Policy modules and auditing
For advanced deployments, custom security modules can be used to track and veto certicate issuance.
FAS administration
T he FAS has several security features.
Restrict StoreFront , users, and VDAs through an ACL
At the center of the FAS security model is the control for which Kerberos accounts can access functionality:
Access Vector Description
StoreFront [IdP] T hese Kerberos accounts are trusted to declare that a user has been correctly
authenticated. If one of these accounts is compromised, then certicates can be created
and used for users allowed by the conguration of the FAS.
VDAs [Relying party] T hese are the machines that are allowed to access the certicates and private keys. A
credential handle retrieved by the IdP is also needed, so a compromised VDA account in this
group has limited scope to attack the system.
Users T his controls which users can be asserted by the IdP. Note that there is overlap with the
Restricted Enrollment Agent conguration options at the CA.

In general, it is advisable to include only non-privileged accounts in this list. T his prevents a
compromised StoreFront account from escalating privileges to a higher administrative level.
In particular, domain administrator accounts should not be allowed by this ACL.
Congure rules
Rules are useful if multiple independent XenApp or XenDesktop deployments use the same FAS server infrastructure. Each
rule has a separate set of conguration options; in particular, the ACLs can be congured independently.
Congure the CA and templates
Different certicate templates and CAs can be congured for different access rights. Advanced congurations may
choose to use less or more powerful certicates, depending on the environment. For example, users identied as external
may have a certicate with fewer privileges than internal users.
In-session and authentication certicates
T he FAS administrator can control whether the certicate used to authenticate is available for use in the users session.
For example, this could be used to have only signing certicates available in-session, with the more powerful logon
certicate being used only at logon.
Private key protection and key length
T he FAS administrator can congure FAS to store private keys in a Hardware Security Module (HSM) or Trusted Platform
Module (T PM). Citrix recommends that at least the RA certicate private key is protected by storing it in a T PM; this option
is provided as part of the ofine certicate request process.
Similarly, user certicate private keys can be stored in a T PM or HSM. All keys should be generated as non-exportable and
be at least 2048 bits in length.
Event logs
T he FAS server provides detailed conguration and runtime event logs, which can be used for auditing and intrusion
detection.
Administrative access and administration tools
T he FAS includes remote administration features (mutually authenticated Kerberos) and tools. Members of the Local
Administrators Group have full control over FAS conguration. T his list should be carefully maintained.
XenApp, XenDesktop, and VDA administrators

In general, the use of the FAS doesnt change the security model of the Delivery Controller and VDA administrators, as the
FAS credential handle simply replaces the Active Directory password. Controller and VDA administration groups should
contain only trusted users. Auditing and event logs should be maintained.
General Windows server security

All servers should be fully patched and have standard rewall and anti-virus software available. Security-critical
infrastructure servers should be kept in a physically secure location, with care taken over disk encryption and virtual machine
maintenance options.
Auditing and event logs should be stored securely on a remote machine.
RDP access should be limited to authorized administrators. Where possible, user accounts should require smart card logon,
especially for CA and domain administrator accounts.
Related information
FAS architectures are introduced in the Federated Authentication Service architectures overview article.

Federated Authentication Service troubleshoot
Windows logon issues
May 22, 20 17
In this article:
Certificates and public key infrastructure

UPN name and certificate mapping
Control logon domain controller selection
Enable account audit events
Certificate validation logs
Kerberos logs
Event log messages
End user error messages
Related information
T his article describes the logs and error messages Windows provides when a user logs on using certicates and/or smart
cards. T hese logs provide information you can use to troubleshoot authentication failures.
Certicates and public key infrastructure

Windows Active Directory maintains several certicate stores that manage certicates for users logging on.
NTAuth certif icate store: T o authenticate to Windows, the CA immediately issuing user certificates (that is, no
chaining is supported) must be placed in the NT Auth store. T o see these certificates, from the certutil program, enter:
certutil viewstore enterprise NT Auth.
Root and intermediate certif icate stores: Usually, certificate logon systems can provide only a single certificate, so if
a chain is in use, the intermediate certificate store on all machines must include these certificates. T he root certificate
must be in the T rusted Root Store, and the penultimate certificate must be in the NT Auth store.
Logon certif icate extensions and Group Policy: Windows can be configured to enforce verification of EKUs and
other certificate policies. See the Microsoft documentation: https://technet.microsoft.com/en-
us/library/ff404287%28v=ws.10%29.aspx.
Registry policy Description
AllowCerticatesWithNoEKU When disabled, certicates must include the smart card logon
Extended Key Usage (EKU).
AllowSignatureOnlyKeys By default, Windows lters out certicates private keys that do

not allow RSA decryption. T his option overrides that lter.
AllowT imeInvalidCerticates By default, Windows lters out expired certicates. T his option
overrides that lter.

EnumerateECCCerts Enables elliptic curve authentication.
X509HintsNeeded If a certicate does not contain a unique User Principal Name

(UPN), or it could be ambiguous, this option allows users to
manually specify their Windows logon account.
UseCachedCRLOnlyAnd Disables revocation checking (usually set on the domain

controller).
IgnoreRevocationUnknownErrors
Domain controller certif icates: T o authenticate Kerberos connections, all servers must have appropriate Domain
Controller certificates. T hese can be requested using the Local Computer Certificate Personal Store MMC snap-in
menu.
UPN name and certicate mapping

It is recommended that user certicates include a unique User Principal Name (UPN) in the Subject Alternate Name
extension.
UPN names in Active Directory
By default, every user in Active Directory has an implicit UPN based on the pattern <samUsername>@<domainNetBios> and
<samUsername>@<domainFQDN>. T he available domains and FQDNs are included in the RootDSE entry for the forest.
Note that a single domain can have multiple FQDN addresses registered in the RootDSE.
Additionally, every user in Active Directory has an explicit UPN and altUserPrincipalNames. T hese are LDAP entries that
specify the UPN for the user.
When searching for users by UPN, Windows looks rst in the current domain (based on the identity of the process looking
up the UPN) for explicit UPNs, then alterative UPNs. If there are no matches, it looks up the implicit UPN, which may resolve
to different domains in the forest.
Certicate Mapping Service
If a certicate does not include an explicit UPN, Active Directory has the option to store an exact public certicate for each
use in an x509certicate attribute. To resolve such a certicate to a user, a computer can query for this attribute directly
(by default, in a single domain).
An option is provided for the user to specify a user account that speeds up this search, and also allows this feature to be
used in a cross-domain environment.
If there are multiple domains in the forest, and the user does not explicitly specify a domain, the Active Directory rootDSE
species the location of the Certicate Mapping Service. T his is usually located on a global catalog machine, and has a
cached view of all x509certicate attributes in the forest. T his computer can be used to efciently nd a user account in

any domain, based on only the certicate.
Control logon domain controller selection

When an environment contains multiple domain controllers, it is useful to see and restrict which domain controller is used
for authentication, so that logs can be enabled and retrieved.
Control domain controller selection
To force Windows to use a particular Windows domain controller for logon, you can explicitly set the list of domain
controllers that a Windows machine uses by conguring the lmhosts le: \Windows\System32\drivers\etc\lmhosts.
T here is usually a sample le named lmhosts.sam in that location. Simply include a line:
1.2.3.4 dcnetbiosname #PRE #DOM:mydomai
Where "1.2.3.4" is the IP address of the domain controller named "dcnetbiosname" in the "mydomain" domain.
After a restart, the Windows machine uses that information to log on to mydomain. Note that this conguration must be
reverted when debugging is complete.
Identif y the domain controller in use
At logon, Windows sets an MSDOS environment variable with the domain controller that logged the user on. To see this,
start the command prompt with the command: echo %LOGONSERVER%.
Logs relating to authentication are stored on the computer returned by this command.
Enable account audit events

By default, Windows domain controllers do not enable full account audit logs. T his can be controlled through audit policies
in the security settings in the Group Policy editor. After they are enabled, the domain controller produces extra event log
information in the security log le.

Certicate validation logs
Check certicate validity
If a smartcard certicate is exported as a DER certicate (no private key required), you can validate it with the command:
certutil verify user.cer
Enable CAPI logging
On the domain controller and users machine, open the event viewer and enable logging for
Microsoft/Windows/CAPI2/Operational Logs.
You can control CAPI logging with the registry keys at: CurrentControlSet\Services\crypt32.
Value Description
DiagLevel (DWORD) Verbosity level (0 to 5)
DiagMatchAnyMask (QUADWORD) Event lter (use 0xffffff for all)
DiagProcessName (MULT I_SZ) Filter by process name (for example, LSASS.exe)
CAPI logs
Message Description
Build Chain LSA called CertGetCerticateChain (includes result)
Verify Revocation LSA called CertVerifyRevocation (includes result)
X509 Objects In verbose mode, certicates and Certicate Revocation Lists (CRLs) are dumped to
AppData\LocalLow\Microsoft\X509Objects
Verify Chain Policy LSA called CertVerifyChainPolicy (includes parameters)
Error messages
Error code Description
Certicate not trusted T he smart card certicate could not be built using
certicates in the computer's intermediate and trusted

root certicate stores.
Certicate revocation check error T he CRL for the smart card could not be downloaded
from the address specied by the certicate CRL
distribution point. If revocation checking is mandated, this
prevents logon from succeeding. See the Certicates and
public key infrastructure section.
Certicate Usage errors T he certicate is not suitable for logon. For example, it
might be a server certicate or a signing certicate.
Kerberos logs
To enable Kerberos logging, on the domain controller and the end user machine, create the following registry values:
Hive Value name Value [DWORD]
CurrentControlSet\Control\Lsa\Kerberos\Parameters LogLevel 0x1
CurrentControlSet\Control\Lsa\Kerberos\Parameters KerbDebuglevel 0xffffffff
CurrentControlSet\Services\Kdc KdcDebugLevel 0x1
CurrentControlSet\Services\Kdc KdcExtraLogLevel 0x1f
Kerberos logging is output to the System event log.
Messages such as untrusted certificate should be easy to diagnose.

T wo error codes are informational, and can be safely ignored:
KDC_ERR_PREAUT H_REQUIRED (used for backward compatibility with older domain controllers)
Unknown error 0x4b
Event log messages

T his section describes the expected log entries on the domain controller and workstation when the user logs on with a
certicate.
Domain controller CAPI2 log

Domain controller security logs
VDA security log

VDA CAPI log
VDA system log
Domain controller CAPI2 log
During a logon, the domain controller validates the callers certicate, producing a sequence of log entries in the following
form.
T he nal event log message shows lsass.exe on the domain controller constructing a chain based on the certicate
provided by the VDA, and verifying it for validity (including revocation). T he result is returned as ERROR_SUCCESS.
Domain controller security log
T he domain controller shows a sequence of logon events, the key event being 4768, where the certicate is used to issue
the Kerberos T icket Granting T icket (krbtgt).
T he messages before this show the machine account of the server authenticating to the domain controller. T he messages
following this show the user account belonging to the new krbtgt being used to authenticate to the domain controller.

VDA security log
T he VDA security audit log corresponding to the logon event is the entry with event ID 4648, originating from
winlogon.exe.

VDA CAPI log
T his example VDA CAPI log shows a single chain build and verication sequence from lsass.exe, validating the domain
controller certicate (dc.citrixtest.net).
VDA system log

When Kerberos logging is enabled, the system log shows the error KDC_ERR_PREAUT H_REQUIRED (which can be ignored),
and an entry from Winlogon showing that the Kerberos logon was successful.
End user error messages

T his section lists common error messages displayed to a user on the Windows logon page.
Error message displayed Description and reference
Invalid Username or Password T he computer believes that you have a valid certicate
and private key, but the Kerberos domain controller has
rejected the connection. See the Kerberos logs section of
this article.
T he system could not log you on. Your credentials could T he domain controller cannot be contacted, or the
not be veried. domain controller does not have appropriate certicates
installed.
Re-enroll the Domain Controller and Domain Controller

T he request is not supported
Authentication certicates on the domain controller, as
described in CT X206156. T his is usually worth trying, even
when the existing certicates appear to be valid.
T he system could not log you on. T he smartcard T he intermediate and root certicates are not installed on
certicate used for authentication was not trusted. the local computer. See CT X206156 for instructions on
installing smart card certicates on non-domain joined
computers. Also, see the Certicates and public key

infrastructure section in this article.
You cannot logon because smart card logon is not A workgroup user account has not been fully congured
supported for your account. for smart card logon.
T he requested key does not exist A certicate references a private key that is not
accessible. T his can happen when a PIV card is not
completely congured and is missing the CHUID or CCC
le.
An error occurred when trying to use the smart card T he smart card middleware was not installed correctly.
See CT X206156 for smart card installation instructions.
Insert a smart card T he smart card or reader was not detected. If the smart
card is inserted, this message indicates a hardware or
middleware issue. See CT X206156 for smart card
installation instructions.
T he PIN is incorrect T he smart card rejected a PIN entered by the user.
No valid smart card certicate could be found. T he extensions on the certicate might not be set
correctly, or the RSA key is too short (<2048 bits). See
CT X206901 for information about generating valid smart
card certicates.
T he smart card is blocked A smart card has been locked (for example, the user
entered an incorrect pin multiple times).
An administrator may have access to the pin unlock (puk)

code for the card, and can reset the user pin using a tool
provided by the smart card vendor.
If the puk code is not available, or locked out, the card

must be reset to factory settings.
Bad Request A smart card private key does not support the
cryptography required by the domain controller. For
example, the domain controller might have requested a
private key decryption, but the smart card supports only
signing.
T his usually indicates that the extensions on the

certicate are not set correctly, or the RSA key is too
short (<2048 bits). See CT X206901 for information about

generating valid smart card certicates.
Related information
Configuring a domain for smart card logon: http://support.citrix.com/article/CT X206156
Smartcard logon policies: https://technet.microsoft.com/en-us/library/ff404287%28v=ws.10%29.aspx
Enabling CAPI logging: http://social.technet.microsoft.com/wiki/contents/articles/242.troubleshooting-pki-problems-on-
windows.aspx
Enabling Kerberos logging: https://support.microsoft.com/en-us/kb/262177
Guidelines for enabling smart card logon with third-party certification authorities: https://support.microsoft.com/en-
us/kb/281245

Federated Authentication Service PowerShell cmdlets
May 22, 20 17
You can use the Federated Authentication Service administration console for simple deployments; however, the PowerShell
interface offers more advanced options. If you plan to use options that are not available in the console, Citrix recommends
using only PowerShell for conguration.
T he following command adds the FAS PowerShell cmdlets:
In a PowerShell window, you can use Get-Help <cmdlet name> to display cmdlet help.
T he zip le linked below contains help les for all FAS PowerShell SDK cmdlets. To use it, click the link, which will download
the zip le. T hen extract its content to a local folder. T he index.html le lists all cmdlets, with links to individual cmdlet help
les.
ZIP Federated Authentication Service PowerShell cmdlet help les

Print
May 22, 20 17
Managing printers in your environment is a multistage process:
1. Become familiar with printing concepts, if you are not already.

2. Plan your printing architecture. T his includes analyzing your business needs, your existing printing infrastructure, how your
users and applications interact with printing today, and which printing management model best applies to your
environment.
3. Configure your printing environment by selecting a printer provisioning method and then creating policies to deploy your
printing design. Update policies when new employees or servers are added.
4. T est a pilot printing configuration before deploying it to users.
5. Maintain your Citrix printing environment by managing printer drivers and optimizing printing performance.
6. T roubleshoot issues that may arise.
Printing concepts
Before you begin planning your deployment, make sure that you understand these core concepts for printing:
T he types of printer provisioning available

How print jobs are routed
T he basics of printer driver management
Printing concepts build on Windows printing concepts. To congure and successfully manage printing in your environment,
you must understand how Windows network and client printing works and how this translates into printing behavior in this
environment.
Print process
In this environment, all printing is initiated (by the user) on machines hosting applications. Print jobs are redirected through
the network print server or user device to the printing device.
T here is no persistent workspace for users of virtual desktops and applications. When a session ends the user's workspace
is deleted, thus all settings need to be rebuilt at the beginning of each session. As a result, each time a user starts a new
session, the system must rebuild the user's workspace.
When a user prints:

Determines what printers to provide to the user. T his is known as printer provisioning.
Restores the user's printing preferences.
Determines which printer is the default for the session.
You can customize how to perform these tasks by conguring options for printer provisioning, print job routing, printer
property retention, and driver management. Be sure to evaluate how the various option settings might change the
performance of printing in your environment and the user experience.
Printer provisioning
T he process that makes printers available in a session is known as provisioning. Printer provisioning is typically handled
dynamically. T hat is, the printers that appear in a session are not predetermined and stored. Instead, the printers are
assembled, based on policies, as the session is built during log on and reconnection. As a result, the printers can change

according to policy, user location, and network changes, provided they are reected in policies. T hus, users who roam to a
different location might see changes to their workspace.
T he system also monitors client-side printers and dynamically adjusts in-session auto-created printers based on additions,
deletions, and changes to the client-side printers. T his dynamic printer discovery benets mobile users as they connect from
various devices.
T he most common methods of printer provisioning are:
Universal Print Server - T he Citrix Universal Print Server provides universal printing support for network printers. T he
Universal Print Server uses the Universal print driver. T his solution enables you to use a single driver on a Server OS
machine to allow network printing from any device.
Citrix recommends the Citrix Universal Print Server for remote print server scenarios. T he Universal Print Server transfers
the print job over the network in an optimized and compressed format, thus minimizing network use and improving the
user experience.
T he Universal Print Server feature comprises:
A client component, UPClient - Enable the UPClient on each Server OS machine that provisions session network
printers and uses the Universal print driver.
A server component, UPServer - Install UPServer on each print server that provisions session network printers and uses
the Universal print driver for the session printers (whether or not the session printers are centrally provisioned).
For Universal Print Server requirements and setup details, refer to the system requirements and installation articles.
T he following illustration shows the typical workow for a network based printer in an environment that uses Universal
Print Server.

When you enable the Citrix Universal Print Server, all connected network printers leverage it automatically through
auto-discovery.
Note: T he Universal Print Server is also supported for VDI-in-a-Box 5.3. For information about installing Universal Print
Server with VDI-in-a-Box, refer to the VDI-in-a-Box documentation.
Autocreation - Autocreation refers to printers automatically created at the beginning of each session. Both remote
network printers and locally attached client printers can be auto-created. Consider auto-creating only the default client
printer for environments with a large number of printers per user. Auto-creating a smaller number of printers uses less
overhead (memory and CPU) on Server OS machines. Minimizing auto-created printers can also reduce user logon times.
Auto-created printers are based on:
T he printers installed on the user device.

Any policies that apply to the session.
Autocreation policy settings enable you to limit the number or type of printers that are auto-created. By default, the
printers are available in sessions when conguring all printers on the user device automatically, including locally
attached and network printers.
After the user ends the session, the printers for that session are deleted.
Client and network printer autocreation has associated maintenance. For example, adding a printer requires that you:
Update the Session printers policy setting.

Add the driver to all Server OS machines using the Printer driver mapping and compatibility policy setting.
Print job routing
T he term printing pathway e ncompasses both the path by which print jobs are routed and the location where print jobs are
spooled. Both aspects of this concept are important. Routing affects network trafc. Spooling affects utilization of local
resources on the device that processes the job.
In this environment, print jobs can take two paths to a printing device: through the client or through a network print server.
T hose paths are referred to as the client printing pathway and the network printing pathway. Which path is chosen by
default depends on the kind of printer used.
Locally attached printers
T he system routes jobs to locally attached printers from the Server OS machine, through the client, and then to the print
device. T he ICA protocol optimizes and compresses the print job trafc. When a printing device is attached locally to the
user device, print jobs are routed over the ICA virtual channel.
Network-based printers
By default, all print jobs destined for network printers route from the Server OS machine, across the network, and directly
to the print server. However, print jobs are automatically routed over the ICA connection in the following situations:
If the virtual desktop or application cannot contact the print server.
If the native printer driver is not available on the Server OS machine.
If the Universal Print Server is not enabled, conguring the client printing pathway for network printing is useful for low
bandwidth connections, such as wide area networks, that can benet from the optimization and trafc compression that
results from sending jobs over the ICA connection.
T he client printing pathway also lets you limit trafc or restrict bandwidth allocated for print jobs. If routing jobs through
the user device is not possible, such as for thin clients without printing capabilities, Quality of Service should be congured
to prioritize ICA/HDX trafc and ensure a good in-session user experience.

Print driver management
T he Citrix Universal Printer Driver (UPD) is a device independent print driver, which has been designed to work with most
printers. T he Citrix UPD consists of two components:
Server component. T he Citrix UPD is installed as part of the XenApp or XenDesktop VDA installation. T he VDA installs the
following drivers with Citrix UPD: "Citrix Universal Printer" (EMF driver) and the "Citrix XPS Universal Printer" (XPS driver).
When a print job is initiated the driver records the output of the application and sends it, without any modication to the
end-point device.
Client component. T he Citrix UPD is installed as part of the Citrix Receiver installation. It fetches the incoming print stream
for the XenApp or XenDesktop session and forwards it to the local printing sub-system where the print job is rendered
using the device specic printer drivers. In addition to Citrix UPD, the Citrix PDF Universal Printer driver can be installed
separately with Citrix Receiver for HT ML5 and Citrix Receiver for Chrome.
T he Citrix UPD supports the following print formats:
Enhanced Metafile Format (EMF), default. EMF is the 32-bit version of the Windows Metafile (WMF) format. T he EMF
driver can only be used by Windows based clients.
XML Paper Specification (XPS). T he XPS driver uses XML to create a platform-independent "electronic paper" similar to
Adobe's PDF format.
Printer Command Language (PCL5c and PCL4 ). PCL is a printing protocol developed originally by Hewlett-Packard for
inkjet printers. It is used for printing basic text and graphics and is widely supported on HP LaserJet and multifunction
peripherals.
PostScript (PS). PostScript is a computer language that can be used for printing text and vector graphics. T he driver is
widely used in low-cost printers and multifunction peripherals.
T he PCL and PS drivers are best suited when using non-Windows based devices such as a Mac or UNIX client. T he order in
which Citrix UPD attempts to use the drivers can be changed using the Universal driver preference policy setting.
T he Citrix UPD (EMF and XPS drivers) supports advanced printing features such as stapling and paper source selection.
T hese features are available if the native driver makes them available using the Microsoft Print Capability technology. T he
native driver should use the standardized Print Schema Keywords in the Print Capabilities XML. If non-standard keywords

are used, the advanced printing features will not be available using Citrix Universal print driver.
T he following illustration shows the Universal print driver components and a typical workow for a printer locally attached
to a device.
When planning your driver management strategy, determine if you will support the Universal print driver, device-specic
drivers, or both. If you support standard drivers, you need to determine:
During printer autocreation, if the system detects a new local printer connected to a user device, it checks the Server OS
machine for the required printer driver. By default, if a Windows-native driver is not available, the system uses the Universal
print driver.
T he printer driver on the Server OS machine and the driver on the user device must match for printing to succeed. T he
illustration that follows shows how a printer driver is used in two places for client printing.

T he types of drivers to support.
Whether to install printer drivers automatically when they are missing from Server OS machines.
Whether to create driver compatibility lists.
Related content
Printing configuration example

Best practices, security considerations, and default operations
Print policies and preferences
Provision printers

Printing conguration example
May 22, 20 17
Choosing the most appropriate printing conguration options for your needs and environment can simplify administration.
Although the default print conguration enables users to print in most environments, the defaults might not provide the
expected user experience or the optimum network usage and management overhead for your environment.
Your printing configuration depends upon:

Your business needs and your existing printing infrastructure.
Design your printing conguration around the needs of your organization. Your existing printing implementation
(whether users can add printers, which users have access to what printers, and so on) might be a useful guide when
dening your printing conguration.
Whether your organization has security policies that reserve printers for certain users (for example, printers for Human
Resources or payroll).
Whether users need to print while away from their primary work location, such as workers who move between
workstations or travel on business.
When designing your printing conguration, try to give users the same experience in a session as they have when printing
from local user devices.
xample print deployment
T he following illustration shows the print deployment for these use cases:
Branch A - A small overseas branch office with a few Windows workstations. Every user workstation has a locally
attached, private printer.
Branch B - A large branch office with thin clients and Windows-based workstations. For increased efficiency, the users
of this branch share network-based printers (one per floor). Windows-based print servers located within the branch
manage the print queues.
Home of f ice - A home office with a Mac OS-based user device that accesses the company's Citrix infrastructure. T he
user device has a locally attached printer.

T he following sections describe the congurations which minimize the complexity of the environment and simplify its
management.
Auto-created client printers and Citrix Universal printer driver
In Branch A, all users work on Windows-based workstations, therefore auto-created client printers and the Universal printer
driver are used. T hose technologies provide these benefits:
Performance - Print jobs are delivered over the ICA printing channel, thus the print data can be compressed to save
bandwidth.
To ensure that a single user printing a large document cannot degrade the session performance of other users, a Citrix
policy is congured to specify the maximum printing bandwidth.
An alternative solution is to leverage a multi-stream ICA connection, in which the print trafc is transferred within a
separate low priority TCP connection. Multi-stream ICA is an option when Quality of Service (QoS) is not implemented on
the WAN connection.

Flexibility - Use of the Citrix Universal printer driver ensures that all printers connected to a client can also be used from a
virtual desktop or application session without integrating a new printer driver in the data center.
Citrix Universal Print Server
In Branch B, all printers are network-based and their queues are managed on a Windows print server, thus the Citrix Universal
Print Server is the most efcient conguration.
All required printer drivers are installed and managed on the print server by local administrators. Mapping the printers into
the virtual desktop or application session works as follows:
For Windows-based workstations - T he local IT team helps users connect the appropriate network-based printer to
their Windows workstations. T his enables users to print from locally-installed applications.
During a virtual desktop or application session, the printers congured locally are enumerated through autocreation. T he
virtual desktop or application then connects to the print server as a direct network connection if possible.
T he Citrix Universal Print Server components are installed and enabled, thus native printer drivers are not required. If a
driver is updated or a printer queue is modied, no additional conguration is required in the data center.
For thin clients - For thin client users, printers must be connected within the virtual desktop or application session. T o
provide users with the simplest printing experience, administrators configure a single Citrix Session Printer policy per floor
to connect a floor's printer as the default printer.
To ensure the correct printer is connected even if users roam between oors, the policies are ltered based on the
subnet or the name of the thin client. T hat conguration, referred to as proximity printing, allows for local printer driver
maintenance (according to the delegated administration model).
If a printer queue needs to be modied or added, Citrix administrators must modify the respective Session printer policy
within the environment.
Because the network printing trafc will be sent outside the ICA virtual channel, QoS is implemented. Inbound and
outbound network trafc on ports used by ICA/HDX trafc are prioritized over all other network trafc. T hat conguration
ensures that user sessions are not impacted by large print jobs.
Auto-created client printers and Citrix Universal printer driver
For home ofces where users work on non-standard workstations and use non-managed print devices, the simplest
approach is to use auto-created client printers and the Universal printer driver.
Deployment summary
In summary, the sample deployment is configured as follows:

No printer drivers are installed on Server OS machines. Only the Citrix Universal printer driver is used. Fallback to native
printing and the automatic installation of printer drivers are disabled.
A policy is configured to auto-create all client printers for all users. Server OS machines will directly connect to the print
servers by default. T he only configuration required is to enable the Universal Print Server components.
A session printer policy is configured for every floor of Branch B and applied to all thin clients of the respective floor.
QoS is implemented for Branch B to ensure excellent user experience.

Best practices, security considerations, and default
operations
May 22, 20 17
Best practices
Many factors determine the best printing solution for a particular environment. Some of these best practices might not
apply to your Site.
Use the Citrix Universal Print Server.
Use the Universal printer driver or Windows-native drivers.
Minimize the number of printer drivers installed on Server OS machines.
Use driver mapping to native drivers.
Never install untested printer drivers on a production site.
Avoid updating a driver. Always attempt to uninstall a driver, restart the print server, and then install the replacement
driver.
Uninstall unused drivers or use the Printer driver mapping and compatibility policy to prevent printers from being created
with the driver.
T ry to avoid using version 2 kernel-mode drivers.
T o determine if a printer model is supported, contact the manufacturer or see the Citrix Ready product guide at
www.citrix.com/ready.
In general, all of the Microsoft-supplied printer drivers are tested with Terminal Services and guaranteed to work with
Citrix. However, before using a third-party printer driver, consult your printer driver vendor so that the driver is certied for
Terminal Services by the Windows Hardware Quality Labs (WHQL) program. Citrix does not certify printer drivers.
Citrix printing solutions are secure by design.

T he Citrix Print Manager Service constantly monitors and responds to session events such as logon and logoff,
disconnect, reconnect, and session termination. It handles service requests by impersonating the actual session user.
Citrix printing assigns each printer a unique namespace in a session.
Citrix printing sets the default security descriptor for auto-created printers to ensure that client printers auto-created in
one session are inaccessible to users running in other sessions. By default, administrative users cannot accidentally print
to another session's client printer, even though they can see and manually adjust permissions for any client printer.
Def ault print operations
By default, if you do not configure any policy rules, printing behavior is as follows:
T he Universal Print Server is disabled.
All printers configured on the user device are created automatically at the beginning of each session.
T his behavior is equivalent to conguring the Citrix policy setting Auto-create client printers with the Auto-create all
client printers option.
T he system routes all print jobs queued to printers locally attached to user devices as client print jobs (that is, over the
ICA channel and through the user device).
T he system routes all print jobs queued to network printers directly from Server OS machines. If the system cannot route
the jobs over the network, it will route them through the user device as a redirected client print job.
T his behavior is equivalent to disabling the Citrix policy setting Direct connection to print servers.

T he system attempts to store printing properties, a combination of the user's printing preferences and printing device-
specific settings, on the user device. If the client does not support this operation, the system stores printing properties in
user profiles on the Server OS machine.
T his behavior is equivalent to conguring the Citrix policy setting Printer properties retention with the Held in prole only
if not saved on client option.
T he system uses the Windows version of the printer driver if it is available on the Server OS machine. If the printer driver is
not available, the system attempts to install the driver from the Windows operating system. If the driver is not available
in Windows, it uses a Citrix Universal print driver.
T his behavior is equivalent to enabling the Citrix policy setting Automatic installation of in-box printer drivers and
conguring the Universal printing setting with the Use universal printing only if requested driver is unavailable.
Enabling Automatic installation of in-box printer drivers might result in the installation of a large number of native printer
drivers.
Note: If you are unsure about what the shipping defaults are for printing, display them by creating a new policy and setting
all printing policy rules to Enabled. T he option that appears is the default.
Always-On logging
An Always-On logging feature is available for the print server and printing subsystem on the VDA.
To collate the logs as a ZIP for emailing, or to automatically upload logs to Citrix Insight Services, use the Start-
TelemetryUpload PowerShell cmdlet.

Printing policies and preferences
May 22, 20 17
When users access printers from published applications, you can configure Citrix policies to specify:
How printers are provisioned (or added to sessions)
How print jobs are routed
How printer drivers are managed
You can have different printing congurations for different user devices, users, or any other objects on which policies are
ltered.
Most printing functions are congured through the Citrix Printing policy settings. Printing settings follow standard Citrix
policy behavior.
T he system can write printer settings to the printer object at the end of a session or to a client printing device, provided the
users network account has sufcient permissions. By default, Citrix Receiver uses the settings stored in the printer object in
the session, before looking in other locations for settings and preferences.
By default, the system stores, or retains, printer properties on the user device (if supported by the device) or in the user
prole on the Server OS machine. When a user changes printer properties during a session, those changes are updated in
the user prole on the machine. T he next time the user logs on or reconnects, the user device inherits those retained
settings. T hat is, printer property changes on the user device do not impact the current session until after the user logs off
and then logs on again.
Printing pref erence locations
In Windows printing environments, changes made to printing preferences can be stored on the local computer or in a
document. In this environment, when users modify printing settings, the settings are stored in these locations:
On the user device itself - Windows users can change device settings on the user device by right-clicking the printer in
the Control Panel and selecting Printing Preferences. For example, if Landscape is selected as page orientation,
landscape is saved as the default page orientation preference for that printer.
Inside of a document - In word-processing and desktop-publishing programs, document settings, such as page
orientation, are often stored inside documents. For example, when you queue a document to print, Microsoft Word
typically stores the printing preferences you specified, such as page orientation and the printer name, inside the
document. T hese settings appear by default the next time you print that document.
From changes a user made during a session - T he system keeps only changes to the printing settings of an auto-
created printer if the change was made in the Control Panel in the session; that is, on the Server OS machine.
On the Server OS machine - T hese are the default settings associated with a particular printer driver on the machine.
T he settings preserved in any Windows-based environment vary according to where the user made the changes. T his also
means that the printing settings that appear in one place, such as in a spreadsheet program, can be different than those in
others, such as documents. As result, printing settings applied to a specic printer can change throughout a session.
Hierarchy of user printing pref erences
Because printing preferences can be stored in multiple places, the system processes them according to a specic priority.
Also, it is important to note that device settings are treated distinctly from, and usually take precedence over, document
settings.

By default, the system always applies any printing settings a user modied during a session (that is, the retained settings)
before considering any other settings. When the user prints, the system merges and applies the default printer settings
stored on the Server OS machine with any retained or client printer settings.
Saving user printing pref erences
Citrix recommends that you do not change where the printer properties are stored. T he default setting, which saves the
printer properties on the user device, is the easiest way to ensure consistent printing properties. If the system is unable to
save properties on the user device, it automatically falls back to the user prole on the Server OS machine.
Review the Printer properties retention policy setting if these scenarios apply:
If you use legacy plug-ins that do not allow users to store printer properties on a user device.
If you use mandatory profiles on your Windows network and want to retain the user's printer properties.

Provision printers
May 25, 20 17
T here are three printer provisioning methods:
Auto-created client printers
Administrator-assigned session printers
When determining the best print solution for your environment, consider the following:
T he Universal Print Server provides features not available for the Windows Print Provider: Image and font caching,
advanced compression, optimization, and QoS support.
T he Universal print driver supports the public device-independent settings defined by Microsoft. If users need access to
device settings that are specific to a print driver manufacturer, the Universal Print Server paired with a Windows-native
driver might be the best solution. With that configuration, you retain the benefits of the Universal Print Server while
providing users access to specialized printer functionality. A trade-off to consider is that Windows-native drivers require
maintenance.
T he Citrix Universal Print Server provides universal printing support for network printers. T he Universal Print Server uses the
Universal print driver, a single driver on the Server OS machine that allows local or network printing from any device,
including thin clients and tablets.
To use the Universal Print Server with a Windows-native driver, enable the Universal Print Server. By default, if the Windows-
native driver is available, it is used. Otherwise, the Universal print driver is used. To specify changes to that behavior, such as
to use only the Windows-native driver or only the Universal print driver, update the Universal print driver usage policy setting.
Install the Universal Print Server

To use the Universal Print Server, install the UpsServer component on your print servers, as described in the installation
documents, and congure it. For more information, see Install core components and Install using the command line.
For environments where you want to deploy the UPClient component separately, for example with XenApp 6.5:
1. Download the XenApp and XenDesktop Virtual Delivery Agent (VDA) standalone package for Windows Desktop OS or
Windows Server OS.
2. Extract the VDA using the command line instructions described in Install using the command line.
3. Install the pre-requisites from the \Image-Full\Support\VcRedist_2013_RT M
Vcredist_x64 / vcredist_x86
Run x86 for 32-bit only, and both for 64-bit deployments
4. Install the cdf prerequisite from the \Image-Full\x64\Virtual Desktop Components or \Image-Full\x86\Virtual Desktop
Components.
Cdf_x64 / Cdf_x86
x86 for 32-bit, x64 for 64-bit
5. Find the UPClient component in \Image-Full\x64\Virtual Desktop Components or \Image-Full\x86\Virtual Desktop
Components.
6. Install the UPClient component by extracting and then launching the component's MSI.
7. A restart is required after installing the UPClient component.

Opt out of CEIP for the Universal Print Server
You are automatically enrolled in the Citrix Customer Experience Improvement Program (CEIP) when you install the Universal
Print Server. T he rst upload of data occurs after seven days from the date and time of installation.
To opt out of CEIP, edit the registry key HKLM\Sof tware\Citrix\Universal Print Server\CEIPEnabled and set the DWORD
value to 0.
To opt back in, set the DWORD value to 1.
For more information, see Citrix Insight Services.
Congure the Universal Print Server

Use the following Citrix policy settings to congure the Universal Print Server. For more information, refer to the on-screen
policy settings help.
Universal Print Server enable. Universal Print Server is disabled by default. When you enable Universal Print Server, you
choose whether to use the Windows Print Provider if the Universal Print Server is unavailable. After you enable the
Universal Print Server, a user can add and enumerate network printers through the Windows Print Provider and Citrix
Provider interfaces.
Universal Print Server print data stream (CGP) port. Specifies the T CP port number used by the Universal Print Server
print data stream CGP (Common Gateway Protocol) listener. Defaults to 7229.
Universal Print Server web service (HTTP/SOAP) port. Specifies the T CP port number used by the Universal Print
Server listener for incoming HT T P/SOAP requests. Defaults to 8080.
To change the default port of HT T P 8080 for Universal Print Server communication to XenApp and XenDesktop VDAs, the
following registry must also be created and the port number value modied on the Universal Print Server computer(s):
HKEY_LOCAL_MACHINE\SOFT WARE\Policies\Citrix\PrintingPolicies
"UpsHttpPort"=DWORD:<portnumber>
T his port number must match the HDX Policy, Universal Print Server web service (HT T P/SOAP) port, in Studio.
Universal Print Server print stream input bandwidth limit (kbps). Specifies the upper bound (in kilobits-per-second)
for the transfer rate of print data delivered from each print job to the Universal Print Server using CGP. Defaults
to 0 (unlimited).
Universal Print Servers f or load balancing. T his setting lists the Universal Print Servers to be used to load balance
printer connections established at session launch, after evaluating other Citrix printing policy settings. T o optimize printer
creation time, Citrix recommends that all print servers have the same set of shared printers.

Universal Print Servers out-of -service threshold. Specifies how long the load balancer should wait for an unavailable
print server to recover before it determines that the server is permanently offline and redistributes its load to other
available print servers. Default is 180 (seconds).
Once the printing policies are modied on the Delivery Controller, it can take a few minutes for the policy changes to be
applied to the VDAs.
Interactions with other policy settings - T he Universal Print Server honors other Citrix printing policy settings and
interacts with them as noted in the following table. T he information provided assumes that the Universal Print Server policy
setting is enabled, the Universal Print Server components are installed, and the policy settings are applied.
Policy setting Interaction
Client printer redirection, Auto-create client After the Universal Print Server is enabled, client network printers are
printers created using the Universal print driver instead of the native drivers.
Users see the same printer name as before.
Session printers When you use the Citrix Universal Print Server solution, Universal print
driver policy settings are honored.
Direct connections to print server When the Universal Print Server is enabled and the Universal print driver
usage policy setting is congured to use universal printing only, a direct
network printer connection can be created to the print server, using the
Universal print driver.
UPD preference Supports EMF and XPS drivers.
Ef f ects on user interf aces - T he Citrix Universal print driver used by the Universal Print Server disables the following user
interface controls:
In the Printer Properties dialog box, the Local Printer Settings button
In the Document Properties dialog box, the Local Printer Settings and Preview on client buttons

T he Citrix Universal print driver (EMF and XPS drivers) supports advanced printing features such as stapling and paper source.
T he user can select Stapling or Paper Source options from the custom UPD print dialog if the client or network printers
which are mapped to the UPD in the session support these features.
Custom UPD print dialog
To set non-standard printer settings such as stapling and secure PIN, select Local Settings in the customer UPD print
dialog for any client mapped printers that use either the Citrix UPD EMF or XPS drivers. T he Printing Pref erences dialog of
the mapped printer is displayed outside the session on the client, allowing the user to change any printer option, and the
modied printer settings are used in the active session when printing that document.
T hese features are available if the native driver makes them available using the Microsoft Print Capability technology. T he
native driver should use the standardized Print Schema Keywords in the Print Capabilities XML. If non-standard keywords
are used, the advanced printing features will not be available using Citrix Universal print driver.
When using the Universal Print Server, the Add Printer Wizard for the Citrix Print Provider is the same as the Add Printer
Wizard for the Windows Print Provider, with the following exceptions:
When adding a printer by name or address, you can provide an HT T P/SOAP port number for the print server. T hat port
number becomes a part of the printer name and appears in displays.
If the Citrix Universal print driver usage policy setting specifies that universal printing must be used, the Universal print
driver name appears when selecting a printer. T he Windows Print Provider cannot use the Universal print driver.
T he Citrix Print Provider does not support client-side rendering.
For more information about the Universal Print Server, see CT X200328.
Auto-created client printers

T hese universal printing solutions are provided for client printers:
Citrix Universal Printer - A generic printer created at the beginning of sessions that is not tied to a printing device. T he
Citrix Universal Printer is not required to enumerate the available client printers during logon, which can greatly reduce
resource usage and decrease user logon times. T he Universal Printer can print to any client-side printing device.
T he Citrix Universal Printer might not work for all user devices or Citrix Receivers in your environment. T he Citrix Universal
Printer requires a Windows environment and does not support the Citrix Ofine Plug-in or applications that are streamed
to the client. Consider using auto-created client printers and the Universal print driver for such environments.
To use a universal printing solution for non-Windows Citrix Receivers, use one of the other Universal print drivers that are
based on postscript/PCL and installed automatically.
Citrix Universal print drivers - A device-independent printer driver. If you configure a Citrix Universal print driver, the
system uses the EMF-based Universal print driver by default.
T he Citrix Universal print driver might create smaller print jobs than older or less advanced printer drivers. However, a
device-specic driver might be needed to optimize print jobs for a specialized printer.
Conf igure universal printing - Use the following Citrix policy settings to configure universal printing. For more information,
refer to the on-screen policy settings help.
Universal print driver usage. Specifies when to use universal printing.
Auto-create generic universal printer. Enables or disables auto-creation of the generic Citrix Universal Printer object for
sessions when a user device compatible with Universal Printing is in use. By default, the generic Universal Printer object is
not auto-created.
Universal driver preference. Specifies the order in which the system attempts to use Universal print drivers, beginning with
the first entry in the list. You can add, edit, or remove drivers and change the order of the drivers in the list.
Universal printing preview preference. Specifies whether to use the print preview function for auto-created or generic
universal printers.
Universal printing EMF processing mode. Controls the method of processing the EMF spool file on the Windows user
device. By default, EMF records are spooled directly to the printer. Spooling directly to the printer allows the spooler to
process the records faster and uses fewer CPU resources.
For more policies, see Optimize printing performance. To change the defaults for settings such as paper size, print quality,
color, duplex, and the number of copies, see CT X113148.
Auto-create printers f rom the user device - At the start of a session, the system auto-creates all printers on the user
device by default. You can control what, if any, types of printers are provisioned to users and prevent autocreation.
Use the Citrix policy setting Auto-create client printers to control autocreation. You can specify that:
All printers visible to the user device, including network and locally attached printers, are created automatically at the
start of each session (default)
All local printers physically attached to the user device is created automatically
Only the default printer for the user device is created automatically
Autocreation is disabled for all client printers
T he Auto-create client printers setting requires that the Client printer redirection setting is Allowed (the default).
Assign network printers to users
By default, network printers on the user device are created automatically at the beginning of sessions. T he system enables
you to reduce the number of network printers that are enumerated and mapped by specifying the network printers to be

created within each session. Such printers are referred to as session printers.
You can lter session printer policies by IP address to provide proximity printing. Proximity printing enables users within a
specied IP address range to automatically access the network printing devices that exist within that same range. Proximity
printing is provided by the Citrix Universal Print Server and does not require the conguration described in this section.
Proximity printing might involve the following scenario:

T he internal company network operates with a DHCP server which automatically designates IP addresses to users.
All departments within the company have unique designated IP address ranges.
Network printers exist within each department's IP address range.
When proximity printing is congured and an employee travels from one department to another, no additional printing
device conguration is required. Once the user device is recognized within the new department's IP address range, it will
have access to all network printers within that range.
Conf igure specif ic printers to be redirected in sessions - T o create administrator-assigned printers, configure the Citrix
policy setting Session printers. Add a network printer to that policy using one of the following methods:
Enter the printer UNC path using the format \\servername\printername.
Browse to a printer location on the network.
Browse for printers on a specific server. Enter the server name using the format \\servername and click Browse.
Important: T he server merges all enabled session printer settings for all applied policies, starting from the highest to lowest
priorities. When a printer is configured in multiple policy objects, custom default settings are taken from only the highest
priority policy object in which that printer is configured.
Network printers created with the Session printers setting can vary according to where the session was initiated by ltering
on objects such as subnets.
Specif y a def ault network printer f or a session - By default, the user's main printer is used as the default printer for the
session. Use the Citrix policy setting Default printer to change how the default printer on the user device is established in a
session.
1. On the Default printer settings page, select a setting for Choose client's default printer:
Network printer name. Printers added with the Session printers policy setting appear in this menu. Select the network
printer to use as the default for this policy.
Do not adjust the user's default printer. Uses the current T erminal Services or Windows user profile setting for the
default printer. For more information, refer to the on-screen policy settings help.
2. Apply the policy to the group of users (or other filtered objects) you want to affect.
Conf igure proximity printing - Proximity printing is also provided by the Citrix Universal Print Server, which does not require
the configuration described here.
1. Create a separate policy for each subnet (or to correspond with printer location).
2. In each policy, add the printers in that subnet's geographic location to the Session printers setting.
3. Set the Default printer setting to Do not adjust the user's default printer.
4. Filter the policies by client IP address. Be sure to update these policies to reflect changes to the DHCP IP address
ranges.

May 22, 20 17
Maintaining the printing environment includes:
Managing printer drivers
Optimizing printing performance
Displaying printer and managing print queues
Manage printer drivers
To minimize administrative overhead and the potential for print driver issues, Citrix recommends use of the Citrix Universal
print driver.
If auto-creation fails, by default, the system installs a Windows-native printer driver provided with Windows. If a driver is not
available, the system falls back to the Universal print driver. For more information about printer driver defaults, refer to Best
practices, security considerations, and default operations.
If the Citrix Universal print driver is not an option for all scenarios, map printer drivers to minimize the amount of drivers
installed on Server OS machines. In addition, mapping printer drivers enables you to:
Allow specified printers to use only the Citrix Universal print driver
Allow or prevent printers to be created with a specified driver
Substitute good printer drivers for outdated or corrupted drivers
Substitute a driver that is available on Windows server for a client driver name
Prevent the automatic installation of printer drivers - T he automatic installation of print drivers should be disabled to
ensure consistency across Server OS machines. T his can be achieved through Citrix policies, Microsoft policies, or both. To
prevent the automatic installation of Windows-native printer drivers, disable the Citrix policy setting Automatic installation
of in-box printer drivers.
Map client printer drivers - Each client provides information about client-side printers during logon, including the printer
driver name. During client printer autocreation, Windows server printer driver names are selected that correspond to the
printer model names provided by the client. T he autocreation process then uses the identied, available printer drivers to
construct redirected client print queues.
Here is the general process for defining driver substitution rules and editing print settings for mapped client printer drivers:
1. T o specify driver substitution rules for auto-created client printers, configure the Citrix policy setting Printer driver
mapping and compatibility by adding the client printer driver name and selecting the server driver that you want to
substitute for the client printer driver from the Find printer driver menu. You can use wildcards in this setting. For example,
to force all HP printers to use a specific driver, specify HP* in the policy setting.
2. T o ban a printer driver, select the driver name and choose the Do not create setting.
3. As needed, edit an existing mapping, remove a mapping, or change the order of driver entries in the list.
4. T o edit the printing settings for mapped client printer drivers, select the printer driver, click Settings, and specify settings
such as print quality, orientation, and color. If you specify a printing option that the printer driver does not support, that
option has no effect. T his setting overrides retained printer settings the user set during a previous session.
5. Citrix recommends testing the behavior of the printers in detail after mapping drivers, since some printer functionality can
be available only with a specific driver.
When users log on the system checks the client printer driver compatibility list before it sets up the client printers.

Optimize printing perf ormance
To optimize printing performance, use the Universal Print Server and Universal print driver. T he following policies control
printing optimization and compression:
Universal printing optimization defaults. Specifies default settings for the Universal Printer when it is created for a
session:
Desired image quality specifies the default image compression limit applied to universal printing. By default, Standard
Quality is enabled, meaning that users can only print images using standard or reduced quality compression.
Enable heavyweight compression enables or disables reducing bandwidth beyond the compression level set by Desired
image quality, without losing image quality. By default, heavyweight compression is disabled.
Image and Font Caching settings specify whether or not to cache images and fonts that appear multiple times in the
print stream, ensuring each unique image or font is sent to the printer only once. By default, embedded images and
fonts are cached.
Allow non-administrators to modify these settings specifies whether or not users can change the default print
optimization settings within a session. By default, users are not allowed to change the default print optimization
settings.
Universal printing image compression limit. Defines the maximum quality and the minimum compression level available for
images printed with the Universal print driver. By default, the image compression limit is set to Best Quality (lossless
compression).
Universal printing print quality limit. Specifies the maximum dots per inch (dpi) available for generating printed output in
the session. By default, no limit is specified.
By default, all print jobs destined for network printers route from the Server OS machine, across the network, and directly
to the print server. Consider routing print jobs over the ICA connection if the network has substantial latency or limited
bandwidth. To do that, disable the Citrix policy setting Direct connections to print servers. Data sent over the ICA
connection is compressed, so less bandwidth is consumed as the data travels across the WAN.
Improve session perf ormance by limiting printing bandwidth - While printing les from Server OS machines to user
printers, other virtual channels (such as video) may experience decreased performance due to competition for bandwidth
especially if users access servers through slower networks. To prevent such degradation, you can limit the bandwidth used
by user printing. By limiting the data transmission rate for printing, you make more bandwidth available in the HDX data
stream for transmission of video, keystrokes, and mouse data.
Important: T he printer bandwidth limit is always enforced, even when no other channels are in use.
Use the following Citrix policy Bandwidth printer settings to configure printing bandwidth session limits. T o set the limits for
the site, perform this task using Studio. T o set the limits for individual servers, perform this task using the Group Policy
Management Console in Windows locally on each Server OS machine.
T he Printer redirection bandwidth limit setting specifies the bandwidth available for printing in kilobits per second (kbps).
T he Printer redirection bandwidth limit percent setting limits the bandwidth available for printing to a percentage of the
overall bandwidth available.
Note: T o specify bandwidth as a percentage using the Printer redirection bandwidth limit percent setting, enable the
Overall session bandwidth limit as well.
If you enter values for both settings, the most restrictive setting (the lower value) is applied.
To obtain real-time information about printing bandwidth, use Citrix Director.
Load balance Universal Print Servers

T he Universal Print Server solution can scale by adding more print servers into the load balance solution. T here is no single
point of failure as each VDA has its own load balancer to distribute the printing load to all print servers.
Use the policy settings, Universal Print Servers for load balancing and Universal Print Servers out-of-service threshold, to
distribute the printing load across all the print servers in the load balance solution.
If there is an unforeseen failure of a print server, the failover mechanism of the load balancer in each VDA automatically
redistributes the printer connections allocated on the failed print servers to the other available print servers such that all
existing and incoming sessions function normally without affecting the user experience and without requiring the
immediate administrator intervention.
Administrators can monitor the activity of the load balanced print servers using a set of performance counters to track the
following on the VDA:
List of load balanced print servers on the VDA and their state (available, unavailable)
Number of printer connections accepted by each print server
Number of printer connections failed on each print server
Number of active printer connection on each print server
Number of pending printer connections on each print server
Display and manage print queues
T he following table summarizes where you can display printers and manage print queues in your environment.
Printing UAC Location

Pathway Enabled?
Client printers (Printers attached to the user Client On Print Management snap-in located in
device) printing the Microsoft Management Console
pathway
Off Pre-Windows 8: Control Panel
Windows 8: Print Management snap-in
Network printers (Printers on a network print Network On Print Server > Print Management snap-
server) printing in located in the Microsoft
pathway Management Console
Off Print Server > Control Panel
Network printers (Printers on a network print Client On Print Server > Print Management snap-
server) printing in located in the Microsoft
pathway Management Console
Off Pre-Windows 8: Control Panel

Windows 8: Print Management snap-in
Local network server printers (Printers from a Network On Print Server > Control Panel
network print server that are added to a Server OS printing
machine) pathway

Off Print Server > Control Panel
Printing UAC Location
Pathway Enabled?
Note: Print queues for network printers that use the network printing pathway are private and cannot be managed
through the system.

HDX
May 24 , 20 17
Citrix HDX includes a broad set of technologies that provide a high-definition user experience.
At the HDX leverages the computing capacity of user devices to enhance and optimize the user experience.
device HDX technology ensures users receive a smooth, seamless experience with multimedia content in their
virtual desktops or applications. Workspace control enables users to pause virtual desktops and
applications and resume working from a different device at the point where they left off.
On the HDX incorporates advanced optimization and acceleration capabilities to deliver the best performance
network over any network, including low-bandwidth and high-latency WAN connections.
HDX features adapt to changes in the environment, balancing performance and bandwidth by applying
the best technologies for each unique user scenario, whether the desktop or application is accessed
locally on the corporate network or remotely from outside the corporate rewall.
In the HDX leverages the processing power and scalability of servers to deliver advanced graphical performance,
datacenter regardless of the capabilities of the client device.
HDX channel monitoring provided by Citrix Director displays the status of connected HDX channels on
user devices.
HDX Insight, the integration of NetScaler Network Inspector and Performance Manager with Director,
captures data about ICA trafc and provides a dashboard view of real-time and historical details such as
client-side and server-side ICA session latency, bandwidth use of ICA channels, and the ICA round trip time
value of each session.
T o experience HDX capabilities from your virtual desktop:

See how Flash Redirection, one of three HDX multimedia redirection technologies, accelerates delivery of Adobe Flash
multimedia content:
1. Download Adobe Flash player (http://get.adobe.com/flashplayer/) and install it on both the virtual desktop and the
user device.
2. On the Desktop Viewer toolbar, click Preferences. In the Desktop Viewer Preferences dialog box, click the Flash tab
and select Optimize content.
3. T o experience how Flash Redirection accelerates the delivery of Flash multimedia content to virtual desktops, view a
video on your desktop from a web site containing Flash videos, such as YouT ube. Flash Redirection is designed to be
seamless so that users do not know when it is running. You can check to see whether Flash Redirection is being used
by looking for a block of color that appears momentarily before the Flash player starts, or by right-clicking on the
video and looking for Flash Redirection in the menu.
See how HDX delivers high definition audio:

1. Configure your Citrix client for maximum audio quality; see the Citrix Receiver documentation for details.
2. Play music files with a digital audio player (such as iT unes) on your desktop.
HDX provides a superior graphics and video experience for most users by default, with no configuration required. Citrix

policy settings that provide the best out-of-the-box experience for the majority of use cases are enabled by default.
HDX automatically selects the best delivery method based on the client, platform, application, and network bandwidth,
and then self-tunes based on changing conditions.
HDX optimizes the performance of 2D and 3D graphics and video.
HDX enables user devices to stream multimedia files directly from the source provider on the Internet or Intranet, rather
than through the host server. If the requirements for this client-side content fetching are not met, media delivery falls
back to server-side content fetching and multimedia redirection. In most cases, no adjustments to the multimedia
redirection feature policies are needed.
HDX delivers rich server-rendered video content to virtual desktops when multimedia redirection is not available: View a
video on a web site containing high definition videos, such as http://www.microsoft.com/silverlight/iis-smooth-
streaming/demo/.
Good to know:
For support and requirements information for HDX features, see the System requirements article. Except where
otherwise noted, HDX features are available for supported Windows Server OS and Windows Desktop OS machines, plus
Remote PC Access desktops.
T his content describes how to further optimize the user experience, improve server scalability, or reduce bandwidth
requirements. For information about working with Citrix policies and policy settings, see the Citrix policies documentation
for this release.
For instructions that include working with the registry, use caution: editing the registry incorrectly can cause serious
problems that may 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.
Tablet mode for touch screen devices

By default, any touch enabled device that connects/roams to a Windows 10 VDA starts in tablet mode.
Tablet mode requires a minimum of version XenServer 7.2. XenServer 7.2 integrates with the XenDesktop VDA, changing the
hypervisor to enable the virtual rmware settings for 2-in-1 devices. Windows 10 loads the GPIO driver on the target virtual
machine based on this updated BIOS. It is used for toggling between tablet and desktop modes within the virtual
machine. For .more information, see http://docs.citrix.com/content/dam/docs/en-us/xenserver/current-
release/downloads/xenserver-release-notes.pdf..
T he tablet mode offers a user interface that is better suited to touch screens:
Slightly larger buttons.

T he Start screen and any apps you start open in a full screen.
T askbar contains a back button.
Icons removed from the task bar.
You have access to the File Explorer.
Web Receivers do not support table mode.

Run the XenServer CLI command to allow laptop/tablet switching:
xe vm-param-set uuid=<VM_UUID> platf orm:acpi_laptop_slate=1
To disable (or re-enable) tablet mode, use the registry setting on XenApp and XenDesktop:
Warning:
Editing the registry incorrectly can cause serious problems that may 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.
To disable or enable the feature, congure this registry setting:
HKEY_LOCAL_MACHINE\Software\Citrix\Sessions
Name: CitrixEnhancedUserExperience
Type: REG_DWORD
Value:
0 (Disable)
1 (Enable)
We recommend for the best results that you navigate to Settings >System >Tablet Mode before starting a session and
set the following options from the drop-down menus:
Use the appropriate mode for my hardware

Dont ask me and always switch

If you don't set these options before starting the session, set the options after you start the session and restart the VDA.
Improve the image quality sent to user devices

T he following visual display policy settings control the quality of images sent from virtual desktops to user devices.
Visual quality. Controls the visual quality of images displayed on the user device: medium, high, always lossless, build to
lossless (default = medium). T he actual video quality with the default setting of medium depends on available bandwidth.
T arget frame rate. Specifies the maximum number of frames per second that are sent from the virtual desktop to the
user device (default = 30). For devices with slower CPUs, specifying a lower value can improve the user experience. T he
maximum supported frame rate per second is 60.
Display memory limit. Specifies the maximum video buffer size for the session in kilobytes (default = 65536 KB). For
connections requiring more color depth and higher resolution, increase the limit. You can calculate the maximum memory
required.
Improve video conference performance

Several popular video conferencing applications have been optimized for delivery from XenApp and XenDesktop through
multimedia redirection (see, for example, HDX RealT ime Optimization Pack for Skype for Business). For applications which
are not optimized, HDX webcam video compression improves bandwidth efciency and latency tolerance for webcams
during video conferencing in a session. T his technology streams webcam trafc over a dedicated multimedia virtual channel;
this uses signicantly less bandwidth compared to the isochronous HDX Plug-n-Play USB redirection support, and works
well over WAN connections.
Citrix Receiver users can override the default behavior by choosing the Desktop Viewer Mic & Webcam setting Don't use my
microphone or webcam. To prevent users from switching from HDX webcam video compression, disable USB device
redirection with the policy settings under ICA policy settings > USB Devices policy settings.
HDX webcam video compression requires that the following policy settings be enabled (all are enabled by default).
Client audio redirection

Client microphone redirection
Multimedia conferencing
Windows Media Redirection

If a webcam supports H.264 hardware encoding, HDX video compression uses the hardware encoding by default. Hardware
encoding may consume more bandwidth than software encoding. To force software compression, add the following
DWORD key value to the registry key: HKCU\Software\Citrix\HdxRealT ime: DeepCompress_ForceSWEncode=1.

Adaptive transport
May 22, 20 17
Introduction
Adaptive transport is a new data transport mechanism for XenApp and XenDesktop. It is faster, more scalable, improves
application interactivity, and is more interactive on challenging long-haul WAN and internet connections. Adaptive transport
maintains high server scalability and efcient use of bandwidth. By using adaptive transport, ICA virtual channels
automatically respond to changing network conditions. T hey intelligently switch the underlying protocol between the new
Citrix protocol called Enlightened Data Transport (EDT ) and TCP to deliver the best performance. It improves data
throughput for all ICA virtual channels including T hinwire display remoting, le transfer (Client Drive Mapping), printing, and
multimedia redirection. T he same setting is applicable for both LAN and WAN conditions.
When set to Pref erred, data transport over EDT is used as primary, with fallback to TCP.
By default, adaptive transport is disabled (Of f ) and TCP is always used.
For testing purposes, you can set Diagnostic mode, in which case only EDT is used, and fallback to TCP is disabled.
Requirements and considerations
XenApp and XenDesktop 7.13 and 7.14

VDA for Desktop OS 7.13 and 7.14
VDA for Server OS 7.13 and 7.14
StoreFront 3.9 and 3.11
Citrix Receiver for Windows 4.7 and 4.8
Citrix Receiver for Mac 12.5 and 12.6
Citrix Receiver for iOS 7.2
IPv4 VDAs only. IPv6 and mixed IPv6 and IPv4 configurations are not supported.
NetScaler 11.1-51.21. For more information on NetScaler configuration, see Configuring NetScaler Gateway to support
Advanced T ransport.
Conguration
1. Install XenApp and XenDesktop.

2. Install StoreFront.

3. Install the VDA (for Desktop OS or Server OS)
4. Install Citrix Receiver for Windows (Citrix Receiver for Mac or Citrix Receiver for iOS).
5. In Studio, enable the policy setting, HDX Adaptive T ransport (it is disabled by default). We also recommend that you do
not enable this feature as a universal policy for all objects in the Site.
T o enable the policy setting, set the value to Preferred, then click OK.
Pref erred. Adaptive transport over EDT is used when possible, with fallback to T CP.
Diagnostic mode. EDT is forced on and falls back to T CP is disabled. We recommend this setting only for
troubleshooting.
Of f . T CP is forced on, and EDT is disabled.
6. Click Next, and complete the steps in the wizard.
7. T he policy takes effect when the user reconnects the ICA session. T hough not required, you can run gpupdate /f orce
to pull the policy setting to the server, but the user still has to reconnect the ICA session.
8. Launch a session from a supported Citrix Receiver to establish a connection using adaptive transport.
9. For secure external access, configure DT LS encryption on NetScaler Unified Gateway. For more information, see
Configuring NetScaler Gateway to support Advanced T ransport.
To conrm that the policy setting has taken effect:
Check that the ICA UDP services are enabled on a VDA using netstat -a.
Check that the virtual channels are running over EDT using Director or the CtxSession.exe command-line utility available
on the VDA.
Director example
In Director, Session Details > Connection Type displays the policy settings. Look for Connection type HDX. If the
protocol is UDP, EDT is active for the session. If the protocol is TCP, the session is in fallback or default mode. If the
Connection type is RDP, ICA is not in use and the protocol is n/a. For more information, see Monitor sessions.

CtxSession.exe example
T his example illustrates that EDT over UDP is active for the session. Type CtxSession.exe in the command line.
C:\Program Files (x86)\Citrix\System32>CtxSession
Session 2 Transport Protocols: UDP -> CGP -> ICA
To see verbose statistics, use the -v switch:
>CtxSession -v

Thinwire
May 22, 20 17
Introduction
T hinwire refers to Citrix's default display remoting technology used in XenApp and XenDesktop.
Display remoting technology allows graphics generated on one machine to be transmitted, typically across a network, to
another machine for display. Graphics are usually generated as a result of user input, for example, keystrokes or mouse
actions.
A successful display remoting solution should provide a highly interactive user experience that is similar to that of a local PC.
T hinwire achieves this by using a range of complex and efcient image analysis and compression techniques. T hinwire
maximizes server scalability and consumes less bandwidth than other display remoting technologies.
Because of this balance, T hinwire meets most general business use cases and is used as the default display remoting
technology in XenApp and XenDesktop.
Thinwire or Framehawk
T hinwire should be used for delivering typical desktop workloads, for example, desktops, ofce productivity or browser-
based applications. T hinwire is also recommended for multi-monitor, high resolution or high DPI scenarios, and for workloads
with a mixture of video and non-video content.
Framehawk should be used for mobile workers on broadband wireless connections where packet loss can be intermittently
high.
HDX 3D Pro
In its default conguration, T hinwire can deliver 3D or highly interactive graphics, however enabling HDX 3D Pro mode
during the installation of the VDA for Desktop OS is a good option for such scenarios. T he 3D Pro mode congures
T hinwire with full-screen H.264 encoding for graphics transmission. T his provides a more uid experience for 3D professional
graphics. For more information, see HDX 3D Pro and GPU acceleration for Windows Desktop OS.
T hinwire has been optimized for modern operating systems, including Windows Server 2012 R2, Windows Server 2016 and
Windows 10. For Windows 7 and Windows Server 2008 R2, legacy graphics mode is recommended. Use the built-in Citrix
policy templates, High Server Scalability-Legacy OS and Optimized for WAN-Legacy OS to deliver the Citrix
recommended combinations of policy settings for these use cases.
T he policy setting which drives the behavior of T hinwire, Use video codec f or compression, is available on VDA versions
in XenApp and XenDesktop 7.6 FP3 and later. T he Use video codec when pref erred option is the default setting on
VDA versions XenApp and XenDesktop 7.9 and later.
All Citrix Receivers support T hinwire. Some Citrix Receivers may however support features of T hinwire that others do not,
for example, 8 or 16-bit graphics for reduced bandwidth usage. Support for such features are automatically negotiated
by Citrix Receiver.
T hinwire will use more server resources (CPU, memory) in multi-monitor and high-resolution scenarios. It is possible to tune
the amount of resources T hinwire uses, however, bandwidth usage may increase as a result.
In low bandwidth or high latency scenarios, you may consider enabling 8 or 16-bit graphics to improve interactivity,

however visual quality will be affected, especially at 8-bit color depth.
Conguration
T hinwire is the default display remoting technology.
T he following Graphics policy setting sets the default and provides alternatives for different use cases:
Use video codec for compression

Use video codec when pref erred. T his is the default setting. No additional configuration is required. Keeping this
setting as the default ensures that T hinwire is selected for all Citrix connections, and is optimized for scalability,
bandwidth, and superior image quality for typical desktop workloads.
Other options in this policy setting will continue to use T hinwire in combination with other technologies for different use
cases. For example:
For actively changing regions. T he adaptive display technology in T hinwire identifies moving images (video, 3D in
motion) and uses H.264 only in the part of the screen where the image is moving.
For the entire screen. Delivers T hinwire with full-screen H.264 to optimize for improved user experience and
bandwidth, especially in cases with heavy use of 3D graphics.
A number of other policy settings, including the following Visual display policy settings can be used to ne tune the
performance of display remoting technology and are all supported by T hinwire:
Preferred color depth for simple graphics

T arget frame rate
Visual quality
To get the Citrix recommended combinations of policy settings for different business use cases, use the built in Citrix Policy
templates. T he High Server Scalability and Very High Denition User Experience templates both use T hinwire with the
optimum combinations of policy settings for your organization's priorities and your users' expectations.
Monitoring Thinwire
You can monitor the use and performance of T hinwire from Citrix Director. T he HDX virtual channel details view contains
useful information for troubleshooting and monitoring T hinwire in any session. To view T hinwire-related metrics:
1. In Director, search for a user, machine or endpoint, open an active session and click Details. Or, you can select Filters >
Sessions > All Sessions, open an active session and click Details.
2. Scroll down to the HDX panel.
3. Select Graphics - Thinwire.

Framehawk
May 22, 20 17
Introduction
Framehawk is a display remoting technology for mobile workers on broadband wireless connections (Wi-Fi and 4G/LT E
cellular networks). Framehawk overcomes the challenges of spectral interference and multipath propagation, delivering a
uid and interactive user experience to users of virtual apps and desktops. Framehawk might also be a suitable choice for
users on long-haul (high latency) broadband network connections where even a small amount of packet loss can otherwise
degrade the user experience. We suggest using Adaptive Transport for this use case - for more information, see Adaptive
Transport.
You can use Citrix policy templates to implement Framehawk for a set of users and access scenarios in a way that is
appropriate for your organization. Framehawk targets single-screen mobile use cases such as laptops and tablets. Use
Framehawk where the business value of real-time interactive performance justies the extra cost in server resources and
the requirement for a broadband connection.
How Framehawk maintains a smooth user experience
T hink of Framehawk as a software implementation of the human eye, looking at what's in the frame buffer and discerning
the different types of content on the screen. What's important to the user? When it comes to areas of the screen that
are changing rapidly, like video or moving graphics, it doesn't matter to the human eye if some pixels are lost along the way
because they are quickly overwritten with new data.
But when it comes to static areas of the screen, such as the icons in the systray or a toolbar, or text after scrolling to
where the user wants to start reading, the human eye is very fussy; a user expects those areas to be pixel perfect. Unlike
protocols that aim to be technically accurate from a "ones and zeros" perspective, Framehawk aims to be relevant to the
human being who is using the technology.
Framehawk includes a next-generation QoS signal amplier plus a time-based heat map for a ner-grained and more
efcient identication of workloads. It uses autonomic, self-healing transforms in addition to data compression, and avoids
retransmission of data to maintain click response, linearity and a consistent cadence. On a lossy network connection,
Framehawk can hide loss with interpolation, and the user still perceives good image quality while enjoying a more uid
experience. In addition, Framehawk algorithms intelligently distinguish between different types of packet loss; for example,
random loss (send more data to compensate) versus congestion loss (don't send more data because the channel is already
clogged).
T he Framehawk Intent Engine in Citrix Receiver distinguishes between scrolling up or down, zooming, moving to the left or
right, reading, typing, and other common actions, and manages the communication back to the Virtual Delivery Agent (VDA)
using a shared dictionary. If the user is trying to read, the visual quality of the text needs to be excellent. If the user is
scrolling, it should be quick and smooth. And it has to be interruptible, so that the user is always in control of the interaction
with the application or desktop.
By measuring cadence on the network connection (which we call "gearing", analogous to the tension on a bicycle chain),
the Framehawk logic can react more quickly, providing a superior experience over high latency connections. T his unique and
patented gearing system provides constant up-to-date feedback on network conditions, allowing Framehawk to react

immediately to changes in bandwidth, latency, and loss.
Design considerations using Thinwire and Framehawk

While T hinwire has led the industry in bandwidth efciency and is well-suited to a broad range of access scenarios and
network conditions, it uses TCP for reliable data communications and therefore must retransmit packets on a lossy or
overburdened network, leading to lag in the user experience. T hinwire over an enlightened data transport (EDT ) layer is
available, addressing the limitations of TCP on high latency network connections.
Framehawk uses a data transport layer built on top of UDP. UDP is just a small part of how Framehawk overcomes lossiness,
as can be seen when comparing the performance of Framehawk with other UDP-based protocols, but it provides an
important foundation to the human-centric techniques that set Framehawk apart.
How much bandwidth does Framehawk require?
T he meaning of broadband wireless depends on several factors, including how many users are sharing the connection, the
quality of the connection, and apps being used. For optimal performance, Citrix suggests a base of 4 or 5 Mbps plus about
150 Kbps per concurrent user.
T he Citrix bandwidth recommendation for T hinwire is generally a base of 1.5 Mbps plus 150 Kbps per user (for more detail,
refer to XenApp and XenDesktop bandwidth blog), but at 3% packet loss you will nd that T hinwire over TCP needs much
more bandwidth than Framehawk to maintain a positive user experience.
Note: T hinwire remains the primary display remoting channel in the ICA protocol. Framehawk is disabled by default. Citrix
recommends enabling it selectively to address the broadband wireless access scenarios in your organization. Remember that
Framehawk requires considerably more server resources (CPU and memory) than T hinwire.
Framehawk and HDX 3D Pro
Framehawk supports all the HDX 3D Pro use cases, both for XenApp (server OS) and XenDesktop (desktop OS) apps. In
early previews, it has been validated in customer environments with 400-500 ms latency and 1-2% packet loss, providing
good interactivity using typical 3D modeling apps such as AutoCAD, Siemens NX, and others. T his support extends the
ability to view and manipulate large CAD models while on the move, or working from an offshore location or poor network
conditions. (Organizations with a requirement to deliver 3D applications over long haul network connections are
encouraged to use Adaptive Transport. For more information, see Adaptive Transport.)
Enabling this functionality doesn't require any additional conguration tasks. When installing the VDA, select the 3DPro
option at the beginning of the installation:

With this selection, HDX will use the GPU vendor's video driver rather than the Citrix video driver, and will default to full-
screen H.264 encoding over T hinwire rather than the usual default of Adaptive Display with Selective H.264 encoding.

Framehawk requires minimum VDA 7.6.300 and Group Policy Management 7.6.300.
T he endpoint must have a minimum Citrix Receiver for Windows 4.3.100 or Citrix Receiver for iOS 6.0.1.
By default, Framehawk uses a bidirectional UDP port range (3224-3324) to exchange Framehawk display channel data with
Citrix Receiver; the range can be customized in a policy setting called "Framehawk display channel port range". Each
concurrent connection between the client and the virtual desktop requires a unique port. For multi-user OS environments,
such as XenApp servers, you need to dene sufcient ports to support the maximum number of concurrent user sessions.
For a single-user OS, such as VDI desktops, it is sufcient to dene a single UDP port. Framehawk attempts to use the rst
dened port, working up to the nal port specied in the range. T his applies both when passing through NetScaler
Gateway, and internal connections directly to the StoreFront server.
For remote access, a NetScaler Gateway must be deployed. By default, NetScaler uses UDP port 443 for encrypted
communication between the client Citrix Receivers and the Gateway. T his port must be open on any external rewalls to
allow secure communication in both directions. T he feature is known as Datagram Transport Security (DT LS).

Note: Framehawk/DT LS connections are not supported on FIPS appliances.
Encrypted Framehawk connections are supported, starting with NetScaler Gateway version 11.0.62 and NetScaler Unied
Gateway version 11.0.64.34 or later.
NetScaler High Availability (HA) is supported from XenApp and XenDesktop 7.12.
Consider the following best practices before implementing Framehawk:
Contact your Security administrator to confirm UDP ports defined for Framehawk are open on the firewall. T he
installation process does not automatically configure the firewall.
In many cases, NetScaler Gateway might be installed in the DMZ, flanked by firewalls on both the external as well as the
internal side. Ensure UDP port 443 is open on the external firewall, and UDP ports 3224-3324 are open on the internal
firewall if the environment is using the default port ranges.
Conguration
Caution: Citrix recommends that you enable Framehawk only for users who are likely to experience high packet loss. It is
also recommended that you do not enable Framehawk as a universal policy for all objects in the Site.
Framehawk is disabled by default. When enabled, the server attempts to use Framehawk for users' graphics and input. If
the prerequisites are not met for any reason, the connection is established using the default mode (T hinwire).
T he following policy settings affect Framehawk:
Framehawk display channel: Enables or disables the feature.

Framehawk display channel port range: Specifies the range of UDP port numbers (lowest port number to highest port
number) that the VDA uses to exchange Framehawk display channel data with the user device. T he VDA attempts to
use each port, starting with the lowest port number and incrementing for each subsequent attempt. T he port handles
inbound and outbound traffic.
Opening ports f or the Framehawk display channel
From XenApp and XenDesktop 7.8, an option is available to recongure the Firewall during the Features step of the VDA
installer. T his checkbox opens UDP ports 3224-3324 on the Windows Firewall, if selected. Please note that manual Firewall
conguration is required in some circumstances:
for any network Firewalls, or

if the default port range is customized.
To open these UDP ports, select the Framehawk checkbox:

You can also use the command line to open UDP ports for Framehawk using /ENABLE_FRAMEHAWK_PORT:
Verifying Framehawk UDP port assignments

During installation, you can verify the UDP ports assigned to Framehawk in the Firewall screen:

T he Summary screen indicates if the Framehawk feature is enabled:

NetScaler Gateway support for Framehawk
Encrypted Framehawk trafc is supported on NetScaler Gateway 11.0.62.10 or later, and NetScaler Unied Gateway
11.0.64.34 or later.
NetScaler Gateway refers to the deployment architecture where the Gateway VPN vServer is directly accessible from
the end-user device; that is, the VPN vServer has a public IP address assigned and the user connects to this IP directly.
NetScaler with Unified Gateway refers to the deployment where the Gateway VPN vServer is bound as a target to the
Content Switching vServer (CS). In this deployment, CS vServer will have the public IP and the Gateway VPN vServer will
have a dummy IP.
To enable Framehawk support on NetScaler Gateway, the DT LS parameter on the Gateway VPN vServer level must be
enabled. After the parameter is enabled and the components on XenApp or XenDesktop are updated correctly, Framehawk
audio, video, and interactive trafc is encrypted between the Gateway VPN vServer and the user device.
NetScaler Gateway, Unied Gateway, and NetScaler Gateway + Global Server Load Balancing are supported with
Framehawk.
T he following scenarios are not supported with Framehawk:

HDX Insight
NetScaler Gateway in IPv6 mode
NetScaler Gateway Double Hop
NetScaler Gateway with Cluster setup
Scenario Framehawk support
NetScaler Gateway Yes
NetScaler + Global Server Load Balancing Yes
Yes
NetScaler with Unified Gateway Note: Unied Gateway version 11.0.64.34 and later is
supported.
HDX Insight No
NetScaler Gateway in IPv6 mode No
NetScaler Gateway Double Hop No
Multiple Secure T icket Authority (ST A) on NetScaler

Yes
Gateway
NetScaler Gateway with High Availability (HA) Yes
NetScaler Gateway with Cluster setup No
Conguring NetScaler f or Framehawk support
To enable Framehawk support on NetScaler Gateway, the DT LS parameter on the Gateway VPN vServer level must be
enabled. After the parameter is enabled and the components on XenApp or XenDesktop are updated correctly, Framehawk
audio, video, and interactive trafc is encrypted between the Gateway VPN vServer and the user device.
T his conguration is required if you are enabling UDP encryption on NetScaler Gateway for remote access.
When conguring NetScaler for Framehawk support:
Ensure UDP port 443 is open on any external firewalls

Ensure CGP port (default 2598) is open on any external firewalls
Enable DT LS in the settings for the VPN virtual server
Unbind and rebind the SSL cert-key pair; note that this is not required if you are using NetScaler version 11.0.64.34 or
later.

To congure NetScaler Gateway for Framehawk support:
1. Deploy and configure NetScaler Gateway to communicate with StoreFront and authenticate users for XenApp and
XenDesktop.
2. In the NetScaler Configuration tab, expand NetScaler Gateway, and select Virtual Servers.
3. Click Edit to display Basic Settings for the VPN Virtual Server; verify the state of the DT LS setting.
4. Click More to display additional configuration options:
5. Select DTLS to provide communications security for datagram protocols such as Framehawk. Click OK. T he Basic
Settings area for the VPN Virtual Server shows that the DT LS flag is set to True.
6. Reopen the Server Certificate Binding screen, and click + to bind the certificate key pair.
7. Choose the certificate key pair from earlier, click Select.
8. Save the changes to the server certificate binding.
9. After saving, the certificate key pair appears. Click Bind.
10. Ignore the "No usable ciphers configured on the SSL vserver/service" warning message, if it appears.
Additional steps for older NetScaler Gateway versions

If you are using a version of NetScaler Gateway older than 11.0.64.34:
1. Reopen the Server Certificate Binding screen, and click + to bind the certificate key pair.
2. Choose the certificate key pair from earlier, click Select.
3. Save the changes to the server certificate binding.
4. After saving, the certificate key pair appears. Click Bind.
5. Ignore the "No usable ciphers configured on the SSL vserver/service" warning message, if it appears.
To congure Unied Gateway for Framehawk support:
1. Ensure that Unified Gateway is installed and properly configured. For additional information, refer to the Unified
Gateway information on the Citrix Product Documentation site.
2. Enable the DT LS parameter on the VPN vServer which is bound to CS vserver as T arget Vserver.
Support f or other VPN products
NetScaler Gateway is the only SSL VPN product to support the UDP encryption required by Framehawk. T he Framehawk
policy may fail to apply if another SSL VPN or an incorrect version of NetScaler Gateway is used. Traditional IPSec VPN
products will support Framehawk without any modications.
Congure Citrix Receiver for iOS to support

Framehawk
To congure older versions of Citrix Receiver for iOS to support Framehawk, you must manually edit default.ica.
1. On the StoreFront server, access the App_Data directory of your store in c:\inetpub\wwwroot\.
2. Open the default.ica file and add the following line in the WFClient section: Framehawk=On
3. Save the changes.
T his allows Framehawk sessions to be established from a compatible Citrix Receiver on iOS devices. T his step is not required
if you are using Citrix Receiver for Windows.

Note
With Receiver for iOS version 7.0 and later, you do not have to explicity add the parameter Framehawk=On in the default.ica le.
Monitoring Framehawk
You can monitor the use and performance of Framehawk from Citrix Director. T he HDX Virtual Channel Details view
contains useful information for troubleshooting and monitoring Framehawk in any session. To view Framehawk-related
metrics, select Graphics-Framehawk.
If the Framehawk connection is established, you will see Provider = VD3D and Connected = True in the details page. It is
normal for the virtual channel state to be idle, because it monitors the signaling channel, which is used only during the initial
handshake. T his page also provides other useful statistics about the connection.
If you encounter issues, see the Framehawk troubleshooting blog.

HDX 3D Pro
May 22, 20 17
T he HDX 3D Pro capabilities of the Server VDA, enables you to deliver desktops and applications that perform best using a
graphics processing unit (GPU) for hardware acceleration. T hese applications include 3D professional graphics applications
based on OpenGL and DirectX. T he standard VDA supports GPU acceleration of DirectX only. For more information about
choosing the standard or HDX 3D Pro VDA, see What to specify when installing a VDA in the Prepare to install article.
All supported Citrix Receivers can be used with 3D graphics. For best performance with complex 3D workloads, high-
resolution monitors, multi-monitor congurations, and high frame rate applications, we recommend the latest versions of
Citrix Receiver for Windows and Citrix Receiver for Linux. For more information on supported versions of Citrix Receiver, see
Lifecycle Milestones for Citrix Receiver.
Examples of 3D professional applications include:
Computer-aided design, manufacturing, and engineering (CAD/CAM/CAE) applications

Geographical Information System (GIS) software
Picture Archiving Communication System (PACS) for medical imaging
Applications using the latest OpenGL, DirectX, NVIDIA CUDA, and OpenCL and WebGL versions
Computationally intensive non-graphical applications that use NVIDIA Compute Unified Device Architecture (CUDA) GPUs
for parallel computing
HDX 3D Pro provides the best user experience over any bandwidth:
On WAN connections: Deliver an interactive user experience over WAN connections with bandwidths as low as 1.5 Mbps.
On LAN connections: Deliver a user experience equivalent to that of a local desktop on LAN connections.
You can replace complex and expensive workstations with simpler user devices by moving the graphics processing into
the data center for centralized management.
HDX 3D Pro provides GPU acceleration for Windows Desktop OS machines and Windows Server OS machines. HDX 3D Pro
is compatible with GPU passthrough and GPU virtualization technologies offered by the following hypervisors, in addition to
bare metal:
Citrix XenServer
GPU passthrough with NVIDIA GRID and Intel GVT -d
GPU virtualization with NVIDIA GRID and Intel GVT -g
Microsoft Hyper V
GPU passthrough (Discrete Device Assignment) with NVIDIA GRID and AMD
VMware vSphere
GPU passthrough (vDGA) with NVIDIA GRID, Intel, and AMD IOMMU
GPU virtualization with NVIDIA GRID and AMD MxGPU
For the supported XenServer versions, see Citrix XenServer Hardware Compatibility List.
Use the HDX Monitor tool to validate the operation and conguration of HDX visualization technologies and to diagnose
and troubleshoot HDX issues. To download the tool and learn more about it, see https://taas.citrix.com/hdx/download/.

Flash Redirection
May 25, 20 17
Flash Redirection offloads the processing of most Adobe Flash content (including animations, videos, and applications) to
users' LAN- and WAN-connected Windows and 32-bit Linux x86 devices, which reduces server and network load. T his results
in greater scalability while ensuring a high definition user experience. Configuring Flash Redirection requires both server-side
and client-side settings.
Caution: Flash Redirection involves signicant interaction between the user device and server components. Use this feature
only in environments where security separation between the user device and server is not required. Additionally, congure
user devices to use this feature only with trusted servers. Because Flash Redirection requires the Adobe Flash Player to be
installed on the user device, enable this feature only if the Flash Player itself is secured.
Flash Redirection is supported on both clients and servers. If the client supports second generation Flash Redirection, Flash
content renders on the client. Flash Redirection features include support for user connections over WAN, intelligent fallback,
and a URL compatibility list; see below for details.
Flash Redirection uses Windows event logging on the server to log Flash events. T he event log indicates whether Flash
Redirection is being used and provides details about issues. T he following are common to all events logged by Flash
Redirection:
Flash Redirection reports events to the Application log.
On Windows 10, Windows 8 and Windows 7 systems, a Flash Redirection-specific log appears in the Applications and
Services Logs node.
T he Source value is Flash.
T he Category value is None.
For the latest updates to HDX Flash compatibility, see CT X136588.
Congure Flash Redirection on the server
T o configure Flash Redirection on the server, use the following Citrix policy settings. For details, see Flash Redirection policy
settings.
By default, Flash Redirection is enabled. T o override this default behavior for individual web pages and Flash instances, use
the Flash URL compatibility list setting.
Flash intelligent fallback - detects instances of small Flash "movies" (such as those frequently used to play
advertisements) and renders them on the server instead of redirecting them for rendering on the user device. T his
optimization does not cause any interruption or failure in the loading of the web page or the Flash application. By
default, Flash intelligent fallback is enabled. T o redirect all instances of Flash content for rendering on the user device,
disable this policy setting. Note that some Flash content may not be successfully redirected.
Flash server-side content fetching URL list allows you to specify websites whose Flash content should be downloaded to
the server and then transferred to the user device for rendering. (By default, Flash Redirection downloads Flash content
directly to the user device with client-side fetching.) T his setting works with (and requires) the Enable server-side content
fetching setting on the user device and is intended primarily for use with Intranet sites and internal Flash applications; see
below for details. It also works with most Internet sites and can be used when the user device does not have direct
access to the Internet (for example, when the XenApp or XenDesktop server provides that connection).
Note: Server-side content fetching does not support Flash applications using Real T ime Messaging Protocols (RT MP);
instead, server-side rendering is used, which supports HT T P and HT T PS.
Flash URL compatibility list - specifies where Flash content from listed websites is rendered: on the user device, on the
server, or blocked.

Flash background color list - enables you to match the colors of web pages and Flash instances, which improves the
appearance of the web page when using Flash Redirection.
Congure Flash Redirection on the user device
Install Citrix Receiver and Adobe Flash Player on the user device. No further conguration is required on the user device.
You can change the default settings using Active Directory Group Policy Objects. Import and add the HDX MediaStream
Flash Redirection - Client administrative template (HdxFlashClient.adm), which is available in the following folders:
For 32-bit computers: %Program Files%\Citrix\ICA Client\Configuration\language
For 64-bit computers: %Program Files (x86)%\Citrix\ICA Client\Configuration\language
T he policy settings appear under Administrative Templates > Classic Administrative Templates (ADM) > HDX MediaStream
Flash Redirection - Client. See the Microsoft Active Directory documentation for details about GPOs and templates.
Change when Flash Redirection is used
Together with server-side settings, the Enable HDX MediaStream Flash Redirection on the user device policy setting controls
whether Adobe Flash content is redirected to the user device for local rendering. By default, Flash Redirection is enabled and
uses intelligent network detection to determine when to play Flash content on the user device.
If no conguration is set and Desktop Lock is used, Flash Redirection is enabled on the user device by default.
T o change when Flash Redirection is used or to disable Flash Redirection on the user device:
1. From the Setting list, select Enable HDX MediaStream Flash Redirection on the user device and click policy setting.
2. Select Not Configured, Enabled (the default), or Disabled.
3. If you select Enabled, choose an option from the Use HDX MediaStream Flash Redirection list:
T o use the latest Flash Redirection functionality when the required configuration is present, and revert to server-side
rendering when it is not, select Only with Second Generation.
T o always use Flash Redirection, select Always. Flash content plays on the user device.
T o never use Flash Redirection, select Never. Flash content plays on the server.
T o use intelligent network detection to assess the security level of the client-side network to determine when using
Flash Redirection is appropriate, select Ask (the default). If the security of the network cannot be determined, the user
is asked whether to use Flash Redirection. If the network security level cannot be determined, the user is prompted to
choose whether to use Flash Redirection.
T he following illustration indicates how Flash Redirection is handled for various network types.

Users can override intelligent network detection from the Citrix Receiver - Desktop Viewer Preferences dialog box by
selecting Optimize or Don't Optimize in the Flash tab. T he choices available vary depending on how Flash Redirection is
congured on the user device, as shown in the following illustration.

Synchronize client-side HTTP cookies with the server-side
Synchronization of the client-side HT T P cookies with the server-side is disabled by default. Enable synchronization to
download HT T P cookies from the server; those HT T P cookies are then used for client-side content fetching and are
available as needed by sites containing Flash content.
Note: Client-side cookies are not replaced during the synchronization; they remain available even if the synchronization
policy is later disabled.
1. From the Setting list, select Enable synchronization of the client-side HT T P cookies with the server-side and click policy
setting.
2. Select Not Configured, Enabled, or Disabled (the default).
Enable server-side content f etching
By default, Flash Redirection downloads Adobe Flash content directly to the user device, where it is played. Enabling server-
side content fetching causes the Flash content to download to the server and then be sent to the user device. Unless there
is an overriding policy (such as a site blocked with the Flash URL compatibility list policy setting), the Flash content plays on
the user device.
Server-side content fetching is frequently used when the user device connects to internal sites through NetScaler Gateway

and when the user device does not have direct access to the Internet.
Note: Server-side content fetching does not support Flash applications using Real T ime Messaging Protocols (RT MP).
Instead, server-side rendering is used for such sites.
Flash Redirection supports three enabling options for server-side content fetching. Two of these options include the ability
to cache server-side content on the user device, which improves performance because content that is reused is already
available on the user device for rendering. T he contents of this cache are stored separately from other HT T P content
cached on the user device.
Fallback to server-side content fetching begins automatically when any of the enabling options is selected and client-side
fetching of .swf les fails.
Enabling server-side content fetching requires settings on both the client device and the server.
1. From the Setting list, select Enable server-side content fetching and click policy setting.
2. Select Not Configured, Enabled, or Disabled (the default). If you enable this setting, choose an option from the Server-
side content fetching state list:
Option Description
Disabled Disables server-side content fetching, overriding the Flash server-side content fetching URL list setting
on the server. Server-side content fetching fallback is also disabled.
Enabled Enables server-side content fetching for web pages and Flash applications identified in the Flash server-
side content fetching URL list. Server-side content fetching fallback is available, but Flash content is not
cached.
(persistent side content fetching URL list. Server-side content fetching fallback is available. Content obtained
caching) through server-side fetching is cached on the user device and stored from session to session.
(temporary side content fetching URL list. Server-side content fetching fallback is available. Content obtained
caching) through server-side fetching is cached on the user device and deleted at the end of the session.
3. On the server, enable the Flash server-side content fetching URL list policy setting and populate it with target URLs.
Redirect user devices to other servers f or client-side content f etching
To redirect an attempt to obtain Flash content, use the URL rewriting rules for client-side content fetching setting, which is
a second generation Flash Redirection feature. When conguring this feature, you provide two URL patterns; when the user
device attempts to fetch content from a website matching the rst pattern (the URL match pattern), it is redirected to the
website specied by the second pattern (the rewritten URL format).
You can use this setting to compensate for content delivery networks (CDN). Some websites delivering Flash content use
CDN redirection to enable the user to obtain the content from the nearest of a group of servers containing the same
content. When using Flash Redirection client-side content fetching, the Flash content is requested from the user device,
while the rest of the web page on which the Flash content resides is requested by the server. If CDN is in use, the server
request is redirected to the nearest server, and the user device request follows to the same location. T his may not be the
location closest to the user device; depending on distance, there could be a noticeable delay between the loading of the
web page and the playing of the Flash content.
1. From the Setting list, select URL rewriting rules for client-side content fetching and click policy setting.

2. Select Not Configured, Enabled, or Disabled. Not Configured is the default; Disabled causes any URL rewriting rules
specified in the next step to be ignored.
3. If you enable the setting, click Show. Using Perl regular expression syntax, type the URL match pattern in the Value name
box and the rewritten URL format in the Value box.
Minimum version checking f or Flash redirection
Warning
Editing the Registry incorrectly can cause serious problems that may require you to reinstall your operating system. Citrix cannot
You can add registry settings to specify the minimum version required for Flash redirection for client devices accessing VDAs
using Citrix Receiver for Windows or Citrix Receiver for Linux. T his security feature ensures that an outdated Flash version is
not used.
ServerFlashPlayerVersionMinimum is a string value that species the minimum version of the Flash Player required on the
ICA Server (VDA).
ClientFlashPlayerVersionMinimum is a string value that species the minimum version of the Flash Player required on the
ICA Client (Citrix Receiver).
T hese version strings can be specied as "10" or "10.2" or "10.2.140". Only the major, minor and build numbers will be
compared. T he revision number will be ignored. For example, for a version string specied as "10" with only the major number
specied, the minor and build numbers will be assumed to be zero.
FlashPlayerVersionComparisonMask is a DWORD value that when set to zero will disable comparing the version of the
Flash Player on the ICA Client against the Flash Player on the ICA Server. T he comparison mask has other values, but these
should not be used because the meaning of any non-zero mask may change. It is recommended to only set the comparison
mask to zero for the desired clients. It is not recommended to set the comparison mask under the client agnostic settings. If
a comparison mask is not specied, Flash redirection will require that the ICA Client has a Flash Player with greater or equal
version to the Flash Player on the ICA Server. It will do so by comparing only the major version number of the Flash Player.
In order for redirection to occur the client and server minimum checks need to be successful in addition to the check using
the comparison mask.
T he subkey ClientID0x51 species Citrix Receiver for Linux. T he subkey ClientID0x1 species Citrix Receiver for Windows. T his
subkey is named by appending the hexadecimal Client Product ID (without any leading zeros) to the string "ClientID". A full
list of Client IDs can be found in the Mobile SDK for Windows Apps
documentation https://www.citrix.com/community/citrix-developer/mobile-sdk-for-windows-apps.html.
32-bit VDA example registry conguration
[HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\HdxMediaStreamForFlash\Server\PseudoServer] Client agnostic settings
"ClientFlashPlayerVersionMinimum"="13.0" Minimum version required for the ICA client

"ServerFlashPlayerVersionMinimum"="13.0" Minimum version required for the ICA server
[HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\HdxMediaStreamForFlash\Server\PseudoServer\ClientID0x1] Windows ICA

Client settings
"ClientFlashPlayerVersionMinimum"="16.0.0" T his species the minimum version of the Flash Player required for the Windows
client [HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\HdxMediaStreamForFlash\Server\PseudoServer\ClientID0x51] Linux ICA
Client settings
"FlashPlayerVersionComparisonMask"=dword:00000000 T his disables the version comparison-check for the linux client
(checking to see that the client has a more recent Flash Player than the server) "ClientFlashPlayerVersionMinimum"="11.2.0"
T his species the minimum version of the Flash Player for the Linux client.
64 -bit VDA example registry conguration
[HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Citrix\HdxMediaStreamForFlash\Server\PseudoServer]
"ClientFlashPlayerVersionMinimum"="13.0" "ServerFlashPlayerVersionMinimum"="13.0"
[HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Citrix\HdxMediaStreamForFlash\Server\PseudoServer\ClientID0x1]
"ClientFlashPlayerVersionMinimum"="16.0.0"
[HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Citrix\HdxMediaStreamForFlash\Server\PseudoServer\ClientID0x51]
"FlashPlayerVersionComparisonMask"=dword:00000000 "ClientFlashPlayerVersionMinimum"="11.2.0"

Auto client reconnect and session reliability
May 22, 20 17
When accessing hosted applications or desktops, network interruption might occur. To experience a smoother
reconnection, we offer auto client reconnect and session reliability. In a default conguration, session reliability starts and
then auto client reconnect follows.
Auto client reconnect
Auto client reconnect relaunches the client engine to reconnect to a disconnected session. Auto client reconnect closes (or
disconnects) the user session after the time specied in the setting. If auto client reconnect is in progress, the system sends
application and desktops network interruption notication to the user as follows:
Desktops. T he session window is grayed out and a countdown timer shows the time until the reconnections occur.
Applications. T he session window closes and a dialog appears to the user containing a countdown timer showing the
time until the reconnections are attempted.
During auto client reconnect, sessions relaunch expecting network connectivity. User cannot interact with sessions while
auto client reconnect is in progress.
On reconnection, the disconnected sessions reconnect using saved connection information. T he user can interact with the
applications and desktops normally.
Default auto client reconnect settings:
Auto client reconnect timeout: 120 seconds

Auto client reconnect: Enabled
Auto client reconnect authentication: Disabled
Auto client reconnect Logging: Disabled
For more information, see Auto client reconnect policy settings.
Session reliability
Session reliability reconnects ICA sessions seamlessly across network interruptions. Session reliability closes (or disconnects)
the user session after the time specied in the setting. After the session reliability timeout, the auto client reconnect
settings take effect, attempting to reconnect the user to the disconnected session. When session reliability is in progress,
application and desktops network interruption notication are sent to the user as follows:
Desktops. T he session window becomes translucent and a countdown timer shows the time until the reconnections
occur.
Applications. T he window becomes translucent along with connection interrupted pop ups from the notification area.
While session reliability is active, the end user cannot interact with the ICA sessions. However, user actions like keystrokes
are buffered for few seconds immediately after the network interruption and retransmitted once the network is available.
On reconnection, the client and the server resume at the same point where they were in their exchange of protocol. T he
session windows lose translucency and appropriate notication area pop ups are shown for applications.
Default session reliability settings

Session reliability timeout: 180 seconds
Reconnection UI transparency level: 80%
Session reliability connection: Enabled
Session reliability port number: 2598
For more information, see Session reliability policy settings.
NetScaler with auto client reconnect and session reliability
If Multistream and Multiport policies are enabled on the server and any or all these conditions are true, auto client
reconnect does not work:
Session reliability is disabled on NetScaler Gateway.

A failover occurs on the NetScaler appliance.
NetScaler SD-WAN is used with NetScaler Gateway.

May 22, 20 17
Content redirection allows you to control whether users access information with applications published on servers or with
applications running locally on user devices.
Host to client redirection is one kind of content redirection. It is supported only on Server OS VDAs (not Desktop OS
VDAs).
When host to client redirection is enabled, URLs are intercepted at the server VDA and sent to the user device. T he web
browser or multimedia player on the user device opens these URLs.
If you enable host to client redirection and the user device fails to connect to a URL, the URL is redirected back to the
server VDA.
When host to client redirection is disabled, users open the URLs with web browsers or multimedia players located on the
server VDA.
When host to client redirection is enabled, users cannot disable it.
Host to client redirection was previously known as server to client redirection.
When to use host to client redirection
You might consider using host to client redirection in specic but uncommon cases, for performance, compatibility, or
compliance. Normally, other forms of content redirection are better.
Perf ormance
You can use host to client redirection for performance, so that whenever an application is installed on the user device, it is
used in preference to an application on the VDA.
Keep in mind that host to client redirection will improve performance only under specic conditions, because the VDA
already optimizes Adobe Flash and other types of multimedia content. First, consider using the other approaches (policy
settings) noted in the tables below, rather than host to client redirection; they offer more exibility and usually give a
better user experience, particularly for less-powerful user devices.
Compatibility
You can use host to client redirection for compatibility in the following use cases:
You use content types other than HT ML or multimedia (for example, a custom URL type).
You use a legacy media format (such as Real Media) that is not supported by the VDA's multimedia player with
multimedia redirection.
T he application for the content type is used by only a small number of users who already have the application installed
on their user device.
T he VDA cannot access certain web sites (for example, web sites internal to another organization).
Compliance
You can use host to client redirection for compliance in the following use cases:
T he application or content licensing agreement does not permit publishing via the VDA.

Organizational policy does not permit a document being uploaded to the VDA.
Some situations are more likely in complex environments, and also if the user device and the VDA belong to different
organizations.
User device considerations
Environments may have many different types of user devices.
User device Situation or environment Content redirection approach
Tablet - Any approach (see next table)
Laptop PC - Any approach (see next table)
Desktop PC Users use a wide range of apps installed on the Any approach (see next table)
user device
Desktop PC Users use only a few known apps that are Local App Access
installed on the user device
Desktop PC Users use no apps installed on the user device Multimedia redirection and/or Flash
redirection
Desktop appliance Vendor supports multimedia redirection and/or Multimedia redirection and/or Flash
Flash redirection redirection
T hin client Vendor supports multimedia redirection, Flash Any approach (see next table)
redirection, and host to client redirection
Zero client Vendor supports multimedia redirection and/or Multimedia redirection and/or Flash
Flash redirection redirection
Use the following examples to help guide your content redirection approach.
URLs link Situation or environment Content redirection

approach
A web page or document T he VDA cannot access the URL Host to client redirection
A web page T he web page contains Adobe Flash Flash redirection

A multimedia le or stream T he VDA has a compatible multimedia player Multimedia redirection
A multimedia le or stream T he VDA does not have a compatible Host to client redirection
multimedia player
A document T he VDA does not have an application for that Host to client redirection
document type
A document T he document must not be downloaded to the No redirection

user device
A document T he document must not be uploaded to the Host to client redirection

VDA
A custom URL type T he VDA does not have an application for that Host to client redirection
custom URL type
Host to client redirection is supported by Citrix Receiver for Windows, Receiver for Mac, Receiver for Linux, Receiver for
HT ML5, and Receiver for Chrome.
To use host to client redirection, the user device must have a web browser, multimedia player, or other application that is
suitable for the content. If the user device is a desktop appliance, thin client, or zero client, conrm that it has suitable
applications and is sufciently powerful.
User devices enabled for Local App Access use a different mechanism for content redirection, and do not require host to
client content redirection.
You can use Citrix policies to prevent host to client content redirection for unsuitable devices.
How users experience host to client redirection
Host to client redirection is used when URLs are:
Embedded as hyperlinks in an application (for example, in an email message or document).

Selected through a VDA application's menus or dialogs, provided that the application uses the Windows ShellExecuteEx
API.
Entered in the Windows Run dialog.
Host to client redirection is not used for URLs in a web browser (either in a web page or entered in the address bar of the
web browser).
Note
If users change their default web browser on the VDA (for example, by using Set Default Programs), that change can interfere with
host to client redirection for applications.

When host to client content redirection is enabled, the app that is used to open the URL depends on the conguration of
the user device for both the URL type and the content type. For example:
An HT T P URL with an HT ML content type will open in the default web browser.
An HT T P URL with a PDF content type might open in the default web browser, or it might open in another application.
T his user device conguration is not controlled by host to client content redirection. If you do not control the
conguration of the user device, consider using Flash redirection and multimedia redirection, rather than host to client
content redirection.
T he following URL types are opened locally through user devices when host to client redirection is enabled:
HT T P (Hypertext T ransfer Protocol)

HT T PS (Secure Hypertext T ransfer Protocol)
RT SP (Real Player and QuickT ime)
RT SPU (Real Player and QuickT ime)
PNM (Legacy Real Player)
MMS (Microsoft Media Format)
You can change the list of URL types for host to client redirection, to remove and add URL types, including custom URL
types.
Enable host to client redirection
Enabling host to client redirection starts with enabling a Citrix policy setting.
T he Host to client redirection policy setting is located in the File Redirection policy settings section. By default, this setting
is disabled.
In addition, you may need to set registry keys and Group Policy for the server VDAs, depending on the VDA's OS.
If the server VDA is Windows Server 2008 R2 SP1, you do not need to set registry keys or Group Policy.
If the server VDA is Windows Server 2012, Windows Server 2012 R2, or Windows Server 2016, you must set registry keys
and Group Policy.
Warning
Using Registry Editor incorrectly can cause serious problems that might require you to reinstall your operating system. Citrix cannot
Registry changes
1. Copy the text between "Reg f ile start" and "Reg f ile end" below, and paste it in Notepad.
2. Save the Notepad file with "Save As" as type All Files and the name ServerFT A.reg.
3. Distribute the ServerFTA.reg file to the servers using Active Directory Group Policy.
ServerFT A.reg COPY

- Reg le start --
Windows Regist ry Edit or Version 5.00
[HKEY_CLASSES_ROOT\ServerFTAHTML\shell\open\command]
@="\"C:\\Program Files (x86)\\Cit rix\\syst em32\\iexplore.exe\" %1"
[HKEY_LOCAL_MACHINE\SOFTWARE\Cit rix\ServerFTA]
@="ServerFTA"
[HKEY_LOCAL_MACHINE\SOFTWARE\Cit rix\ServerFTA\Capabilit ies]
"Applicat ionDescript ion"="Server FTA URL."
"Applicat ionIcon"="C:\\Program Files (x86)\\Cit rix\\syst em32\\iexplore.exe,0"
"Applicat ionName"="ServerFTA"
[HKEY_LOCAL_MACHINE\SOFTWARE\Cit rix\ServerFTA\Capabilit ies\URLAssociat ions]
"ht t p"="ServerFTAHTML"
"ht t ps"="ServerFTAHTML"
[HKEY_LOCAL_MACHINE\SOFTWARE\Regist eredApplicat ions]
"Cit rix.ServerFTA"="SOFTWARE\\Cit rix\\ServerFTA\\Capabilit ies"
-- Reg le end --
Group Policy changes
Create an XML le. Copy the text between "xml le start" and "xml le end" below, paste it in the XML le, and then save
the le as ServerFTAdef aultPolicy.xml.
ServerFT AdefaultPolicy.xml COPY

-- xml le start --
<?xml version="1.0" encoding="UTF-8"?>
<Default Associat ions>
<Associat ion Ident ier="ht t p" ProgId="ServerFTAHTML" Applicat ionName="ServerFTA" />
<Associat ion Ident ier="ht t ps" ProgId="ServerFTAHTML" Applicat ionName="ServerFTA" />
</Default Associat ions>
-- xml le end --
From the current Group Policy Management Console, navigate to: Computer conguration > Administrative Templates
> Windows Components > File Explorer > Set a def ault associations conguration le, and provide the
ServerFTAdefaultPolicy.xml le you created.
Change the list of URL types f or host to client redirection
To change the list of URL types for host to client redirection, set the following registry key on the server VDA.
Key: HKLM\Software\Wow6432Node\Citrix\SFTA
To remove URL types from the list, set DisableServerFTA and NoRedirectClasses:
Name: DisableServerFTA
Type: REG_DWORD
Data: 1
Name: NoRedirectClasses
Type: REG_MULT I_SZ
Data: Specify any combination of the values: http, https, rtsp, rtspu, pnm, or mms. Enter multiple values on separate
lines. For example:
http
https
rtsp
To add URL types to the list, set ExtraURLProtocols:
Name: ExtraURLProtocols
Type: REG_MULT I_SZ
Data: Specify any combination of URL types. Each URL type must include the :// sufx; separate multiple values with
semicolons. For example:

customtype1://;customtype2://
Enable host to client redirection f or a specic set of web sites
To enable host to client redirection for a specic set of web sites, set the following registry key on the server VDA.
Key: HKLM\Software\Wow6432Node\Citrix\SFTA
Name: ValidSites
Type: REG_MULT I_SZ
Data: Specify any combination of fully-qualied domain names (FQDNs). Enter multiple FQDNs on separate lines. An
FQDN may include a wildcard in the leftmost position only. T his matches a single level of domain, which is consistent
with the rules in RFC 6125. For example:
www.example.com
*.example.com
Conguration f or Internet Explorer 9 and later versions
To use Internet Explorer 9 and later versions as a published browser, change the following registry key values on the server
VDA:
Keys:
HKLM\Software\Classes\htmlle\shell\opennew
HKLM\Software\Classes\http\shell\open
HKLM\Software\Classes\https\shell\open
HKCR\http\shell\open
HKCR\https\shell\open
HKCR\htmlle\shell\opennew
Change from:
Name: CommandID
Type: REG_SZ
Data: IE.Protocol
To:
Name: CommandID
Type: REG_SZ

Data: IE.ProtocolX

GPU acceleration for Windows Desktop OS
May 22, 20 17
With HDX 3D Pro you can deliver graphically intensive applications as part of hosted desktops or applications on Desktop
OS machines. HDX 3D Pro supports physical host computers (including desktop, blade, and rack workstations) and GPU
Passthrough and GPU virtualization technologies offered by XenServer, vSphere, and Hyper-V (passthrough only)
hypervisors.
Using GPU Passthrough, you can create VMs with exclusive access to dedicated graphics processing hardware. You can
install multiple GPUs on the hypervisor and assign VMs to each of these GPUs on a one-to-one basis.
Using GPU virtualization, multiple virtual machines can directly access the graphics processing power of a single physical GPU.
T he true hardware GPU sharing provides desktops suitable for users with complex and demanding design requirements. GPU
virtualization for NVIDIA GRID cards (see NVIDIA GRID) uses the same NVIDIA graphics drivers that are deployed on non-
virtualized operating systems. GPU virtualization is also supported for 5th and 6th Generation Intel CPUs with Intel Iris Pro
graphics with Intel GVT -g. For more information on these families of Intel processors, see 5th Generation Intel Core
Processors and 6th Generation Intel Core i5 Processors. GPU virtualization is also supported for AMD FirePro S-Series server
cards, see AMD Professional Graphics virtualization solution.
HDX 3D Pro oers the following features:
Adaptive H.264-based deep compression for optimal WAN and wireless performance. HDX 3D Pro uses CPU-based full-screen H.264
compression as the default compression technique for encoding. Hardware encoding is used with NVIDIA cards that support NVENC.
Lossless compression option for specialized use cases. HDX 3D Pro also offers a CPU-based lossless codec to support applications where
pixel-perfect graphics are required, such as medical imaging. True lossless compression is recommended only for specialized use cases
because it consumes significantly more network and processing resources.
When using lossless compression:
The lossless indicator, a system tray icon, notifies the user if the screen displayed is a lossy frame or a lossless frame. This helps when
the Visual Quality policy setting specifies Build to lossless. The lossless indicator turns green when the frames sent are lossless.
The lossless switch enables the user to change to Always Lossless mode anytime within the session. To select or deselect Lossless
anytime within a session, right-click the icon or use the shortcut ALT+SHIFT+1.
For lossless compression: HDX 3D Pro uses the lossless codec for compression regardless of the codec selected through policy.
For lossy compression: HDX 3D Pro uses the original codec, either the default or the one selected through policy.
Lossless switch settings are not retained for subsequent sessions. To use lossless codec for every connection, select Always lossless in
the Visual quality policy setting.
You can override the default shortcut, ALT+SHIFT+1, to select or deselect Lossless within a session. Configure a new registry setting at
HKLM\SOFTWARE\Citrix\HDX3D\LLIndicator.
Name: HKLM_HotKey, Type: String
The format to configure a shortcut combination is C=0|1, A=0|1, S=0|1, W=0|1, K=val. Keys must be comma "," separated. The order of
the keys does not matter.
A, C, S, W and K are keys, where C=Control, A=ALT, S=SHIFT, W=Win, and K=a valid key. Allowed values for K are 0-9, a-z, and any
virtual key code. For more information on virtual key codes, see Virtual-Key Codes on MSDN.
For example:
For F10, set K=0x79
For Ctrl + F10, set C=1, K=0x79
For Alt + A, set A=1, K=a or A=1, K=A or K=A, A=1
For Ctrl + Alt + 5, set C=1, A=1, K=5 or A=1, K=5, C=1
For Ctrl + Shift + F5, set A=1, S=1, K=0x74
Caut ion: Editing the registry incorrectly can cause serious problems that may 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.

Multiple and high resolution monitor support. For desktop OS machines, HDX 3D Pro supports user devices with up to four monitors. Users
can arrange their monitors in any configuration and can mix monitors with different resolutions and orientations. The number of monitors is
limited by the capabilities of the host computer GPU, the user device, and the available bandwidth. HDX 3D Pro supports all monitor
resolutions and is limited only by the capabilities of the GPU on the host computer.
HDX 3D Pro also provides limited support for dual-monitor access to Windows XP desktops. For more information about this, see VDAs on
machines running Windows XP or Windows Vista.
Dynamic resolution. You can resize the virtual desktop or application window to any resolution. Not e: The only supported method to change
the resolution is by resizing the VDA session window. Changing resolution from within the VDA session (using Control Panel > Appearance
and Personalization > Display > Screen Resolution) is not supported.
Support for NVIDIA GRID architecture. HDX 3D Pro supports NVIDIA GRID cards (see NVIDIA GRID) for GPU passthrough and GPU sharing.
NVIDIA GRID vGPU enables multiple VMs to have simultaneous, direct access to a single physical GPU, using the same NVIDIA graphics
drivers that are deployed on non-virtualized operating systems.
Support for VMware vSphere and VMware ESX using Virtual Direct Graphics Acceleration (vDGA) - You can use HDX 3D Pro with vDGA for
both RDS and VDI workloads.
Support for VMware vSphere/ESX using NVIDIA GRID vGPU and AMD MxGPU.
Support for Microsoft HyperV using Discrete Device Assignment in Windows Server 2016.
Support for Data Center Graphics with Intel Xeon Processor E3 Family. HDX 3D Pro supports multi-monitors (up to 3), console blanking,
custom resolution, and high frame-rate with the supported family of Intel processors. For more information, see http://www.citrix.com/intel
and http://www.intel.com/content/www/us/en/servers/data-center-graphics.html.
Support for AMD RapidFire on the AMD FirePro S-series server cards. HDX 3D Pro supports multi-monitors (up to 6), console blanking,
custom resolution, and high frame-rate. Note: HDX 3D Pro support for AMD MxGPU (GPU virtualization) works with VMWare vSphere vGPUs
only. XenServer and Hyper-V are supported with GPU passthrough. For more information, see AMD Virtualization Solution.
Access to a high-performance video encoder for NVIDIA GPUs and Intel Iris Pro graphics processors. T his feature is
controlled by a policy setting (enabled by default) and allows the use of hardware encoding for H.264 encoding (where
available). If such hardware is not available, the VDA will fall back to CPU-based encoding using the software video codec.
For more information, see Graphics policy settings.
As shown in the following gure:
When a user logs on to Citrix Receiver and accesses the virtual application or desktop, the Controller authenticates the
user and contacts the VDA for HDX 3D Pro to broker a connection to the computer hosting the graphical application.
T he VDA for HDX 3D Pro uses the appropriate hardware on the host to compress views of the complete desktop or
of just the graphical application.
T he desktop or application views and the user interactions with them are transmitted between the host computer and
the user device through a direct HDX connection between Citrix Receiver and the VDA for HDX 3D Pro.

Install the VDA f or HDX 3D Pro
When you use the installer's graphical interface to install a VDA for Windows Desktop OS, select Yes on the HDX 3D Pro
page. When using the command line interface, include the /enable_hdx_3d_pro option with the XenDesktop VdaSetup.exe
command.
To upgrade HDX 3D Pro, uninstall both the separate HDX 3D for Professional Graphics component and the VDA before
installing the VDA in HDX 3D Pro mode. Similarly, to switch from the standard VDA mode for Windows Desktop OS to the
3D Pro mode, uninstall the standard VDA and then install the VDA in HDX 3D Pro mode.
Standard mode HDX 3D Pro mode
Generally best for virtual desktops without graphics Generally best for data center desktops with graphics
hardware acceleration, and for Remote PC Access. hardware acceleration, unless more than four monitors are
required.
Any GPU can be used for Remote PC Access, with some Supports GPU acceleration with any GPU, however console
app compatibility limitations: blanking, non-standard screen resolutions and true multi-
monitor support require NVIDIA GRID, Intel Iris Pro, or AMD
On Windows 7, 8, and 8.1, GPU acceleration for
RapidFire graphics.
DirectX feature levels up to 9.3. Some DirectX 10, 11,
12 applications may not run if they do not tolerate Leverages graphics vendor's driver for broadest application
fallback to DirectX 9. compatibility:
On Windows 10, GPU acceleration is provided for
All 3D APIs (DirectX or OpenGL) that the GPU supports.
windowed DirectX 10, 11, and 12 apps. DX 9 apps are
Full-screen 3D app support with Intel Iris Pro (Win10
rendered by WARP. DX apps cannot be used in full-

screen mode. only) and NVIDIA GRID and AMD RapidFire.
OpenGL application acceleration in remote sessions if Support for custom driver extensions and APIs. For
supported by the GPU vendor (currently only NVIDIA). example, CUDA or OpenCL.
Arbitrary monitor resolutions (limit determined by Supports up to four monitors.

Windows OS and performance) and up to eight monitors.
H.264 hardware encoding available with Intel Iris Pro H.264 hardware encoding available with Intel Iris Pro
graphics processors. graphics processors and NVIDIA cards.
Install and upgrade NVIDIA drivers
T he NVIDIA GRID API provides direct access to the frame buffer of the GPU, providing the fastest possible frame rate for a
smooth and interactive user experience. If you install NVIDIA drivers before you install a VDA with HDX 3D Pro, NVIDIA
GRID is enabled by default.
To enable NVIDIA GRID on a VM, disable Microsoft Basic Display Adapter from the Device Manager. Run the following
command and then restart the VDA: NVFBCEnable.exe -enable -noreset
If you install NVIDIA drivers after you install a VDA with HDX 3D Pro, NVIDIA GRID is disabled. Enable NVIDIA GRID by using
the NVFBCEnable tool provided by NVIDIA.
To disable NVIDIA GRID, run the following command and then restart the VDA: NVFBCEnable.exe -disable -noreset
Install Intel graphics drivers
You can install the Intel graphics drivers before installing the VDA. T he following step is only required if you install Intel
drivers after you install a VDA with HDX 3D Pro or if the Intel driver has been updated.
In order to enable the Intel drivers required for multi-monitor support, run the following command using the
GfxDisplayTool.exe, then restart the VDA: Gf xDisplayTool.exe -vd enable
GfxDisplayTool.exe is included with the VDA installer. T he GfxDisplayTool.exe is in C:\Program Files\Citrix\ICAServices.
Note
Uninstalling NVIDIA or Intel drivers within ICA sessions is not supported.
Optimize the HDX 3D Pro user experience
To use HDX 3D Pro with multiple monitors, ensure that the host computer is congured with at least as many monitors as
are attached to user devices. T he monitors attached to the host computer can be either physical or virtual.
Do not attach a monitor (either physical or virtual) to a host computer while a user is connected to the virtual desktop or
application providing the graphical application. Doing so can cause instability for the duration of a user's session.
Let your users know that changes to the desktop resolution (by them or an application) are not supported while a graphical
application session is running. After closing the application session, a user can change the resolution of the Desktop Viewer

window in the Citrix Receiver - Desktop Viewer Preferences.
When multiple users share a connection with limited bandwidth (for example, at a branch ofce), Citrix recommends that
you use the Overall session bandwidth limit policy setting to limit the bandwidth available to each user. T his ensures that
the available bandwidth does not uctuate widely as users log on and off. Because HDX 3D Pro automatically adjusts to
make use of all the available bandwidth, large variations in the available bandwidth over the course of user sessions can
negatively impact performance.
For example, if 20 users share a 60 Mbps connection, the bandwidth available to each user can vary between 3 Mbps and
60 Mbps, depending on the number of concurrent users. To optimize the user experience in this scenario, determine the
bandwidth required per user at peak periods and limit users to this amount at all times.
For users of a 3D mouse, Citrix recommends that you increase the priority of the Generic USB Redirection virtual channel to
0. For information about changing the virtual channel priority, see CT X128190.

GPU acceleration for Windows Server OS
May 22, 20 17
HDX 3D Pro allows graphics-heavy applications running in Windows Server OS sessions to render on the server's graphics
processing unit (GPU). By moving OpenGL, DirectX, Direct3D, and Windows Presentation Foundation (WPF) rendering to the
server's GPU, the server's CPU is not slowed by graphics rendering. Additionally, the server is able to process more graphics
because the workload is split between the CPU and GPU.
Since Windows Server is a multi-user operating system, a GPU accessed by XenApp can be shared by multiple users without
the need for GPU virtualization (vGPU).
For procedures that involve editing the registry, use caution: Editing the registry incorrectly can cause serious problems that
may 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.
GPU sharing
GPU Sharing enables GPU hardware rendering of OpenGL and DirectX applications in remote desktop sessions; it has the
following characteristics:
Can be used on bare metal or virtual machines to increase application scalability and performance.
Enables multiple concurrent sessions to share GPU resources (most users do not require the rendering performance of a
dedicated GPU).
Requires no special settings.
You can install multiple GPUs on a hypervisor and assign VMs to each of these GPUs on a one-to-one basis: either install a
graphics card with more than one GPU, or install multiple graphics cards with one or more GPUs each. Mixing heterogeneous
graphics cards on a server is not recommended.
Virtual machines require direct passthrough access to a GPU, which is available with Citrix XenServer, VMware vSphere vDGA
and Intel GVT -d. When HDX 3D Pro is used with GPU Passthrough, each GPU in the server supports one multi-user virtual
machine.
GPU Sharing does not depend on any specific graphics card.

When running on a hypervisor, select a hardware platform and graphics cards that are compatible with your hypervisor's
GPU Passthrough implementation. T he list of hardware that has passed certification testing with XenServer GPU
Passthrough is available at GPU Passthrough Devices.
When running on bare metal, it is recommended to have a single display adapter enabled by the operating system. If
multiple GPUs are installed on the hardware, disable all but one of them using Device Manager.
Scalability using GPU Sharing depends on several factors:

T he applications being run
T he amount of video RAM they consume
T he graphics card's processing power
Some applications handle video RAM shortages better than others. If the hardware becomes extremely overloaded, this
could cause instability or a crash of the graphics card driver. Limit the number of concurrent users to avoid such issues.
To conrm that GPU acceleration is occurring, use a third-party tool such as GPU-Z. GPU-Z is available at
http://www.techpowerup.com/gpuz/.

DirectX, Direct3D, and WPF rendering
DirectX, Direct3D, and WPF rendering is only available on servers with a GPU that supports a display driver interface (DDI)
version of 9ex, 10, or 11.
On Windows Server 2008 R2, DirectX and Direct3D require no special settings to use a single GPU.
On Windows Server 2016 and Windows Server 2012, Remote Desktop Services (RDS) sessions on the RD Session Host
server use the Microsoft Basic Render Driver as the default adapter. T o use the GPU in RDS sessions on Windows Server
2012, enable the Use the hardware default graphics adapter for all Remote Desktop Services sessions setting in the
group policy Local Computer Policy > Computer Configuration > Administrative T emplates > Windows Components >
Remote Desktop Services > Remote Desktop Session Host > Remote Session Environment.
T o enable WPF applications to render using the server's GPU, create the following settings in the registry of the server
running Windows Server OS sessions:
[HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\CtxHook\AppInit_Dlls\Multiple Monitor Hook]
"EnableWPFHook"=dword:00000001
[HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Citrix\CtxHook\AppInit_Dlls\Multiple Monitor Hook]
"EnableWPFHook"=dword:00000001
GPU acceleration f or CUDA or OpenCL applications
GPU acceleration of CUDA and OpenCL applications running in a user session is disabled by default.
T o use the CUDA acceleration POC features, enable the following registry settings:
[HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\CtxHook\AppInit_Dlls\Graphics Helper] "CUDA"=dword:00000001
[HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Citrix\CtxHook\AppInit_Dlls\Graphics Helper]
"CUDA"=dword:00000001
T o use the OpenCL acceleration POC features, enable the following registry settings:
[HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\CtxHook\AppInit_Dlls\Graphics Helper] "OpenCL"=dword:00000001
[HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Citrix\CtxHook\AppInit_Dlls\Graphics Helper]
"OpenCL"=dword:00000001

OpenGL Software Accelerator
May 22, 20 17
T he OpenGL Software Accelerator is a software rasterizer for OpenGL applications such as ArcGIS, Google Earth, Nehe,
Maya, Blender, Voxler, CAD, and CAM. In some cases, the OpenGL Software Accelerator can eliminate the need to use
graphics cards to deliver a good user experience with OpenGL applications.
Important: T he OpenGL Software Accelerator is provided "as is" and must be tested with all applications. It might not work
with some applications and is intended as a solution to try if the Windows OpenGL rasterizer does not provide adequate
performance. If the OpenGL Software Accelerator works with your applications, it can be used as a way to avoid the cost
of GPU hardware.
T he OpenGL Software Accelerator is provided in the Support folder on the installation media, and is supported on all valid
VDA platforms.
When should you try the OpenGL Software Accelerator?

On servers without graphics processing hardware, if the performance of OpenGL applications running in virtual machines
on XenServer or other hypervisors is an issue, try using OpenGL Accelerator. For some applications, the OpenGL
Accelerator outperforms the Microsoft OpenGL software rasterizer that is included with Windows because the OpenGL
Accelerator leverages SSE4.1 and AVX. OpenGL Accelerator also supports applications using OpenGL versions up to 2.1.
For applications running on a workstation, first try the default version of OpenGL support provided by the workstation's
graphics adapter. If the graphics card is the latest version, in most cases it will deliver the best performance. If the
graphics card is an earlier version or does not delivery satisfactory performance, then try the OpenGL Software
Accelerator.
3D OpenGL applications that are not adequately delivered using CPU-based software rasterization may benefit from
OpenGL GPU hardware acceleration. T his feature can be used on bare metal or virtual machines.

Audio features
May 22, 20 17
You can congure and add the following Citrix policy settings to a policy that optimizes HDX audio features. For usage
details plus relationships and dependencies with other policy settings, see Audio policy settings and Bandwidth policy
settings and Multi-stream connections policy settings.
Important: Most audio features are transported using the ICA stream and are secured in the same way as other ICA traffic.
User Datagram Protocol (UDP) audio uses a separate, unsecured, transport mechanism when NetScaler Access Gateway is
not in path. If NetScaler Access Gateway is configured to access XenApp and XenDesktop resources, then UDP audio
traffic between the endpoint device and NetScaler Access Gateway is secured using DT LS protocol.
Audio quality
In general, higher sound quality consumes more bandwidth and server CPU utilization by sending more audio data to user
devices. Sound compression allows you to balance sound quality against overall session performance; use Citrix policy
settings to congure the compression levels to apply to sound les.
By default, the Audio quality policy setting is set to High - high denition audio when TCP transport is used, and to Medium
- optimized-for-speech when UDP transport (recommended) is used. T he High Denition audio setting provides high delity
stereo audio, but consumes more bandwidth than other quality settings. Do not use this audio quality for non-optimized
voice chat or video chat applications (such as softphones), because it may introduce latency into the audio path that is not
suitable for real-time communications. T he optimized for speech policy setting is recommended for real-time audio,
regardless of the selected transport protocol.
Consider creating separate policies for groups of dial-up users and for those who connect over a LAN or WAN. Over
connections where bandwidth is limited, download speed is often more important to users than sound quality. T herefore,
you may want to create one policy for low speed connections that applies high compression levels to sound, and another
for LAN or WAN connections that applies lower compression levels.
For setting details, see Audio policy settings. Remember to enable Client audio settings on the user device; see Audio
setting policies for user devices.
To allow users to receive audio from an application on a server through speakers or other sound devices (such as
headphones) on the user device, leave the Client audio redirection setting at its default (Allowed).
Client audio mapping may cause a heavy load on the servers and the network; however, prohibiting client audio redirection
disables all HDX audio functionality.
For setting details see Audio policy settings. Remember to enable client audio settings on the user device; see Audio setting
policies for user devices.
To allow users to record audio using input devices such as microphones on the user device leave the Client microphone
redirection setting at its default (Allowed).
For security, users are alerted when servers that are not trusted by their user devices try to access microphones, and can
choose to accept or reject access prior to using the microphone. Users can disable this alert on Citrix Receiver.

For setting details, see Audio policy settings. Remember to enable Client audio settings on the user device; see Audio
Audio Plug N Play
T he Audio Plug N Play policy setting allows or prevents the use of multiple audio devices to record and play sound. T his
setting is Enabled by default. Audio plug n play enables audio devices to be recognized even if they are not plugged in until
after the user's session has been established.
T his setting applies only to Windows Server OS machines.
For setting details, see Audio policy settings.
Audio redirection bandwidth limit and Audio redirection bandwidth limit percent
T he Audio redirection bandwidth limit policy setting species the maximum bandwidth (in kilobits per second) for a playing
and recording audio in a session. T he Audio redirection bandwidth limit percent setting species the maximum bandwidth
for audio redirection as a percentage of the total available bandwidth. By default, zero (no maximum) is specied for both
settings. If both settings are congured, the one with the lowest bandwidth limit is used.
For setting details, see Bandwidth policy settings. Remember to enable Client audio settings on the user device; see Audio
Audio over UDP Real-time Transport and Audio UDP port range
By default, Audio over UDP Real-time T ransport is allowed (when selected at time of installation), opening up a UDP port on
the server for connections that use Audio over UDP Real-time T ransport. Citrix recommends configuring UDP/RT P for
audio, to ensure the best possible user experience in the event of network congestion or packet loss.
Important: Audio data transmitted with UDP is not encrypted when NetScaler Access Gateway is not in path. If NetScaler
Access Gateway is configured to access XenApp and XenDesktop resources then audio traffic between the endpoint
device and NetScaler Access Gateway is secured using DT LS protocol.
T he Audio UDP port range species the range of port numbers that the Virtual Delivery Agent (VDA) uses to exchange
audio packet data with the user device.
By default, the range is16500 - 16509.
For setting details about Audio over UDP Real-time Transport, see Audio policy settings; for details about Audio UDP port
range, see Multi-stream connections policy settings. Remember to enable Client audio settings on the user device; see
Audio setting policies for user devices.
Audio setting policies f or user devices
1. Load the group policy templates by following Configure Receiver with the Group Policy Object template.
2. In the Group Policy Editor, expand Administrative T emplates > Citrix Components > Citrix Receiver > User Experience.
3. For Client audio settings, select Not Conf igured, Enabled, or Disabled.
Not Conf igured. By default Audio Redirection is enabled with high quality audio or previously configured custom
audio settings.
Enabled. Audio redirection is enabled with selected options.
Disabled. Audio redirection is disabled.
4. If you select Enabled, choose a sound quality. For UDP audio, use Medium (default).
5. For UDP audio only, select Enable Real-Time Transport and then set the range of incoming ports to open in the local
Windows firewall.

6. T o use UDP Audio with NetScaler Access Gateway, select Allow Real-Time Transport Through gateway. NetScaler
Access Gateway should be configured with DT LS. For more information, see UDP Audio T hrough a Netscaler Gateway.
As an Administrator, if you do not have control on endpoint devices to make these changes, for example in the case of
BYOD or home computers, then use the default.ica attributes from StoreFront to enable UDP Audio.
1. On the StoreFront machine, open C:\inetpub\wwwroot\Citrix\<Store Name>\App_Data\default.ica with an editor such

as notepad.
2. Make the entries below under the [Application] section.
command COPY
; This is t o enable Real-Time Transport
EnableRt pAudio=t rue
; This is t o Allow Real-Time Transport Through gat eway
EnableUDPThroughGat eway=t rue
; This is t o set audio qualit y t o Medium
AudioBandwidt hLimit =1-
; UDP Port range
Rt pAudioLowest Port =16500
Rt pAudioHighest Port =16509
If UDP Audio is enabled by editing default.ica, then UDP audio will enabled for all users who are using that store.
Avoid echo during multimedia conf erences
Users in audio or video conferences may hear an echo. Echoes usually occur when speakers and microphones are too close
to each other. For that reason, Citrix recommends the use of headsets for audio and video conferences.
HDX provides an echo cancellation option (enabled by default) that minimizes echo. T he effectiveness of echo cancellation
is sensitive to the distance between the speakers and the microphone; devices should not be too close or too far away
from each other.
You can change a registry setting to disable echo cancellation. When working in the registry, use caution: editing the
registry incorrectly can cause serious problems that may 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.
1. Using the Registry Editor on the user device, navigate to one of the following:
32-bit computers: HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\ICA
Client\Engine\Configuration\Advanced\Modules\ClientAudio\EchoCancellation
64-bit computers: HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Citrix\ICA
Client\Engine\Configuration\Advanced\Modules\ClientAudio\EchoCancellation
2. Change the Value data field to FALSE.

Network trafc priorities
May 22, 20 17
Priorities are assigned to network trafc across multiple connections for a session with quality of service (QoS)-supported
routers. Four TCP streams (real-time, interactive, background, and bulk) and two UDP streams (for voice and for Framehawk
display remoting) are available to carry ICA trafc between the user device and the server. Each virtual channel is associated
with a specic priority and transported in the corresponding connection. You can set the channels independently, based on
the TCP port number used for the connection.
Multiple channel streaming connections are supported for Virtual Delivery Agents (VDAs) installed on Windows 10, Windows
8 and Windows 7 machines. Work with your network administrator to ensure the Common Gateway Protocol (CGP) ports
congured in the Multi-Port Policy setting are assigned correctly on the network routers.
Quality of service (QoS) is supported only when multiple session reliability ports, or the CGP ports, are congured.
Caution: Use transport security when using this feature. Citrix recommends using Internet Protocol Security (IPsec) or
T ransport Layer Security (T LS). T LS connections are supported only when the connections traverse a NetScaler Gateway
that supports multi-stream ICA. On an internal corporate network, multi-stream connections with T LS are not supported.
T o set quality of service for multiple streaming connections, add the following Citrix policy settings to a policy (see Multi-
stream connections policy settings for details):
Multi-Port policy - T his setting specifies ports for ICA traffic across multiple connections, and establishes network
priorities.
Select a priority from the CGP default port priority list; by default, the primary port (2598) has a High priority.
Enter additional CGP ports in CGP port1, CGP port2, and CGP port3 as needed, and identify priorities for each. Each
port must have a unique priority.
Explicitly congure the rewalls on VDAs to allow the additional TCP trafc.
Multi-Stream computer setting - T his setting is disabled by default. If you use Citrix NetScaler SD-WAN with Multi-
Stream support in your environment, you do not need to configure this setting. Configure this policy setting when using
third-party routers or legacy Branch Repeaters to achieve the desired Quality of Service (QoS).
Multi-Stream user setting - T his setting is disabled by default.
For policies containing these settings to take effect, users must log off and then log on to the network.

USB and client drive considerations
May 22, 20 17
HDX technology provides optimized support for most popular USB devices. T his includes:
Monitors
Mice
Keyboards
VoIP phones
Headsets
Webcams
Scanners
Cameras
Printers
Drives
Smart card readers
Drawing tablets
Signature pads
Optimized support offers an improved user experience with better performance and bandwidth efciency over a WAN.
Optimized support is usually the best option, especially in high latency or security-sensitive environments.
HDX technology provides generic USB redirection for specialty devices that don't have optimized support or where it is
unsuitable, for example:
T he USB device has additional advanced features that are not part of optimized support, such as a mouse or webcam
with additional buttons.
Users need functions which are not part of optimized support, such as burning a CD.
T he USB device is a specialized device, such as test and measurement equipment or an industrial controller.
An application requires direct access to the device as a USB device.
T he USB device only has a Windows driver available. For example, a smart card reader may not have a driver available for
Citrix Receiver for Android.
T he version of Citrix Receiver does not provide optimized support for this type of USB device.
With generic USB redirection:
Users do not need to install device drivers on the user device.

USB client drivers are installed on the VDA machine.
Note
Generic USB redirection can be used together with optimized support. If you enable generic USB redirection, configure Citrix USB
devices policy settings for both generic USB redirection and optimized support to avoid inconsistent and unexpected behavior.
T he Citrix policy setting Client USB device optimization rules is a specific setting for generic USB redirection, for a particular of USB
device. It is not optimized support as described here.
Client USB plug and play device redirection is a related feature that provides optimized support for devices such as cameras and
media players that use the Picture T ransfer Protocol (PT P) or Media T ransfer Protocol (MT P). Client USB plug and play redirection
is not part of generic USB redirection. Client USB plug and play redirection is available on Server OS only.

Perf ormance considerations f or USB devices
With generic USB redirection, for some types of USB devices, network latency and bandwidth can affect user experience
and USB device operation. For example, timing-sensitive devices may not operate correctly over high-latency low-bandwidth
links. Use optimized support instead where possible.
Some USB devices require high bandwith to be usable, for example a 3D mouse (used with 3D apps that also typically
require high bandwidth). You can avoid performance problems using Citrix polices. For more information, see Bandwidth
policy settings for Client USB device redirection, and Multi-stream connection policy settings.
Security considerations f or USB devices
Some USB devices are security-sensitive by nature, for example, smart card readers, ngerprint readers, and signature pads.
Other USB devices such as USB storage devices can be used to transmit data that may be sensitive.
USB devices are often used to distribute malware. Conguration of Citrix Receiver, XenApp and XenDesktop can reduce, but
not eliminate, risk from these USB devices. T his applies whether generic USB redirection or optimized support is used.
Important
For security-sensitive devices and data, always secure the HDX connection using either T LS or IPSec.
Only enable support for the USB devices that you need. Congure both generic USB redirection and optimized support to meet this
need.
Provide guidance to users for safe use of USB devices: only use USB devices that have been obtained from a trustworthy source;
not to leave USB devices unattended in open environments - for example, a ash drive in an Internet cafe; explain the risks of using
a USB device on more than one computer.
Compatibility with generic USB redirection
Generic USB redirection is supported for USB 2.0 and earlier devices. Generic USB redirection is also supported for USB 3.0
devices connected to a USB 2.0 or USB 3.0 port. Generic USB redirection does not support USB features introduced in USB
3.0, such as super speed.
T hese Citrix Receivers support generic USB redirection:
Citrix Receiver for Windows, see Configure your XenDesktop environment

Citrix Receiver for Mac, see Configuring Citrix Receiver for Mac
Citrix Receiver for Linux, see Optimize
Citrix Receiver for Chrome OS, see About Citrix Receiver for Chrome 2.1
For Citrix Receiver versions, see the Citrix Receiver feature matrix.
If you are using earlier versions of Citrix Receiver, refer to Citrix Receiver documentation to conrm that generic USB
redirection is supported. Refer to Citrix Receiver documentation for any restrictions on USB device types that are
supported.

Generic USB redirection is supported for desktop sessions from VDA for Desktop OS version 7.6 through current.
Generic USB redirection is supported for desktop sessions from VDA for Server OS version 7.6 through current, with these
restrictions:
T he VDA must be running Windows Server 2012 R2 or Windows Server 2016.

Only single-hop scenarios are supported. Double-hop generic USB redirection is not supported for desktop hosted
application sessions.
T he USB device drivers must be fully compatible with Remote Desktop Session Host (RDSH) for Windows 2012 R2,
including full virtualization support.
Some types of USB devices are not supported for generic USB redirection because it would not be useful to redirect them:
USB modems.
USB network adapters.
USB hubs. T he USB devices connected to USB hubs are handled individually.
USB virtual COM ports. Use COM port redirection rather than generic USB Redirection.
For information on USB devices that have been tested with generic USB redirection, see CT X123569. Some USB devices do
not operate correctly with generic USB redirection.
Congure generic USB redirection
You can control which types of USB devices use generic USB redirection. T his is separately congurable:
On the VDA, using Citrix policy settings. For more information, see Redirection of client drives and user devices and USB
devices policy settings in the Policy settings reference
In Citrix Receiver, using Citrix Receiver-dependent mechanisms. For example, Citrix Receiver for Windows is configured
with registry settings that can be controlled by an Administrative T emplate. By default, USB redirection is allowed for
certain classes of USB devices and denied for others; for more information, see Configure your XenDesktop environment
in the Citrix Receiver for Windows documentation for details.
T his separate conguration provides exibility. For example:
If two different organizations or departments are responsible for Citrix Receiver and VDA they can enforce control
separately. T his would apply when a user in one organization accesses an application in another organization.
If USB devices should be allowed only for certain users or for users only connecting over LAN (rather than with NetScaler
Gateway), this can be controlled with Citrix policy settings.
Enable generic USB redirection
To enable generic USB Redirection, congure both Citrix policy settings and Citrix Receiver.
In Citrix policy settings:
1. Add the Client USB device redirection to a policy and set its value to Allowed.

2. (Optional) To update the list of USB devices available for redirection, add the Client USB device redirection rules setting to
a policy and specify the USB policy rules.
In Citrix Receiver:
3. Enable USB support when you install Citrix Receiver on user devices. You can do this using an Administrative template or in
Citrix Receiver for Windows > Preferences > Connections.

If you specied USB policy rules for the VDA in the previous step, specify those same policy rules for Citrix Receiver.
For thin clients, consult the manufacturer for details of USB support and any required conguration.
Conguring the types of USB devices available f or generic USB redirection
USB devices are automatically redirected when USB support is enabled and the USB user preference settings are set to
automatically connect USB devices. USB devices are also automatically redirected when operating in Desktop Appliance
mode and the connection bar is not present.
Users can explicitly redirect devices that are not automatically redirected by selecting the devices from the USB device list.
Users can get more help on how to do this in the Citrix Receiver for Windows user help article, Display your devices in the
Desktop Viewer.

To use generic USB redirection rather than optimized support, you can either:
In Citrix Receiver, manually select the USB device to use generic USB redirection, choose Switch to generic from
the Devices tab of the Preferences dialog box.
Automatically select the USB device to use generic USB redirection, by configuring auto-redirection for the USB device
type (for example, AutoRedirectStorage=1) and set USB user preference settings to automatically connect USB devices.
For more information, see CT X123015.
Note: Only congure generic USB redirection for use with a webcam if the webcam is found to be incompatible with HDX
multimedia redirection.
To prevent USB devices from ever being listed or redirected, you can specify device rules for Citrix Receiver and the VDA.
For generic USB redirection, you will need to know at least the USB device class and subclass. Not all USB devices use their
obvious USB device class and subclass. For example:
Pens use the mouse device class.

Smart card readers may use the vendor-defined or HID device class.
For more precise control, you will also need to know the Vendor ID, Product ID, and Release ID. You can get this
information from the device vendor.
Important
Malicious USB devices may present USB device characteristics that do not match their intended usage. Device rules are not intended

to prevent this behavior.
You control the USB devices available for generic USB redirection by specifying USB device redirection rules for both VDA
and Citrix Receiver, to override the default USB policy rules.
For the VDA:
Edit the administrator override rules for the Server OS machines through group policy rules. T he Group Policy
Management Console is included on the installation media:
For x64: dvd root \os\lang\x64\Citrix Policy\ CitrixGroupPolicyManagement_x64.msi
For x86: dvd root \os\lang\x86\Citrix Policy\ CitrixGroupPolicyManagement_x86.msi
At Citrix Receiver for Windows:
Edit the user device registry. An Administrative template (ADM file) is included on the installation media so you can
change the user device through Active Directory Group Policy:
dvd root \os\lang\Support\Configuration\icaclient_usb.adm
Warning
T he product default rules are stored in HKLM\SOFT WARE\Citrix\PortICA\GenericUSB\DeviceRules. Do not edit these
product default rules. Instead, use them as a guide for creating administrator override rules as explained below. T he GPO
overrides are evaluated before the product default rules.
T he administrator override rules are stored in HKLM\SOFT WARE\Policies\Citrix\PortICA\GenericUSB\DeviceRules. GPO

policy rules take the format {Allow:|Deny:} followed by a set of tag=value expressions separated by white space.
T he following tags are supported:
Tag Description
VID Vendor ID from the device descriptor
PID Product ID from the device descriptor
REL Release ID from the device descriptor
Class Class from either the device descriptor or an interface descriptor; see the USB Web site at
http://www.usb.org/ for available USB Class Codes

SubClass Subclass from either the device descriptor or an interface descriptor
Prot Protocol from either the device descriptor or an interface descriptor
When creating new policy rules, note the following:
Rules are case-insensitive.

Rules may have an optional comment at the end, introduced by #. A delimiter is not required, and the comment is ignored
for matching purposes.
Blank and pure comment lines are ignored.
White space is used as a separator, but cannot appear in the middle of a number or identifier. For example, Deny: Class =
08 SubClass=05 is a valid rule, but Deny: Class=0 Sub Class=05 is not.
T ags must use the matching operator =. For example, VID=1230.
Each rule must start on a new line or form part of a semicolon-separated list.
Note
If you are using the ADM template le, you must create rules on a single line, as a semicolon-separated list.
Examples:
T he following example shows an administrator-defined USB policy rule for vendor and product identifiers:
Allow: VID=046D PID=C626 # Allow Logitech SpaceNavigator 3D Mouse
Deny: VID=046D # Deny all Logitech products
T he following example shows an administrator-defined USB policy rule for a defined class, sub-class, and protocol:
Deny: Class=EF SubClass=01 Prot=01 # Deny MS Active Sync devices
Allow: Class=EF SubClass=01 # Allow Sync devices
Allow: Class=EF # Allow all USB-Miscellaneous devices
Use and remove USB devices
Users can connect a USB device before or after starting a virtual session.
When using Citrix Receiver for Windows, the following apply:

Devices connected after a session starts appear immediately in the USB menu of the Desktop Viewer.
If a USB device is not redirecting properly, you can try to resolve the problem by waiting to connect the device until after
the virtual session starts.
T o avoid data loss, use the Windows "Safely Remove Hardware" icon before removing the USB device.
Security controls f or USB mass storage devices
Optimized support is provided for USB mass storage devices. T his is part of XenApp and XenDesktop client drive mapping.
Drives on the user device are automatically mapped to drive letters on the virtual desktop when users log on. T he drives are
displayed as shared folders with mapped drive letters. To congure client drive mapping, use the Client removable
drives setting in the File Redirection policy settings section of the ICA policy settings.
With USB mass storage devices you can use either Client drive mapping or generic USB redirection, or both, controlled by

Citrix polices. T he main differences are:
Feature Client drive mapping Generic USB redirection
Enabled by default Yes No
Read-only access congurable Yes No
Encrypted device access Yes, if encryption is unlocked before the device is No

accessed
Safe to remove device during a No Yes, provided users follow

session operating system
recommendations for safe
removal
If both generic USB redirection and the client drive mapping policies are enabled and a mass storage device is inserted either
before or after a session starts, it will be redirected using client drive mapping. When both generic USB redirection and the
client drive mapping policies are enabled and a device is congured for automatic redirection (see
http://support.citrix.com/article/CT X123015) and a mass storage device is inserted either before or after a session starts, it
will be redirected using generic USB redirection.
Note
USB redirection is supported over lower bandwidth connections, for example 50 Kbps, however copying large les will not work.
Control le access with client drive mapping
You can control whether users can copy les from their virtual environments to their user devices. By default, les and
folders on mapped client-drives are available in read/write mode from within the session.
To prevent users from adding or modifying les and folders on mapped client-devices, enable the Read-only client drive
access policy setting. When adding this setting to a policy, make sure the Client drive redirection setting is set
to Allowed and is also added to the policy.

HTML5 multimedia redirection
May 22, 20 17
HT ML5 multimedia redirection extends the multimedia redirection features of HDX MediaStream to include HT ML5 audio
and video. Because of growth in online distribution of multimedia content, especially to mobile devices, the browser industry
has developed more efcient ways to present audio and video.
Flash has been the standard, but it requires a plug-in, doesn't work on all devices, and has higher battery usage in mobile
devices. Companies like Youtube, NetFlix.com, and newer browsers versions of Mozilla, Google, and Microsoft are moving to
HT ML5 making it the new standard.
HT ML5-based multimedia has many advantages over proprietary plug-ins, including:
Company-independent standards (W3C)

Simplified digital rights management (DRM) workflow
Better performance without the security issues raised by plug-ins
HTTP progressive downloads
HT T P progressive downloads is an HT T P-based pseudo-streaming method that supports HT ML5. In a progressive

download, the browser plays back a single le (encoded at a single quality) while it is being downloaded from an HT T P web
server. T he video is stored on the hard drive as it's received and is played from the hard drive. If you rewatch the video, the
browser can load the video from cache.
For an example of a progressive download, see the HT ML5 video redirection test page. Use the developer tools in your
browser to inspect the video element in the webpage and nd the source (an mp4 container format) in the HT ML5 video
tag:
<video src="https://www.citrix.com/content/dam/citrix61/en_us/images/offsite/html5-redirect.mp4" controls=""

style="width:800px;"></video>
Comparison between HTML5 and Flash

Feature HTML5 Flash
Requires a proprietary player No Yes
Runs on mobile devices Yes Some
Running speed on different platforms High Slow
Supported by iOS Yes No
Resource usage Less More
Load faster Yes No
Requirements
We support only redirection for progressive downloads in mp4 format. We don't support WebM and Adaptive bitrate
streaming technologies like DASH/HLS.
We support:
Server side render

Server fetch client render
Client side fetching
Control these by using policies. For more information, see Multimedia policy settings.
Minimum versions of Citrix Receiver:
Citrix Receiver for Windows 4.5

Citrix Receiver for Linux 13.5

Minimum VDA browser version Windows OS version/build/SP
Windows 10 x86 (1607 RS1) and x64 (1607

RS1)
Windows 7 x86 and x64

Internet Explorer 11.0
Windows Server 2016 RT M 14393 (1607)
Windows 10 x86 (1607 RS1) and x64 (1607

Firefox 47 RS1)
Manually add the certicates to the Firefox
certicate store or congure Firefox to search Windows 7 x86 and x64
for certicates from a Windows trusted
certicate store. For more information, see Windows Server 2016 RT M 14393 (1607)
https://wiki.mozilla.org/CA:AddRootToFirefox
Windows 10 x86 (1607 RS1) and x64 (1607

RS1)
Windows 7 x86 and x64

Chrome 51
Windows Server 2016 RT M 14393 (1607)
Components of the HTML5 video redirection solution

HdxVideo.js - JavaScript hook intercepting video commands on the website. HdxVideo.js communicates with
WebSocketService using Secure WebSockets (SSL/T LS).
WebSocket SSL Certif icates - T wo certificates are installed on the T rusted Root Certificates store on the VDA:
Issued to Citrix HDX and issued by Citrix HDX
Issued to 127.0.0.1 and issued by Citrix HDX
WebSocketService.exe - Runs on the local system and performs SSL termination and user session mapping. T LS Secure
WebSocket listening on 127.0.0.1 port 9001.
WebSocketAgent.exe - Runs on the user session and renders the video as instructed from WebSocketService
commands.
How do I enable HTML5 video redirection

In this release, this feature is available for internal web pages only. It requires the addition of the HdxVideo.js JavaScript
(included with the XenDesktop and XenApp Installation media) to the web pages where the HT ML5 multimedia content is
available. For example, videos on an internal training site.
For more information, see Multimedia policy settings.
Troubleshooting Tips
Errors might occur when the webpage tries to execute HdxVideo.js. If the JavaScript fails to load, the HT ML5 redirection
mechanism fails. Ensure there are no errors related to HdxVideo.js by inspecting the console in the developers tool windows
of your browser. For example:

Policies
May 22, 20 17
Policies are a collection of settings that dene how sessions, bandwidth, and security are managed for a group of users,
devices, or connection types.
You can apply policy settings to physical and virtual machines or to users. You can apply settings to individual users at the
local level or in security groups in Active Directory. T he congurations dene specic criteria and rules, and if you do not
specically assign the policies, the settings are applied to all connections.
You can apply policies on different levels of the network. Policy settings placed at the Organizational Unit GPO level take
the highest precedence on the network. Policies at the Domain GPO level override policies on the Site Group Policy Object
level, which override any conicting policies on both the Microsoft and Citrix Local Policies levels.
All Citrix Local Policies are created and managed in the Citrix Studio console and stored in the Site Database; whereas,
Group Policies are created and managed with the Microsoft Group Policy Management Console (GPMC) and stored in
Active Directory. Microsoft Local Policies are created in the Windows Operating System and are stored in the registry.
Studio uses a Modeling Wizard to help administrators compare conguration settings within templates and policies to help
eliminate conicting and redundant settings. Administrators can set GPOs using the GPMC to congure settings and apply
them to a target set of users at different levels of the network.
T hese GPOs are saved in Active Directory, and access to the management of these settings is generally restricted for most
of IT for security.
Settings are merged according to priority and their condition. Any disabled setting overrides a lower-ranked enabled setting.
Uncongured policy settings are ignored and do not override lower-ranked settings.
Local policies can also have conicts with group policies in the Active Directory, which could override each other depending
on the situation.
All policies are processed in the following order:
1. T he end user logs on to a machine using domain credentials.

2. Credentials are sent to the domain controller.
3. Active Directory applies all policies (end user, endpoint, organizational unit, and domain).
4. T he end user logs on to Receiver and accesses an application or desktop.

5. Citrix and Microsoft policies are processed for the end user and machine hosting the resource.
6. Active Directory determines precedence for policy settings and applies them to the registries of the endpoint device and
to the machine hosting the resource.
7. T he end user logs off from the resource. Citrix policies for the end user and endpoint device are no longer active.
8. T he end user logs off the user device, which releases the GPO user policies.
9. T he end user turns off the device, which releases the GPO machine policies.
When creating policies for groups of users, devices, and machines, some members may have different requirements and
would need exceptions to some policy settings. Exceptions are made by way of lters in Studio and the GPMC that
determine who or what the policy affects.
Note: Mixing Windows and Citrix policies in the same GPO is not supported.
Related content
Work with policies

Policy templates
Create policies

Work with policies
May 22, 20 17
Congure Citrix policies to control user access and session environments. Citrix policies are the most efcient method of
controlling connection, security, and bandwidth settings. You can create policies for specic groups of users, devices, or
connection types. Each policy can contain multiple settings.
Tools f or working with Citrix policies
You can use the following tools to work with Citrix policies.
Studio - If you are a Citrix administrator without permission to manage group policy, use Studio to create policies for
your site. Policies created using Studio are stored in the site database and updates are pushed to the virtual desktop
either when that virtual desktop registers with the broker or when a user connects to that virtual desktop.
Local Group Policy Editor (Microsoft Management Console snap-in) - If your network environment uses Active
Directory and you have permission to manage group policy, you can use the Local Group Policy Editor to create policies
for your Site. T he settings you configure affect the Group Policy Objects (GPOs) you specify in the Group Policy
Management Console.
Important: You must use the Local Group Policy Editor to configure some policy settings, including those related to
registering VDAs with a Controller and those related to Microsoft App-V servers.
Policy processing order and precedence
Group policy settings are processed in the following order:

1. Local GPO
2. XenApp or XenDesktop Site GPO (stored in the Site database)
3. Site-level GPOs
4. Domain-level GPOs
5. Organizational Units
However, if a conflict occurs, policy settings that are processed last can overwrite those that are processed earlier. T his
means that policy settings take precedence in the following order:
1. Organizational Units
2. Domain-level GPOs
3. Site-level GPOs
4. XenApp or XenDesktop Site GPO (stored in the Site database)
5. Local GPO
For example, a Citrix administrator uses Studio to create a policy (Policy A) that enables client le redirection for the
company's sales employees. Meanwhile, another administrator uses the Group Policy Editor to create a policy (Policy B) that
disables client le redirection for sales employees. When the sales employees log on to the virtual desktops, Policy B is
applied and Policy A is ignored because Policy B was processed at the domain level and Policy A was processed at the
XenApp or XenDesktop Site GPO level.
However, when a user launches an ICA or Remote Desktop Protocol (RDP) session, Citrix session settings override the same
settings congured in an Active Directory policy or using Remote Desktop Session Host Conguration. T his includes
settings that are related to typical RDP client connection settings such as Desktop wallpaper, Menu animation, and View
window contents while dragging.

When using multiple policies, you can prioritize policies that contain conicting settings; see Compare, prioritize, model, and
troubleshoot policies for details.
Workow f or Citrix policies
T he process for configuring policies is as follows:

1. Create the policy.
2. Configure policy settings.
3. Assign the policy to machine and user objects.
4. Prioritize the policy.
5. Verify the effective policy by running the Citrix Group Policy Modeling wizard.
Navigate Citrix policies and settings
In the Local Group Policy Editor, policies and settings appear in two categories: Computer Conguration and User
Conguration. Each category has a Citrix Policies node. See the Microsoft documentation for details about navigating and
using this snap-in.
In Studio, policy settings are sorted into categories based on the functionality or feature they affect. For example, the
Profile management section contains policy settings for Profile management.
Computer settings (policy settings applying to machines) define the behavior of virtual desktops and are applied when a
virtual desktop starts. T hese settings apply even when there are no active user sessions on the virtual desktop. User
settings define the user experience when connecting using ICA. User policies are applied when a user connects or
reconnects using ICA. User policies are not applied if a user connects using RDP or logs on directly to the console.
T o access policies, settings, or templates, select Policies in the Studio navigation pane.
T he Policies tab lists all policies. When you select a policy, tabs to the right display: Overview (name, priority,
enabled/disabled status, and description), Settings (list of configured settings), and Assigned to (user and machine
objects to which the policy is currently assigned). For more information, see Create policies.
T he Templates tab lists Citrix-provided and custom templates you created. When you select a template, tabs to the
right display: Description (why you might want to use the template) and Settings (list of configured settings). For more
information, see Policy templates.
T he Comparison tab enables you to compare the settings in a policy or template with those in other policies or
templates. For example, you might want to verify setting values to ensure compliance with best practices. For more
information, see Compare, prioritize, model, and troubleshoot policies.
From the Modelling tab, you can simulate connection scenarios with Citrix policies. For more information, see
Compare, prioritize, model, and troubleshoot policies.
T o search for a setting in a policy or template:
1. Select the policy or template.
2. Select Edit policy or Edit T emplate in the Actions pane.
3. On the Settings page, begin to type the name of the setting.
You can rene your search by selecting a specic product version, selecting a category (for example, Bandwidth), or by
selecting the View selected only check box or selecting to search only the settings that have been added to the
selected policy. For an unltered search, select All Settings.
T o search for a setting within a policy :

1. Select the policy.
2. Select the Settings tab, begin to type the name of the setting.
You can rene your search by selecting a specic product version or by selecting a category. For an unltered search, select

All Settings.
A policy, once created, is completely independent of the template used. You can use the Description eld on a new policy
to keep track of the source template used.
In Studio, policies and templates are displayed in a single list regardless of whether they contain user, computer or both
types of settings and can be applied using both user and computer lters.
In Group Policy Editor, Computer and User settings must be applied separately, even if created from a template that
contains both types of settings. In this example choosing to use Very High Denition User Experience in Computer
Conguration:
Legacy Graphics mode is a Computer setting that will be used in a policy created from this template.
T he User settings, grayed out, will not be used in a policy created from this template.

Policy templates
May 22, 20 17
Templates are a source for creating policies from a predened starting point. Built-in Citrix templates, optimized for specic
environments or network conditions, can be used as:
A source for creating your own policies and templates to share between sites.
A reference for easier comparison of results between deployments as you will be able to quote the results, for example,
"..when using Citrix template x or y..".
A method for communicating policies with Citrix Support or trusted third parties by importing or exporting templates.
Policy templates can be imported or exported. For additional templates and updates to the built-in templates, see
CT X202000.
For considerations when using templates to create policies, see CT X202330.
Built-in Citrix templates
T he following policy templates are available:
Very High Def inition User Experience. T his template enforces default settings which maximize the user experience.
Use this template in scenarios where multiple policies are processed in order of precedence.
High Server Scalability. Apply this template to economize on server resources. T his template balances user experience
and server scalability. It offers a good user experience while increasing the number of users you can host on a single
server. T his template does not use video codec for compression of graphics and prevents server side multimedia
rendering.
High Server Scalability-Legacy OS. T his High Server Scalability template applies only to VDAs running Windows Server
2008 R2 or Windows 7 and earlier. T his template relies on the Legacy graphics mode which is more efficient for those
operating systems.
Optimized f or CloudBridge. Apply this template for users working from branch offices with CloudBridge for optimizing
delivery of XenDesktop. NetScaler SD-WAN is the new name for CloudBridge.
Optimized f or WAN. T his template is intended for task workers in branch offices using a shared WAN connection or
remote locations with low bandwidth connections accessing applications with graphically simple user interfaces with
little multimedia content. T his template trades off video playback experience and some server scalability for optimized
bandwidth efficiency.
Optimized f or WAN-Legacy OS. T his Optimized for WAN template applies only to VDAs running Windows Server 2008
R2 or Windows 7 and earlier. T his template relies on the Legacy graphics mode which is more efficient for those
operating systems.
Security and Control. Use this template in environments with low tolerance to risk, to minimize the features enabled by
default in XenApp and XenDesktop. T his template includes settings which will disable access to printing, clipboard,
peripheral devices, drive mapping, port redirection, and Flash acceleration on user devices. Applying this template may use
more bandwidth and reduce user density per server.
While we recommend using the built-in Citrix templates with their default settings, you will nd settings that do not have a
specic recommended value, for example, Overall session bandwidth limit, included in the Optimized for WAN templates. In
this case, the template exposes the setting so the administrator will understand this setting is likely to apply to the
scenario.

If you are working with a deployment (policy management and VDAs) prior to XenApp and XenDesktop 7.6 FP3, and require
High Server Scalability and Optimized for WAN templates, please use the Legacy OS versions of these templates when
these apply.
Note
Built-in templates are created and updated by Citrix. You cannot modify or delete these templates.
Create and manage templates using Studio
To create a new template based on a template:
1. Select Policies in the Studio navigation pane.

2. Select the Templates tab and then select the template from which you will create the new template.
3. Select Create Template in the Actions pane.
4. Select and configure the policy settings to include in the template. Remove any existing settings that should not be
included. Enter a name for the template.
After you click Finish, the new template appears on the Templates tab.
To create a new template based on a policy:

2. Select the Policies tab and then select the policy from which you will create the new template.
3. Select Save as Template in the Actions pane.
4. Select and configure any new policy settings to include in the template. Remove any existing settings that should not be
included. Enter a name and description for the template, and then click Finish.
To import a template:

2. Select the Templates tab and then select Import Template.
3. Select the template file to import and then click Open. If you import a template with the same name as an existing
template, you can choose to overwrite the existing template or save the template with a different name that is
generated automatically.
To export a template:

2. Select the Templates tab and then select Export Template.
3. Select the location where you want to save the template and then click Save.
A .gpt le is created in the specied location.
Create and manage templates using the Group Policy Editor
From the Group Policy Editor, expand Computer Configuration or User Configuration. Expand the Policies node and then
select Citrix Policies. Choose the appropriate action below.
Task Instruction
Create a new template from an existing On the Policies tab, select the policy and then select Actions > Save as
policy T emplate.
Create a new policy from an existing On the T emplates tab, select the template and then click New Policy.
template
Create a new template from an existing On the T emplates tab, select the template and then click New
template T emplate.
Import a template On the T emplates tab, select Actions > Import.
Export a template On the T emplates tab, select Actions > Export.
View template settings On the T emplates tab, select the template and then click the Settings
tab.
View a summary of template properties On the T emplates tab, select the template and then click the Properties
tab.
View template prerequisites On the T emplates tab, select the template and then click the
Prerequisites tab.

Templates and Delegated Administration
Policy templates are stored on the machine where the policy management package was installed. T his machine is either the
Delivery Controller machine or the Group Policy Objects management machine - not the XenApp and XenDesktop Site's
database. T his means that the policy template les are controlled by Windows administrative permissions rather than Site's
Delegated Administration roles and scopes.
As a result, an administrator with read-only permission in the Site can, for example, create new templates. However,
because templates are local les, no changes are actually made to your environment.
Custom templates are only visible to the user account that creates them and stored in the users Windows prole. To
expose a custom template further, create a policy from it or export it to a shared location.

Create policies
May 22, 20 17
Before creating a policy, decide which group of users or devices it should affect. You may want to create a policy based on
user job function, connection type, user device, or geographic location. Alternatively, you can use the same criteria that you
use for Windows Active Directory group policies.
If you already created a policy that applies to a group, consider editing that policy and conguring the appropriate settings,
instead of creating another policy. Avoid creating a new policy solely to enable a specic setting or to exclude the policy
from applying to certain users.
When you create a new policy, you can base it on settings in a policy template and customize settings as needed, or you
can create it without using a template and add all the settings you need.
In Citrix Studio, new policies created are set to Disabled unless the Enable policy checkbox is explicitly checked.
Policy settings
Policy settings can be enabled, disabled, or not congured. By default, policy settings are not congured, which means they
are not added to a policy. Settings are applied only when they are added to a policy.
Some policy settings can be in one of the following states:

Allowed or Prohibited allows or prevents the action controlled by the setting. In some cases, users are allowed or
prevented from managing the setting's action in a session. For example, if the Menu animation setting is set to Allowed,
users can control menu animations in their client environment.
Enabled or Disabled turns the setting on or off. If you disable a setting, it is not enabled in lower-ranked policies.
In addition, some settings control the effectiveness of dependent settings. For example, Client drive redirection controls
whether or not users are allowed to access the drives on their devices. To allow users to access their network drives, both
this setting and the Client network drives setting must be added to the policy. If the Client drive redirection setting is
disabled, users cannot access their network drives, even if the Client network drives setting is enabled.
In general, policy setting changes that impact machines go into effect either when the virtual desktop restarts or when a
user logs on. Policy setting changes that impact users go into effect the next time users log on. If you are using Active
Directory, policy settings are updated when Active Directory re-evaluates policies at 90-minute intervals and applied either
when the virtual desktop restarts or when a user logs on.
For some policy settings, you can enter or select a value when you add the setting to a policy. You can limit conguration
of the setting by selecting Use default value; this disables conguration of the setting and allows only the setting's default
value to be used when the policy is applied, regardless of the value that was entered before selecting Use default value.
As best practice:
Assign policies to groups rather than individual users. If you assign policies to groups, assignments are updated
automatically when you add or remove users from the group.
Do not enable conflicting or overlapping settings in Remote Desktop Session Host Configuration. In some cases,
Remote Desktop Session Host Configuration provides similar functionality to Citrix policy settings. When possible, keep
all settings consistent (enabled or disabled) for ease of troubleshooting.
Disable unused policies. Policies with no settings added create unnecessary processing.

Policy assignments
When creating a policy, you assign it to certain user and machine objects; that policy is applied to connections according to
specic criteria or rules. In general, you can add as many assignments as you want to a policy, based on a combination of
criteria. If you specify no assignments, the policy is applied to all connections.
T he following table lists the available assignments:
Assignment Name Applies a policy based on
Access Control Access control conditions through which a client is connecting.

Connection type - Whether to apply the policy to connections made with or without
NetScaler Gateway.
NetScaler Gateway farm name - Name of the NetScaler Gateway virtual server.
Access condition - Name of the end point analysis policy or session policy to use.
Citrix CloudBridge Whether or not a user session is launched through Citrix CloudBridge.
Note: You can add only one Citrix CloudBridge assignment to a policy.
Client IP Address IP address of the user device used to connect to the session.
IPv4 examples: 12.0.0.0, 12.0.0.*, 12.0.0.1-12.0.0.70, 12.0.0.1/24
IPv6 examples: 2001:0db8:3c4d:0015:0:0:abcd:ef12, 2001:0db8:3c4d:0015::/54
Client Name Name of the user device.
Exact match: ClientABCName

Using wildcard: Client*Name
Delivery Group Delivery Group membership.
Delivery Group type Type of desktop or application: private desktop, shared desktop, private application, or shared
application.
Organizational Unit Organizational unit.

(OU)
Tag Tags.
Note: To ensure that policies are applied correctly when using tags, install the hotx
at CT X142439.
User or Group User or group name.
When a user logs on, all policies that match the assignments for the connection are identied. T hose policies are sorted
into priority order and multiple instances of any setting are compared. Each setting is applied according to the priority

ranking of the policy. Any policy setting that is disabled takes precedence over a lower-ranked setting that is enabled. Policy
settings that are not congured are ignored.
Important: When configuring both Active Directory and Citrix policies using the Group Policy Management Console,
assignments and settings may not be applied as expected. For more information, see CT X127461
A policy named "Unfiltered" is provided by default.
If you use Studio to manage Citrix policies, settings you add to the Unfiltered policy are applied to all servers, desktops,
and connections in a Site.
If you use the Local Group Policy Editor to manage Citrix policies, settings you add to the Unfiltered policy are applied to
all Sites and connections that are within the scope of the Group Policy Objects (GPOs) that contain the policy. For
example, the Sales OU contains a GPO called Sales-US that includes all members of the US sales team. T he Sales-US GPO
is configured with an Unfiltered policy that includes several user policy settings. When the US Sales manager logs on to
the Site, the settings in the Unfiltered policy are automatically applied to the session because the user is a member of
the Sales-US GPO.
An assignment's mode determines if the policy is applied only to connections that match all the assignment criteria. If the
mode is set to Allow (the default), the policy is applied only to connections that match the assignment criteria. If the mode
is set to Deny, the policy is applied if the connection does not match the assignment criteria. T he following examples
illustrate how assignment modes affect Citrix policies when multiple assignments are present.
Example: Assignments of like type with dif f ering modes - In policies with two assignments of the same type, one
set to Allow and one set to Deny, the assignment set to Deny takes precedence, provided the connection satisfies both
assignments. For example:
Policy 1 includes the following assignments:
Assignment A specifies the Sales group; the mode is set to Allow
Assignment B specifies the Sales manager's account; the mode is set to Deny
Because the mode for Assignment B is set to Deny, the policy is not applied when the Sales manager logs on to the Site,
even though the user is a member of the Sales group.
Example: Assignments of dif f ering type with like modes - In policies with two or more assignments of differing
types, set to Allow, the connection must satisfy at least one assignment of each type in order for the policy to be
applied. For example:
Assignment C is a User assignment that specifies the Sales group; the mode is set to Allow
Assignment D is a Client IP Address assignment that specifies 10.8.169.* (the corporate network); the mode is set to
Allow
When the Sales manager logs on to the Site from the ofce, the policy is applied because the connection satises both
assignments.

Assignment E is a User assignment that specifies the Sales group; the mode is set to Allow
Assignment F is an Access Control assignment that specifies NetScaler Gateway connection conditions; the mode is
set to Allow
When the Sales manager logs on to the Site from the ofce, the policy is not applied because the connection does not
satisfy Assignment F.
Create a new policy based on a template, using Studio

2. Select the T emplates tab and select a template.

3. Select Create Policy from T emplate in the Actions pane.
4. By default, the new policy uses all the default settings in the template (the Use template default settings radio button is
selected). If you want to change settings, select the Modify defaults and add more settings radio button, and then add
or remove settings.
5. Specify how to apply the policy by selecting one of the following:
Assign to selected user and machine objects and then select the user and machine objects to which the policy will
apply.
Assign to all objects in a site to apply the policy to all user and machine objects in the Site.
6. Enter a name for the policy (or accept the default); consider naming the policy according to who or what it affects, for
example Accounting Department or Remote Users. Optionally, add a description.
T he policy is enabled by default; you can disable it. Enabling the policy allows it to be applied immediately to users logging
on. Disabling prevents the policy from being applied. If you need to prioritize the policy or add settings later, consider
disabling the policy until you are ready to apply it.
Create a new policy using Studio

2. Select the Policies tab.
3. Select Create Policy in the Actions pane.
4. Add and configure policy settings.
5. Specify how to apply the policy by choosing one of the following:
Assign to selected user and machine objects and then select the user and machine objects to which the policy will
apply.
Assign to all objects in a site to apply the policy to all user and machine objects in the Site.
6. Enter a name for the policy (or accept the default); consider naming the policy according to who or what it affects, for
example Accounting Department or Remote Users. Optionally, add a description.
T he policy is enabled by default; you can disable it. Enabling the policy allows it to be applied immediately to users logging
on. Disabling prevents the policy from being applied. If you need to prioritize the policy or add settings later, consider
disabling the policy until you are ready to apply it.
Create and manage policies using the Group Policy Editor
From the Group Policy Editor, expand Computer Configuration or User Configuration. Expand the Policies node and then
select Citrix Policies. Choose the appropriate action below.
Task Instruction
Create a new policy On the Policies tab, click New.
Edit an existing policy On the Policies tab, select the policy and then click Edit.
Change the priority of an existing On the Policies tab, select the policy and then click either Higher or Lower.
policy
View summary information about a On the Policies tab, select the policy and then click the Summary tab.
policy
View and amend policy settings On the Policies tab, select the policy and then click the Settings tab.

Task
View and amend policy filters Instruction
On the Policies tab, select the policy and then click the Filters tab.
Enable or disable a policy On the Policies tab, select the policy and then select either Actions > Enable or
Actions > Disable.
Create a new policy from an existing On the T emplates tab, select the template and then click New Policy.
template

May 22, 20 17
You can use multiple policies to customize your environment to meet users' needs based on their job functions, geographic
locations, or connection types. For example, for security you may need to place restrictions on user groups who regularly
work with sensitive data. You can create a policy that prevents users from saving sensitive les on their local client drives.
However, if some people in the user group do need access to their local drives, you can create another policy for only those
users. You then rank or prioritize the two policies to control which one takes precedence.
When using multiple policies, you must determine how to prioritize them, how to create exceptions, and how to view the
effective policy when policies conict.
In general, policies override similar settings congured for the entire Site, for specic Delivery Controllers, or on the user
device. T he exception to this principle is security. T he highest encryption setting in your environment, including the
operating system and the most restrictive shadowing setting, always overrides other settings and policies.
Citrix policies interact with policies you set in your operating system. In a Citrix environment, Citrix settings override the
same settings congured in an Active Directory policy or using Remote Desktop Session Host Conguration. T his includes
settings that are related to typical Remote Desktop Protocol (RDP) client connection settings such as Desktop wallpaper,
Menu animation, and View window contents while dragging. For some policy settings, such as Secure ICA, the settings in
policies must match the settings in the operating system. If a higher priority encryption level is set elsewhere, the Secure
ICA policy settings that you specify in the policy or when you are delivering application and desktops can be overridden.
For example, the encryption settings that you specify when creating Delivery Groups should be at the same level as the
encryption settings you specied throughout your environment.
Note: In the second hop of double-hop scenarios, when a Desktop OS VDA connects to Server OS VDA, Citrix policies act
on the Desktop OS VDA as if it were the user device. For example, if policies are set to cache images on the user device, the
images cached for the second hop in a double-hop scenario are cached on the Desktop OS VDA machine.
Compare policies and templates
You can compare settings in a policy or template with those in other policies or templates. For example, you might need to
verify setting values to ensure compliance with best practices. You might also want to compare settings in a policy or
template with the default settings provided by Citrix.
2. Click the Comparison tab and then click Select.
3. Choose the policies or templates to compare. T o include default values in the comparison, select the Compare to default
settings check box.
4. After you click Compare, the configured settings are displayed in columns.
5. T o see all settings, select Show All Settings. T o return to the default view, select Show Common Settings.
Prioritize policies
Prioritizing policies allows you to dene the precedence of policies when they contain conicting settings. When a user logs
on, all policies that match the assignments for the connection are identied. T hose policies are sorted into priority order
and multiple instances of any setting are compared. Each setting is applied according to the priority ranking of the policy.
You prioritize policies by giving them different priority numbers in Studio. By default, new policies are given the lowest
priority. If policy settings conflict, a policy with a higher priority (a priority number of 1 is the highest) overrides a policy with a

lower priority. Settings are merged according to priority and the setting's condition; for example, whether the setting is
disabled or enabled. Any disabled setting overrides a lower-ranked setting that is enabled. Policy settings that are not
configured are ignored and do not override the settings of lower-ranked settings.
1. Select Policies in the Studio navigation pane. Make sure the Policies tab is selected.
2. Select a policy.
3. Select Lower Priority or Higher Priority in the Actions pane.
Exceptions
When you create policies for groups of users, user devices, or machines, you may find that some members of the group
require exceptions to some policy settings. You can create exceptions by:
Creating a policy only for those group members who need the exceptions and then ranking the policy higher than the
policy for the entire group
Using the Deny mode for an assignment added to the policy
An assignment with the mode set to Deny applies a policy only to connections that do not match the assignment criteria.
For example, a policy contains the following assignments:
Assignment A is a client IP address assignment that specifies the range 208.77.88.*; the mode is set to Allow
Assignment B is a user assignment that specifies a particular user account; the mode is set to Deny
T he policy is applied to all users who log on to the Site with IP addresses in the range specied in Assignment A. However,
the policy is not applied to the user logging on to the Site with the user account specied in Assignment B, even though the
user's computer is assigned an IP address in the range specied in Assignment A.
Determine which policies apply to a connection
Sometimes a connection does not respond as expected because multiple policies apply. If a higher priority policy applies to
a connection, it can override the settings you congure in the original policy. You can determine how nal policy settings are
merged for a connection by calculating the Resultant Set of Policy.
You can calculate the Resultant Set of Policy in the following ways:
Use the Citrix Group Policy Modeling Wizard to simulate a connection scenario and discern how Citrix policies might be
applied. You can specify conditions for a connection scenario such as domain controller, users, Citrix policy assignment
evidence values, and simulated environment settings such as slow network connection. T he report that the wizard
produces lists the Citrix policies that would likely take effect in the scenario. If you are logged on to the Controller as a
domain user, the wizard calculates the Resultant Set of Policy using both site policy settings and Active Directory Group
Policy Objects (GPOs).
Use Group Policy Results to produce a report describing the Citrix policies in effect for a given user and controller. T he
Group Policy Results tool helps you evaluate the current state of GPOs in your environment and generates a report that
describes how these objects, including Citrix policies, are currently being applied to a particular user and controller.
You can launch the Citrix Group Policy Modeling Wizard from the Actions pane in Studio. You can launch either tool from
the Group Policy Management Console in Windows.
If you run the Citrix Group Policy Modeling Wizard or Group Policy Results tool from the Group Policy Management
Console, site policy settings created using Studio are not included in the Resultant Set of Policy.
To ensure you obtain the most comprehensive Resultant Set of Policy, Citrix recommends launching the Citrix Group Policy
Modeling wizard from Studio, unless you create policies using only the Group Policy Management Console.
Use the Citrix Group Policy Modeling Wizard

Open the Citrix Group Policy Modeling Wizard using one of the following:
Select Policies in the Studio navigation pane, select the Modeling tab, and then select Launch Modeling Wizard in the
Actions pane.
Launch the Group Policy Management Console (gpmc.msc), right-click Citrix Group Policy Modeling in the tree pane, and
then select Citrix Group Policy Modeling Wizard.
Follow the wizard instructions to select the domain controller, users, computers, environment settings, and Citrix
assignment criteria to use in the simulation. After you click Finish, the wizard produces a report of the modeling results. In
Studio, the report appears in the middle pane under the Modeling tab.
To view the report, select View Modeling Report.
Troubleshoot policies
Users, IP addresses, and other assigned objects can have multiple policies that apply simultaneously. T his can result in
conflicts where a policy may not behave as expected. When you run the Citrix Group Policy Modeling Wizard or the Group
Policy Results tool, you might discover that no policies are applied to user connections. When this happens, users
connecting to their applications and desktops under conditions that match the policy evaluation criteria are not affected
by any policy settings. T his occurs when:
No policies have assignments that match the policy evaluation criteria.
Policies that match the assignment do not have any settings configured.
Policies that match the assignment are disabled.
If you want to apply policy settings to the connections that meet the specified criteria, make sure:
T he policies you want to apply to those connections are enabled.
T he policies you want to apply have the appropriate settings configured.

May 22, 20 17
T he following tables list policy settings, their default, and the Virtual Delivery Agent (VDA) versions to which they apply.
ICA
Name Def ault setting VDA
Client clipboard redirection Allowed All VDA versions
Desktop launches Prohibited VDA for Server OS 7

through current
EDT Off VDA 7.13
See Adaptive
Transport.
ICA listener connection timeout 120000 milliseconds VDA 5, 5.5, 5.6 FP1,
VDA for Desktop OS
7 through current
ICA listener port number 1494 All VDA versions
Launching of non-published programs during client connection Prohibited VDA for Server OS 7
through current
Client clipboard write allowed formats No formats are specied VDA 7.6 through
current
Restrict client clipboard write Prohibited VDA 7.6 through

current
Restrict session clipboard write Prohibited VDA 7.6 through

current
Session clipboard write allowed formats No formats are specied VDA 7.6 through
current
ICA/Adobe Flash Delivery/Flash Redirection

Flash video fallback prevention Not configured VDA 7.6 FP3 through current
Flash video fallback prevention error *.swf VDA 7.6 FP3 through current
ICA/Audio
Audio Plug N Play Allowed VDA for Server OS 7 through current
Audio quality High - high definition audio All VDA versions
Client audio redirection Allowed All VDA versions
Client microphone redirection Allowed All VDA versions
ICA/Auto Client Reconnect
Auto client reconnect Allowed All VDA versions
Auto client reconnect authentication Do not require authentication All VDA versions
Auto client reconnect logging Do not log auto-reconnect events All VDA versions
ICA/Bandwidth
Name Def ault VDA

setting
Audio redirection bandwidth limit 0 Kbps All VDA versions
Audio redirection bandwidth limit 0 All VDA versions

percent
Client USB device redirection 0 Kbps VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
bandwidth limit Desktop OS 7 through current
Client USB device redirection 0 VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for

bandwidth limit percent Desktop OS 7 through current
Name Def ault VDA
setting
Clipboard redirection bandwidth limit 0 Kbps All VDA versions
Clipboard redirection bandwidth limit 0 All VDA versions

percent
COM port redirection bandwidth 0 Kbps All VDA versions; for VDA 7.0 through 7.8, configure this setting using
limit the registry
COM port redirection bandwidth 0 All VDA versions; for VDA 7.0 through 7.8, configure this setting using
limit percent the registry
File redirection bandwidth limit 0 Kbps All VDA versions
File redirection bandwidth limit 0 All VDA versions

percent
HDX MediaStream Multimedia 0 Kbps VDA 5.5, 5.6 FP1, VDA for Server OS 7 and VDA for Desktop OS 7
Acceleration bandwidth limit through current VDA for Server OS and VDA for Desktop OS
HDX MediaStream Multimedia 0 VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
Acceleration bandwidth limit Desktop OS 7 through current
percent
LPT port redirection bandwidth limit 0 Kbps All VDA versions; for VDA 7.0 through 7.8, configure this setting using
the registry
LPT port redirection bandwidth limit 0 All VDA versions; for VDA 7.0 through 7.8, configure this setting using
percent the registry
Overall session bandwidth limit 0 Kbps All VDA versions
Printer redirection bandwidth limit 0 Kbps All VDA versions
Printer redirection bandwidth limit 0 All VDA versions

percent
T WAIN device redirection 0 Kbps VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
bandwidth limit Desktop OS 7 through current
T WAIN device redirection 0 VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
bandwidth limit percent Desktop OS 7 through current
ICA/Client Sensors

Name Def ault VDA
setting
Allow applications to use the physical Prohibited VDA 5.6 FP1, VDA for Server OS 7 through current, VDA for
location of the client device Desktop OS 7 through current
ICA/Desktop UI
Desktop Composition Redirection Disabled (7.6 FP3 through VDA 5.6, VDA for Desktop OS 7 through
current) current
Enabled (5.6 through 7.6 FP2)
Desktop Composition Redirection graphics Medium VDA 5.6, VDA for Desktop OS 7 through
quality current
Desktop wallpaper Allowed All VDA versions
Menu animation Allowed All VDA versions
View window contents while dragging Allowed All VDA versions
ICA/End User Monitoring
ICA round trip calculation Enabled All VDA versions
ICA round trip calculation interval 15 seconds All VDA versions
ICA round trip calculations for idle connections Disabled All VDA versions
ICA/Enhanced Desktop Experience
Enhanced Desktop Experience Allowed VDA for Server OS 7 through current
ICA/File Redirection

Name Def ault VDA
setting
Auto connect client Allowed All VDA versions

drives
Client drive redirection Allowed All VDA versions
Client fixed drives Allowed All VDA versions
Client floppy drives Allowed All VDA versions
Client network drives Allowed All VDA versions
Client optical drives Allowed All VDA versions
Client removable drives Allowed All VDA versions
Host to client Disabled VDA for Server OS 7 through current

redirection
Preserve client drive Disabled VDA 5, 5.5, 5.6 FP1, VDA for Desktop OS 7 through current
letters
Read-only client drive Disabled VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for Desktop OS 7
access through current
Special folder Allowed Web Interface deployments only; VDA for Server OS 7 through current
redirection
Use asynchronous Disabled All VDA versions

writes
ICA/Graphics
Allow visually lossless compression Disabled VDA 7.6 through current
Display memory limit 65536 Kb VDA 5, 5.5, 5.6 FP1, VDA for
Desktop OS 7 through current
Display mode degrade preference Degrade color depth rst All VDA versions

Dynamic windows preview Enabled VDA 5.5, 5.6 FP1, VDA for Server
OS 7 through current, VDA for
Image caching Enabled VDA 5.5, 5.6 FP1, VDA for Server
OS 7 through current, VDA for
Legacy graphics mode Disabled VDA for Server OS 7 through

current, VDA for Desktop OS 7
through current
Maximum allowed color depth 32 bits per pixel All VDA versions
Notify user when display mode is degraded Disabled VDA for Server OS 7 through
current
Queuing and tossing Enabled All VDA versions
Use video codec for compression Use video codec when preferred VDA 7.6 FP3 through current
Use hardware encoding for video codec Enabled VDA 7.11 through current
ICA/Graphics/Caching
Persistent cache threshold 3000000 bps VDA for Server OS 7 through current
ICA/Graphics/Framehawk
Framehawk display channel Disabled VDA 7.6 FP2 through current
Framehawk display channel port range 3224,3324 VDA 7.6 FP2 through current
ICA/Keep Alive

ICA
Namekeep alive timeout 60
Defseconds
ault setting All
VDA VDA versions
ICA keep alives Do not send ICA keep alive messages All VDA versions
ICA/Local App Access
Allow local app access Prohibited VDA for Server OS 7 through current, VDA for Desktop OS 7 through
current
URL redirection black No sites are VDA for Server OS 7 through current, VDA for Desktop OS 7 through
list specified current
URL redirection white No sites are VDA for Server OS 7 through current, VDA for Desktop OS 7 through
ICA/Mobile Experience
Name Def ault VDA

setting
Automatic keyboard Prohibited VDA 5.6 FP1, VDA for Server OS 7 through current, VDA for Desktop OS 7
display through current
Launch touch-optimized Allowed VDA 5.6 FP1, VDA for Server OS 7 through current, VDA for Desktop OS 7
desktop through current
T his setting is disabled and not available for Windows 10 and Windows
Server 2016 machines.
Remote the combo box Prohibited VDA 5.6 FP1, VDA for Server OS 7 through current, VDA for Desktop OS 7
through current
ICA/Multimedia
Name Def ault VDA

setting
HT ML5 video redirection Prohibited VDA 7.12 through current
Limit video quality Not congured VDA for Server OS 7 through

current, VDA for Desktop OS
7 through current

Multimedia conferencing Allowed All VDA versions
Optimization for Windows Media multimedia redirection over WAN Allowed VDA for Server OS 7 through
7 through current
Use GPU for optimizing Windows Media multimedia redirection over Prohibited VDA for Server OS 7 through
WAN current, VDA for Desktop OS
7 through current
Windows media fallback prevention Not congured VDA 7.6 FP3 through current
Windows Media client-side content fetching Allowed VDA for Server OS 7 through
7 through current
Windows Media Redirection Allowed All VDA versions
Windows Media Redirection buffer size 5 seconds VDA 5, 5.5, 5.6 FP1
Windows Media Redirection buffer size use Disabled VDA 5, 5.5, 5.6 FP1
ICA/Multi-Stream Connections
Audio over UDP Allowed VDA for Server OS 7 through current
Audio UDP port 16500, 16509 VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
range Desktop OS 7 through current
Multi-Port policy Primary port (2598) has VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
High Priority Desktop OS 7 through current
Multi-Stream Disabled VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
computer setting Desktop OS 7 through current
Multi-Stream user Disabled VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
setting Desktop OS 7 through current
ICA/Port Redirection

Name Def ault VDA
setting
Auto connect client COM Disabled All VDA versions; for VDA 7.0 through 7.8, configure this setting using
ports the registry
Auto connect client LPT Disabled All VDA versions; for VDA 7.0 through 7.8, configure this setting using
ports the registry
Client COM port redirection Prohibited All VDA versions; for VDA 7.0 through 7.8, configure this setting using
the registry
Client LPT port redirection Prohibited All VDA versions; for VDA 7.0 through 7.8, configure this setting using
the registry
ICA/Printing
Client printer redirection Allowed All VDA

versions
Default printer Set default printer to the client's main printer All VDA
versions
Printer assignments User's current printer is used as the default printer for the All VDA
session versions
Printer auto-creation event log Log errors and warnings All VDA
preference versions
Session printers No printers are specified All VDA

versions
Wait for printers to be created Disabled All VDA

(desktop) versions
ICA/Printing/Client Printers
Auto-create client printers Auto-create all client printers All VDA versions
Auto-create generic universal printer Disabled All VDA versions
Client printer names Standard printer names All VDA versions
Direct connections to print servers Enabled All VDA versions

Printer driver mapping and compatibility No rules are specified All VDA versions
Printer properties retention Held in profile only if not saved on client All VDA versions
Retained and restored client printers Allowed VDA 5, 5,5, 5.6 FP1
ICA/Printing/Drivers
Automatic installation of in-box printer Enabled All VDA

drivers versions
Universal driver preference EMF; XPS; PCL5c; PCL4; PS All VDA

versions
Universal print driver usage Use universal printing only if requested driver is All VDA
unavailable versions
ICA/Printing/Universal Print Server
Universal Print Server enable Disabled All VDA versions
Universal Print Server print data stream (CGP) port 7229 All VDA versions
Universal Print Server print stream input bandwidth limit (kpbs) 0 All VDA versions
Universal Print Server web service (HT T P/SOAP) port 8080 All VDA versions
Universal Print Servers for load balancing VDA versions 7.9

through current
Universal Print Server out-of-service threshold 180 (seconds) VDA versions 7.9
through current
ICA/Printing/Universal Printing

Universal printing EMF processing Spool directly to printer All VDA
mode versions
Universal printing image compression Best quality (lossless compression) All VDA
limit versions
Universal printing optimization Image Compression All VDA

defaults Desired image quality = Standard quality versions
Enable heavyweight compression = False
Image and Font Caching

Allow caching of embedded images = T rue
Allow caching of embedded fonts = T rue
Allow non-administrators to modify these settings = False
Universal printing preview preference Do not use print preview for auto-created or generic universal All VDA
printers versions
Universal printing print quality limit No limit All VDA

versions
ICA/Security
SecureICA minimum encryption level Basic VDA for Server OS 7 through current
ICA/Server Limits
Server idle timer interval 0 milliseconds VDA for Server OS 7 through current
ICA/Session Limits
Disconnected session timer Disabled VDA 5, 5.5, 5.6 FP1, VDA for Desktop OS 7 through current
Disconnected session timer interval 1440 minutes VDA 5, 5.5, 5.6 FP1, VDA for Desktop OS 7 through current
Session connection timer Disabled VDA 5, 5.5, 5.6 FP1, VDA for Desktop OS 7 through current

Session connection timer interval 1440 minutes VDA 5, 5.5, 5.6 FP1, VDA for Desktop OS 7 through current
Session idle timer Enabledf VDA 5, 5.5, 5.6 FP1, VDA for Desktop OS 7 through current
Session idle timer interval 1440 minutes VDA 5, 5.5, 5.6 FP1, VDA for Desktop OS 7 through current
ICA/Session Reliability
Session reliability connections Allowed All VDA versions
Session reliability port number 2598 All VDA versions
Session reliability timeout 180 seconds All VDA versions
ICA/Time Zone Control
Estimate local time for legacy clients Enabled VDA for Server OS 7 through current
Use local time of client Use server time zone All VDA versions
ICA/TWAIN Devices
Name Def ault VDA

setting
Client T WAIN device Allowed VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for Desktop OS
redirection 7 through current
T WAIN compression Medium VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for Desktop OS
level 7 through current
ICA/USB Devices
Client USB device optimization rules Enabled (VDA 7.6 FP3 through VDA 7.6 FP3 through current
current)
Disabled (VDA 7.11 through current)

By default, no rules are specied
Client USB device redirection Prohibited All VDA versions
Client USB device redirection rules No rules are specied All VDA versions
Client USB Plug and Play device Allowed VDA for Server OS 7 through current,
redirection VDA for Desktop OS 7 through
current
ICA/Visual Display
Preferred color depth for simple graphics 24 bits per pixel VDA 7.6 FP3 through current
Target frame rate 30 fps All VDA versions
Visual quality Medium VDA for Server OS 7 through current, VDA for Desktop
OS 7 through current
ICA/Visual Display/Moving Images
Name Def ault VDA

setting
Minimum image quality Normal VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
Moving image compression Enabled VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
Progressive compression level None VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
Progressive compression 2147483647 VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
threshold value Kbps Desktop OS 7 through current
T arget minimum frame rate 10 fps VDA 5.5, 5.6 FP1, VDA for Server OS 7 through current, VDA for
ICA/Visual Display/Still Images

Extra color compression Disabled All VDA versions
Extra color compression threshold 8192 Kbps All VDA versions
Heavyweight compression Disabled All VDA versions
Lossy compression level Medium All VDA versions
Lossy compression threshold value 2147483647 Kbps All VDA versions
ICA/WebSockets
WebSockets Prohibited VDA for Server OS 7 through current, VDA for

connections Desktop OS 7 through current
WebSockets port 8008 VDA for Server OS 7 through current, VDA for
number Desktop OS 7 through current
WebSockets trusted T he wildcard, *, is used to trust all VDA for Server OS 7 through current, VDA for
origin server list Receiver for Web URLs Desktop OS 7 through current
Load Management
Concurrent logon tolerance 2 VDA for Server OS 7 through current
CPU usage Disabled VDA for Server OS 7 through current
CPU usage excluded process priority Below Normal or Low VDA for Server OS 7 through current
Disk usage Disabled VDA for Server OS 7 through current
Maximum number of sessions 250 VDA for Server OS 7 through current
Memory usage Disabled VDA for Server OS 7 through current
Memory usage base load Zero load: 768MB VDA for Server OS 7 through current

Prole Management/Advanced settings
Disable automatic configuration Disabled All VDA versions
Log off user if a problem is encountered Disabled All VDA versions
Number of retries when accessing locked files 5 All VDA versions
Process Internet cookie files on logoff Disabled All VDA versions
Prole Management/Basic settings
Active write back Disabled All VDA versions
Enable Profile management Disabled All VDA versions
Excluded groups Disabled. Members of all user groups are processed. All VDA versions
Offline profile support Disabled All VDA versions
Path to user store Windows All VDA versions
Process logons of local administrators Disabled All VDA versions
Processed groups Disabled. Members of all user groups are processed. All VDA versions
Prole Management/Cross-Platf orm Settings
Cross-platform settings user groups Disabled. All user groups specified in Processed groups are All VDA
processed versions
Enable cross-platform settings Disabled All VDA

versions
Path to cross-platform definitions Disabled. No path is specified. All VDA

versions

Name
Path to cross-platform settings store Def ault setting
Disabled. Windows\PM_CM is used. VDA
All VDA
versions
Source for creating cross-platform Disabled All VDA

settings versions
Prole Management/File System/Exclusions
Exclusion list - directories Disabled. All folders in the user profile are synchronized. All VDA versions
Exclusion list - files Disabled. All files in the user profile are synchronized. All VDA versions
Prole Management/File System/Synchronization
Directories to synchronize Disabled. Only non-excluded folders are synchronized. All VDA versions
Files to synchronize Disabled. Only non-excluded files are synchronized. All VDA versions
Folders to mirror Disabled. No folders are mirrored. All VDA versions
Prole Management/Folder Redirection
Grant administrator access Disabled All VDA versions
Include domain name Disabled All VDA versions
Prole Management/Folder Redirection/AppData(Roaming)
AppData(Roaming) path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the All VDA
AppData(Roaming) AppData(Roaming) path policy settings versions
Prole Management/Folder Redirection/Contacts

Contacts path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Contacts path All VDA
Contacts policy settings versions
Prole Management/Folder Redirection/Desktop
Desktop path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Desktop path All VDA
Desktop policy settings versions
Prole Management/Folder Redirection/Documents
Documents path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Documents All VDA
Documents path policy settings versions
Prole Management/Folder Redirection/Downloads
Downloads path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Downloads All VDA
Downloads path policy settings versions
Prole Management/Folder Redirection/Favorites
Favorites path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Favorites path All VDA
Favorites policy settings versions

Prole Management/Folder Redirection/Links
Links path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Links path policy All VDA
Links settings versions
Prole Management/Folder Redirection/Music
Music path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Music path All VDA
Music policy settings versions
Prole Management/Folder Redirection/Pictures
Pictures path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Pictures path All VDA
Pictures policy settings versions
Prole Management/Folder Redirection/Saved Games
Saved Games path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Saved Games All VDA
Saved Games path policy settings versions
Prole Management/Folder Redirection/Searches
Searches path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Searches path All VDA
Searches policy settings versions

Prole Management/Folder Redirection/Start Menu
Start Menu path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Start Menu All VDA
Start Menu path policy settings versions
Prole Management/Folder Redirection/Video
Video path Disabled. No location is specified. All VDA

versions
Redirection settings for Contents are redirected to the UNC path specified in the Video path All VDA
Video policy settings versions
Prole Management/Log settings
Active Directory Disabled All VDA

actions versions
Common information Disabled All VDA

versions
Common warnings Disabled All VDA

versions
Enable logging Disabled All VDA

versions
File system actions Disabled All VDA

versions
File system Disabled All VDA

notifications versions
Logoff Disabled All VDA

versions
Logon Disabled All VDA

versions
Maximum size of the 1048576 All VDA

log file versions
Path to log file Disabled. Log files are saved in the default location; All VDA
%SystemRoot%\System32\Logfiles\UserProfileManager. versions
Personalized user Disabled All VDA

information versions
Policy values at logon Disabled All VDA

and logoff versions
Registry actions Disabled All VDA

versions
Registry differences at Disabled All VDA

logoff versions
Prole Management/Prole handling
Delay before deleting cached profiles 0 All VDA

versions
Delete locally cached profiles on Disabled All VDA

logoff versions
Local profile conflict handling Use local profile All VDA

versions
Migration of existing profiles Local and roaming All VDA

versions
Path to the template profile Disabled. New user profiles are created from the default user All VDA
profile on the device where a user first logs on. versions
T emplate profile overrides local profile Disabled All VDA

versions
T emplate profile overrides roaming Disabled All VDA

profile versions
T emplate profile used as a Citrix Disabled All VDA

mandatory profile for all logons versions
Prole Management/Registry
Exclusion list Disabled. All registry keys in the HKCU hive are processed when a user logs off. All VDA versions

Inclusion list Disabled. All registry keys in the HKCU hive are processed when a user logs off. All VDA versions
Prole Management/Streamed user proles
Always cache Disabled All VDA

versions
Always cache size 0 Mb All VDA

versions
Profile streaming Disabled All VDA

versions
Streamed user profile groups Disabled. All user profiles within an OU are processed All VDA
normally. versions
T imeout for pending area lock files 1 day All VDA

(days) versions
Receiver
StoreFront accounts No stores are VDA for Server OS 7 through current, VDA for Desktop OS 7 through
Virtual Delivery Agent
Controller registration IPv6 No netmask is VDA for Server OS 7 through current, VDA for Desktop OS 7
netmask specified through current
Controller registration port 80 All VDA versions
Controller SIDs No SIDs are specified All VDA versions
Controllers No controllers are All VDA versions

specified
Enable auto update of Enabled VDA for Server OS 7 through current, VDA for Desktop OS 7
controllers through current
Only use IPv6 controller Disabled VDA for Server OS 7 through current, VDA for Desktop OS 7
registration through current

Site GUID No GUID is specified All VDA versions
Virtual Delivery Agent/HDX 3D Pro
Enable lossless Enabled VDA 5.5, 5.6 FP1
HDX 3D Pro quality settings VDA 5.5, 5.6 FP1
Virtual Delivery Agent/Monitoring
Enable process monitoring Disabled VDA 7.11 through current
Enable resource monitoring Enabled VDA 7.11 through current
Virtual IP
Virtual IP loopback support Disabled VDA 7.6 through current
Virtual IP virtual loopback programs list None VDA 7.6 through current

May 22, 20 17
Policies contain settings that are applied when the policy is enforced. Descriptions in this section also indicate if additional
settings are required to enable a feature or are similar to a setting.
Quick ref erence
T he following tables list the settings you can congure within a policy. Find the task you want to complete in the left
column, then locate its corresponding setting in the right column.
Audio
For this task Use this policy setting
Control whether to allow the use of multiple audio devices Audio Plug N Play
Control whether to allow audio input from microphones on Client microphone redirection
the user device
Control audio quality on the user device Audio quality
Control audio mapping to speakers on the user device Client audio redirection
Bandwidth f or user devices
To limit bandwidth used f or Use this policy setting
Client audio mapping Audio redirection bandwidth limit or
Audio redirection bandwidth limit percent
Cut-and-paste using local clipboard Clipboard redirection bandwidth limit or
Clipboard redirection bandwidth limit percent
Access in a session to local client drives File redirection bandwidth limit or
File redirection bandwidth limit percent
HDX MediaStream Multimedia Acceleration HDX MediaStream Multimedia Acceleration bandwidth

limit or
HDX MediaStream Multimedia Acceleration bandwidth

limit percent
Client session Overall session bandwidth limit
Printing Printer redirection bandwidth limit or
Printer redirection bandwidth limit percent
T WAIN devices (such as a camera or scanner) T WAIN device redirection bandwidth limit or
T WAIN device redirection bandwidth limit percent
USB devices Client USB device redirection bandwidth limit or
Client USB device redirection bandwidth limit percent
Redirection of client drives and user devices
Control whether or not drives on the user device are Auto connect client drives
connected when users log on to the server
Control cut-and-paste data transfer between the server and Client clipboard redirection
the local clipboard
Control how drives map from the user device Client drive redirection
Control whether users' local hard drives are available in a Client xed drives and
session
Client drive redirection
Control whether users' local oppy drives are available in a Client oppy drives and
session
Control whether users' network drives are available in a Client network drives and
session
Control whether users' local CD, DVD, or Blu-ray drives are Client optical drives and
available in a session

Control whether users' local removable drives are available in Client removable drives and
a session
Control whether users' T WAIN devices, such as scanners and Client T WAIN device redirection
cameras, are available in a session and control compression of
T WAIN compression redirection
image data transfers
Control whether USB devices are available in a session Client USB device redirection and
Client USB device redirection rules
Improve the speed of writing and copying les to a client disk Use asynchronous writes
over a WAN
Content redirection
Control whether to use content redirection from the server Host to client redirection
to the user device
Desktop UI
Control whether or not Desktop wallpaper is used in users' Desktop wallpaper

sessions
View window contents while a window is dragged View window contents while dragging
Graphics and multimedia
Control the maximum number of frames per second sent to Target frame rate
user devices from virtual desktops
Control the visual quality of images displayed on the user Visual quality
device
Control whether Flash content is rendered in sessions Flash default behavior

Control whether websites can display Flash content when Flash server-side content fetching URL list
accessed in sessions Flash URL compatibility list
Flash video fallback prevention policy setting
Flash video fallback prevention error *.swf
Control compression of server-rendered video Use video codec for compression

Use hardware encoding for video codec
Control the delivery of HT ML5 multimedia web content to HT ML5 video redirection
users
Prioritize Multi-Stream network traf c
Specify ports for ICA trafc across multiple connections and establish network Multi-Port policy
priorities
Enable support for multi-stream connections between servers and user devices Multi-Stream (computer and user
settings)
Print
Control creation of client printers on the user device Auto-create client printers and
Client printer redirection
Control the location where printer properties are stored Printer properties retention
Control whether print requests are processed by the client or the server Direct connections to print servers
Control whether users can access printers connected to their user devices Client printer redirection
Control installation of native Windows drivers when automatically creating Automatic installation of in-box printer
client and network printers drivers
Control when to use the Universal Printer Driver Universal print driver usage
Choose a printer based on a roaming user's session information Default printer

Load balance and set failover threshold for Universal Print Servers Universal Print Servers for load balancing
Universal Print Servers out-of-service

threshold
Note: Policies cannot be used to enable a screen saver in a desktop or application session. For users who require screen
savers, the screen saver can be implemented on the user device.

ICA policy settings
May 22, 20 17
T he ICA section contains policy settings related to ICA listener connections and mapping to the clipboard.
Adaptive transport
T his setting allows or prevents data transport over EDT as primary and fallback to TCP.
By default, adaptive transport is disabled (Of f ) and TCP is always used.
1. In Studio, enable the policy setting, HDX adaptive transport (it is disabled by default). We also recommend that you
do not enable this feature as a universal policy for all objects in the Site.
2. T o enable the policy setting, set the value to Pref erred, then click OK.
Pref erred. Adaptive transport over EDT is used when possible, with fallback to TCP.
Diagnostic mode. EDT is forced on and fall back to TCP is disabled. We recommend this setting
only for troubleshooting.
Of f . TCP is forced on, and EDT is disabled.
For more information, see Adaptive transport.
Application launch wait timeout
T his setting species the wait timeout value in milliseconds for a session to wait for the rst application to start. If the
start of the application exceeds this time period, the session ends.
You can choose the default time (10000 milliseconds) or specify a number in milliseconds.
Client clipboard redirection
T his setting allows or prevents the clipboard on the user device being mapped to the clipboard on the server.
By default, clipboard redirection is allowed.
To prevent cut-and-paste data transfer between a session and the local clipboard, select Prohibit. Users can still cut and
paste data between applications running in sessions.
After allowing this setting, congure the maximum allowed bandwidth the clipboard can consume in a client connection
using the Clipboard redirection bandwidth limit or the Clipboard redirection bandwidth limit percent settings.
Client clipboard write allowed f ormats
When the Restrict client clipboard write setting is Enabled, host clipboard data cannot be shared with the client endpoint
but you can use this setting to allow specic data formats to be shared with the client endpoint clipboard. To use this
setting, enable it and add the specic formats to be allowed.
T he following clipboard formats are system defined:

CF_T EXT
CF_BIT MAP

CF_MET AFILEPICT
CF_SYLK
CF_DIF
CF_T IFF
CF_OEMT EXT
CF_DIB
CF_PALET T E
CF_PENDAT A
CF_RIFF
CF_WAVE
CF_UNICODET EXT
CF_ENHMET AFILE
CF_HDROP
CF_LOCALE
CF_DIBV5
CF_OWNERDISPLAY
CF_DSPT EXT
CF_DSPBIT MAP
CF_DSPMET AFILEPICT
CF_DISPENHMET AFILE
T he following custom formats are predefined in XenApp and XenDesktop:

CFX_RICHT EXT
CFX_OfficeDrawingShape
CFX_BIFF8
HT ML Format
HT ML Format is disabled by default. To enable this feature:
Make sure Client clipboard redirection is set to allowed.

Make sure Restrict client clipboard write is set to enabled.
Add an entry for HTML Format (and any other formats you want supported) in Client clipboard write allowed
f ormats.
Note: Enabling HT ML format clipboard copy support (HT ML Format) will copy any scripts (if they exist) from the source of
the copied content to the destination. Check that you trust the source before proceeding to copy. If you do copy content
containing scripts, they will only be live if you save the destination le as an HT ML le and execute it.
Additional custom formats can be added. T he custom format name must match the formats to be registered with the
system. Format names are case-sensitive.
T his setting does not apply if either Client clipboard redirection or Restrict client clipboard write is set to Prohibited.
Desktop launches
T his setting allows or prevents non-administrative users in a VDA's Direct Access Users group connecting to a session on
that VDA using an ICA connections.
By default, non-administrative users cannot connect to these sessions.

T his setting has no effect on non-administrative users in a VDA's Direct Access Users group who are using a RDP
connection; these users can connect to the VDA whether this setting is enabled or disabled. T his setting has no effect on
non-administrative users not in a VDA's Direct Access Users group; these users cannot connect to the VDA whether this
setting is enabled or disabled.
ICA listener connection timeout
Note: T his setting applies only to Virtual Delivery Agents 5.0, 5.5, and 5.6 Feature Pack 1.
T his setting species the maximum wait time for a connection using the ICA protocol to be completed.
By default, the maximum wait time is 120000 milliseconds, or two minutes.
ICA listener port number
T his setting species the TCP/IP port number used by the ICA protocol on the server.
By default, the port number is set to 1494.
Valid port numbers must be in the range of 0-65535 and must not conict with other well-known port numbers. If you
change the port number, restart the server for the new value to take effect. If you change the port number on the server,
you must also change it on every Citrix Receiver or plug-in that connects to the server.
Launching of non-published programs during client connection
T his setting species whether to allow launching initial applications through RDP on the server.
By default, launching initial applications through RDP on the server is not allowed.
Logof f checker startup delay
T his setting species the duration to delay the logoff checker startup. Use this policy to set the time (in seconds) that a
client session waits before disconnecting the session.
T his setting also increases the time it takes for a user to log off the server.
Restrict client clipboard write
If this setting is Allowed, host clipboard data cannot be shared with the client endpoint. You can allow specic formats by
enabling the Client clipboard write allowed formats setting.
By default, this is set to Prohibited.
Restrict session clipboard write
When this setting is Allowed, client clipboard data cannot be shared within the user session. You can allow specic formats
by enabling the Session clipboard write allowed formats setting.
By default, this is set to Prohibited.
Session clipboard write allowed f ormats
When the Restrict session clipboard write setting is Allowed, client clipboard data cannot be shared with session
applications, but you can use this setting to allow specic data formats to be shared with the session clipboard.

T he following clipboard formats are system defined:
CF_T EXT
CF_BIT MAP
CF_MET AFILEPICT
CF_SYLK
CF_DIF
CF_T IFF
CF_OEMT EXT
CF_DIB
CF_PALET T E
CF_PENDAT A
CF_RIFF
CF_WAVE
CF_UNICODET EXT
CF_ENHMET AFILE
CF_HDROP
CF_LOCALE
CF_DIBV5
CF_OWNERDISPLAY
CF_DSPT EXT
CF_DSPBIT MAP
CF_DSPMET AFILEPICT
CF_DISPENHMET AFILE
T he following custom formats are predefined in XenApp and XenDesktop:

CFX_RICHT EXT
CFX_OfficeDrawingShape
CFX_BIFF8
HT ML Format
HT ML Format is disabled by default. To enable this feature:
Make sure Client clipboard redirection is set to allowed.

Make sure Restrict session clipboard write is set to enabled.
Add an entry for HTML Format (and any other formats you want supported) in Session clipboard write allowed
f ormats.
Note: Enabling HT ML Format clipboard copy support (HT ML Format) will copy any scripts (if they exist) from the source of
the copied content to the destination. Check that you trust the source before proceeding to copy. If you do copy content
containing scripts, they will only be live if you save the destination le as an HT ML le and execute it.
Additional custom formats can be added. T he custom format name must match the formats to be registered with the
system. Format names are case-sensitive.
T his setting does not apply if either the Client clipboard redirection setting or Restrict session clipboard write setting is set
to Prohibited.

Auto client reconnect policy settings
May 22, 20 17
T he auto client reconnect section contains policy settings for controlling the automatic reconnection of sessions.
Auto client reconnect
T his setting allows or prevents automatic reconnection by the same client after a connection has been interrupted.
For Citrix Receiver for Windows 4.7 and later, auto client reconnect uses only the policy settings from Citrix Studio. Updates
to these policies in Studio synchronize auto client reconnect from server to client. With older versions of Citrix Receiver for
Windows, to congure auto client reconnect, use a Studio policy and modify the registry or the default.ica le.
Allowing automatic client reconnect allows users to resume working where they were interrupted when a connection was
broken. Automatic reconnection detects broken connections and then reconnects the users to their sessions.
If the Citrix Receiver cookie containing the key to the session ID and credentials isn't used, automatic reconnection might
result in a new session being started. T hat is, instead of reconnecting to an existing session. T he cookie is not used if it has
expired, for example, because of a delay in reconnection, or if credentials must be reentered. If users intentionally
disconnect, auto client reconnect is not triggered.
A session window is grayed out when a reconnection is in progress. A countdown timer displays the time remaining before
the session is reconnected. Once a session is timed out, it is disconnected.
For application sessions, when automatic reconnect is allowed, a countdown timer appears in the notication area
specifying the time remaining before the session is reconnected. Citrix Receiver tries to reconnect to the session until there
is a successful reconnection or the user cancels the reconnection attempts.
For user sessions, when automatic reconnect is allowed, Citrix Receiver tries to reconnect to the session for a specied
period, unless there is a successful reconnection or the user cancels the reconnection attempts. By default, this period is
two minutes. To change this period, edit the policy.
By default, automatic client reconnect is allowed.
To disable auto client reconnect:
1. Start Citrix Studio.

2. Open the Auto client reconnect policy.
3. Set the policy to Prohibited.

Auto client reconnect authentication
T his setting requires authentication for automatic client reconnections.
When a user initially logs on, the credentials are encrypted, stored in memory, and a cookie is created containing the
encryption key. T he cookie is sent to Citrix Receiver. When this setting is congured, cookies are not used. Instead, a dialog
box is displayed to users requesting credentials when Citrix Receiver attempts to reconnect automatically.
By default, authentication is not required.
To change auto client reconnect authentication:

2. Open the Auto client reconnect authentication policy.
3. Enable or disable authentication.
4. Click OK.
Auto client reconnect logging
T his setting enables or disables the recording of auto client reconnections in the event log.

When logging is enabled, the server system log captures information about successful and failed automatic reconnection
events. A site does not provide a combined log of reconnection events for all servers.
By default, logging is disabled.
To change auto client reconnect logging:

2. Open the Auto client reconnect logging policy.
3. Enable or disable logging.
4. Click OK.
Auto client reconnect timeout
By default, auto client reconnect timeout is set to 120 seconds, the maximum congurable value for an auto client
reconnect timeout is 300 seconds.
To change auto client reconnect timeout:

2. Open the Auto client reconnect timeout policy.
3. Edit the timeout value.
4. Click OK.
Reconnect UI transparency level
You can use Studio policy to congure the transparency level applied to the XenApp or XenDesktop session window during
session reliability reconnection time.
By default, Reconnect UI transparency is set to 80%.
To change the reconnect user interface transparency level:

2. Open the Reconnect UI transparency level policy.
3. Edit the value.
4. Click OK.

Audio policy settings
May 22, 20 17
T he Audio section contains policy settings that permit user devices to send and receive audio in sessions without reducing
performance.
Audio over UDP real-time transport
T his setting allows or prevents the transmission and receipt of audio between the VDA and user device over RT P using the
User Datagram Protocol (UDP). When this setting is disabled, audio is sent and received over TCP.
By default, audio over UDP is allowed.
Audio Plug N Play
T his setting allows or prevents the use of multiple audio devices to record and play sound.
By default, the use of multiple audio devices is allowed.
T his setting applies only to Windows Server OS machines.
Audio quality
T his setting species the quality level of sound received in user sessions.
By default, sound quality is set to High - high denition audio.
T o control sound quality, choose one of the following options:

Select Low - for low speed connections for low-bandwidth connections. Sounds sent to the user device are compressed
up to 16 Kbps. T his compression results in a significant decrease in the quality of the sound but allows reasonable
performance for a low-bandwidth connection.
Select Medium - optimized for speech to deliver Voice over IP (VoIP) applications, to deliver media applications in
challenging network connections with lines less than 512 Kbps, or significant congestion and packet loss. T his codec
offers very fast encode time, making it ideal for use with softphones and Unified Communications applications when you
require server-side media processing.
Audio sent to the user device is compressed up to 64 Kbps; this compression results in a moderate decrease in the quality
of the audio played on the user device, while providing low latency and consuming low bandwidth. If VoIP quality is
unsatisfactory, ensure that the Audio over UDP Real-time Transport policy setting is set to Allowed.
Currently, Real-time Transport (RT P) over UDP is only supported when this audio quality is selected. Use this audio quality
even for delivering media applications for the challenging network connections like very low (less than 512Kbps) lines and
when there is congestion and packet loss in the network.
Select High - high definition audio for connections where bandwidth is plentiful and sound quality is important. Clients
can play sound at its native rate. Sounds are compressed at a high quality level maintaining up to CD quality, and using up
to 112 Kbps of bandwidth. T ransmitting this amount of data can result in increased CPU utilization and network
congestion.
Bandwidth is consumed only while audio is recording or playing. If both occur at the same time, the bandwidth consumption
is doubled.

To specify the maximum amount of bandwidth, congure the Audio redirection bandwidth limit or the Audio redirection
bandwidth limit percent settings.
T his setting species whether applications hosted on the server can play sounds through a sound device installed on the
user device. T his setting also species whether users can record audio input.
By default, audio redirection is allowed.
After allowing this setting, you can limit the bandwidth consumed by playing or recording audio. Limiting the amount of
bandwidth consumed by audio can improve application performance but may also degrade audio quality. Bandwidth is
consumed only while audio is recording or playing. If both occur at the same time, the bandwidth consumption doubles. To
specify the maximum amount of bandwidth, congure the Audio redirection bandwidth limit or the Audio redirection
bandwidth limit percent settings.
On Windows Server OS machines, ensure that the Audio Plug N Play setting is Enabled to support multiple audio devices.
Important: Prohibiting Client audio redirection disables all HDX audio functionality.
T his setting enables or disables client microphone redirection. When enabled, users can use microphones to record audio
input in a session.
By default, microphone redirection is allowed.
For security, users are alerted when servers that are not trusted by their devices try to access microphones. Users can
choose to accept or not accept access. Users can disable the alert on Citrix Receiver.
On Windows Server OS machines, ensure that the Audio Plug N Play setting is Enabled to support multiple audio devices.
If the Client audio redirection setting is disabled on the user device, this rule has no effect.

Bandwidth policy settings
May 22, 20 17
T he Bandwidth section contains policy settings to avoid performance problems related to client session bandwidth use.
Important: Using these policy settings with the Multi-Stream policy settings may produce unexpected results. If you use
Multi-Stream settings in a policy, ensure these bandwidth limit policy settings are not included.
Audio redirection bandwidth limit
T his setting species the maximum allowed bandwidth, in kilobits per second, for playing or recording audio in a user session.
By default, no maximum (zero) is specied.
If you enter a value for this setting and a value for the Audio redirection bandwidth limit percent setting, the most
restrictive setting (with the lower value) is applied.
Audio redirection bandwidth limit percent
T his setting species the maximum allowed bandwidth limit for playing or recording audio as a percentage of the total
session bandwidth.
If you enter a value for this setting and a value for the Audio redirection bandwidth limit setting, the most restrictive setting
(with the lower value) is applied.
If you congure this setting, you must also congure the Overall session bandwidth limit setting, which species the total
amount of bandwidth available for client sessions.
Client USB device redirection bandwidth limit
T his setting species the maximum allowed bandwidth, in kilobits per second, for the redirection of USB devices to and from
the client.
If you enter a value for this setting and a value for the Client USB device redirection bandwidth limit percent setting, the
most restrictive setting (with the lower value) is applied.
Client USB device redirection bandwidth limit percent
T his setting species the maximum allowed bandwidth for the redirection of USB devices to and from the client as a
percentage of the total session bandwidth.
If you enter a value for this setting and a value for the Client USB device redirection bandwidth limit setting, the most
Clipboard redirection bandwidth limit

T his setting species the maximum allowed bandwidth, in kilobits per second, for data transfer between a session and the
local clipboard.
If you enter a value for this setting and a value for the Clipboard redirection bandwidth limit percent setting, the most
Clipboard redirection bandwidth limit percent
T his setting species the maximum allowed bandwidth for data transfer between a session and the local clipboard as a
percentage of the total session bandwidth.
If you enter a value for this setting and a value for the Clipboard redirection bandwidth limit setting, the most restrictive
setting (with the lower value) is applied.
COM port redirection bandwidth limit
Note: For the Virtual Delivery Agent 7.0 through 7.8, configure this setting using the registry; see Configure COM Port and
LPT Port Redirection settings using the registry.
T his setting species the maximum allowed bandwidth in kilobits per second for accessing a COM port in a client
connection. If you enter a value for this setting and a value for the COM port redirection bandwidth limit percent setting,
the most restrictive setting (with the lower value) is applied.
COM port redirection bandwidth limit percent
T his setting species the maximum allowed bandwidth for accessing COM ports in a client connection as a percentage of
the total session bandwidth.
By default, no maximum (zero) is specied
If you enter a value for this setting and a value for the COM port redirection bandwidth limit setting, the most restrictive
amount of bandwidth available for client sessions
File redirection bandwidth limit
T his setting species the maximum allowed bandwidth, in kilobits per second, for accessing a client drive in a user session.
If you enter a value for this setting and a value for the File redirection bandwidth limit percent setting, the most restrictive
setting (with the lower value) takes effect.
File redirection bandwidth limit percent

T his setting species the maximum allowed bandwidth limit for accessing client drives as a percentage of the total session
bandwidth.
If you enter a value for this setting and a value for the File redirection bandwidth limit setting, the most restrictive setting
(with the lower value) is applied.
HDX MediaStream Multimedia Acceleration bandwidth limit
T his setting species the maximum allowed bandwidth limit, in kilobits per second, for delivering streaming audio and video
using HDX MediaStream Multimedia Acceleration.
If you enter a value for this setting and a value for the HDX MediaStream Multimedia Acceleration bandwidth limit percent
setting, the most restrictive setting (with the lower value) takes effect.
HDX MediaStream Multimedia Acceleration bandwidth limit percent
T his setting species the maximum allowed bandwidth for delivering streaming audio and video using HDX MediaStream
Multimedia Acceleration as a percentage of the total session bandwidth.
If you enter a value for this setting and a value for the HDX MediaStream Multimedia Acceleration bandwidth limit setting,
the most restrictive setting (with the lower value) takes effect.
LPT port redirection bandwidth limit
T his setting species the maximum allowed bandwidth, in kilobits per second, for print jobs using an LPT port in a single user
session.
If you enter a value for this setting and a value for the LPT port redirection bandwidth limit percent setting, the most
LPT port redirection bandwidth limit percent
T his setting species the bandwidth limit for print jobs using an LPT port in a single client session as a percentage of the
total session bandwidth.

If you enter a value for this setting and a value for the LPT port redirection bandwidth limit setting, the most restrictive
Overall session bandwidth limit
T his setting species the total amount of bandwidth available, in kilobits per second, for user sessions.
T he maximum enforceable bandwidth cap is 10 Mbps (10,000 Kbps). By default, no maximum (zero) is specied.
Limiting the amount of bandwidth consumed by a client connection can improve performance when other applications
outside the client connection are competing for limited bandwidth.
Printer redirection bandwidth limit
T his setting species the maximum allowed bandwidth, in kilobits per second, for accessing client printers in a user session.
If you enter a value for this setting and a value for the Printer redirection bandwidth limit percent setting, the most
Printer redirection bandwidth limit percent
T his setting species the maximum allowed bandwidth for accessing client printers as a percentage of the total session
bandwidth.
If you enter a value for this setting and a value for the Printer redirection bandwidth limit setting, the most restrictive
TWAIN device redirection bandwidth limit
T his setting species the maximum allowed bandwidth, in kilobits per second, for controlling T WAIN imaging devices from
published applications.
If you enter a value for this setting and a value for the T WAIN device redirection bandwidth limit percent setting, the most
TWAIN device redirection bandwidth limit percent
T his setting species the maximum allowed bandwidth for controlling T WAIN imaging devices from published applications as
a percentage of the total session bandwidth.
If you enter a value for this setting and a value for the T WAIN device redirection bandwidth limit setting, the most


Bidirectional content redirection policy settings
May 22, 20 17
T he bidirectional content redirection section contains policy settings to enable or disable client to host and host to client
URL redirection. Server policies are set in Studio, and client policies are set from the Citrix Receiver Group Policy Object
administration template.
T hough Citrix also offers host to client redirection and Local App Access for client to URL redirection, we recommend that
you use bidirectional content redirection for domain-joined Windows clients.
Bidirectional content redirection requires XenApp or XenDesktop 7.13 and later plus Citrix Receiver for Windows 4.7 and
later.
Important
Ensure that redirection rules don't result in a looping configuration. For example, client rules at the VDA are set to
https://www.citrix.com, and VDA rules at the client are set to the same URL possibly resulting in infinite looping.
We support only domain joined endpoints.
URL redirection supports only explicit URLs (URLs displayed in the browser address bar or found using the in-browser navigation,
depending on the browser). We don't support link shorteners.
Bidirectional content redirection supports only Internet Explorer 8 through 11. Internet Explorer must be used on both the user
device and the VDA.
T he Internet Explorer browser add-on is required for Bidirectional Content Redirection. Fore more information, see Register
browser add-ons.
No fallback mechanism is present if redirection fails due to session start issues.
If two applications with same display name are configured with multiple StoreFront accounts, one display name in the primary
StoreFront account is used to start.
Supports only Citrix Receiver for Windows.
A new browser window appears only when the URL is redirected to the client. When the URL is redirected to the VDA and the
browser is already open, the redirected URL opens in a new tab.
Supports embedded links in files including documents, emails, and PDFs.
T his feature works on both desktop sessions and application sessions, unlike Local App Access URL redirection, which works
only on desktop sessions.
If Local App Access is enabled for URL redirection (either at the VDA or client), bidirectional content redirection does not take
effect.
Host to client and host to host redirection
Use Studio to congure the host to client (client) and host to host (VDA) redirection policies.
By default, bidirectional content redirection is Prohibited.
To enable bidirectional content redirection
When you include URLs, you can specify one URL or a semi-colon delimited list of URLs. You can use an asterisk (*) as a
wildcard in the domain name. For example:
http://*.citrix.com; http://www.google.com

2. Open the Bidirectional Content Redirection policy.
3. Select Allow Bidirectional Content Redirection, choose Allowed, and click OK. If you do not allow this option, you are
unable to complete this procedure.
4. Select Allowed URLs to be redirected to Client and specify a URL, a list of URLs, or choose the default value.
5. Select Allowed URLs to be redirected to VDA and specify a URL, a list of URLs, or choose the default value.
Client to host (VDA) and client to client redirection
Use Citrix Receiver Group Policy Object administrative template to congure client to host (VDA) and client to client (client)
redirection.
To enable bidirectional content redirection
When you include URLs, you can specify one URL or a semi-colon delimited list of URLs. You can use an asterisk (*) as a
wildcard.
For more information, see Conguring bidirectional content redirection in the Citrix Receiver documentation.

Register browser add-ons
T he Internet Explorer browser add-on is required for Bidirectional Content Redirection.
You can use the following commands to register and unregister Internet Explorer add-on:
T o register Internet Explorer add-on on a client device: <client-installation-folder>\redirector.exe /regIE

T o unregister Internet Explorer add-on on a client device: <client-installation-folder>\redirector.exe /unregIE
T o register Internet Explorer add-on on a VDA: <VDAinstallation-folder>\VDARedirector.exe /regIE
T o unregister Internet Explorer add-on on a VDA: <VDAinstallation-folder>\VDARedirector.exe /unregIE
For example, the following command registers Internet Explorer add-on on a device running Citrix Receiver.
C:\Program Files\Citrix\ICA Client\redirector.exe/regIE
T he following command registers Internet Explorer add-on on a Windows Server OS VDA.
C:\Program Files (x86)\Citrix\System32\VDARedirector.exe /regIE

Client sensors policy settings
May 22, 20 17
T he Client Sensors section contains policy settings for controlling how mobile device sensor information is handled in a user
session.
Allow applications to use the physical location of the client device
T his setting determines whether applications running in a session on a mobile device are allowed to use the physical
location of the user device.
By default, the use of location information is prohibited
When this setting is prohibited, attempts by an application to retrieve location information return a "permission denied"
value.
When this setting is allowed, a user can prohibit use of location information by denying a Citrix Receiver request to access
the location. Android and iOS devices prompt at the rst request for location information in each session.
When developing hosted applications that use the Allow applications to use the physical location of the client device
setting, consider the following:
A location-enabled application should not rely on location information being available because:
A user might not allow access to location information.
T he location might not be available or might change while the application is running.
A user might connect to the application session from a different device that does not support location information.
A location-enabled application must:
Have the location feature off by default.
Provide a user option to allow or disallow the feature while the application is running.
Provide a user option to clear location data that is cached by the application. (Citrix Receiver does not cache location
data.)
A location-enabled application must manage the granularity of the location information so that the data acquired is
appropriate to the purpose of the application and conforms to regulations in all relevant jurisdictions.
A secure connection (for example, using T LS or a VPN) should be enforced when using location services. Citrix Receiver
should connect to trusted servers.
Consider obtaining legal advice regarding the use of location services.

Desktop UI policy settings
May 22, 20 17
T he Desktop UI section contains policy settings that control visual effects such as desktop wallpaper, menu animations,
and drag-and-drop images, to manage the bandwidth used in client connections. You can improve application performance
on a WAN by limiting bandwidth usage.
Desktop Composition Redirection
T his setting species whether to use the processing capabilities of the graphics processing unit (GPU) or integrated graphics
processor (IGP) on the user device for local DirectX graphics rendering to provide users with a more uid Windows desktop
experience. When enabled, Desktop Composition Redirection delivers a highly responsive Windows experience while
maintaining high scalability on the server.
By default, Desktop Composition Redirection is disabled.
To turn off Desktop Composition Redirection and reduce the bandwidth required in user sessions, select Disabled when
adding this setting to a policy.
Desktop Composition Redirection graphics quality
T his setting species the quality of graphics used for Desktop Composition Redirection.
By default, this is set to high.
Choose from High, Medium, Low, or Lossless quality.
Desktop wallpaper
T his setting allows or prevents wallpaper showing in user sessions.
By default, user sessions can show wallpaper.
To turn off desktop wallpaper and reduce the bandwidth required in user sessions, select Prohibited when adding this
setting to a policy.
Menu animation
T his setting allows or prevents menu animation in user sessions.
By default, menu animation is allowed.
Menu animation is a Microsoft personal preference setting for ease of access. When enabled, it causes a menu to appear
after a short delay, either by scrolling or fading in. An arrow icon appears at the bottom of the menu. T he menu appears
when you point to that arrow.
Menu animation is enabled on a desktop if this policy setting is set to Allowed and the menu animation Microsoft personal
preference setting is enabled.
Note: Changes to the menu animation Microsoft personal preference setting are changes to the desktop. T his means that
if the desktop is set to discard changes when the session ends, a user who has enabled menu animations in a session may
not have menu animation available in subsequent sessions on the desktop. For users who require menu animation, enable

the Microsoft setting in the master image for the desktop or ensure that the desktop retains user changes.
View window contents while dragging
T his setting allows or prevents the display of window contents when dragging a window across the screen.
By default, viewing window contents is allowed.
When set to Allowed, the entire window appears to move when you drag it. When set to Prohibited, only the window
outline appears to move until you drop it.

End user monitoring policy settings
May 22, 20 17
T he End User Monitoring section contains policy settings for measuring session trafc.
ICA round trip calculation
T his setting determines whether ICA round trip calculations are performed for active connections.
By default, calculations for active connections are enabled.
By default, each ICA round trip measurement initiation is delayed until some trafc occurs that indicates user interaction.
T his delay can be indenite in length and is designed to prevent the ICA round trip measurement being the sole reason for
ICA trafc.
ICA round trip calculation interval
T his setting species the frequency, in seconds, at which ICA round trip calculations are performed.
By default, ICA round trip is calculated every 15 seconds.
ICA round trip calculations f or idle connections
T his setting determines whether ICA round trip calculations are performed for idle connections.
By default, calculations are not performed for idle connections.
By default, each ICA round trip measurement initiation is delayed until some trafc occurs that indicates user interaction.
T his delay can be indenite in length and is designed to prevent the ICA round trip measurement being the sole reason for
ICA trafc.

Enhanced desktop experience policy setting
May 22, 20 17
T he Enhanced Desktop Experience policy setting sessions running on server operating systems to look like local Windows 7
desktops, providing users with an enhanced desktop experience.
By default, this setting is allowed.
If a user prole with Windows Classic theme already exists on the virtual desktop, enabling this policy does not provide an
enhanced desktop experience for that user. If a user with a Windows 7 theme user prole logs on to a virtual desktop
running Windows Server 2012 for which this policy is either not congured or disabled, that user sees an error message
indicating failure to apply the theme.
In both cases, resetting the user prole resolves the issue.
If the policy changes from enabled to disabled on a virtual desktop with active user sessions, the look and feel of those
sessions is inconsistent with both the Windows 7 and Windows Classic desktop experience. To avoid this, ensure you restart
the virtual desktop after changing this policy setting. You must also delete any roaming proles on the virtual desktop. Citrix
also recommends deleting any other user proles on the virtual desktop to avoid inconsistencies between proles.
If you are using roaming user proles in your environment, ensure the Enhanced Desktop Experience feature is enabled or
disabled for all virtual desktops that share a prole.
Citrix does not recommend sharing roaming proles between virtual desktops running server operating systems and client
operating systems. Proles for client and server operating systems differ and sharing roaming proles across both types can
lead to inconsistencies in prole properties when a user moves between the two.

File Redirection policy settings
May 22, 20 17
T he File Redirection section contains policy settings relating to client drive mapping and client drive optimization.
Auto connect client drives
T his setting allows or prevents automatic connection of client drives when users log on.
By default, automatic connection is allowed.
When adding this setting to a policy, make sure to enable the settings for the drive types you want automatically
connected. For example, to allow automatic connection of users' CD-ROM drives, congure this setting and the Client
optical drives setting.
T he following policy settings are related:

Client floppy drives
Client optical drives
Client fixed drives
Client network drives
Client removable drives
T his setting enables or disables le redirection to and from drives on the user device.
By default, le redirection is enabled.
When enabled, users can save les to all their client drives. When disabled, all le redirection is prevented, regardless of the
state of the individual le redirection settings such as Client oppy drives and Client network drives.

Client floppy drives
Client fixed drives
Client xed drives
T his setting allows or prevents users from accessing or saving les to xed drives on the user device.
By default, accessing client xed drives is allowed.
When adding this setting to a policy, make sure the Client drive redirection setting is present and set to Allowed. If these
settings are disabled, client xed drives are not mapped and users cannot access these drives manually, regardless of the
state of the Client xed drives setting.
To ensure xed drives are automatically connected when users log on, congure the Auto connect client drives setting.

Client oppy drives
T his setting allows or prevents users from accessing or saving les to oppy drives on the user device.
By default, accessing client oppy drives is allowed.
settings are disabled, client oppy drives are not mapped and users cannot access these drives manually, regardless of the
state of the Client oppy drives setting.
To ensure oppy drives are automatically connected when users log on, congure the Auto connect client drives setting.
T his setting allows or prevents users from accessing and saving les to network (remote) drives through the user device.
By default, accessing client network drives is allowed.
settings are disabled, client network drives are not mapped and users cannot access these drives manually, regardless of the
state of the Client network drives setting.
To ensure network drives are automatically connected when users log on, congure the Auto connect client drives setting.
T his setting allows or prevents users from accessing or saving les to CD-ROM, DVD-ROM, and BD-ROM drives on the user
device.
By default, accessing client optical drives is allowed.
settings are disabled, client optical drives are not mapped and users cannot access these drives manually, regardless of the
state of the Client optical drives setting.
To ensure optical drives are automatically connected when users log on, congure the Auto connect client drives setting.
T his setting allows or prevents users from accessing or saving les to USB drives on the user device.
By default, accessing client removable drives is allowed.
settings are disabled, client removable drives are not mapped and users cannot access these drives manually, regardless of
the state of the Client removable drives setting.
To ensure removable drives are automatically connected when users log on, congure the Auto connect client drives
setting.
T his setting enables or disables le type associations for URLs and some media content to be opened on the user device.
When disabled, content opens on the server.

By default, le type association is disabled.
T hese URL types are opened locally when you enable this setting:
Hypertext T ransfer Protocol (HT T P)
Secure Hypertext T ransfer Protocol (HT T PS)
Real Player and QuickT ime (RT SP)
Real Player and QuickT ime (RT SPU)
Legacy Real Player (PNM)
Microsoft Media Server (MMS)
Preserve client drive letters
T his setting enables or disables mapping of client drives to the same drive letter in the session.
By default, client drive letters are not preserved.
When adding this setting to a policy, make sure the Client drive redirection setting is present and set to Allowed.
Read-only client drive access
T his setting allows or prevents users and applications from creating or modifying les or folders on mapped client drives.
By default, les and folders on mapped client drives can be modied.
If set to Enabled, les and folders are accessible with read-only permissions.
When adding this setting to a policy, make sure the Client drive redirection setting is present and set to Allowed.
Special f older redirection
T his setting allows or prevents Citrix Receiver and Web Interface users to see their local Documents and Desktop special
folders from a session.
By default, special folder redirection is allowed.
T his setting prevents any objects ltered through a policy from having special folder redirection, regardless of settings that
exist elsewhere. When this setting is prohibited, any related settings specied for StoreFront, Web Interface, or Citrix
Receiver are ignored.
To dene which users can have special folder redirection, select Allowed and include this setting in a policy ltered on the
users you want to have this feature. T his setting overrides all other special folder redirection settings.
Because special folder redirection must interact with the user device, policy settings that prevent users from accessing or
saving les to their local hard drives also prevent special folder redirection from working.
When adding this setting to a policy, make sure the Client xed drives setting is present and set to Allowed.
Use asynchronous writes
T his setting enables or disables asynchronous disk writes.
By default, asynchronous writes are disabled.
Asynchronous disk writes can improve the speed of le transfers and writing to client disks over WANs, which are typically

characterized by relatively high bandwidth and high latency. However, if there is a connection or disk fault, the client le or
les being written may end in an undened state. If this happens, a pop-up window informs the user of the les affected.
T he user can then take remedial action such as restarting an interrupted le transfer on reconnection or when the disk
fault is corrected.
Citrix recommends enabling asynchronous disk writes only for users who need remote connectivity with good le access
speed and who can easily recover les or data lost in the event of connection or disk failure.
When adding this setting to a policy, make sure that the Client drive redirection setting is present and set to Allowed. If this
setting is disabled, asynchronous writes will not occur.

Flash Redirection policy settings
May 22, 20 17
T he Flash Redirection section contains policy settings for handling Flash content in user sessions.
Flash acceleration
T his setting enables or disables Flash content rendering on user devices instead of the server. By default, client-side Flash
content rendering is enabled.
Note: T his setting is used for legacy Flash redirection with the Citrix online plug-in 12.1.
When enabled, this setting reduces network and server load by rendering Flash content on the user device. Additionally, the
Flash URL compatibility list setting forces Flash content from specic websites to be rendered on the server.
On the user device, the Enable HDX MediaStream for Flash on the user device setting must be enabled as well.
When this setting is disabled, Flash content from all websites, regardless of URL, is rendered on the server. To allow only
certain websites to render Flash content on the user device, congure the Flash URL compatibility list setting.
Flash background color list
T his setting enables you to set key colors for given URLs.
By default, no key colors are specied.
Key colors appear behind client-rendered Flash and help provide visible region detection. T he key color specied should be
rare; otherwise, visible region detection might not work properly.
Valid entries consist of a URL (with optional wildcards at the beginning or end) followed by a 24-bit RGB color hexadecimal
code. For example: http://citrix.com 000003.
Ensure that the URL specied is the URL for the Flash content, which might be different from the URL of the website.
Warning
Using Registry Editor incorrectly can cause serious problems that can require you to reinstall the operating system. Citrix cannot
guarantee that problems resulting from incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Make
sure you back up the registry before you edit it.
On VDA machines running Windows 8 or Windows 2012, this setting might fail to set key colors for the URL. If this occurs,
edit the registry on the VDA machine.
For 32-bit machines, use this registry setting:
[HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\HdxMediaStreamForFlash\Server\PseudoServer]
"ForceHDXFlashEnabled"=dword:00000001
For 64-bit machines, use this registry setting:
[HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Citrix\HdxMediaStreamForFlash\Server\PseudoServer]

"ForceHDXFlashEnabled"=dword:00000001
Flash backwards compatibility
T his setting enables or disables the use of original, legacy Flash redirection features with older versions of Citrix Receiver
(formerly the Citrix online plug-in).
By default, this setting is enabled.
On the user device, the Enable HDX MediaStream for Flash on the user device setting must also be enabled.
Second generation Flash redirection features are enabled for use with Citrix Receiver 3.0. Legacy redirection features are
supported for use with the Citrix online plug-in 12.1. To ensure second generation Flash redirection features are used, both
the server and the user device must have second generation Flash redirection enabled. If legacy redirection is enabled on
either the server or the user device, legacy redirection features are used.
Flash def ault behavior
T his setting establishes the default behavior for second generation Flash acceleration.
By default, Flash acceleration is enabled.
T o configure this setting, choose one of the following options:

Enable Flash acceleration. Flash Redirection is used.
Block Flash Player. Flash Redirection and server-side rendering are not used. T he user cannot view any Flash content.
Disable Flash acceleration. Flash Redirection is not used. T he user can view server-side rendered Flash content if a version
of Adobe Flash Player for Windows Internet Explorer compatible with the content is installed on the server.
T his setting can be overridden for individual Web pages and Flash instances based on the conguration of the Flash URL
compatibility list setting. Additionally, the user device must have the Enable HDX MediaStream for Flash on the user device
setting enabled.
Flash event logging
T his setting enables Flash events to be recorded in the Windows application event log.
By default, logging is allowed.
On computers running Windows 7 or Windows Vista, a Flash redirection-specic log appears in the Applications and Services
Log node.
Flash intelligent f allback
T his setting enables or disables automatic attempts to employ server-side rendering for Flash Player instances where client-
side rendering is either unnecessary or provides a poor user experience.
Flash latency threshold
T his setting species a threshold between 0-30 milliseconds to determine where Adobe Flash content is rendered.
By default, the threshold is 30 milliseconds.

During startup, HDX MediaStream for Flash measures the current latency between the server and user device. If the
latency is under the threshold, HDX MediaStream for Flash is used to render Flash content on the user device. If the
latency is above the threshold, the network server renders the content if an Adobe Flash player is available there.
When enabling this setting, make sure the Flash backwards compatibility setting is also present and set to Enabled.
Note: Applies only when using HDX MediaStream Flash redirection in Legacy mode.
Flash video f allback prevention
T his setting species if and how "small" ash content is rendered and displayed to users.
By default, this setting is not congured.
To congure this setting, choose one of the following options:
Only small content. Only intelligent fallback content will be rendered on the server; other Flash content will be replaced
with an error *.swf.
Only small content with a supported client. Only intelligent fallback content will be rendered on the server if the
client is currently using Flash Redirection; other content will be replaced with an error *.swf.
No server side content. All content on the server will be replaced with an error *swf.
To use this policy setting you should specify an error *.swf le. T his error *.swf will replace any content that you do not
want to be rendered on the VDA.
Flash video f allback prevention error *.swf
T his setting species the URL of the error message which is displayed to users to replace Flash instances when the server
load management policies are in use. For example:
http://domainName.tld/sample/path/error.swf
Flash server-side content f etching URL list
T his setting species websites whose Flash content can be downloaded to the server and then transferred to the user
device for rendering.
By default, no sites are specied.
T his setting is used when the user device does not have direct access to the Internet; the server provides that connection.
Additionally, the user device must have the Enable server-side content fetching setting enabled.
Second generation Flash redirection includes a fallback to server-side content fetching for Flash .swf les. If the user device
is unable to fetch Flash content from a Web site, and the Web site is specied in the Flash server-side content fetching URL
list, server-side content fetching occurs automatically.
When adding URLs to the list:

Add the URL of the Flash application instead of the top-level HT ML page that initiates the Flash Player.
Use an asterisk (*) at the beginning or end of the URL as a wildcard.
Use a trailing wildcard to allow all child URLs (http://www.citrix.com/*).
T he prefixes http:// and https:// are used when present, but are not required for valid list entries.
Flash URL compatibility list

T his setting species the rules which determine whether Flash content on certain websites is rendered on the user device,
rendered on the server, or blocked from rendering.
By default, no rules are specied.
When adding URLs to the list:

Prioritize the list with the most important URLs, actions, and rendering locations at the top.
Use an asterisk (*) at the beginning or end of the URL as a wildcard.
Use a trailing wildcard to refer to all child URLs (http://www.citrix.com/*).
T he prefixes http:// and https:// are used when present, but are not required for valid list entries.
Add to this list websites whose Flash content does not render correctly on the user device and select either the Render
on Server or Block options.

Graphics policy settings
May 22, 20 17
T he Graphics section contains policy settings for controlling how images are handled in user sessions.
Allow visually lossless compression
T his setting allows visually lossless compression to be used instead of true lossless compression for graphics. Visually lossless
improves performance over true lossless, but has minor loss that is unnoticeable by sight. T his setting changes the way the
values of the Visual quality setting are used.
By default this setting is disabled.
Display memory limit
T his setting species the maximum video buffer size in kilobytes for the session.
By default, the display memory limit is 65536 kilobytes.
Species the maximum video buffer size in kilobytes for the session. Specify an amount in kilobytes from 128 to 4,194,303.
T he maximum value of 4,194,303 does not limit the display memory. By default, the display memory is 65536 kilobytes. Using
more color depth and higher resolution for connections requires more memory. In legacy graphics mode, if the memory limit
is reached, the display degrades according to the "Display mode degrade preference" setting.
For connections requiring more color depth and higher resolution, increase the limit. Calculate the maximum memory
required using the equation:
Memory depth in bytes = (color-depth-in-bits-per-pixel) / 8) * (vertical-resolution-in-pixels) * (horizontal-resolution-in-pixels).
For example, with a color depth of 32, vertical resolution of 600, and a horizontal resolution of 800, the maximum memory
required is (32 / 8) * (600) * (800) = 1920000 bytes, which yields a display memory limit of 1920 KB.
Color depths other than 32-bit are available only if the Legacy graphics mode policy setting is enabled.
HDX allocates only the amount of display memory needed for each session. So, if only some users require more than the
default, there is no negative impact on scalability by increasing the display memory limit.
Display mode degrade pref erence
Note: For the Virtual Delivery Agent 7.x, this policy setting applies only when the Legacy graphics mode policy setting is
enabled.
T his setting species whether color depth or resolution degrades rst when the session display memory limit is reached.
By default, color depth is degraded rst.
When the session memory limit is reached, you can reduce the quality of displayed images by choosing whether color depth
or resolution is degraded rst. When color depth is degraded rst, displayed images use fewer colors. When resolution is
degraded rst, displayed images use fewer pixels per inch.
To notify users when either color depth or resolution are degraded, congure the Notify user when display mode is
degraded setting.

Dynamic windows preview
T his setting enables or disables the display of seamless windows in Flip, Flip 3D, T askbar Preview, and Peek window preview
modes.
Windows Aero preview Description

option
T askbar Preview When the user hovers over a window's taskbar icon, an image of that window appears
above the taskbar.
Windows Peek When the user hovers over a taskbar preview image, a full-sized image of the window
appears on the screen.
Flip When the user presses ALT +T AB, small preview icons are shown for each open window.
Flip 3D When the user presses T AB+Windows logo key, large images of the open windows
cascade across the screen.
Image caching
enabled.
T his setting enables or disables the caching and retrieving of sections of images in sessions. Caching images in sections and
retrieving these sections when needed makes scrolling smoother, reduces the amount of data transmitted over the
network, and reduces the processing required on the user device.
By default, the image caching setting is enabled.
Note: T he image caching setting controls how images are cached and retrieved; it does not control whether images are
cached. Images are cached if the Legacy graphics mode setting is enabled.
Legacy graphics mode
T his setting disables the rich graphics experience. Use this setting to revert to the legacy graphics experience, reducing
bandwidth consumption over a WAN or mobile connection. Bandwidth reductions introduced in XenApp and XenDesktop
7.13 make this mode obsolete.
By default, this setting is disabled and users are provided with the rich graphics experience.
Legacy graphics mode is supported with Windows 7 and Windows Server 2008 R2 VDAs. While it is also supported on
Windows 2012 and 2012 R2, it is not recommended.
Legacy graphics mode is not supported on Windows 10, 8.1 or 8.
See CT X202687 for more on optimizing graphics modes and policies in XenApp and XenDesktop 7.6 FP3 or higher.
Maximum allowed color depth
enabled.

T his setting species the maximum color depth allowed for a session.
By default, the maximum allowed color depth is 32 bits per pixel.
T his setting applies only to T hinWire drivers and connections. It does not apply to VDAs that have a non-T hinWire driver as
the primary display driver, such as VDAs that use a Windows Display Driver Model (WDDM) driver as the primary display driver.
For Desktop OS VDAs using a WDDM driver as the primary display driver, such as Windows 8, this setting has no effect. For
Windows Server OS VDAs using a WDDM driver, such as Windows Server 2012 R2, this setting might prevent users from
connecting to the VDA.
Setting a high color depth requires more memory. To degrade color depth when the memory limit is reached, congure the
Display mode degrade preference setting. When color depth is degraded, displayed images use fewer colors.
Notif y user when display mode is degraded
enabled.
T his setting displays a brief explanation to the user when the color depth or resolution is degraded.
By default, notifying users is disabled.
Queuing and tossing
enabled.
T his setting discards queued images that are replaced by another image.
By default, queuing and tossing is enabled.
T his improves response when graphics are sent to the user device. Conguring this setting can cause animations to become
choppy because of dropped frames.
Use video codec f or compression
Allows use of a video codec (H.264) to compress graphics when video decoding is available on the endpoint. When For the
entire screen is chosen the video codec will be applied as the default codec for all. When For actively changing regions is
selected the video codec will be used for areas where there is constant change on the screen, other data will use still image
compression and bitmap caching. When video decoding is not available on the endpoint, or when you specify Do not use, a
combination of still image compression and bitmap caching is used. When Use video codec when pref erred is selected,
the system chooses, based on various factors. T he results may vary between versions as the selection method is enhanced.
Select Use video codec when pref erred to allow the system to make its best effort to choose appropriate settings for
the current scenario.
Select For the entire screen to optimize for improved user experience and bandwidth, especially in cases with heavy use of
server-rendered video and 3D graphics.
Select For actively changing regions to optimize for improved video performance, especially in low bandwidth, while
maintaining scalability for static and slowly changing content. T his setting is supported in multi-monitor deployments.
Select Do not use video codec to optimize for server CPU load and for cases that do not have a lot of server-rendered
video or other graphically intense applications.

T he default is Use video codec when pref erred.
Use hardware encoding f or video
T his setting allows the use of graphics hardware, if available, to compress screen elements with video (H.264) codec. If such
hardware is not available, the VDA will fall back to CPU-based encoding using the software video codec.
T he default option for this policy setting is Enabled.
Multiple monitors are supported.
Any Citrix Receiver that supports H.264 decoding can be used with NVENC hardware encoding.
Lossy (4:2:0) and visually lossless (4:4:4) compression are supported. Visually lossless (graphics policy setting, Allow visually
lossless compression) requires Receiver for Windows 4.5 or higher.
NVIDIA
For NVIDIA GRID GPUs, hardware encoding is supported with VDAs for Desktop OS in HDX 3D Pro mode.
NVIDIA GPUs must support NVENC hardware encoding. See NVIDIA video codec SDK for a list of supported GPUs.
NVIDIA GRID requires driver version 3.1 or higher. NVIDIA Quadro requires driver version 362.56 or higher. Citrix recommends
drivers from the NVIDIA Release R361 branch.
Lossless text, a feature of the VDA when congured in standard mode (not HDX 3D Pro), is not compatible with NVENC
hardware encoding. If it has been enabled in HDX 3D Pro mode, lossless text takes priority over NVENC hardware encoding.
Selective use of the H.264 hardware codec for actively changing regions is not supported.
Intel
For Intel Iris Pro graphics processors, hardware encoding is supported with VDAs for Desktop OS (in standard or HDX 3D
Pro mode) and VDAs for Server OS.
Intel Iris Pro graphics processors in the Intel Broadwell processor family and later are supported. Intel Iris Pro hardware
encoder SDK is required and can be downloaded from Intel website: Remote Displays SDK.
Lossless text is supported.
Selective use of the H.264 hardware codec for actively changing regions is supported.
Supported with Windows 10 and Windows Server 2012 and higher.
On VDAs in 3D Pro mode, the Intel encoder provides a good user experience for up to eight encoding sessions (for example
one user using eight monitors or eight users using a monitor each). If more than eight encoding sessions are required, check
how many monitors the virtual machine connects with. To maintain a good user experience, the administrator can decide to
congure this policy setting on a per user or per machine basis.

Caching policy settings
May 22, 20 17
T he Caching section contains policy settings that enable caching image data on user devices when client connections are
limited in bandwidth.
Persistent cache threshold
enabled.
T his setting caches bitmaps on the hard drive of the user device. T his enables re-use of large, frequently-used images from
previous sessions.
By default, the threshold is 3000000 bits per second.
T he threshold value represents the point below which the Persistent Cache feature will take effect. For example, using the
default value, bitmaps are cached on the hard drive of the user device when bandwidth falls below 3000000 bps.

Framehawk policy settings
May 22, 20 17
T he Framehawk section contains policy settings that enable and congure the Framehawk display channel on the server.
Framehawk display channel

When enabled, the server attempts to use the Framehawk display channel for the user's graphics and input remoting. T hat
display channel will use UDP to provide a better user experience on networks with high loss and latency characteristics;
however, it may also use more server resources and bandwidth than other graphics modes.
By default, the Framehawk display channel is disabled.
Framehawk display channel port range

T his policy setting species the range of UDP port numbers (in the form lowest port number,highest port number) the VDA
uses to exchange Framehawk display channel data with the user device. T he VDA attempts to use each port, starting with
the lowest port number and incrementing for each subsequent attempt. T he port handles inbound and outbound trafc.
By default, the port range is 3224,3324.

Keep alive policy settings
May 22, 20 17
T he Keep Alive section contains policy settings for managing ICA keep-alive messages.
ICA keep alive timeout
T his setting species the number of seconds between successive ICA keep-alive messages.
By default, the interval between keep-alive messages is 60 seconds.
Specify an interval between 1-3600 seconds in which to send ICA keep-alive messages. Do not congure this setting if your
network monitoring software is responsible for closing inactive connections.
ICA keep alives
T his setting enables or disables sending ICA keep-alive messages periodically.
By default, keep-alive messages are not sent.
Enabling this setting prevents broken connections from being disconnected. If the server detects no activity, this setting
prevents Remote Desktop Services (RDS) from disconnecting the session. T he server sends keep-alive messages every few
seconds to detect if the session is active. If the session is no longer active, the server marks the session as disconnected.
ICA keep-alive does not work if you are using session reliability. Congure ICA keep-alive only for connections that are not
using Session Reliability.
Related policy settings: Session reliability connections.

Local App Access policy settings
May 22, 20 17
T he Local App Access section contains policy settings that manage the integration of users' locally-installed applications
with hosted applications in a hosted desktop environment.
Allow local app access
T his setting allows or prevents the integration of users' locally-installed applications with hosted applications within a
hosted desktop environment.
When a user launches a locally-installed application, that application appears to run within their virtual desktop, even
though it is actually running locally.
By default, local app access is prohibited.
URL redirection black list
T his setting species websites that are redirected to and launched in the local Web browser. T his might include websites
requiring locale information, such as msn.com or newsgoogle.com, or websites containing rich media content that are
better rendered on the user device.
URL redirection white list
T his setting species websites that are rendered in the environment in which they are launched.

Mobile experience policy settings
May 22, 20 17
T he Mobile Experience section contains policy settings for handling the Citrix Mobility Pack.
Automatic keyboard display
T his setting enables or disables the automatic display of the keyboard on mobile device screens.
By default, the automatic display of the keyboard is disabled.
Launch touch-optimized desktop
T his setting is disabled and not available for Windows 10 or Windows Server 2016 machines.
T his setting determines the overall Citrix Receiver interface behavior by allowing or prohibiting a touch-friendly interface
that is optimized for tablet devices.
By default, a touch-friendly interface is used.
To use only the Windows interface, set this policy setting to Prohibited.
Remote the combo box
T his setting determines the types of combo boxes you can display in sessions on mobile devices. To display the device-
native combo box control, set this policy setting to Allowed. When this setting is allowed, a user can change a Citrix
Receiver for iOS session setting to use the Windows combo box.
By default, the Remote the combo box feature is prohibited.

Multimedia policy settings
May 26, 20 17
T he Multimedia section contains policy settings for managing streaming HT ML5 and Windows audio and video in user
sessions.
HTML5 video redirection
Controls and optimizes the way XenApp and XenDesktop servers deliver HT ML5 multimedia web content to users.
By default, this setting is disabled.

In this release, this feature is available for controlled web pages only. It requires the addition of JavaScript to the web pages
where the HT ML5 multimedia content is available, for example, videos on an internal training site.
To congure HT ML5 video redirection:
1. Copy the file, HdxVideo.js, from %Program Files%/Citrix/ICA Service/HT ML5 Video Redirection on the VDA install to the
location of your internal web page.
2. Insert this line into your web page (if your web page has other scripts, include HdxVideo.js before those scripts):
<script src="HdxVideo.js" type="text/javascript"></script>
Note: If HdxVideo.js is not in the same location as your web page, use the src attribute to specify the full path to it.
If the JavaScript has not been added to your controlled web pages and the user plays an HT ML5 video, XenApp and
XenDesktop defaults to server side rendering.
For redirection of HT ML5 videos to work, allow Windows Media Redirection. T his policy is mandatory for Server Fetch
Client Render, and necessary for Client Side Fetching (which in turn also requires Windows Media client-side content
fetching to be Allowed).
Microsoft Edge doesn't support this feature.
HdxVideo.js replaces the browser HT ML5 Player controls with its own. To check that the HT ML5 video redirection policy is
in effect on a certain website, compare the player controls to a scenario where the HTML5 video redirection policy is
Prohibited:
(Citrix custom controls when the policy is Allowed)

(Native webpage controls when the policy is Prohibited or not congured)
T he following video controls are supported:
play
pause
seek
repeat
audio
full screen
You can view an HT ML5 video redirection test page at https://www.citrix.com/virtualization/hdx/html5-redirect.html.
TLS and HTML5 video redirection
HT ML5 video redirection includes support for video content over T LS (HT T PS). To achieve this redirection and maintain the
T LS integrity of the webpage, place custom certicates in the computer certicate store on the VDA.
HdxVideo.js uses Secure Websockets to communicate with another process running on the VDA:
WebSocketService.exe runs on the Local System, and performs SSL termination and user session mapping. T LS Secure
WebSocket is listening on 127.0.0.1 port 9001.
Limit video quality
T his setting applies only to Windows Media and not to HT ML5. It requires you enable Optimization for Windows Media
multimedia redirection over WAN.
T his setting species the maximum video quality level allowed for an HDX connection. When congured, maximum video
quality is limited to the specied value, ensuring that multimedia Quality of Service (QoS) is maintained within an
environment.
By default, this setting is not congured.
T o limit the maximum video quality level allowed, choose one of the following options:
1080p/8.5mbps
720p/4.0mbps
480p/720kbps
380p/400kbps
240p/200kbps
Playing multiple videos simultaneously on the same server consumes large amounts of resources and may impact server

scalability.
Multimedia conf erencing
T his setting allows or prevents support for video conferencing applications.
By default, video conferencing support is allowed.
When adding this setting to a policy, make sure the Windows Media Redirection setting is present and set to Allowed.
When using multimedia conferencing, make sure the following conditions are met:
Manufacturer-supplied drivers for the web cam used for multimedia conferencing are installed.
Connect the web cam to the user device before initiating a video conferencing session. T he server uses only one installed
web cam at any given time. If multiple web cams are installed on the user device, the server attempts to use each web
cam in succession until a video conferencing session is created successfully.
Optimization f or Windows Media multimedia redirection over WAN
T his setting applies only to Windows Media and not to HT ML5. T he setting enables real-time multimedia transcoding,
allowing audio and video media streaming to mobile devices over degraded networks, and enhancing the user experience by
improving how Windows Media content is delivered over a WAN.
By default, the delivery of Windows Media content over the WAN is optimized.
When adding this setting to a policy, make sure the Windows Media Redirection setting is present and set to Allowed.
When this setting is enabled, real-time multimedia transcoding is deployed automatically as needed to enable media
streaming, providing a seamless user experience even in extreme network conditions.
Use GPU f or optimizing Windows Media multimedia redirection over WAN
T his setting applies only to Windows Media and enables real-time multimedia transcoding to be done in the Graphics
Processing Unit (GPU) on the Virtual Delivery Agent (VDA). It improve server scalability. GPU transcoding is available only if the
VDA has a supported GPU for hardware acceleration. Otherwise, transcoding falls back to the CPU.
Note: GPU transcoding is supported only on NVIDIA GPUs.
By default, using the GPU on the VDA to optimize the delivery of Windows Media content over the WAN is prohibited.
When adding this setting to a policy, make sure the Windows Media Redirection and Optimization for Windows Media
multimedia redirection over WAN settings are present and set to Allowed.
Windows media f allback prevention
T his setting applies to both HT ML5 and Windows Media. For it to work with HT ML5, set the HTML video redirection
policy to Allowed.
Administrators can use the Windows media fallback prevention policy setting to specify the methods that will be
attempted to deliver streamed content to users.
By default, this setting is not congured. When the setting is set to Not Confgured, the behavior is the same as Play all
content.
To congure this setting, choose one of the following options:

Play all content. Attempt client-side content fetching, then Windows Media Redirection. If unsuccessful, play content
on the server.
Play all content only on client. Attempt client-side fetching, then Windows Media Redirection. If unsuccessful, the
content does not play.
Play only client-accessible content on client. Attempt only client-side fetching. If unsuccessful, the content does not
play.
When the content does not play, the error message "Company has blocked video because of lack of resources" displays in
the player window (for a default duration of 5 seconds).
T he duration of this error message can be customized with the following registry key on the VDA. If the registry entry does
not exist, the duration defaults to 5 seconds.
Warning
T he registry path varies depending on architecture of the VDA:
\HKLM\SOFT WARE\Wow6432Node\Citrix\HdxMediastream
or
\HKLM\SOFT WARE\Citrix\HdxMediastream

Registry key:
Name: VideoLoadManagementErrDuration
Type: DWORD
Range: 1 - up to DWORD limit (default = 5)
Unit: seconds
Windows Media client-side content f etching
T his setting applies to both HT ML5 and Windows Media. T he setting enables a user device to stream multimedia les
directly from the source provider on the internet or intranet, rather than through the XenApp or XenDesktop host server.
By default, this setting is Allowed. Allowing this setting improves network usage and server scalability by moving any
processing on the media from the host server to the user device. It also removes the requirement that an advanced
multimedia framework such as Microsoft DirectShow or Media Foundation be installed on the user device. the user device
requires only the ability to play a le from a URL
When adding this setting to a policy, make sure the Windows Media Redirection setting is present and set to Allowed. If
Windows Media Redirection is disabled, the streaming of multimedia les to the user device direct from the source
provider is also disabled.
Windows Media redirection
T his setting applies to both HT ML5 and Windows Media and controls and optimizes the way servers deliver streaming audio
and video to users.
By default, this setting is Allowed. For HT ML5, this setting doesn't take effect if the policy HTML5 video redirection is
Prohibited.
Allowing this setting increases the quality of audio and video rendered from the server to a level that compares with audio
and video played locally on a user device. T he server streams multimedia to the client in the original, compressed form and
allows the user device to decompress and render the media.
Windows Media redirection optimizes multimedia les that are encoded with codecs that adhere to Microsoft DirectShow,
DirectX Media Objects (DMO), and Media Foundation standards. To play back a given multimedia le, a codec compatible
with the encoding format of the multimedia le must be present on the user device.
By default, audio is disabled on Citrix Receiver. To allow users to run multimedia applications in ICA sessions, turn on audio or
give users permission to turn on audio in their Citrix Receiver interface.
Select Prohibited only if playing media using Windows Media redirection appears worse than when rendered using basic
ICA compression and regular audio. T his is rare but can happen under low bandwidth conditions, for example, with media
with a very low frequency of key frames.
Windows Media Redirection buf f er size
T his setting is a legacy and does not apply to HT ML5.
T his setting species a buffer size from 1 to 10 seconds for multimedia acceleration.

By default, the buffer size is 5 seconds.
Windows Media Redirection buf f er size use
T his setting is a legacy and does not apply to HT ML5.
T his setting enables or disables using the buffer size specied in the Windows Media Redirection buf f er size setting.
By default, the buffer size specied is not used.
If this setting is disabled or if the Windows Media Redirection buffer size setting is not congured, the server uses the
default buffer size value (ve seconds).

Multi-stream connections policy settings
May 22, 20 17
T he Multi-Stream Connections section contains policy settings for managing Quality of Service (QoS) prioritization for
multiple ICA connections in a session.
Audio over UDP
T his setting allows or prevents audio over UDP on the server.
By default, audio over UDP is allowed on the server.
When enabled, this setting opens a UDP port on the server to support all connections congured to use Audio over UDP
Realtime Transport.
Audio UDP port range
T his setting species the range of port numbers (in the form lowest port number,highest port number) used by the Virtual
Delivery Agent (VDA) to exchange audio packet data with the user device. T he VDA attempts to use each UDP port pair to
exchange data with the user device, starting with the lowest and incrementing by two for each subsequent attempt. Each
port handles both inbound and outbound trafc.
By default, this is set to 16500,16509.
Multi-Port policy
T his setting species the TCP ports to be used for ICA trafc and establishes the network priority for each port.
By default, the primary port (2598) has a High priority.
When you configure ports, you can assign the following priorities:
Very High - for real-time activities, such as webcam conferences
High - for interactive elements, such as screen, keyboard, and mouse
Medium - for bulk processes, such as client drive mapping
Low - for background activities, such as printing
Each port must have a unique priority. For example, you cannot assign a Very High priority to both CGP port 1 and CGP port
3.
To remove a port from prioritization, set the port number to 0. You cannot remove the primary port and you cannot modify
its priority level.
When conguring this setting, restart the server. T his setting takes effect only when the Multi-Stream computer setting
policy setting is enabled.
Multi-Stream computer setting
T his setting enables or disables Multi-Stream on the server.
By default, Multi-Stream is disabled.
If you use Citrix NetScaler SD-WAN with Multi-Stream support in your environment, you do not need to congure this

setting. Congure this policy setting when using third-party routers or legacy Branch Repeaters to achieve the desired
Quality of Service (QoS).
When configuring this setting, reboot the server to ensure changes take effect.
Important: Using this policy setting in conjunction with bandwidth limit policy settings such as Overall session bandwidth
limit may produce unexpected results. When including this setting in a policy, ensure that bandwidth limit settings are not
included.
Multi-Stream user setting
T his setting enables or disables Multi-Stream on the user device.
By default, Multi-Stream is disabled for all users.
T his setting takes effect only on hosts where the Multi-Stream computer setting policy setting is enabled.
Important: Using this policy setting with bandwidth limit policy settings such as Overall session bandwidth limit may produce
unexpected results. When including this setting in a policy, ensure that bandwidth limit settings are not included.

Port redirection policy settings
May 22, 20 17
T he Port Redirection section contains policy settings for client LPT and COM port mapping.
For Virtual Delivery Agent versions earlier than 7.0, use the following policy settings to congure port redirection. For VDA
versions 7.0 through 7.8, congure these settings using the registry; see Congure COM Port and LPT Port Redirection
settings using the registry. For VDA version 7.9, use the following policy settings.
Auto connect client COM ports
T his setting enables or disables automatic connection of COM ports on user devices when users log on to a site.
By default, client COM ports are not automatically connected.
Auto connect client LPT ports
T his setting enables or disables automatic connection of LPT ports on user devices when users log on to a site.
By default, client LPT ports are not connected automatically.
Client COM port redirection
T his setting allows or prevents access to COM ports on the user device.
By default, COM port redirection is prohibited.

COM port redirection bandwidth limit
COM port redirection bandwidth limit percent
Client LPT port redirection
T his setting allows or prevents access to LPT ports on the user device.
By default, LPT port redirection is prohibited.
LPT ports are used only by legacy applications that send print jobs to the LPT ports and not to the print objects on the
user device. Most applications today can send print jobs to printer objects. T his policy setting is necessary only for servers
that host legacy applications that print to LPT ports.
Note, although Client COM port redirection is bi-directional, LPT port redirection is output only and limited to \\client\LPT 1
and \\client\LPT 2 within an ICA session.

LPT port redirection bandwidth limit
LPT port redirection bandwidth limit percent

Printing policy settings
May 22, 20 17
T he Printing section contains policy settings for managing client printing.
Client printer redirection
T his setting controls whether client printers are mapped to a server when a user logs on to a session.
By default, client printer mapping is allowed. If this setting is disabled, the PDF printer for the session is not auto-created.
Related policy settings: auto-create client printers
Def ault printer
T his setting species how the default printer on the user device is established in a session.
By default, the user's current printer is used as the default printer for the session.
T o use the current Remote Desktop Services or Windows user profile setting for the default printer, select Do not adjust
the user's default printer. If you choose this option, the default printer is not saved in the profile and it does not change
according to other session or client properties. T he default printer in a session will be the first printer auto-created in the
session, which is either:
T he first printer added locally to the Windows server in Control Panel > Devices and Printers.
T he first auto-created printer, if there are no printers added locally to the server.
You can use this option to present users with the nearest printer through prole settings (known as proximity printing).
Printer assignments
T his setting provides an alternative to the Default printer and Session printers settings. Use the individual Default printer
and Session printers settings to congure behaviors for a site, large group, or organizational unit. Use the Printer
assignments setting to assign a large group of printers to multiple users.
T his setting species how the default printer on the listed user devices is established in a session.
By default, the user's current printer is used as the default printer for the session.
It also species the network printers to be auto-created in a session for each user device. By default, no printers are
specied.
When setting the default printer value:

To use the current default printer for the user device, select Do not adjust.
To use the current Remote Desktop Services or Windows user prole setting for the default printer, select Do no adjust.
If you choose this option, the default printer is not saved in the prole and it does not change according to other
session or client properties. T he default printer in a session will be the rst printer auto-created in the session, which is
either:
T he first printer added locally to the Windows server in Control Panel > Devices and Printers.
T he first auto-created printer, if there are no printers added locally to the server.
When setting the session printers value: to add printers, type the UNC path of the printer you want to auto-create.

After adding the printer, you can apply customized settings for the current session at every logon.
Printer auto-creation event log pref erence
T his setting species the events that are logged during the printer auto-creation process. You can choose to log no errors
or warnings, only errors, or errors and warnings.
By default, errors and warnings are logged.
An example of a warning is an event in which a printers native driver could not be installed and the Universal print driver is
installed instead. To use the Universal print driver in this scenario, congure the Universal print driver usage setting to Use
universal printing only or Use universal printing only if requested driver is unavailable.
Session printers
T his setting species the network printers to be auto-created in a session.
By default, no printers are specied.
To add printers, type the UNC path of the printer you want to auto-create. After adding the printer, you can apply
customized settings for the current session at every logon.
Wait f or printers to be created (server desktop)
T his setting allows or prevents a delay in connecting to a session so that server desktop printers can be auto-created.
By default, a connection delay does not occur.

Client printers policy settings
May 22, 20 17
T he Client Printers section contains policy settings for client printers, including settings to autocreate client printers, retain
printer properties, and connect to print servers.
Auto-create client printers
T his setting species the client printers that are auto-created. T his setting overrides default client printer auto-creation
settings.
By default, all client printers are auto-created.
T his setting takes effect only if the Client printer redirection setting is present and set to Allowed.
When adding this setting to a policy, select an option:

Auto-create all client printers automatically creates all printers on a user device.
Auto-create the client's default printer only automatically creates only the printer selected as the default printer on the
user device.
Auto-create local (non-network) client printers only automatically creates only printers directly connected to the user
device through an LPT , COM, USB, T CP/IP, or other local port.
Do not auto-create client printers turns off autocreation for all client printers when users log on. T his causes the
Remote Desktop Services (RDS) settings for autocreating client printers to override this setting in lower priority policies.
Auto-create generic universal printer
Note: Hotfixes that address the issues with this policy setting are available as Knowledge Center articles CT X141565 and
CT X141566.
T his setting enables or disables autocreation of the generic Citrix Universal Printer object for sessions where a user device
compatible with Universal Printing is in use.
By default, the generic Universal Printer object is not autocreated.

Universal print driver usage
Universal driver preference
Client printer names
T his setting selects the naming convention for auto-created client printers.
By default, standard printer names are used.
Select Standard printer names to use printer names such as "HPLaserJet 4 from clientname in session 3."
Select Legacy printer names to use old-style client printer names and preserve backward compatibility for users or groups
using MetaFrame Presentation Server 3.0 or earlier. An example of a legacy printer name is "Client/clientname#/HPLaserJet
4." T his option is less secure.
Note: T his option is provided only for backwards compatibility with legacy versions of XenApp and XenDesktop.
Direct connections to print servers

T his setting enables or disables direct connections from the virtual desktop or server hosting applications to a print server
for client printers hosted on an accessible network share.
By default, direct connections are enabled.
Enable direct connections if the network print server is not across a WAN from the virtual desktop or server hosting
applications. Direct communication results in faster printing if the network print server and the virtual desktop or server
hosting applications are on the same LAN.
Disable direct connections if the network is across a WAN or has substantial latency or limited bandwidth. Print jobs are
routed through the user device where they are redirected to the network print server. Data sent to the user device is
compressed, so less bandwidth is consumed as the data travels across the WAN.
If two network printers have the same name, the printer on the same network as the user device is used.
Printer driver mapping and compatibility
T his setting species the driver substitution rules for auto-created client printers.
T his setting is congured to exclude Microsoft OneNote and XPS Document Writer from the auto-created client printers
list.
When you dene driver substitution rules, you can allow or prevent printers to be created with the specied driver.
Additionally, you can allow created printers to use only universal print drivers. Driver substitution overrides or maps printer
driver names the user device provides, substituting an equivalent driver on the server. T his gives server applications access to
client printers that have the same drivers as the server, but different driver names.
You can add a driver mapping, edit an existing mapping, override custom settings for a mapping, remove a mapping, or
change the order of driver entries in the list. When adding a mapping, enter the client printer driver name and then select
the server driver you want to substitute.
Printer properties retention
T his setting species whether or not to store printer properties and where to store them.
By default, the system determines if printer properties are stored on the user device, if available, or in the user prole.

Saved on the client device only is for user devices that have a mandatory or roaming profile that is not saved. Choose
this option only if all the servers in your farm are running XenApp 5 and above and your users are using Citrix online plug-in
versions 9 through 12.x, or Citrix Receiver 3.x.
Retained in user profile only is for user devices constrained by bandwidth (this option reduces network traffic) and logon
speed or for users with legacy plug-ins. T his option stores printer properties in the user profile on the server and prevents
any properties exchange with the user device. Use this option with MetaFrame Presentation Server 3.0 or earlier and
MetaFrame Presentation Server Client 8.x or earlier. Note that this is applicable only if a Remote Desktop Services (RDS)
roaming profile is used.
Held in profile only if not saved on client allows the system to determine where printer properties are stored. Printer
properties are stored either on the user device, if available, or in the user profile. Although this option is the most flexible,
it can also slow logon time and use extra bandwidth for system-checking.
Do not retain printer properties prevents storing printer properties.

Retained and restored client printers
T his setting enables or disables the retention and re-creation of printers on the user device. By default, client printers are
auto-retained and auto-restored.
Retained printers are user-created printers that are created again, or remembered, at the start of the next session. When
XenApp recreates a retained printer, it considers all policy settings except the Auto-create client printers setting.
Restored printers are printers fully customized by an administrator, with a saved state that is permanently attached to a
client port.

Drivers policy settings
May 22, 20 17
T he Drivers section contains policy settings related to printer drivers.
Automatic installation of in-box printer drivers
T his setting enables or disables the automatic installation of printer drivers from the Windows in-box driver set or from
driver packages staged on the host using pnputil.exe /a.
By default, these drivers are installed as needed.
Universal driver pref erence
T his setting species the order in which universal printer drivers are used, beginning with the rst entry in the list.
By default, the preference order is:

EMF
XPS
PCL5c
PCL4
PS
You can add, edit, or remove drivers, and change the order of drivers in the list.
Universal print driver usage
T his setting species when to use universal printing.
By default, universal printing is used only if the requested driver is unavailable.
Universal printing employs generic printer drivers instead of standard model-specic drivers, potentially simplifying the burden
of driver management on host computers. T he availability of universal print drivers depends on the capabilities of the user
device, host, and print server software. In certain congurations, universal printing might not be available.

Use only printer model specific drivers specifies that the client printer uses only the standard model-specific drivers that
are auto-created at logon. If the requested driver is unavailable, the client printer cannot be auto-created.
Use universal printing only specifies that no standard model-specific drivers are used. Only universal print drivers are used
to create printers.
Use universal printing only if requested driver is unavailable uses standard model-specific drivers for printer creation if they
are available. If the driver is not available on the server, the client printer is created automatically with the appropriate
universal driver.
Use printer model specific drivers only if universal printing is unavailable uses the universal print driver if it is available. If the
driver is not available on the server, the client printer is created automatically with the appropriate model-specific printer
driver.

Universal Print Server policy settings
May 22, 20 17
T he Universal Print Server section contains policy settings for handling the Universal Print Server.
Universal Print Server enable
T his setting enables or disables the Universal Print Server feature on the virtual desktop or the server hosting applications.
Apply this policy setting to Organizational Units (OUs) containing the virtual desktop or server hosting applications.
By default, the Universal Print Server is disabled.
When adding this setting to a policy, select one of the following options:
Enabled with f allback to Windows native remote printing. Network printer connections are serviced by the Universal
Print Server, if possible. If the Universal Print Server is not available, the Windows Print Provider is used. T he Windows Print
Provider continues to handle all printers previously created with the Windows Print Provider.
Enabled with no f allback to Windows native remote printing. Network printer connections are serviced by the
Universal Print Server exclusively. If the Universal Print Server is unavailable, the network printer connection fails. T his
setting effectively disables network printing through the Windows Print Provider. Printers previously created with the
Windows Print Provider are not created while a policy containing this setting is active.
Disabled. T he Universal Print Server feature is disabled. No attempt is made to connect with the Universal Print Server
when connecting to a network printer with a UNC name. Connections to remote printers continue to use the Windows
native remote printing facility.
Universal Print Server print data stream (CGP) port
T his setting species the TCP port number used by the Universal Print Server print data stream Common Gateway Protocol
(CGP) listener. Apply this policy setting only to OUs containing the print server.
Valid port numbers must be in the range of 1 to 65535.
Universal Print Server print stream input bandwidth limit (kpbs)
T his setting species the upper boundary (in kilobits per second) for the transfer rate of print data delivered from each print
job to the Universal Print Server using CGP. Apply this policy setting to OUs containing the virtual desktop or server hosting
applications.
By default, the value is 0, which species no upper boundary.
Universal Print Server web service (HTTP/SOAP) port
T his setting species the TCP port number used by the Universal Print Server's web service (HT T P/SOAP) listener. T he
Universal Print Server is an optional component that enables the use of Citrix universal print drivers for network printing
scenarios. When the Universal Print Server is used, printing commands are sent from XenApp and XenDesktop hosts to the
Universal Print Server via SOAP over HT T P. T his setting modies the default TCP port on which the Universal Print Server
listens for incoming HT T P/SOAP requests.
You must congure both host and print server HT T P port identically. If you do not congure the ports identically, the host
software will not connect to the Universal Print Server. T his setting changes the VDA on XenApp and XenDesktop. In

addition, you must change the default port on the Universal Print Server.
Valid port numbers must be in the range of 0 to 65535.
Universal Print Servers f or load balancing
T his setting lists the Universal Print Servers to be used to load balance printer connections established at session launch,
after evaluating other Citrix printing policy settings. To optimize printer creation time, Citrix recommends that all print
servers have the same set of shared printers. T here is no upper limit to the number of print servers which can be added for
load balancing.
T his setting also implements print server failover detection and printer connections recovery. T he print servers are checked
periodically for availability. If a server failure is detected, that server is removed from the load balancing scheme, and printer
connections on that server are redistributed among other available print servers. When the failed print server recovers, it is
returned to the load balancing scheme.
Click Validate Servers to check that each server is a print server and that all servers have an identical set of shared printers
installed. T his operation may take some time.
Universal Print Servers out-of-service threshold
T his setting species how long the load balancer should wait for an unavailable print server to recover before it determines
that the server is permanently ofine and redistributes its load to other available print servers.
By default, the threshold value is set to 180 (seconds).

Universal printing policy settings
May 22, 20 17
T he Universal Printing section contains policy settings for managing universal printing.
Universal printing EMF processing mode
T his setting controls the method of processing the EMF spool le on the Windows user device.
By default, EMF records are spooled directly to the printer.

Reprocess EMFs for printer forces the EMF spool file to be reprocessed and sent through the GDI subsystem on the
user device. You can use this setting for drivers that require EMF reprocessing but that might not be selected
automatically in a session.
Spool directly to printer, when used with the Citrix Universal print driver, ensures the EMF records are spooled and
delivered to the user device for processing. T ypically, these EMF spool files are injected directly to the client's spool
queue. For printers and drivers that are compatible with the EMF format, this is the fastest printing method.
Universal printing image compression limit
T his setting species the maximum quality and the minimum compression level available for images printed with the Citrix
Universal print driver.
By default, the image compression limit is set to Best quality (lossless compression).
If No Compression is selected, compression is disabled for EMF printing only.

No compression
Best quality (lossless compression)
High quality
Standard quality
Reduced quality (maximum compression)
When adding this setting to a policy that includes the Universal printing optimization defaults setting, be aware of the
following:
If the compression level in the Universal printing image compression limit setting is lower than the level defined in the
Universal printing optimization defaults setting, images are compressed at the level defined in the Universal printing image
compression limits setting.
If compression is disabled, the Desired image quality and Enable heavyweight compression options of the Universal
printing optimization defaults setting have no effect in the policy.
Universal printing optimization def aults
T his setting specifies the default values for printing optimization when the universal print driver is created for a session.
Desired image quality specifies the default image compression limit applied to universal printing. By default, Standard
Quality is enabled, meaning that users can only print images using standard or reduced quality compression.
Enable heavyweight compression enables or disables reducing bandwidth beyond the compression level set by Desired
image quality, without losing image quality. By default, heavyweight compression is disabled.

Image and Font Caching settings specify whether or not to cache images and fonts that appear multiple times in the
print stream, ensuring each unique image or font is sent to the printer only once. By default, embedded images and fonts
are cached. Note that these settings apply only if the user device supports this behavior.
Allow non-administrators to modify these settings specifies whether or not users can change the default print
optimization settings within a session. By default, users are not allowed to change the default print optimization
settings.
Note: All of these options are supported for EMF printing. For XPS printing, only the Desired image quality option is
supported.
When adding this setting to a policy that includes the Universal printing image compression limit setting, be aware of the
following:
If the compression level in the Universal printing image compression limit setting is lower than the level defined in the
Universal printing optimization defaults setting, images are compressed at the level defined in the Universal printing image
compression limits setting.
If compression is disabled, the Desired image quality and Enable heavyweight compression options of the Universal
printing optimization defaults setting have no effect in the policy.
Universal printing preview pref erence
T his setting species whether or not to use the print preview function for auto-created or generic universal printers.
By default, print preview is not used for auto-created or generic universal printers.

Do not use print preview for auto-created or generic universal printers
Use print preview for auto-created printers only
Use print preview for generic universal printers only
Use print preview for both auto-created and generic universal printers
Universal printing print quality limit
T his setting species the maximum dots per inch (dpi) available for generating printed output in a session.
By default, No Limit is enabled, meaning users can select the maximum print quality allowed by the printer to which they
connect.
If this setting is congured, it limits the maximum print quality available to users in terms of output resolution. Both the print
quality itself and the print quality capabilities of the printer to which the user connects are restricted to the congured
setting. For example, if congured to Medium Resolution (600 DPI), users are restricted to printing output with a maximum
quality of 600 DPI and the Print Quality setting on the Advanced tab of the Universal Printer dialog box shows resolution
settings only up to and including Medium Quality (600 DPI).

Draft (150 DPI)
Low Resolution (300 DPI)
Medium Resolution (600 DPI)
High Resolution (1200 DPI)
No Limit

Security policy settings
May 22, 20 17
T he Security section contains the policy setting for conguring session encryption and encryption of logon data.
SecureICA minimum encryption level
T his setting species the minimum level at which to encrypt session data sent between the server and a user device.
Important: For the Virtual Delivery Agent 7.x, this policy setting can be used only to enable the encryption of the logon
data with RC5 128-bit encryption. Other settings are provided only for backwards compatibility with legacy versions of
XenApp and XenDesktop.
For the VDA 7.x, encryption of session data is set using the basic settings of the VDA's Delivery Group. If Enable Secure ICA
is selected for the Delivery Group, session data is encrypted with RC5 (128 bit) encryption. If Enable Secure ICA is not
selected for the Delivery Group, session data is encrypted with Basic encryption.

Basic encrypts the client connection using a non-RC5 algorithm. It protects the data stream from being read directly, but
it can be decrypted. By default, the server uses Basic encryption for client-server traffic.
RC5 (128 bit) logon only encrypts the logon data with RC5 128-bit encryption and the client connection using Basic
encryption.
RC5 (40 bit) encrypts the client connection with RC5 40-bit encryption.
T he settings you specify for client-server encryption can interact with any other encryption settings in your environment
and your Windows operating system. If a higher priority encryption level is set on either a server or user device, settings you
specify for published resources can be overridden.
You can raise encryption levels to further secure communications and message integrity for certain users. If a policy requires
a higher encryption level, Citrix Receivers using a lower encryption level are denied connection.
SecureICA does not perform authentication or check data integrity. To provide end-to-end encryption for your site, use
SecureICA with T LS encryption.
SecureICA does not use FIPS-compliant algorithms. If this is an issue, congure the server and Citrix Receivers to avoid using
SecureICA.

Server limits policy settings
May 22, 20 17
T he Server Limits section contains the policy setting for controlling idle connections.
Server idle timer interval
T his setting determines, in milliseconds, how long an uninterrupted user session is maintained if there is no input from the
user.
By default, idle connections are not disconnected (server idle timer interval = 0).
Note
When this policy setting is used, an "Idle timer expired" dialog box might appear to users when the session has been idle for the
specied time. T his is a Mircosoft dialog box that is not controlled by Citirx policy settings. For more information, see
http://support.citrix.com/article/CT X118618.

Session limits policy settings
May 22, 20 17
T he Session Limits section contains policy settings that control how long sessions remain connected before they are
forced to log off.
Disconnected session timer
T his setting enables or disables a timer that species how long a disconnected, locked desktop can remain locked before
the session is logged off.
By default, disconnected sessions are not logged off.
Disconnected session timer interval
T his setting species how many minutes a disconnected, locked desktop can remain locked before the session is logged off.
By default, the time period is 1440 minutes (24 hours).
Session connection timer
T his setting enables or disables a timer that species the maximum duration of an uninterrupted connection between a
user device and a desktop.
By default, this timer is disabled.
Session connection timer interval
T his setting species the maximum number of minutes for an uninterrupted connection between a user device and a
desktop.
By default, the maximum duration is 1440 minutes (24 hours).
Session idle timer
T his setting enables or disables a timer that species how long an uninterrupted user device connection to a desktop will be
maintained if there is no input from the user.
By default, this timer is enabled.
Session idle timer interval
T his setting species how many minutes an uninterrupted user device connection to a desktop will be maintained if there is
no input from the user.
By default, idle connections are maintained for 1440 minutes (24 hours).

Session reliability policy settings
May 22, 20 17
T he session reliability section contains policy settings for managing session reliability connections.
Session reliability connections
T his setting allows or prevents sessions to remain open during a loss of network connectivity. Session reliability, along with
auto client reconnection, allows users to automatically reconnect to their Citrix Receiver sessions after recovering from
network disruptions.
For Citrix Receiver for Windows 4.7 and later, session reliability uses only the policy settings from Citrix Studio. Updates to
these policies in Studio synchronize session reliability from server to client. With older versions of Citrix Receiver for
Windows, to congure session reliability, use a Studio policy and modify the registry or the default.ica le.
Note: Setting the Enable session reliability option to Disabled in the Citrix Receiver Group Policy Object administrative
template or in the Citrix Studio policy disables session reliability. If you didn't congure the Enable session reliability option
in the Citrix Studio policy and set it to Disabled in the Citrix Receiver Group Policy Object administrative template, session
reliability is enabled.
Session reliability keeps sessions active and on the user's screen when network connectivity is interrupted. Users continue
to see the application they are using until network connectivity resumes.
With session reliability, the session remains active on the server. To indicate that connectivity is lost, the user display
becomes opaque. T he user might see a frozen session during the interruption and can resume interacting with the
application when the network connection is restored. Session reliability reconnects users without reauthentication
prompts.
If you use both session reliability and auto client reconnect, the two features work in sequence. Session reliability closes (or
disconnects) the user session after the amount of time specied in the session reliability timeout setting. After that, the
auto client reconnect settings take effect, attempting to reconnect the user to the disconnected session.
By default, session reliability is Allowed.
To disable session reliability:

2. Open the Session Reliability connections policy.
3. Set the policy to Prohibited.

Session reliability port number
T his setting species the TCP port number for incoming session reliability connections.
To modify session reliability port number:

2. Open the Session reliability port number policy.
3. Edit the port number.
4. Click OK.
Session reliability timeout
T his setting species the length of time, in seconds, the session reliability proxy waits for a user to reconnect before
allowing the session to be disconnected.
Although you can extend the amount of time a session is kept open, this feature is a convenience and doesn't prompt the
user for reauthentication. T he longer a session open, chances increase that a user might leave the device unattended and
potentially accessible to unauthorized users.

By default, the timeout is set to 180 seconds, or three minutes.
To change session reliability timeout:

2. Open the Session reliability timeout policy.
3. Edit the timeout value.
4. Click OK.

Time zone control policy settings
May 22, 20 17
T he T ime Zone Control section contains policy settings related to using local time in sessions.
Estimate local time f or legacy clients
T his setting enables or disables estimating the local time zone of user devices that send inaccurate time zone information
to the server.
By default, the server estimates the local time zone when necessary.
T his setting is intended for use with legacy Citrix Receivers or ICA clients that do not send detailed time zone information
to the server. When used with Citrix Receivers that send detailed time zone information to the server, such as supported
versions of Citrix Receiver for Windows, this setting has no effect.
Use local time of client
T his setting determines the time zone setting of the user session. T his can be either the time zone of the user session or
the time zone of the user device.
By default, the time zone of the user session is used.
For this setting to take effect, enable the Allow time zone redirection setting in the Group Policy Editor (User Conguration
> Administrative Templates > Windows Components > Remote Desktop Services > Remote Desktop Session Host > Device
and Resource Redirection).

TWAIN devices policy settings
May 22, 20 17
T he T WAIN devices section contains policy settings related to mapping client T WAIN devices, such as digital cameras or
scanners, and optimizing image transfers from server to client.
Note
T WAIN 2.0 is supported with Citrix Receiver for Windows 4.5.
Client TWAIN device redirection
T his setting allows or prevents users from accessing T WAIN devices on the user device from image processing applications
hosted on servers. By default, T WAIN device redirection is allowed.

T WAIN compression level
T WAIN device redirection bandwidth limit
T WAIN device redirection bandwidth limit percent
TWAIN compression level
T his setting species the level of compression of image transfers from client to server. Use Low for best image quality,
Medium for good image quality, or High for low image quality. By default, medium compression is applied.

USB devices policy settings
May 22, 20 17
T he USB devices section contains policy settings for managing le redirection for USB devices.
Client USB device optimization rules
Client USB device optimization rules can be applied to devices to disable optimization, or to change the optimization mode.
When a user plugs in a USB input device, the host checks if the device is allowed by the USB policy settings. If the device is
allowed, the host then checks the Client USB device optimization rules for the device. If no rule is specied, then the
device is not optimized. Capture mode (04) is the recommended mode for signature devices. For other devices which have
degraded performance over higher latency, administrators can enable Interactive mode (02) . See descriptions below for
available modes.
Good to know
For the use of Wacom signature pads and tablets, Citrix recommends that you disable the screen saver. Steps on how to
do this are at the end of this section.
Support for the optimization of Wacom ST U signature pads and tablets series of products has been preconfigured in
the installation of XenApp and XenDesktop policies.
Signature devices work across XenApp and XenDesktop and do not require a driver to be used as a signature device.
Wacom has additional software that can be installed to customize the device further. See http://www.wacom.com/.
Drawing tablets. Certain drawing input devices may present as an HID device on PCI/ACPI buses and are not supported.
T hese devices should be attached on a USB host controller on the client to be redirected inside a XenDesktop session.
Policy rules take the format of tag=value expressions separated by whitespace. T he following tags are supported:
Tag Name Description
Mode T he optimization mode is supported for input devices for class=03.

Supported modes are:
No optimization - value 01.
Interactive mode - value 02. Recommended for devices such as pen

tablets and 3D Pro mice.
Capture mode - value 04 . Preferred for devices such as signature

pads.
VID Vendor ID from the device descriptor.
PID Product ID from the device descriptor.
REL Release ID from the device descriptor.

Class Class from either the device descriptor or an interface descriptor.
SubClass Subclass from either the device descriptor or an interface descriptor.
Prot Protocol from either the device descriptor or an interface descriptor.
Examples
Mode=00000004 VID=1230 PID=1230 class=03 #Input device operating in capture mode
Mode=00000002 VID=1230 PID=1230 class=03 #Input device operating in interactive mode (default)
Mode=00000001 VID=1230 PID=1230 class=03 #Input device operating without any optimization
Mode=00000100 VID=1230 PID=1230 # Device setup optimization disabled (default)
Mode=00000200 VID=1230 PID=1230 # Device setup optimization enabled
Disabling the screen saver f or Wacom signature pad devices
For the use of Wacom signature pads and tablets, Citrix recommends that you disable the screen saver as follows:
1. Install the Wacom-STU-Driver after redirecting the device.

2. Install Wacom-STU-Display MSI to gain access to the signature pad control panel.
3. Go to Control Panel > Wacom STU Display > STU4 30 or STU530, and select the tab for your model.
4. Click Change, then select Yes when the UAC security window pops up.
5. Select Disable slideshow, then Apply.
After the setting is set for one signature pad model, it is applied to all models.
Client USB device redirection
T his setting allows or prevents redirection of USB devices to and from the user device.
By default, USB devices are not redirected.
Client USB device redirection rules
T his setting species redirection rules for USB devices.
By default, no rules are specied.
When a user plugs in a USB device, the host device checks it against each policy rule in turn until a match is found. T he rst
match for any device is considered denitive. If the rst match is an Allow rule, the device is remoted to the virtual desktop.
If the rst match is a Deny rule, the device is available only to the local desktop. If no match is found, default rules are used.
Policy rules take the format {Allow:|Deny:} followed by a set of tag= value expressions separated by whitespace. T he
following tags are supported:
VID Vendor ID from the device descriptor

PID Product ID from the device descriptor
REL Release ID from the device descriptor
Class Class from either the device descriptor or an interface descriptor
SubClass Subclass from either the device descriptor or an interface descriptor
Prot Protocol from either the device descriptor or an interface descriptor
When creating new policy rules, remember:

Rules are case-insensitive.
Rules may have an optional comment at the end, introduced by #.
Blank and pure comment lines are ignored.
T ags must use the matching operator = (for example, VID=1230_.
Each rule must start on a new line or form part of a semicolon-separated list.
Refer to the USB class codes available from the USB Implementers Forum, Inc. web site.
Examples of administrator-defined USB policy rules:

Allow: VID=1230 PID=0007 # ANOther Industries, ANOther Flash Drive
Deny: Class=08 subclass=05 # Mass Storage
T o create a rule that denies all USB devices, use "DENY:" with no other tags.
Client USB plug and play device redirection
T his setting allows or prevents plug-and-play devices such as cameras or point-of-sale (POS) devices to be used in a client
session.
By default, plug-and-play device redirection is allowed. When set to Allowed, all plug-and-play devices for a specic user or
group are redirected. When set to Prohibited, no devices are redirected.

Visual display policy settings
May 22, 20 17
T he Visual Display section contains policy settings for controlling the quality of images sent from virtual desktops to the
user device.
Pref erred color depth f or simple graphics
T his policy setting is available in VDA versions 7.6 FP3 and later. T he 8-bit option is available in VDA versions 7.12 and later.
T his setting makes it possible to lower color depth at which simple graphics are sent over the network. Lowering to 8-bit or
16-bit per pixel potentially improves responsiveness over low bandwidth connections, at the cost of a slight degradation in
image quality. T he 8-bit color depth is not supported when the Use video codec for compression policy setting is set to For
the entire screen.
T he default preferred color depth is 24-bits per pixel.
VDAs will fall back to 24-bit (default) color depth if the 8-bit setting is applied on VDA version 7.11 and earlier.
Target f rame rate
T his setting species the maximum number of frames per second sent from the virtual desktop to the user device.
By default, the maximum is 30 frames per second.
Setting a high number of frames per second (for example, 30) improves the user experience, but requires more bandwidth.
Decreasing the number of frames per second (for example, 10) maximizes server scalability at the expense of user
experience. For user devices with slower CPUs, specify a lower value to improve the user experience.
T he maximum supported frame rate per second is 60.
Visual quality
T his setting species the desired visual quality for images displayed on the user device.
By default, this is set to Medium.
T o specify the quality of images, choose one of the following options:

Low
Medium - Offers the best performance and bandwidth efficiency in most use cases
High - Recommended if you require visually lossless image quality
Build to lossless - Sends lossy images to the user device during periods of high network activity and lossless images
after network activity reduces; this setting improves performance over bandwidth-constrained network connections
Always lossless - In cases where preserving image data is vital (for example, when displaying X-ray images where no loss
of quality is acceptable), select Always lossless to ensure lossy data is never sent to the user device.
If the Legacy graphics mode setting is enabled, the Visual quality setting has no effect in the policy.

Moving images policy settings
May 22, 20 17
T he Moving Images section contains settings that enable you to remove or alter compression for dynamic images.
Minimum image quality
enabled.
T his setting species the minimum acceptable image quality for Adaptive Display. T he less compression used, the higher the
quality of images displayed. Choose from Ultra High, Very High, High, Normal, or Low compression.
By default, this is set to Normal.
Moving image compression
T his setting specifies whether or not Adaptive Display is enabled. Adaptive Display automatically adjusts the image quality
of videos and transitional slides in slide shows based on available bandwidth. With Adaptive Display enabled, users should
see smooth-running presentations with no reduction in quality.
By default, Adaptive Display is enabled.
For VDA versions 7.0 through 7.6, this setting applies only when Legacy graphics mode is enabled. For VDA versions 7.6 FP1
and later, this setting applies when Legacy graphics mode is enabled, or when the legacy graphics mode is disabled and a
video codec is not used to compress graphics.
When legacy graphics mode is enabled, the session must be restarted before policy changes take effect. Adaptive Display is
mutually exclusive with Progressive Display; enabling Adaptive Display disables Progressive Display and vice versa. However,
both Progressive Display and Adaptive Display can be disabled at the same time. Progressive Display, as a legacy feature, is
not recommended for XenApp or XenDesktop. Setting Progressive threshold Level will disable Adaptive Display.
Progressive compression level
enabled.
T his setting provides a less detailed but faster initial display of images.
By default, no progressive compression is applied.
T he more detailed image, dened by the normal lossy compression setting, appears when it becomes available. Use Very
High or Ultra High compression for improved viewing of bandwidth-intensive graphics such as photographs.
For progressive compression to be effective, its compression level must be higher than the Lossy compression level setting.
Note: T he increased level of compression associated with progressive compression also enhances the interactivity of
dynamic images over client connections. T he quality of a dynamic image, such as a rotating three-dimensional model, is
temporarily decreased until the image stops moving, at which time the normal lossy compression setting is applied.
Progressive compression threshold value
Progressive heavyweight compression

enabled.
T his setting represents the maximum bandwidth in kilobits per second for a connection to which progressive compression is
applied. T his is applied only to client connections under this bandwidth.
By default, the threshold value is 2147483647 kilobits per second.

Progressive heavyweight compression
Target minimum f rame rate
T his setting specifies the minimum frame rate per second the system attempts to maintain, for dynamic images, under low
bandwidth conditions.
By default, this is set to 10fps.
For VDA versions 7.0 through 7.6, this setting applies only when Legacy graphics mode is enabled. For VDA versions 7.6 FP1
and later, this setting applies when the Legacy graphics mode is disabled or enabled.

Still images policy settings
May 22, 20 17
T he Still Images section contains settings that enable you to remove or alter compression for static images.
Extra color compression
T his setting enables or disables the use of extra color compression on images delivered over client connections that are
limited in bandwidth, improving responsiveness by reducing the quality of displayed images.
By default, extra color compression is disabled.
When enabled, extra color compression is applied only when the client connection bandwidth is below the Extra color
compression threshold value. When the client connection bandwidth is above the threshold value or Disabled is selected,
extra color compression is not applied.
Extra color compression threshold
enabled.
T his setting represents the maximum bandwidth in kilobits per second for a connection below which extra color
compression is applied. If the client connection bandwidth drops below the set value, extra color compression, if enabled, is
applied.
Heavyweight compression
enabled.
T his setting enables or disables reducing bandwidth beyond progressive compression without losing image quality by using a
more advanced, but more CPU-intensive, graphical algorithm.
By default, heavyweight compression is disabled.
If enabled, heavyweight compression applies to all lossy compression settings. It is supported on Citrix Receiver but has no
effect on other plug-ins.

Progressive compression level
Lossy compression level
enabled.
T his setting controls the degree of lossy compression used on images delivered over client connections that are limited in
bandwidth. In such cases, displaying images without compression can be slow.
By default, medium compression is selected.
For improved responsiveness with bandwidth-intensive images, use high compression. Where preserving image data is vital;

for example, when displaying X-ray images where no loss of quality is acceptable, you may not want to use lossy
compression.
Related policy setting: Lossy compression threshold value
Lossy compression threshold value
enabled.
T his setting represents the maximum bandwidth in kilobits per second for a connection to which lossy compression is
applied.
Adding the Lossy compression level setting to a policy and including no specied threshold can improve the display speed of
high-detail bitmaps, such as photographs, over a LAN.
Related policy setting: Lossy compression level

WebSockets policy settings
May 22, 20 17
T he WebSockets section contains policy settings for accessing virtual desktops and hosted applications with Citrix Receiver
for HT ML5. T he WebSockets feature increases security and reduces overhead by conducting two-way communication
between browser-based applications and servers without opening multiple HT T P connections.
WebSockets connections
T his setting allows or prohibits WebSockets connections.
By default, WebSocket connections are prohibited.
WebSockets port number
T his setting identies the port for incoming WebSocket connections.
By default, the value is 8008.
WebSockets trusted origin server list
T his setting provides a comma-separated list of trusted origin servers, usually Citrix Receiver for Web, expressed as URLs.
Only WebSockets connections originating from one of these addresses is accepted by the server.
By default, the wildcard * is used to trust all Citrix Receiver for Web URLs.
If you choose to type an address in the list, use this syntax:
<protocol>://<Fully qualied domain name of host>:[port]
T he protocol should be HT T P or HT T PS. If the port is not specied, port 80 is used for HT T P and port 443 is used for
HT T PS.
T he wildcard * can be used within the URL, except as part of an IP address (10.105.*.*).

Load management policy settings
May 22, 20 17
T he Load Management section contains policy settings for enabling and conguring load management between servers
delivering Windows Server OS machines.
For information about calculating the load evaluator index, see CT X202150.
Concurrent logon tolerance
T his setting species the maximum number of concurrent logons a server can accept.
By default, this is set to 2.
CPU usage
T his setting species the level of CPU usage, as a percentage, at which the server reports a full load. When enabled, the
default value at which the server reports a full load is 90%.
By default, this setting is disabled and CPU usage is excluded from load calculations.
CPU usage excluded process priority
T his setting species the priority level at which a process' CPU usage is excluded from the CPU Usage load index.
By default, this is set to Below Normal or Low.
Disk usage
T his setting species the disk queue length at which the server reports a 75% full load. When enabled, the default value for
disk queue length is 8.
By default, this setting is disabled and disk usage is excluded from load calculations.
Maximum number of sessions
T his setting species the maximum number of sessions a server can host. When enabled, the default setting for maximum
number of sessions a server can host is 250.
Memory usage
T his setting species the level of memory usage, as a percentage, at which the server reports a full load. When enabled, the
default value at which the server reports a full load is 90%.
By default, this setting is disabled and memory usage is excluded from load calculations.
Memory usage base load
T his setting species an approximation of the base operating system's memory usage and denes, in MB, the memory
usage below which a server is considered to have zero load.
By default, this is set to 768 MB.

Prole management policy settings
May 22, 20 17
T he Prole Management section contains policy settings for enabling prole management and specifying which groups to
include in and exclude from prole management processing.
Other information (such as the names of the equivalent .ini le settings and which version of prole management is required
for a policy setting) is available in Prole Management Policies.

Advanced policy settings
May 22, 20 17
T he Advanced settings section contains policy settings relating to the advanced conguration of Prole management.
Disable automatic conguration
T his setting enables prole management to examine your environment, for example, to check for the presence of Personal
vDisks and congure Group Policy accordingly. Only Prole management policies in the Not Congured state are adjusted,
so any customizations made previously are preserved. T his feature speeds up deployment and simplies optimization. No
conguration of the feature is necessary, but you can disable automatic conguration when upgrading (to retain settings
from earlier versions) or when troubleshooting. Automatic conguration does not work in XenApp or other environments.
By default, automatic conguration is allowed.
If this setting is not congured here, the value from the .ini le is used.
If this setting is not congured here or in the .ini le, automatic conguration is turned on so Prole management settings
might change if your environment changes.
Log of f user if a problem is encountered
T his setting enables Prole management to log a user off if a problem is encountered; for example, if the user store is
unavailable. When enabled, an error message is displayed to the user before they are logged off. When disabled, users are
given a temporary prole.
By default, this setting is disabled and users are given a temporary prole if a problem is encountered.
If this setting is not congured here or in the .ini le, a temporary prole is provided.
Number of retries when accessing locked les
T his setting species the number of attempts Prole management makes to access locked les.
By default, this is set to ve retries.
If this setting is not congured here or in the .ini le, the default value is used.
Process Internet cookie les on logof f
T his setting enables Prole management to process index.dat on logoff to remove Internet cookies left in the le system
after sustained browsing that can lead to prole bloat. Enabling this setting increases logoff times, so only enable it if you
experience this issue.
By default, this setting is disabled and Prole management does not process index.dat on logoff.
If this setting is not congured here or in the .ini le, no processing of Index.dat takes place.

Basic policy settings
May 22, 20 17
T he Basic settings section contains policy settings relating to the basic conguration of Prole management.
Active write back
T his setting enables modied les and folders (but not registry settings) to be synchronized to the user store during a
session, before logoff.
By default, synchronization to the user store during a session is disabled.
If this setting is not congured here or in the .ini le, it is enabled.
Enable Prole management
T his setting enables Prole management to process logons and logoffs.
By default, this is setting is disabled to facilitate deployment.
Important: Citrix recommends enabling Profile management only after carrying out all other setup tasks and testing how
Citrix user profiles perform in your environment.
If this setting is not congured here or in the .ini le, Prole management does not process Windows user proles in any
way.
Excluded groups
T his setting species which computer local groups and domain groups (local, global, and universal) are excluded from Prole
management processing.
When enabled, Prole management does not process members of the specied user groups.
By default, this setting is disabled and members of all user groups are processed.
Specify domain groups in the form <DOMAIN NAME>\<GROUP NAME>.
If this setting is not congured here, the value from the .ini le is used .
If this setting is not congured here or in the .ini le, members of all user groups are processed.
Of ine prole support
T his setting enables ofine prole support, allowing proles to synchronize with the user store at the earliest opportunity
after a network disconnection.
By default, support for ofine proles is disabled.
T his setting is applicable to laptop or mobile users who roam. When a network disconnection occurs, proles remain intact
on the laptop or device even after restarting or hibernating. As mobile users work, their proles are updated locally and are

synchronized with the user store when the network connection is re-established.
If this setting is not congured here or in the .ini le, support for ofine proles is disabled.
Path to user store
T his setting species the path to the directory (user store) in which user settings, such as registry settings and synchronized
les, are saved.
By default, the Windows directory on the home drive is used.
If this setting is disabled, user settings are saved in the Windows subdirectory of the home directory.
T he path can be:

A relative path.T his must be relative to the home directory, typically configured as the #homeDirectory# attribute for a
user in Active Directory.
An absolute UNC path. T his typically specifies a server share or a DFS namespace.
Disabled or unconf igured. In this case, a value of #homeDirectory#\Windows is assumed.
Use the following types of variables when configuring this policy setting:
System environment variables enclosed in percent signs (for example, %ProfVer%). Note that system environment
variables generally require additional setup.
Attributes of the Active Directory user object enclosed in hashes (for example, #sAMAccountName#).
Profile management variables. For more information, see the Profile management documentation.
You can also use the %username% and %userdomain% user environment variables and create custom attributes to fully
dene organizational variables such as location or users. Attributes are case-sensitive.
Examples:
\\server\share\#sAMAccountName# stores the user settings to the UNC path \\server\share\JohnSmith (if
#sAMAccountName# resolves to JohnSmith for the current user)
\\server\profiles$\%USERNAME%.%USERDOMAIN%\!CT X_PROFILEVER!!CT X_OSBIT NESS! might expand to
\\server\profiles$\JohnSmith.DOMAINCONT ROLLER1\v2x64
Important: Whichever attributes or variables you use, check that this setting expands to the folder one level higher than
the folder containing NT USER.DAT . For example, if this file is contained in
\\server\profiles$\JohnSmith.Finance\v2x64\UPM_Profile, set the path to the user store as
\\server\profiles$\JohnSmith.Finance\v2x64, not the \UPM_Profile subfolder.
If this setting is not congured here or in the .ini le, the Windows directory on the home drive is used.
Process logons of local administrators
T his setting species whether or not logons of members of the BUILT IN\Administrators group are processed. T his allows
domain users with local administrator rights, typically users with assigned virtual desktops, to bypass processing, log on, and
troubleshoot a desktop experiencing problems with Prole management.
If this setting is disabled or not congured on server operating systems, Prole management assumes that logons by
domain users, but not local administrators, must be processed. On desktop operating systems, local administrator logons

are processed.
By default this setting is disabled, and local administrator logons are not processed.
If this setting is not congured here or in the .ini le, local administrator logons are not processed.
Processed groups
T his setting species which computer local groups and domain groups (local, global, and universal) are included in Prole
When enabled, Prole management processes only members of the specied user groups.
By default, this setting is disabled and members of all user groups are processed.
Specify domain groups in the form <DOMAIN NAME>\<GROUP NAME>.
If this setting is not congured here or in the .ini le, members of all user groups are processed.

Cross-platform policy settings
May 22, 20 17
T he Cross-Platform section contains policy settings relating to conguring the Prole management cross-platform settings
feature.
Cross-platf orm settings user groups
T his setting species the Windows user groups whose proles are processed when the cross-platform settings feature is
enabled.
By default, this setting is disabled and all user groups specied in the Processed Group policy setting are processed.
If this setting is not congured here or in the .ini le, all user groups are processed.
Enable cross-platf orm settings
T his setting enables or disables the cross-platforms settings feature, that allows you to migrate users' proles and roam
them when a user connects to the same application running on multiple operating systems.
By default the cross-platform settings feature is disabled.
If this setting is not congured here or in the .ini le, no cross-platform settings are applied.
Path to cross-platf orm denitions
T his setting species the network location, as a UNC path, of the denition les copied from the download package.
Note: Users must have read access, and administrators write access, to this location and it must be either a Server Message
Block (SMB) or Common Internet File System (CIFS) file share.
By default, no path is specied.
If this setting is not congured here or in the .ini le, no cross-platform settings are applied.
Path to cross-platf orm settings store
T his setting species the path to the cross-settings store, the folder in which users' cross-platform settings are saved. T his
path can be either a UNC path or a path relative to the home directory.
Note: Users must have write access to the cross-settings store.

By default, this setting is disabled and the path Windows\PM_CP is used.
Source f or creating cross-platf orm settings

T his setting species a platform as the base platform if this setting is enabled for that platform's OU. Data from the base
platform's proles is migrated to the cross-platform settings store.
Each platform's own set of proles are stored in a separate OU. T his means you must decide which platform's prole data
to use to seed the cross-platform settings store. T his is referred to as the base platform.
When enabled, Prole management migrates the data from the single-platform prole to the store if the cross-platform
settings store contains a denition le with no data, or if the cached data in a single-platform prole is newer than the
denition's data in the store.
Important: If this setting is enabled in multiple OUs, or multiple user or machine objects, the platform that the first user logs
on to becomes the base profile.
By default, this setting is disabled and Prole management does not migrate the data from the single-platform prole to
the store.

File system policy settings
May 22, 20 17
T he File System section contains policy settings for conguring which les and directories in a users prole are synchronized
between the system where the prole is installed and the user store.

Exclusions policy settings
May 22, 20 17
T he Exclusions section contains policy settings for conguring which les and directories in a users prole are excluded from
the synchronization process.
Exclusion list - directories
T his setting species a list of folders in the user prole that are ignored during synchronization.
Specify folder names as paths relative to the user prole (%USERPROFILE%).
By default, this setting is disabled and all folders in the user prole are synchronized.
Example: Desktop ignores the Desktop folder in the user prole
If this setting is not congured here or in the .ini le, all folders in the user prole are synchronized.
Exclusion list - les
T his setting species a list of les in the user prole that are ignored during synchronization.
By default, this setting is disabled and all les in the user prole are synchronized.
Specify le names as paths relative to the user prole (%USERPROFILE%). Note that wildcards are allowed and are applied
recursively.
Example: Desktop\Desktop.ini ignores the le Desktop.ini in the Desktop folder
If this setting is not congured here or in the .ini le, all les in the user prole are synchronized.

Synchronization policy settings
May 22, 20 17
T he Synchronization section contains policy settings for specifying which les and folders in a users prole are synchronized
between the system on which the prole is installed and the user store.
Directories to synchronize
T his setting species any les you want Prole management to include in the synchronization process that are located in
excluded folders. By default, Prole management synchronizes everything in the user prole. It is not necessary to include
subfolders of the user prole by adding them to this list. For more information, see Include and exclude items.
Paths on this list must be relative to the user prole.
Example: Desktop\exclude\include ensures that the subfolder called include is synchronized even if the folder called
Desktop\exclude is not
By default, this setting is disabled and no folders are specied.
If this setting is not congured here or in the .ini le, only non-excluded folders in the user prole are synchronized.
Files to synchronize
T his setting species any les you want Prole management to include in the synchronization process that are located in
excluded folders. By default, Prole management synchronizes everything in the user prole. It is not necessary to include
les in the user prole by adding them to this list. For more information, see Include and exclude items.
Paths on this list must be relative to the user prole. Relative paths are interpreted as being relative to the user prole.
Wildcards can be used but are allowed only for le names. Wildcards cannot be nested and are applied recursively.
Examples:
AppData\Local\Microsoft\Office\Access.qat specifies a file below a folder that is excluded in the default configuration
AppData\Local\MyApp\*.cfg specifies all files with the extension .cfg in the profile folder AppData\Local\MyApp and its
subfolders
By default, this setting is disabled and no les are specied.
If this setting is not congured here or in the .ini le, only non-excluded les in the user prole are synchronized.
Folders to mirror
T his setting species which folders relative to a user's prole root folder to mirror. Conguring this policy setting can help
solve issues involving any transactional folder (also known as a referential folder), that is a folder containing interdependent
les, where one le references others.
Mirroring folders allows Prole management to process a transactional folder and its contents as a single entity, avoiding
prole bloat. Be aware that, in these situations the "last write wins" so les in mirrored folders that have been modied in
more than one session will be overwritten by the last update, resulting in loss of prole changes.

For example, you can mirror the Internet Explorer cookies folder so that Index.dat is synchronized with the cookies that it
indexes.
If a user has two Internet Explorer sessions, each on a different server, and they visit different sites in each session, cookies
from each site are added to the appropriate server. When the user logs off from the rst session (or in the middle of a
session, if the active write back feature is congured), the cookies from the second session should replace those from the
rst session. However, instead they are merged, and the references to the cookies in Index.dat become out of date.
Further browsing in new sessions results in repeated merging and a bloated cookie folder.
Mirroring the cookie folder solves the issue by overwriting the cookies with those from the last session each time the user
logs off so Index.dat stays up to date.
By default, this setting is disabled and no folders are mirrored.
If this policy is not congured here or in the .ini le, no folders are mirrored.

Folder redirection policy settings
May 22, 20 17
T he Folder Redirection section contains policy settings that specify whether to redirect folders that commonly appear in
proles to a shared network location.
Grant administrator access
T his setting enables an administrator to access the contents of a user's redirected folders.
By default, this setting is disabled and users are granted exclusive access to the contents of their redirected folders.
Include domain name
T his setting enables the inclusion of the %userdomain% environment variable as part of the UNC path specied for
redirected folders.
By default, this setting is disabled and the %userdomain% environment variable is not included as part of the UNC path
specied for redirected folders.

AppData(Roaming) policy settings
May 22, 20 17
T he AppData(Roaming) section contains policy settings for specifying whether to redirect the contents the
AppData(Roaming) folder to a shared network location.
AppData(Roaming) path
T his setting species the network location to which the contents of the AppData(Roaming) folder are redirected.
By default, this setting is disabled and no location is specied.
If this setting is not congured here, Prole management does not redirect the specied folder.
Redirection settings f or AppData(Roaming)
T his setting species how to redirect the contents of the AppData(Roaming) folder.
By default, contents are redirected to a UNC path.

Contacts policy settings
May 22, 20 17
T he Contacts section contains policy settings for specifying whether to redirect the contents the Contacts folder to a
shared network location.
Contacts path
T his setting species the network location to which the contents of the Contacts folder are redirected.
Redirection settings f or Contacts
T his setting species how to redirect the contents of the Contacts folder.

Desktop policy settings
May 22, 20 17
T he Desktop section contains policy settings for specifying whether to redirect the contents the Desktop folder to a
Desktop path
T his setting species the network location to which the contents of the Desktop folder are redirected.
Redirection settings f or Desktop
T his setting species how to redirect the contents of the Desktop folder.

Documents policy settings
May 22, 20 17
T he Documents section contains policy settings for specifying whether to redirect the contents the Documents folder to
a shared network location.
Documents path
T his setting species the network location to which les in the Documents folder are redirected.
T he Documents path setting must be enabled not only to redirect les to the Documents folder, but also to redirect les
to the Music, Pictures, and Videos folders.
Redirection settings f or Documents
T his setting species how to redirect the contents of the Documents folder.
T o control how to redirect the contents of the Documents folder, choose one of the following options:
Redirect to the following UNC path. Redirects content to the UNC path specified in the Documents path policy setting.
Redirect to the users home directory. Redirects content to the users home directory, typically configured as the
#homeDirectory# attribute for a user in Active Directory.

Downloads policy settings
May 22, 20 17
T he Downloads section contains policy settings that specify whether to redirect the contents the Downloads folder to a
Downloads path
T his setting species the network location to which les in the Downloads folder are redirected.
Redirection settings f or Downloads
T his setting species how to redirect the contents of the Downloads folder.

Favorites policy settings
May 22, 20 17
T he Favorites section contains policy settings that specify whether to redirect the contents the Favorites folder to a
Favorites path
T his setting species the network location to which the contents of the Favorites folder are redirected.
Redirection settings f or Favorites
T his setting species how to redirect the contents of the Favorites folder.

Links policy settings
May 22, 20 17
T he Links section contains policy settings that specify whether to redirect the contents the Links folder to a shared
network location.
Links path
T his setting species the network location to which the contents of the Links folder are redirected.
Redirection settings f or Links
T his setting species how to redirect the contents of the Links folder.

Music policy settings
May 22, 20 17
T he Music section contains policy settings that specify whether to redirect the contents the Music folder to a shared
network location.
Music path
T his setting species the network location to which the contents of the Music folder are redirected.
Redirection settings f or Music
T his setting species how to redirect the contents of the Music folder.
T o control how to redirect the contents of the Music folder, choose one of the following options:
Redirect to the following UNC path. Redirects content to the UNC path specified in the Music path policy setting.
Redirect relative to Documents folder. Redirects content to a folder relative to the Documents folder.
To redirect content to a folder relative to the Documents folder, the Documents path setting must be enabled.

Pictures policy settings
May 22, 20 17
T he Pictures section contains policy settings that specify whether to redirect the contents the Pictures folder to a shared
network location.
Pictures path
T his setting species the network location to which the contents of the Pictures folder are redirected.
Redirection settings f or Pictures
T his setting species how to redirect the contents of the Pictures folder.
T o control how to redirect the contents of the Pictures folder, choose one of the following options:
Redirect to the following UNC path. Redirects content to the UNC path specified in the Pictures path policy setting.

Saved Games policy settings
May 22, 20 17
T he Saved Games section contains policy settings that specify whether to redirect the contents the Saved Games folder
to a shared network location.
Redirection settings f or Saved Games
T his setting species how to redirect the contents of the Saved Games folder.
Saved Games path
T his setting species the network location to which the contents of the Saved Games folder are redirected.

Searches policy settings
May 22, 20 17
T he Searches section contains policy settings that specify whether to redirect the contents the Searches folder to a
Redirection settings f or Searches
T his setting species how to redirect the contents of the Searches folder.
Searches path
T his setting species the network location to which the contents of the Searches folder are redirected.

Start menu policy settings
May 22, 20 17
T he Start Menu section contains policy settings that specify whether to redirect the contents the Start Menu folder to a
Redirection settings f or Start Menu
T his setting species how to redirect the contents of the Start Menu folder.
Start Menu path
T his setting species the network location to which the contents of the Start Menu folder are redirected.

Video policy settings
May 22, 20 17
T he Video section contains policy settings that specify whether to redirect the contents the Video folder to a shared
network location.
Redirection settings f or Video
T his setting species how to redirect the contents of the Video folder.
T o control how to redirect the contents of the Video folder, choose one of the following options:
Redirect to the following UNC path. Redirects content to the UNC path specified in the Video path policy setting.
Video path
T his setting species the network location to which the contents of the Video folder are redirected.

Log policy settings
May 22, 20 17
T he Log section contains policy settings that congure Prole management logging.
Active Directory actions
T his setting enables or disables verbose logging of actions performed in Active Directory.
When enabling this setting, make sure the Enable logging setting is also enabled.
If this setting is not congured here or in the .ini le, errors and general information are logged.
Common inf ormation
T his setting enables or disables verbose logging of common information.
Common warnings
T his setting enables or disables verbose logging of common warnings.
Enable logging
T his settings enables or disables Prole management logging in debug (verbose logging) mode. In debug mode, extensive
status information is logged in the log les located in "%SystemRoot%\System32\Logles\UserProleManager".
By default, this setting is disabled and only errors are logged.
Citrix recommends enabling this setting only if you are troubleshooting Prole management.
If this setting is not congured here or in the .ini le, only errors are logged.

File system actions
T his setting enables or disables verbose logging of actions performed in the le system.
File system notications
T his setting enables or disables verbose logging of le systems notications.
Logof f
T his setting enables or disables verbose logging of user logoffs.
Logon
T his setting enables or disables verbose logging of user logons.
Maximum size of the log le
T his setting species the maximum permitted size for the Prole management log le, in bytes.
By default, this is set to 1048576 bytes (1MB).
Citrix recommends increasing the size of this le to 5 MB or more, if you have sufcient disk space. If the log le grows
beyond the maximum size, an existing backup of the le (.bak) is deleted, the log le is renamed to .bak, and a new log le is

created.
T he log le is created in %SystemRoot%\System32\Logles\UserProleManager.
Path to log le
T his setting species an alternative path to save the Prole management log le.
By default, this setting is disabled and log les are saved in the default location:
%SystemRoot%\System32\Logles\UserProleManager.
T he path can point to a local drive or a remote network-based drive (UNC path). Remote paths can be useful in large
distributed environments but they may create signicant network trafc, which may be inappropriate for log les. For
provisioned, virtual machines with a persistent hard drive, set a local path to that drive. T his ensures log les are preserved
when the machine restarts. For virtual machines without a persistent hard drive, setting a UNC path allows you to retain the
log les, but the system account for the machines must have write access to the UNC share. Use a local path for any
laptops managed by the ofine proles feature.
If a UNC path is used for log les, Citrix recommends that an appropriate access control list is applied to the log le folder
to ensure that only authorized user or computer accounts can access the stored les.
If this setting is not congured here or in the .ini le, the default location
%SystemRoot%\System32\Logles\UserProleManager is used.
Personalized user inf ormation
T his setting enables or disables verbose logging of personalized user information.
Policy values at logon and logof f
T his setting enables or disables verbose logging of policy values when a user logs on and off.
Registry actions

T his setting enables or disables verbose logging of actions performed in the registry.
Registry dif f erences at logof f
T his setting enables or disables verbose logging of any differences in the registry when a user logs off.

Prole handling policy settings
May 22, 20 17
T he Prole handling section contains policy settings that specify how Prole management handles user proles.
Delay bef ore deleting cached proles
T his setting species an optional extension to the delay, in minutes, before Prole management deletes locally cached
proles at logoff.
A value of 0 deletes the proles immediately at the end of the logoff process. Prole management checks for logoffs every
minute, so a value of 60 ensures that proles are deleted between one and two minutes after users log off (depending on
when the last check occurred). Extending the delay is useful if you know that a process keeps les or the user registry hive
open during logoff. With large proles, this can also speed up logoff.
By default, this is set to 0 and Prole management deletes locally cached proles immediately.
When enabling this setting, ensure the Delete locally cached proles on logoff is also enabled.
If this setting is not congured here or in the .ini le, proles are deleted immediately.
Delete locally cached proles on logof f
T his setting species whether locally cached proles are deleted after a user logs off.
When this setting is enabled, a user's local prole cache is deleted after they have logged off. Citrix recommends enabling
this setting for terminal servers.
By default, this setting is disabled and a users local prole cache is retained after they log off.
If this setting is not congured here or in the .ini le, cached proles are not deleted.
Local prole conict handling
T his setting congures how Prole management behaves if a user prole exists both in the user store and as a local
Windows user prole (not a Citrix user prole).
By default, Prole management uses the local Windows prole, but does not change it in any way.
T o control how Profile management behaves, choose one of the following options:
Use local profile. Profile management uses the local profile, but does not change it in any way.
Delete local profile. Profile management deletes the local Windows user profile, and then imports the Citrix user profile
from the user store.
Rename local profile. Profile management renames the local Windows user profile (for backup purposes) and then
imports the Citrix user profile from the user store.

If this setting is not congured here or in the .ini le, existing local proles are used.
Migration of existing proles
T his setting species the types of prole migrated to the user store during logon if a user has no current prole in the user
store.
Prole management can migrate existing proles "on the y" during logon if a user has no prole in the user store. After
this, the user store prole is used by Prole management in both the current session and any other session congured with
the path to the same user store.
By default, both local and roaming proles are migrated to the user store during logon.
T o specifies the types of profile migrated to the user store during logon, choose one of the following options:
Local and roaming profiles
Local
Roaming
None (Disabled)
If you select None, the system uses the existing Windows mechanism to create new proles, as if in a environment where
Prole management is not installed.
If this setting is not congured here or in the .ini le, existing local and roaming proles are migrated.
Path to the template prole
T his setting species the path to the prole you want Prole management to use as a template to create new user
proles.
T he specified path must be the full path to the folder containing the NT USER.DAT registry file and any other folders and
files required for the template profile.
Note: Do not include NT USER.DAT in the path. For example, with the file \\myservername\myprofiles\template\ntuser.dat,
set the location as \\myservername\myprofiles\template.
Use absolute paths, which can be either UNC paths or paths on the local machine. Use the latter, for example, to specify a
template prole permanently on a Citrix Provisioning Services image. Relative paths are not supported.
Note: T his setting does not support expansion of Active Directory attributes, system environment variables, or the
%USERNAME% and %USERDOMAIN% variables.
By default, this setting is disabled and new user proles are created from the default user prole on the device where a user
rst logs on.
If this setting is not congured here or in the .ini le, no template is used.
Template prole overrides local prole
T his setting enables the template prole to override the local prole when creating new user proles.
If a user has no Citrix user prole, but a local Windows user prole exists, by default the local prole is used (and migrated to
the user store, if this is not disabled). Enabling this policy setting allows the template prole to override the local prole used

when creating new user proles.
Template prole overrides roaming prole
T his setting enables the template prole to override a roaming prole when creating new user proles.
If a user has no Citrix user prole, but a roaming Windows user prole exists, by default the roaming prole is used (and
migrated to the user store, if this is not disabled). Enabling this policy setting allows the template prole to override the
roaming prole used when creating new user proles.
Template prole used as a Citrix mandatory prole f or all logons
T his setting enables Prole management to use the template prole as the default prole for creating all new user proles.
By default, this setting is disabled and new user proles are created from the default user prole on the device where a user
rst logs on.

Registry policy settings
May 22, 20 17
T he Registry section contains policy settings that specify which registry keys are included or excluded from Prole
Exclusion list
T his setting species the list of registry keys in the HKCU hive excluded from Prole management processing when a user
logs off.
When enabled, keys specied in this list are excluded from processing when a user logs off.
By default, this setting is disabled, and all registry keys in the HKCU hive are processed when a user logs off.
If this setting is not congured here or in the .ini le, no registry keys are excluded from processing.
Inclusion list
T his setting species the list of registry keys in the HKCU hive included in Prole management processing when a user logs
off.
When enabled, only keys specied in this list are processed when a user logs off.
By default, this setting is disabled, and all registry keys in the HKCU hive are processed when a user logs off.
If this setting is not congured here or in the .ini le, all of HKCU is processed .

Streamed user proles policy settings
May 22, 20 17
T he Streamed user proles section contains policy settings that specify how Prole management processes streamed user
proles.
Always cache
T his setting species whether or not Prole management caches streamed les as soon as possible after a user logs on.
Caching les after a user logs on saves network bandwidth, enhancing the user experience.
Use this setting with the Prole streaming setting.
By default, this setting is disabled and streamed les are not cached as soon as possible after a user logs on.
If this setting is not congured here or in the .ini le, it is disabled.
Always cache size
T his setting species a lower limit, in megabytes, on the size of les that are streamed. Prole management caches any les
this size or larger as soon as possible after a user logs on.
By default, this is set to 0 (zero) and the cache entire prole feature is used. When the cache entire prole feature is
enabled, Prole management fetches all prole contents in the user store, after a user logs on, as a background task.
Prole streaming
T his setting enables and disables the Citrix streamed user proles feature. When enabled, les and folders contained in a
prole are fetched from the user store to the local computer only when they are accessed by users after they have logged
on. Registry entries and les in the pending area are fetched immediately.
By default, prole streaming is disabled.
Streamed user prole groups
T his setting species which user proles within an OU are streamed, based on Windows user groups.
When enabled, only user proles within the specied user groups are streamed. All other user proles are processed
normally.
By default, this setting is disabled and all user proles within an OU are processed normally.

If this setting is not congured here or in the .ini le, all user proles are processed.
To enable prole streaming exclusion
When prole streaming exclusion is enabled, Prole Management does not stream folders in the exclusion list, and all the
folders are fetched immediately from the user store to the local computer when a user logs on.
For more information, see To enable prole streaming exclusion.
Timeout f or pending area lock les
T his setting species the number of days after which users' les are written back to the user store from the pending area,
in the event that the user store remains locked when a server becomes unresponsive. T his prevents bloat in the pending
area and ensures the user store always contains the most up-to-date les.
By default, this is set to 1 (one) day.

Receiver policy settings
May 22, 20 17
Note: Unless otherwise noted, "Receiver" refers to Citrix Receiver.
T he Receiver section contains policy settings that specify a list of StoreFront addresses to push to Citrix Receiver for
Windows running on the virtual desktop.
StoreFront accounts list
T his settings species a list of StoreFront stores administrators can choose to push to Citrix Receiver for Windows running
on the virtual desktop. When creating a Delivery Group, administrators can select which stores to push to Citrix Receiver for
Windows running on virtual desktops within that group.
By default, no stores are specied.
For each store, specify the following information as a semicolon-delimited entry:

Store name. T he name displayed to users of the store.
Store URL. T he URL for the store.
Store enabled state. Whether or not the store is available to users. T his is either On or Off.
Store description. T he description displayed to users of the store.
For example: Sales Store;https://sales.mycompany.com/Citrix/Store/discovery;On;Store for Sales staff

Virtual Delivery Agent policy settings
May 22, 20 17
T he Virtual Delivery Agent (VDA) section contains policy settings that control communication between the VDA and
controllers for a site.
Important: T he VDA requires information provided by these settings to register with a Delivery Controller, if you are not
using the auto-update feature. Because this information is required for registration, you must configure the following
settings using the Group Policy Editor, unless you provide this information during the VDA installation:
Controller registration IPv6 netmask
Controller registration port
Controller SIDs
Controllers
Only use IPv6 controller registration
Site GUID
Controller registration IPv6 netmask
T his policy setting allows administrators to restrict the VDA to only a preferred subnet (rather than a global IP, if one is
registered). T his setting species the IPv6 address and network where the VDA will register. T he VDA will register only on
the rst address that matches the specied netmask. T his setting is valid only if the Only use IPv6 controller registration
policy setting is enabled.
By default this setting is blank.
Controller registration port
Use this setting only if the Enable auto update of controllers setting is disabled.
T his setting species the TCP/IP port number the VDA uses to register with a Controller when using registry-based
registration.
Controller SIDs
T his setting species a space-separated list of controller Security Identiers (SIDs) the VDA uses to register with a
Controller when using registry-based registration. T his is an optional setting which may be used with the Controllers setting
to restrict the list of Controllers used for registration.
By default, this setting is blank.
Controllers
T his setting species a space-separated list of controller Fully Qualied Domain Names (FQDNs) the VDA uses to register
with a Controller when using registry-based registration. T his is an optional setting that may be used with the Controller
SIDs setting.

Enable auto update of controllers
T his setting enables the VDA to register with a Controller automatically after installation.
After the VDA registers, the Controller with which it registered sends a list of the current controller FQDNs and SIDs to the
VDA. T he VDA writes this list to persistent storage. Each Controller also checks the Site database every 90 minutes for
Controller information; if a Controller has been added or removed since the last check, or if a policy change has occurred,
the Controller sends updated lists to its registered VDAs. T he VDA will accept connections from all the Controllers in the
most recent list it received.
Only use IPv6 controller registration
T his setting controls which form of address the VDA uses to register with the Controller:
When enabled, the VDA registers with the Controller using the machine's IPv6 address. When the VDA communicates
with the Controller, it uses the following address order: global IP address, Unique Local Address (ULA), link-local address (if
no other IPv6 addresses are available).
When disabled, the VDA registers and communicates with the Controller using the machine's IPv4 address.
By default, this is setting is disabled.
Site GUID
T his setting species the Globally Unique Identier (GUID) of the site the VDA uses to register with a Controller when using
Active Directory-based registration.

HDX 3D Pro policy settings
May 22, 20 17
T he HDX 3D Pro section contains policy settings for enabling and conguring the image quality conguration tool for users.
T he tool enables users to optimize use of available bandwidth by adjusting in real time the balance between image quality
and responsiveness.
Enable lossless
T his setting species whether or not users can enable and disable lossless compression using the image quality
conguration tool. By default, users are not given the option to enable lossless compression.
When a user enables lossless compression, the image quality is automatically set to the maximum value available in the
image conguration tool. By default, either GPU or CPU-based compression can be used, according to the capabilities of
the user device and the host computer.
HDX 3D Pro quality settings
T his setting species the minimum and maximum values that dene the range of image quality adjustment available to users
in the image quality conguration tool.
Specify image quality values of between 0 and 100, inclusive. T he maximum value must be greater than or equal to the
minimum value.

Monitoring policy settings
May 22, 20 17
T he Monitoring section contains policy settings for process, resource monitoring, and application failure monitoring.
T he scope of these policies can be dened based on the Site, Delivery Group, type of Delivery Group, organizational unit,
and tags.
Policies for process and resource monitoring

Each data point for CPU, memory, and processes is collected from the VDA and stored on the Monitoring database.
Sending the data points from the VDA to the monitoring database consumes network bandwidth. If you do not want to
monitor either resource data or process data or both for a specic scope (for example, a specic delivery group or
organizational unit), it is recommended to disable the policy.
Enable process monitoring
Enable this setting to allow monitoring of processes running on machines with VDAs. Statistics such as CPU and memory
use are sent to the Monitoring Service. T he statistics are used for real-time notications and historical reporting in Director.
T he default for this setting is Disabled.
Enable resource monitoring
Enable this setting to allow monitoring of critical performance counters on machines with VDAs. Statistics (such as CPU and
memory use, IOPS and disk latency data) are sent to the Monitoring Service. T he statistics are used for real-time
notication and historical reporting in Director.
T he default for this setting is Enabled.
Note: T he Monitoring Group Policies - Enable monitoring of application f ailures, Enable monitoring of application
f ailures on Desktop OS VDAs, and Enable monitoring of application f ailures on Desktop OS VDAs are not functional
in XenApp and XenDesktop version 7.14.
Scalability
T he CPU and memory data is pushed to the database from each VDA at 5-minute intervals; process data (if enabled) is
pushed to the database at 10-minute intervals. IOPS and disk latency data is pushed to the database at 1-hour intervals.
CPU and memory data
CPU and memory data is enabled by default. T he data retention values are as follows (Platinum license):
Data granularity Number of Days
5 Minute Data 1 Day
10 Minute Data 7 Days

Hourly Data 30 Days
Daily Data 90 Days
IOPS and disk latency data
IOPS and disk latency data is enabled by default. T he data retention values are as follows (Platinum license):
Hourly Data 3 Days
Daily Data 90 Days
With the data retention settings as above, approximately 276 KB of disk space is required to store the CPU, memory, IOPS
and disk latency data for one VDA over a period of one year.
Number of machines Approximate storage required
1 276 KB
1K 270 MB
40K 10.6 GB
Process data
Process data is disabled by default. It is recommended to enable process data on a subset of machines on a need basis.
T he default data retention settings for the process data is as follows:
10 minute Data 1 Day
Hourly Data 7 Days
If process data is enabled, with the default retention settings, process data would consume approximately 1.5 MB per VDA
and 3 MB per Terminal Services VDA (T S VDA) over a period of one year.
Number of machines Approximate storage required VDA Approximate storage required T S VDA

1 1.5 MB 3 MB
1K 1.5 GB 3 GB
Note
T he above numbers do not include the Index space. And all the above calculations are approximate and may vary depending on the
deployment.
Optional Congurations
You can modify the default retention settings to suit your needs. However, this consumes extra storage. By enabling the
settings below you can gain more accuracy in the process utilization data. T he congurations which can be enabled are:
EnableMinuteLevelGranularityProcessUtilization
EnableDayLevelGranularityProcessUtilization
T hese Congurations can be enabled from the Monitoring Powershell cmdlet: Set-MonitorConguration
Storage planning tips
Group policy. If you are not interested in monitoring the Resource Data or Process Data, either or both can be turned off
using the group policy. For more information, see the Group Policy section of Create policies.
Data grooming. T he default data retention settings can be modied to groom the data early and free up storage space.
For more information on grooming settings, see Data granularity and retention in Accessing data using the API.

Virtual IP policy settings
May 22, 20 17
T he Virtual IP section contains policy settings that control whether sessions have their own virtual loopback address.
Virtual IP loopback support
When this setting is enabled, each session has its own virtual loopback address. When disabled, sessions do not have
individual loopback addresses.
Virtual IP virtual loopback programs list
T his setting species the application executables that can use virtual loopback addresses. When adding programs to the
list, specify only the executable name; you do not need to specify the entire path.
By default, no executables are specied.

Congure COM Port and LPT Port Redirection settings
using the registry
May 22, 20 17
In VDA versions 7.0 through 7.8 COM Port and LPT Port settings are only congurable using the registry. For VDA versions
earlier than 7.0 and for VDA version 7.9, these settings are congurable in Studio. For more information, see Port redirection
policy settings and Bandwidth policy settings.
Policy settings for COM Port and LPT Port Redirection are located under
HKLM\Software\Citrix\GroupPolicy\Defaults\Deprecated on the VDA image or machine.
T o enable COM port and LPT port redirection, add new registry keys of type REG_DWORD, as follows:
Registry key Description Permitted values
AllowComPortRedirection Allow or prohibit COM port redirection 1 (Allow) or 0

(Prohibit)
LimitComBw Bandwidth limit for COM port redirection channel Numeric value
LimitComBWPercent Bandwidth limit for COM port redirection channel as a Numeric value
percentage of total session bandwidth between 0 and 100
AutoConnectClientComPorts Automatically connect COM ports from the user device 1 (Allow) or 0
(Prohibit)
AllowLptPortRedirection Allow or prohibit LPT port redirection 1 (Allow) or 0

(Prohibit)
LimitLptBw Bandwidth limit for LPT port redirection channel Numeric value
LimitLptBwPercent Bandwidth limit for LPT port redirection channel as a Numeric value
percentage of total session bandwidth between 0 and 100
AutoConnectClientLptPorts Automatically connect LPT ports from the user device 1 (Allow) or 0
(Prohibit)
After conguring these settings, modify your machine catalogs to use the new master image or updated physical machine.
Desktops are updated with the new settings the next time users log off.

Connector for Conguration Manager 2012 policy
settings
May 22, 20 17
T he Connector for Conguration Manager 2012 section contains policy settings for conguring the Citrix Connector 7.5
agent.
Important: Warning, logoff, and reboot message policies apply only to deployments to Server OS machine catalogs that are
managed manually or by Provisioning Services. For those machine catalogs, the Connector service alerts users when there
are pending application installs or software updates.
For catalogs managed by MCS, use Studio to notify users. For manually managed Desktop OS catalogs, use Conguration
Manager to notify users. For Desktop OS catalogs managed by Provisioning Services, use Provisioning Services to notify
users.
Advance warning f requency interval
T his setting denes the interval between appearances of the advance warning message to users.
Intervals are set using the format ddd.hh:mm:ss, where:

ddd is days, an optional parameter, with a range of 0 to 999.
hh is hours with a range of 0 to 23.
mm is minutes with a range of 0 to 59.
ss is seconds with a range of 0 to 59.
By default, the interval setting is 1 hour (01:00:00).
Advance warning message box body text
T his setting contains the editable text of the message to users notifying them of upcoming software updates or
maintenance that requires them to log off.
By default, the message is: {T IMESTAMP} Please save your work. T he server will go ofine for maintenance in {T IMELEFT }
Advance warning message box title
T his setting contains the editable text of the title bar of the advance warning message to users.
By default, the title is: Upcoming Maintenance
Advance warning time period
T his setting denes how far before maintenance the advance warning message rst appears.
T he time is set using the format ddd.hh:mm:ss, where:

By default, the setting is 16 hours (16:00:00), indicating that the rst advance warning message appears approximately 16

hours before maintenance.
Final f orce logof f message box body text
T his setting contains the editable text of the message alerting users that a forced logoff has begun.
By default, the message is: T he server is currently going ofine for maintenance
Final f orce logof f message box title
T his setting contains the editable text of the title bar of the nal force logoff message.
By default, the title is: Notication From IT Staff
Force logof f grace period
T his setting denes the period of time between notifying users to log off and the implementation of the forced logoff to
process the pending maintenance.

By default, the force logoff grace period setting is 5 minutes (00:05:00).
Force logof f message box body text
T his setting contains the editable text of the message telling users to save their work and log off prior to the start of a
forced logoff.
By default, the message contains the following: {T IMESTAMP} Please save your work and log off. T he server will go ofine
for maintenance in {T IMELEFT }
Force logof f message box title
T his setting contains the editable text of the title bar of the force logoff message.
By default, the title is: Notication From IT Staff
Image-managed mode
T he Connector agent automatically detects if it is running on a machine clone managed by Provisioning Services or MCS.
T he agent blocks Conguration Manager updates on image-managed clones and automatically installs the updates on the
master image of the catalog.
After a master image is updated, use Studio to orchestrate the reboot of MCS catalog clones. T he Connector Agent
automatically orchestrates the reboot of PVS catalog clones during Conguration Manager maintenance windows. To
override this behavior so that software is installed on catalog clones by Conguration Manager, change Image-managed
mode to Disabled.
Reboot message box body text

T his setting contains the editable text of the message notifying users when the server is about to be restarted.
By default, the message is: T he server is currently going ofine for maintenance
Regular time interval at which the agent task is to run
T his setting determines how frequently the Citrix Connector agent task runs.

By default, the regular time interval setting is 5 minutes (00:05:00).

Manage
May 22, 20 17
Managing a XenApp or XenDesktop site covers a variety of items and tasks.
Licensing
A valid connection to the Citrix License Server is required when you create a site. Later, you can complete several licensing
tasks from Studio, including adding licenses, changing license types or models, and managing license administrators. You can
also access the License Administration Console from Studio.
Applications
Manage applications in Delivery Groups and optionally, Application Groups.
Zones
In a geographically disperse deployment, you can use zones to keep applications and desktops closer to end users, which
can improve performance. When you install and congure a site, all Controllers, Machine Catalogs, and host connections are
in one primary zone. Later, you can use Studio to create satellite zones containing those items. After your site has more
than one zone, you will be able to indicate in which zone any newly-created Machine Catalogs, host connections, or added
Controllers will be placed. You can also move items between zones.
If you are using a hypervisor or cloud service to host machines that will deliver applications and desktops to users, you
create your rst connection to that hypervisor or cloud service when you create a site. T he storage and network details for
that connection form its resources. Later, you can change that connection and its resources, and create new connections.
You can also manage the machines that use a congured connection.
Local Host Cache
Local Host Cache allows connection brokering operations in a site to continue when the connection between a Delivery
Controller and the site database fails. It is the most comprehensive high availability feature Citrix offers for XenApp and
XenDesktop.
Connection leasing
Citrix recommends trying Local Host Cache instead of connection leasing. Local Host Cache is a more powerful alternative.
T he Microsoft virtual IP address feature provides a published application with a unique dynamically-assigned IP address for
each session. T he Citrix virtual loopback feature allows you to congure applications that depend on communications with
localhost (127.0.0.1 by default) to use a unique virtual loopback address in the localhost range (127.*).
T his article details considerations and procedures when adding and removing Controllers from a site. It also describes how
to move Controllers to another zone or site, and how to move a VDA to another site.

Before a VDA can facilitate delivery of applications and desktops, it must register (establish communication) with a
Controller. Controller addresses can be specied in several ways, which are described in this article. It is critical that VDAs
have current information as Controllers are added, moved, and removed in the site.
Sessions
Maintaining session activity is critical to providing the best user experience. Several features can optimize the reliability of
sessions, reduce inconvenience, downtime, and loss of productivity.
Session reliability
Auto Client Reconnect
ICA Keep-Alive
Workspace control
Session roaming
Using search in Studio
When you want to view information about machines, sessions, Machine Catalogs, applications, or Delivery Groups in Studio,
use the exible search feature.
Tags
Use tags to identify items such as machines, applications, groups, and policies. You can then tailor certain operations to
apply on to items with a specic tag.
IPv4 /IPv6
XenApp and XenDesktop supports pure IPv4, pure IPv6, and dual-stack deployments that use overlapping IPv4 and IPv6
networks. T his article describes and illustrates these deployments. It also describes the Citrix policy settings that control the
use of IPv4 or IPv6.
Client f older redirection
Client folder redirection changes the way client-side les are accessible on the host-side session. When you enable only
client drive mapping on the server, client-side full volumes are automatically mapped to the sessions as Universal Naming
Convention (UNC) links. When you enable client folder redirection on the server and the user congures it on the Windows
desktop device, the portion of the local volume specied by the user is redirected.
User proles
By default, Citrix Prole management is installed automatically when you install a VDA. If you use this prole solution,
review this article for general information and see the Prole management documentation for full details.
Citrix Insight Services (CIS) is a Citrix platform for instrumentation, telemetry, and business insight generation.

Licensing
May 22, 20 17
Note
Studio and Director do not support Citrix License Server VPX. For more information about Citrix License Server VPX, see the Citrix
Licensing documentation.
From Studio, you can manage and track licensing, if the license server is in the same domain as Studio or in a trusted domain.
For information about other licensing tasks, see the licensing documentation and Multi-type licensing.
You must be a full license administrator to complete the tasks described below, except for viewing license information. To
view license information in Studio, an administrator must have at least the Read Licensing Delegated Administration
permission; the built-in Full Administrator and Read-Only Administrator roles have that permission.
T he following table lists the supported editions and license models:
Products Editions License models
XenApp Platinum Concurrent

Enterprise
Advanced
XenDesktop Platinum User/Device

Enterprise Concurrent
App
VDI
To view license information, select Conguration > Licensing in the Studio navigation pane. A summary of license usage
and settings for the Site is displayed with a list of all the licenses currently installed on the specied license server.
To download a license from Citrix:
1. Select Conf iguration > Licensing in the Studio navigation pane.

2. Select Allocate Licenses in the Actions pane.
3. T ype the License Access Code, which is supplied in an email from Citrix.
4. Select a product and click Allocate Licenses. All the licenses available for that product are allocated and downloaded.
After you allocate and download all the licenses for a specific License Access Code, you cannot use that License Access
Code again. T o perform additional transactions with that code, log on to My Account.
To add licenses that are stored on your local computer or on the network:

2. Select Add Licenses in the Actions pane.
3. Browse to a license file and add it to the license server.

To change the license server:

2. Select Change License Server in the Actions pane.
3. T ype the address of the license server in the form name:port, where name is a DNS, NetBIOS, or IP address. If you do
not specify a port number, the default port (27000) is used.
To select the type of license to use:
When configuring the Site, after you specify the license server, you are prompted to select the type of license to use. If
there are no licenses on the server, the option to use the product for a 30-day trial period without a license is
automatically selected.
If there are licenses on the server, their details are displayed and you can select one of them. Or, you can add a license
file to the server and then select that one.
To change the product edition and licensing model:

2. Select Edit Product Edition in the Actions pane.
3. Update the appropriate options.
To access the License Administration Console, in the Actions pane, select License Administration Console. T he console
either appears immediately, or if the dashboard is congured as password-protected, you are prompted for License
Administration Console credentials. For details about how to use the console, see the licensing documentation.
To add a licensing administrator:

2. Select the Licensing Administrators tab in the middle pane.
3. Select Add licensing administrator in the Actions pane.
4. Browse to the user you want to add as an administrator and choose permissions.
To change a licensing administrator's permissions or delete a licensing administrator:

2. Select the Licensing Administrators tab in the middle pane and then select the administrator.
3. Select either Edit licensing administrator or Delete licensing administrator in the Actions pane.
To add a licensing administrator group:

2. Select the Licensing Administrators tab in the middle pane.
3. Select Add licensing administrator group in the Actions pane.
4. Browse to the group you want to act as licensing administrators and choose permissions. Adding an Active Directory
Group gives licensing administrator permissions to the users within that group.
To change a licensing administrator group's permissions or delete a licensing administrator group:

2. Select the Licensing Administrators tab in the middle pane and then select the administrator group.
3. Select either Edit licensing administrator group or Delete licensing administrator group in the Actions pane.

Multi-type licensing
May 22, 20 17
Multi-type licensing supports consumption of different license types for Delivery Groups on a single XenApp or XenDesktop
site. Type is a single combination of Product ID (XDT, MPS) and Model (UserDevice, Concurrent). T he Delivery Groups must
use the Product Edition set for the site.
If multi-type licensing is not congured, different license types can be used only when congured on entirely separate sites.
T he Delivery Groups use the site license.
To determine the Delivery Groups that consume the different types of licenses, use these Broker PowerShell cmdlets:
New-BrokerDesktopGroup
Set-BrokerDesktopGroup
Get-BrokerDesktopGroup
To install licenses, use:
Citrix Studio
Citrix Licensing Manager
License Administration Console
citrix.com
Subscription Advantage dates are specic to each license le and to each product and model. Delivery Groups set
differently might have different Subscription Advantage dates than each other.
Broker PowerShell SDK

T he DesktopGroup object has these two properties you can manipulate using the associated New-BrokerDesktopGroup
and Set-BrokerDesktopGroup cmdlets.
Name Value Restriction
An enum (Concurrent or UserDevice) specifying the licensing model If the feature toggle is disabled, attempting to
LicenseModel
for the group. set either property fails.
A text string of XDT (for XenDesktop) or MPS (for XenApp) specifying If the feature toggle is disabled, attempting to
ProductCode
the licensing Product ID for the group. set either property fails.
New-BrokerDesktopGroup
Creates a desktop group for managing the brokering of groups of desktops. For more information on this cmdlet, see
https://citrix.github.io/delivery-controller-sdk/Broker/New-BrokerDesktopGroup/.
Set-BrokerDesktopGroup
Disables or enables an existing broker desktop group or alters its settings. For more information on this cmdlet, see
https://citrix.github.io/delivery-controller-sdk/Broker/Set-BrokerDesktopGroup/
Get-BrokerDesktopGroup
Retrieves desktop groups matching the specied criteria. T he output of the Get-BrokerDesktopGroup cmdlet includes the
ProductCode and LicenseModel properties of the group. If the properties have not been set using New-
BrokerDesktopGroup or Set-BrokerDesktopGroup, null values are returned. If null, the site-wide license model and product
code is used. For more information on this cmdlet, see https://citrix.github.io/delivery-controller-sdk/Broker/Get-
BrokerDesktopGroup/.
Example
T his PowerShell cmdlet example illustrates setting multi-type licensing for two existing Delivery Groups and creates and sets
a third Delivery Group.
To see the license product and license model associated with a Delivery Group, use the Get-
BrokerDesktopGroup PowerShell cmdlet.
1. We set the first Delivery Group for XenApp and Concurrent.

Set-BrokerDesktopGroup -Name "Delivery Group f or XenApp Platinum Concurrent" -ProductCode MPS -
LicenseModel Concurrent
2. We set the second Delivery Group for XenDesktop and Concurrent.
Set-BrokerDesktopGroup -Name "Delivery Group f or XenDesktop Platinum Concurrent" -ProductCode XDT -
LicenseModel Concurrent
3. We create and set the third Delivery Group for XenDesktop and UserDevice.
New-BrokerDesktopGroup -Name "Delivery Group f or XenDesktop Platinum UserDevice" -PublishedName
"MyDesktop" -DesktopKind Private -ProductCode XDT -LicenseModel UserDevice

Special considerations
Multi-type licensing has different functionality than regular XenApp and XenDesktop licensing.
T here are no alerts and notifications from Director or Studio:

No information when nearing license limits or the trigger or expiry of the Supplemental Grace Period.
No notification if there is a problem with a specific group.
You publish an application on multiple Delivery Groups having different Licensing T ypes. Some of the Delivery Groups do
not license the application. T he application starts only on the Delivery Group machines set to the supported Licensing
T ypes. For example,
T he site is set to ProductCode XenDesktop and Edition Enterprise. Delivery Group1 inherits these settings, and you
set Delivery Group 2 to ProductCode XenApp and it inherits Edition Enterprise.
Start a single session application licensed for XenApp Enterprise but not for XenDesktop Enterprise. T he
application starts only on the Delivery Group 2 machines

Applications
May 22, 20 17
Introduction
If your deployment uses only Delivery Groups (and not Application Groups), you add applications to the Delivery Groups. If
you also have Application Groups, generally you should add applications to the Application Groups. T his guidance provides
easier administration. An application must always belong to at least one Delivery Group or Application Group.
In the Add Applications wizard, you can select one or more Delivery Groups, or one or more Application Groups, but not
both. Although you can later change an application's group association (for example, moving an application from an
Application Group to a Delivery Group), best practice discourages adding that complexity. Keep your applications in one
type of group.
When you associate an application with more than one Delivery Group or Application Group, a visibility issue can occur if
you do not have sufcient permission to view the application in all of those groups. In such cases, either consult an
administrator with greater permissions or have your scope extended to include all the groups to which the application is
associated.
If you publish two applications with the same name (perhaps from different groups) to the same users, change the
Application name (for user) property in Studio; otherwise, users will see duplicate names in Citrix Receiver.
You can change an application's properties (settings) when you add it, or later. You can also change the application folder
where the application is placed, either when you add the application, or later.
For information about:
Delivery Groups, see the Create Delivery Groups article.

Application Groups, see the Create Application Groups article.
T ags, which you can add to applications; see the T ags article.
Add applications
You can add applications when you create a Delivery Group or Application Group; those procedures are detailed in the
Create Delivery Groups and Create Application Groups articles. T he following procedure describes how to add applications
after you create a group.
Good to know:
You cannot add applications to Remote PC Access Delivery Groups.

You cannot use the Add Application wizard to remove applications from Delivery Groups or Application Groups. T hat is a
separate operation.
To add one or more applications:
1. Select Applications in the Studio navigation pane and then select Add Applications in the Actions pane.

2. T he Add Applications wizard launches with an Introduction page, which you can remove from future launches of this
wizard.
3. T he wizard guides you through the Groups, Applications, and Summary pages described below. When you are done with
each page, click Next until you reach the Summary page.
Alternatives to step 1 if you want to add applications to a single Delivery Group or Application Group:
T o add applications to only one Delivery Group, in step 1, select Delivery Groups in the Studio navigation pane, then
select a Delivery Group in the middle pane, and then select Add Applications in the Actions pane. T he wizard will not
display the Groups page.
T o add applications to only one Application Group, in step 1, select Applications in the Studio navigation pane, then
select an Application Group in the middle pane, and then select the Add Applications entry under the Application
Group's name in the Actions pane. T he wizard will not display the Groups page.
Groups
T his page lists all the Delivery Groups in the Site. If you have also created Application Groups, the page lists the Application
Groups and Delivery Groups. You can choose from either group, but not from both groups. In other words, you cannot add
applications to an Application Group and a Delivery Group at the same time. Generally, if you are using Application Groups,
applications should be added to Application Groups rather than Delivery Groups.
When adding an application, you must select the check box next to at least one Delivery Group (or Application Group, if
available) because every application must always be associated with at least one group
Applications
Source Descript ion
From Start menu Applications that are discovered on a machine in the selected Delivery Groups. When you select this
source, a new page launches with a list of discovered applications. Select the check boxes of applications
to add, and then click OK.
This source cannot be selected if you (1) selected Application Groups that have no associated Delivery
Groups, (2) selected Application Groups with associated Delivery Groups that contain no machines, or (3)
selected a Delivery Group containing no machines.
Manually dened Applications located in the Site or elsewhere in your network. When you select this source, a new page
launches where you type the path to the executable, working directory, optional command line arguments,
and display names for administrators and users. After entering this information, click OK.
Existing Applications previously added to the Site. When you select this source, a new page launches with a list of
discovered applications. Select the check boxes of applications to add and then click OK.
This source cannot be selected If the Site has no applications.
App-V Applications in App-V packages. When you select this source, a new page launches where you select the
App-V server or the Application Library. From the resulting display, select the checkboxes of applications to
add, and then click OK. For more information, see the App-V article.
This source cannot be selected if App-V is not congured for the Site.

Application Group Application Groups. When you select this source, a new page launches with a list of Application Groups.
(Although the display also lists the applications in each group, you can select only the group, not individual
applications.) All current and future applications in the selected groups will be added. Select the check
boxes of Application Groups to add, and then click OK.
This source cannot be selected if (1) there are no Application Groups, or (2) if the selected Delivery Groups
do not support Application Groups (for example, Delivery Groups with statically assigned machines).
As noted in the table, some sources in the Add dropdown cannot be selected if there is no valid source of that type.
Sources that are incompatible (for example, you cannot add Application Groups to Application Groups) are not included in
the dropdown. Applications that have already been added to the groups you chose cannot be selected.
To add an application from an assigned AppDisk, select From Start menu. If the application is not available there, select
Manually dened and provide the details. If a folder access error occurs, congure the folder as "shared" and try to add
the application through Manually dened again.
You can change an application's properties (settings) from this page, or later.
By default, applications you add are placed in the application folder named Applications. You can change the application
from this page, or later. If you try to add an application and one with the same name already exists in the same folder, you
are prompted to rename the application youre adding. You can accept the new name offered, or decline and then rename
the application or select a different folder. For example, if "app" already exists in the Applications folder, and you attempt
to add another application named "app" to that folder, the new name "app_1" will be offered.
Summary
If you are adding 10 or fewer applications, their names are listed in Applications to add. If you are adding more than 10
applications, the total number is specied.
Review the summary information and then click Finish.
Change an application's group association

After adding an application, you can change the Delivery Groups and Application Groups with which the application is
associated.
You can use drag-and-drop to associate an application with an additional group. T his is an alternative to using commands in
the Actions pane.
If an application is associated with more than one Delivery Group or more than one Application Group, group priority can
used to specify the order in which multiple groups are checked to nd applications. By default, all groups are priority 0 (the
highest). Groups at the same priority are load balanced.
An application can be associated with Delivery Groups containing shared (not private) machines that can deliver
applications. You can also select Delivery Groups containing shared machines that deliver desktops only, if (1) the Delivery
Group contains shared machines and was created with an earlier XenDesktop 7.x version, and (2) you have Edit Delivery
Group permission. T he Delivery Group type is automatically converted to "desktops and applications" when the properties

dialog is committed.
1. Select Applications in the Studio navigation pane and then select the application in the middle pane.
2. Select Properties in the Actions pane.
3. Select the Groups page.
4. T o add a group, click the Add dropdown and select Application Groups or Delivery Groups. (If you have not created
any Application Groups, the only entry will be Delivery Groups.) T hen select one or more available groups. Groups that are
incompatible with the application, or that are already associated with the application, cannot be selected.
5. T o remove a group, select one or more groups and then click Remove. If removing group association would result in the
application no longer being associated with any Application Group or Delivery Group, you will be alerted that the
application will be deleted.
6. T o change the priority of a group, select the group and then click Edit Priority. Select a priority value and then click OK.
7. When you are finished, click Apply to apply the changes and leave the window open, or click OK to apply the changes
and close the window.
Duplicate, enable or disable, rename, or delete an

application
Using these actions:
Duplicate: You might want to duplicate an application to create a different version with different parameters or
properties. When you duplicate an application, it is automatically renamed with a unique suffix and placed adjacent to
the original. You might also want to duplicate an application and then add it to a different group. (After duplicating, the
easiest way to move it is using drag-and-drop.)
Enable or disable: Enabling and disabling an application is a different action than enabling and disabling a Delivery Group
or Application Group.
Rename: You can rename only one application at a time. If you try to rename an application and one with the same
name already exists in the same folder or group, you are prompted to specify a different name.
Delete: Deleting an application removes it from the Delivery Groups and Application Groups with which it was
associated, but not from the source that was used to add the application originally. Deleting an application is a different
action than removing it from a Delivery Group or Application Group.
To duplicate, enable or disable, rename, or delete an application:

2. Select one or more applications in the middle pane and then select the appropriate task in the Actions pane.
3. Confirm the action, when prompted.
Remove applications from a Delivery Group

An application must be associated (belong) with at least one Delivery Group or Application Group. If you attempt to remove
an application from a Delivery Group that would remove that applications association with any Delivery Group or
Application Group, you are notied that the application will be deleted if you continue. When that happens, if you want to
deliver that application, you must add it again from a valid source.

2. Select a Delivery Group. In the lower middle pane, select the Applications tab and then the application you want to
remove.
3. Select Remove Application from the Actions pane.
Remove applications from an Application Group

An application must belong to at least one Delivery Group or Application Group. If you attempt to remove an application
from an Application Group that will result in that application no longer belonging to any Delivery Group or Application
Group, you are notied that the application will be deleted if you continue. When that happens, if you want to deliver that
application, you must add it again from a valid source.

2. Select the Application Group in the middle pane, and then select one or more applications in the middle pane.
3. Select Remove f rom Application Group in the Actions pane.
Change application properties

You can change the properties of only one application at a time.
To change the properties of an application:

2. Select an application and then select Edit Application Properties in the Actions pane.
3. Select the page containing the property you want to change.
4. When you are finished, click Apply to apply any hanges you made and keep the window open, or click OK to apply
changes tand close the window.
Propert y Select t his page
Category/folder where application appears in Receiver Delivery
Command line arguments (see Pass parameters to published Location

applications section)
Delivery Groups and Application Groups where the application is Groups

available
Description Identication
File extensions and le type association: which extensions the File Type Association
application opens automatically

Icon Delivery
Keywords for StoreFront Identication
Limits (see Congure application limits section) Delivery
Name: the names seen by the user and by the administrator Identication
Path to executable (see Pass parameters to published applications Location

section)
Shortcut on users desktop: enable or disable Delivery
Visibility: limits which users can see the application in Citrix Receiver (an Limit Visibility
invisible application can still be started; to make it unavailable as well
as invisible, add it to a dierent group)
Working directory Location
Application changes may not take effect for current application users until they log off their sessions.
Congure application limits

Congure application limits to help manage application use. For example, you can use application limits to manage the
number of users accessing an application simultaneously. Similarly, application limits can be used to manage the number of
simultaneous instances of resource-intensive applications, this can help maintain server performance and prevent
deterioration in service.
Important: T his feature limits the number of application launches that are brokered by the Controller (for example, from
Citrix Receiver and StoreFront), and not the number of running applications that could be launched by other methods. T his
means that application limits assist administrators when managing concurrent usage, but do not provide enforcement in all
scenarios. For example, application limits cannot be applied when the Controller is in leased connection mode.
By default, there is no limit on how many application instances can run at the same time. T here are two application limit
settings; you can congure either or both:
T he maximum number of concurrent instances of an application by all users in the Delivery Group.
One instance of the application per user in the Delivery Group
If a limit is congured, an error message is generated when a user attempts to launch an instance of the application that
will exceed the congured limit.
Examples using application limits:

Maximum number of simultaneous instances limit. In a Delivery Group, you configure the maximum number of
simultaneous instances of application Alpha to 15. Later, users in that Delivery Group have 15 instances of that
application running at the same time. If any user in that Delivery Group now attempts to launch Alpha, an error message
is generated, and Alpha is not launched because it would exceed the configured simultaneous application instance limit
(15).
One-instance-per-user application limit. In another Delivery Group, you enable the one-instance-per-user option for
application Beta. User T ony launches application Beta successfully. Later in the day, while that application is still running
in T onys session, he attempts to launch another instance of Beta. An error message is generated and Beta is not
launched because it would exceed the one-instance-per-user limit.
Maximum number of simultaneous instances and one-instance-per-user limits. In another Delivery Group, you
configure a maximum number of simultaneous instances of 10 and enable the one-instance-per-user option for
application Delta. Later, when ten users in that Delivery Group each have an instance of Delta running, any other user in
that Delivery Group who tries to launch Delta will receive an error message, and Delta will not be launched. If any of the
ten current Delta users attempt to launch a second instance of that application, they will receive an error message and
second instance will not be launched.
If application instances are also launched by methods other than Controller brokering (for example, while a Controller is in
leased connection mode) and congured limits are exceeded, users will not be able to launch additional instances until they
close sufcient instances to no longer exceed the limits. T he instances that exceeded the limit will not be forcibly shut
down; they will be allowed to continue until their users close them.
If you disable session roaming, then disable the one-instance-per-user application limit. If you enable the one-instance-per-
user application limit, do not congure either of the two values that allow new sessions on new devices. For information
about roaming, see the Sessions article.
To congure application limits:
1. Select Applications in the Studio navigation pane and then select an application.
2. Select the Edit Application Properties in the Actions pane.
3. On the Delivery page, choose one of the options listed below. When you are finished, click OK or Apply. (OK applies the
change and closes the Edit Application Properties dialog box; Apply applies the change and leaves the dialog box open.)
Allow unlimited use of the application. T here is no limit to the number of instances running at the same time. T his is the
default.
Set limits for the application. T here are two limit types; specify either or both.
Specify the maximum number of instances that can run concurrently
Limit to one instance of the application per user
Pass parameters to published applications

Use the Location page of an application's properties to enter the command line and pass parameters to published
applications.
When you associate a published application with le types, the symbols %* (percent and star symbols enclosed in double
quotation marks) are appended to the end of the command line for the application. T hese symbols act as a placeholder for
parameters passed to user devices.
If a published application does not launch when expected, verify that its command line contains the correct symbols. By

default, parameters supplied by user devices are validated when the symbols %* are appended. For published applications
that use customized parameters supplied by the user device, the symbols %** are appended to the command line to
bypass command-line validation. If you do not see these symbols in a command line for the application, add them manually.
If the path to the executable le includes directory names with spaces (such as C:\Program Files), enclose the command
line for the application in double quotation marks to indicate that the space belongs in the command line. To do this, add
double quotation marks around the path, and another set of double quotation marks around the %* symbols. Be sure to
include a space between the closing quotation mark for the path and the opening quotation mark for the %* symbols.
For example, the command line for the published application Windows Media Player is:
C:\Program Files\Windows Media Player\mplayer1.exe %*
Manage application folders

By default, new applications you add to Delivery Groups are placed in a folder named Applications. You can specify a
different folder when you create the Delivery Group, when you add an application, or later.
Good to know:
You cannot rename or delete the Applications folder, but you can move all the applications it contains to other folders
you create.
A folder name can contain 1-64 characters. Spaces are permitted.
Folders can be nested up to five levels.
Folders do not have to contain applications; empty folders are allowed.
Folders are listed alphabetically in Studio unless you move them or specify a different location when you create them.
You can have more than one folder with the same name, as long as each has a different parent folder. Similarly, you can
have more than one application with the same name, as long as each is in a different folder.
You must have View Applications permission to see the applications in folders, and you must have Edit Application
Properties permission for all applications in the folder to remove, rename, or delete a folder that contains applications.
Most of the following procedures request actions using the Actions pane in Studio. Alternatively, you can use right-click
menus or drag and drop. For example, if you create or move a folder in a location you did not intend, you can drag/drop it
to the correct location.
To manage application folders, select Applications in the Studio navigation pane. Use the following list for guidance.
T o view all folders (excluding nested folders), click Show all above the folder list.
T o create a folder at the highest level (not nested), select the Applications folder. T o place the new folder under an
existing folder other than Applications, select that folder. T hen, select Create Folder in the Actions pane. Enter a name.
T o move a folder, select the folder and then select Move Folder in the Actions pane. You can move only one folder at a
time unless the folder contains nested folders. T ip: T he easiest way to move a folder is to use drag and drop.
T o rename a folder, select the folder, and then select Rename Folder in the Actions pane. Enter a name.
T o delete a folder, select the folder, and then select Delete Folder in the Actions pane. When you delete a folder that
contains applications and other folders, those objects are also deleted. Deleting an application removes the application
assignment from the Delivery Group; it does not remove it from the machine.
T o move applications into a folder, select one or more applications. T hen, select Move Application in the Actions pane.
Select the folder.

You can also place applications you are adding in a specic folder (even a new one) on the Application page of the Create
Delivery Group and Create Application Group wizards. By default, added applications go in the Applications folder; click
Change to select or create a folder.)

Universal Windows Platform Apps
May 22, 20 17
XenApp and XenDesktop supports the use of Universal Windows Platform (UWP) apps with VDAs on Windows 10 and
Windows Server 2016 machines. For information about UWP apps, see the following Microsoft documentation:
What is a Universal Windows Platform (UWP) app?

Distribute offline apps
Guide to Universal Windows Platform (UWP) apps
T he term Universal Apps is used throughout this article to refer to UWP apps.
Requirements and limitations
Universal Apps are supported for VDAs on Windows 10 and Windows Server 2016 machines.
VDAs must be minimum version 7.11.
T he following XenApp and XenDesktop features are either not supported or limited when using Universal Apps:
File type association is not supported.

Local App Access is not supported.
Dynamic preview: If apps running in the session overlap, the preview shows the default icon. T he Win32 APIs used for
Dynamic Preview are not supported in Universal Apps.
Action Center remoting: Universal Apps can use the Action Center for displaying the messages in the session. Redirect
these messages to the endpoint to display them to the user.
Launching Universal apps and non-Universal apps from same server is not supported for Windows 10 VDAs. For Windows
Server 2016, Universal apps and non-Universal apps should be in separate Delivery Groups or Application Groups.
All Universal Apps installed on the machine are enumerated; therefore, Citrix recommends disabling user access to the
Windows Store. T his prevents the Universal Apps installed by one user from being accessed by a different user.
During sideloading, the Universal App is installed on the machine and is available for use for other users. When any other user
launches the app, the app is installed. T he OS then updates its AppX database to indicate "as installed" for the user
launching the app.
Graceful logoffs from a published Universal App that was launched in a seamless or xed window might result in the session
not closing, and the user being logged off. In such cases, several processes remaining in the session prevent the session
from closing properly. To resolve this, determine which process is preventing the session from closing, and then add it to the
"LogoffCheckSysModules" registry key value, following the guidance in CT X891671.
Application Display Names and Descriptions for Universal Apps might not have correct names. Edit and correct these
properties when adding the applications to the Delivery Group.
Check the Known issues article for any additional issues.
Currently, several Universal Apps have white icons with transparency enabled, which results in the icon not being visible
against the white background of the StoreFront display. To avoid this issue, you can change the background. For example,
on the StoreFront machine, edit the le C:\inetpub\wwwroot\Citrix\StoreWeb\custom\style.css. At the end of the le,

add .storeapp-icon {background-image: radial-gradient( circle at top right , yellow, red ); }. T he graphic below
illustrates the before-and-after for this example.
On Windows Server 2016, the Server Manager might also launch when a Univeral App is launched. To prevent this from
occurring, you can disable Server Manager from auto-starting during logon with
the HKLM\Software\Microsoft\ServerManager\DoNotOpenServerManagerAtLogon registry key. For details,
see https://blogs.technet.microsoft.com/rmilne/2014/05/30/how-to-hide-server-manager-at-logon/.
Install and publish Universal Apps
Support for Universal Apps is enabled by default.
To disable the use of Universal Apps on a VDA, add the registry setting EnableUWASeamlessSupport in
HKLM\Software\Citrix\VirtualDesktopAgent\FeatureToggle and set to 0.
To install one or more Universal Apps on VDAs (or a master image), use one of the following methods:
Complete an offline install from the Windows Store for Business, using a tool such as Deployment Image Servicing and
Management (DISM) to deploy the apps to the desktop image. For more information, see
https://technet.microsoft.com/en-us/itpro/windows/manage/distribute-offline-apps.
Sideload the apps. For more information, see https://technet.microsoft.com/en-us/itpro/windows/deploy/sideload-
apps-in-windows-10.
To add (publish) one or more Universal Apps in XenApp or XenDesktop:
After the Universal Apps are installed on the machine, add the Universal Apps to a Delivery Group or Application Group.
You can do this when you create a group, or later. On the Applications page of the wizard, select the From Start
menu source.

When the applications list appears, select the check boxes of the Universal Apps you want to publish. T hen click Next.
Uninstall Universal Apps
When you uninstall a Universal App with a command such as Remove-AppXPackage, the item is uninstalled only for
administrators. To remove the app from the machines of users who may have launched and used the app, you must run the
removal command on each machine. You cannot uninstall the AppX package from all users' machines with one command.

Zones
May 22, 20 17
Deployments that span widely-dispersed locations connected by a WAN can face challenges due to network latency and
reliability. T here are two options that mitigate those challenges:
Deploy multiple Sites, each with their own SQL Server Site database.
T his option is recommended for large enterprise deployments. Multiple Sites are managed separately, and each
requires its own SQL Server Site database. Each Site is a separate XenApp deployment.
Configure multiple zones within a single Site.
Conguring zones can help users in remote regions connect to resources without necessarily forcing their
connections to traverse large segments of the WAN. Using zones allows effective Site management from a single
Citrix Studio console, Citrix Director, and the Site database. T his saves the costs of deploying, stafng, licensing, and
operating additional Sites containing separate databases in remote locations.
Zones can be helpful in deployments of all sizes. You can use zones to keep applications and desktops closer to end
users, which improves performance. A zone can have one or more Controllers installed locally for redundancy and
resiliency, but it is not required.
T he number of Controllers congured in the Site can affect the performance of some operations, such as adding new
Controllers to the Site itself. To avoid this, we recommend that you limit the number of zones in your XenApp or
XenDesktop Site to no more than 10.
Note: When the network latency of your zones is more than 250 ms RT T, we recommend that you deploy multiple
Sites instead of zones.
T hroughout this article the term local refers to the zone being discussed. For example, "A VDA registers with a local
Controller" means that a VDA registers with a Controller in the zone where the VDA is located.
Zones in this release are similar, but not identical to zones in XenApp version 6.5 and earlier. For example, in this
implementation of zones, there are no data collectors. All Controllers in the Site communicate with one Site database in
the primary zone. Also, failover and preferred zones work differently in this release.
Zone types
A Site always has one primary zone. It can also optionally have one or more satellite zones. Satellite zones can be used for
disaster recovery, geographically-distant datacenters, branch ofces, a cloud, or an availability zone in a cloud.
Primary zone
T he primary zone has the default name "Primary," which contains the SQL Server Site database (and high availability
SQL servers, if used), Studio, Director, Citrix StoreFront, Citrix License Server, and NetScaler Gateway. T he Site
database should always be in the primary zone.
T he primary zone should also have at least two Controllers for redundancy, and may have one or more VDAs with
applications that are tightly-coupled with the database and infrastructure.

Satellite zone
A satellite zone contains one or more VDAs, Controllers, StoreFront servers, and NetScaler Gateway servers. Under
normal operations, Controllers in a satellite zone communicate directly with the database in the primary zone.
A satellite zone, particularly a large one, might also contain a hypervisor that is used to provision and/or store
machines for that zone. When you congure a satellite zone, you can associate a hypervisor or cloud service
connection with it. (Be sure any Machine Catalogs that use that connection are in the same zone.)
A Site can have satellite zones of different congurations, based on your unique needs and environment. T he following
gure illustrates a primary zone and examples of satellite zones.
T he Primary zone contains two Controllers, Studio, Director, StoreFront, License Server, and the Site database (plus high
availability SQL Server deployments). T he Primary zone also contains several VDAs and a NetScaler Gateway.
Satellite zone 1 - VDAs with Controller
Satellite zone 1 contains a Controller, VDAs, and a StoreFront server. VDAs in this satellite zone register with the local
Controller. T he local Controller communicates with the Site database and license server in the primary zone.
If the WAN fails, the connection leasing feature allows the Controller in the satellite zone to continue brokering
connections to VDAs in that zone. Such a deployment can be effective in an ofce where workers use a local
StoreFront site and the local Controller to access their local resources, even if the WAN link connecting their ofce to
the corporate network fails.
Satellite zone 2 - VDAs with redundant Controllers
Satellite zone 2 contains two Controllers, VDAs, and a StoreFront server. T his is the most resilient zone type, offering

protection against a simultaneous failure of the WAN and one of the local Controllers.
Where VDAs register and where Controllers fail over

In a Site containing primary and satellite zones, with VDAs at minimum version 7.7:
A VDA in the primary zone registers with a Controller in the primary zone. A VDA in the primary zone will never attempt to
register with a Controller in a satellite zone.
A VDA in a satellite zone registers with a local Controller, if possible. (T his is considered the preferred Controller.) If no
local Controllers are available (for example, because the local Controllers cannot accept more VDA registrations or the
local Controllers have failed), the VDA will attempt to register with a Controller in the primary zone. In this case, the VDA
stays registered in the primary zone, even if a Controller in satellite zone becomes available again. A VDA in a satellite
zone will never attempt to register with a Controller in another satellite zone.
When auto-update is enabled for VDA discovery of Controllers, and you specify a list of Controller addresses during VDA
installation, a Controller is randomly selected from that list for initial registration (regardless of which zone the Controller
resides in). After the machine with that VDA is restarted, the VDA will start to prefer registering with a Controller in its
local zone.
If a Controller in a satellite zone fails, it fails over to another local Controller, if possible. If no local Controllers are
available, it fails over to a Controller in the primary zone.
If you move a Controller in or out of a zone, and auto-update is enabled, VDAs in both zones receive updated lists
indicating which Controllers are local and which are in the primary zone, so they know with whom they can register and
accept connections from.
If you move a Machine Catalog to another zone, the VDAs in that catalog will re-register with Controllers in the zone
where you moved the catalog. (When you move a catalog, make sure you also move any associated host connection to
the same zone.)
Controllers in the primary zone keep connection leasing data for all zones. Controllers in satellite zones keep connection
leasing data for their own zone and the primary zone, but not data for any other satellite zones.
If all Controllers in the primary zone fail:
Studio cannot connect to the Site.

Connections to VDAs in the primary zone cannot be made.
Site performance will increasingly degrade until the Controllers in the primary zone become available.
For Sites containing VDA versions earlier than 7.7:
A VDA in a satellite zone will accept requests from Controllers in their local zone and the primary zone. (VDAs at minimum
version 7.7 can accept Controller requests from other satellite zones.)
A VDA in a satellite zone will register with a Controller in the primary zone or the local zone at random. (VDAs at minimum
version 7.7 prefer the local zone.)
Zone preference
Important: To use the zone preference feature, you must be using minimum StoreFront 3.7 and NetScaler Gateway 11.0-
65.x.

In a multi-zone Site, the zone preference feature offers the administrator more exibility to control which VDA is used to
launch an application or desktop.
How zone pref erence works
T here are three forms of zone preference. You might prefer to use a VDA in a particular zone, based on:
Where the application's data is stored. T his is referred to as the application home.
T he location of the user's home data, such as a profile or home share. T his is referred to as the user home.
T he user's current location (where the Citrix Receiver is running). T his is referred to as the user location.
T he following graphic shows an example multi-zone conguration.
In this example, VDAs are spread among three satellite zones, but they are all in the same Delivery Group. T herefore, the
broker might have a choice which VDA to use for a user launch request. T his example indicates there are a number of
locations where users can be running their Citrix Receiver endpoints: User A is using a device with Citrix Receiver in satellite
zone 1; User B is using a device in satellite zone 2. A user's documents could be stored in a number of locations: Users A and
B use a share based in satellite zone 1; User C uses a share from satellite zone C. Also, one of the published applications uses
a database located in satellite zone 1.
You associate a user or application with a zone by conguring a home zone for the user or application. T he broker in the
Delivery Controller then uses those associations to help select the zone where a session will be launched, if resources are
available. You:
Configure the home zone for a user by adding a user to a zone.

Configure the home zone for an application by editing the application properties.
A user or an application can have only one home zone at a time. (An exception for users can occur when multiple zone

memberships occur because of user group membership; see the "Other considerations" section. However, even in this case,
the broker uses only one home zone.)
Although zone preferences for users and applications can be congured, the broker selects only one preferred zone for a
launch. T he default priority order for selecting the preferred zone is application home > user home > user location. (You can
restrict the sequence, as described in the next section.) When a user launches an application:
If that application has a configured zone association (an application home), then the preferred zone is the home zone
for that application.
If the application does not have a configured zone association, but the user has a configured zone association (a user
home), then the preferred zone is the home zone for that user.
If neither the application nor the user has a configured zone association, then the preferred zone is the zone where the
user is running a Citrix Receiver instance (the user location). If that zone is not defined, a random VDA and zone selection
is used. Load balancing is applied to all VDAs in the preferred zone. If there is no preferred zone, load balancing is applied
to all VDAs in the Delivery Group.
Tailoring zone pref erence
When you congure (or remove) a home zone for a user or an application, you can also further restrict how zone
preference will (or will not) be used.
Mandatory user home zone use: In a Delivery Group, you can specify that a session should be launched in the user's
home zone (if the user has a home zone), with no failover to a different zone if resources are not available in the home
zone. T his restriction is helpful when you need to avoid the risk of copying large profiles or data files between zones. In
other words, you would rather deny a session launch than to launch the session in a different zone.
Mandatory application home zone use: Similarly, when you configure a home zone for an application, you can
indicate that the application should be launched only in that zone, with no failover to a different zone if resources are
not available in the application's home zone.
No application home zone, and ignore conf igured user home zone: If you do not specify a home zone for an
application, you can also indicate that any configured user zones should not be considered when launching that
application. For example, you might prefer that users run a specific application on a VDA close to the machine they are
using (where Citrix Receiver is running), using the user location zone preference, even though some users might have a
different home zone.
How pref erred zones af f ect session use
When a user launches an application or desktop, the broker prefers using the preferred zone rather than using an existing
session.
If the user launching an application or desktop already has a session that is suitable for the resource being launched (for
example, that can use session sharing for an application, or a session that is already running the resource being launched),
but that session is running on a VDA in a zone other than the preferred zone for the user/application, then the system may
create a new session. T his satises launching in the correct zone (if it has available capacity), ahead of reconnecting to a
session in a less-preferred zone for that user's session requirements.
To prevent an orphan session that can no longer be reached, reconnection is allowed to existing disconnected sessions,
even if they are in a non-preferred zone.
T he order of desirability for sessions to satisfy a launch is:

1. Reconnect to an existing session in the preferred zone.
2. Reconnect to an existing disconnected session in a zone other than the preferred zone.
3. Start a new session in the preferred zone.
4. Reconnect to a connected existing session in a zone other than the preferred zone.
5. Start a new session in a zone other than the preferred zone.
Other zone pref erence considerations
If you configure a home zone for a user group (such as a security group), that group's users (through direct or indirect
membership) are associated with the specified zone. However, a user can be a member of multiple security groups, and
therefore could have a different home zone configured through other group membership. In such cases, determination
of that user's home zone can be ambiguous.
If a user has a congured home zone that was not acquired through group membership, that zone is used for zone
preference. Any zone associations acquired through group membership are ignored.
If the user has multiple different zone associations acquired solely through group membership, the broker chooses
among the zones randomly. Once the broker makes this choice, that zone is used for subsequent session launches,
until the user's group membership changes.
T he user location zone preference requires detection of Citrix Receiver on the endpoint device by the Citrix NetScaler
Gateway through which that device is connecting. T he NetScaler must be configured to associate ranges of IP
addresses with particular zones, and discovered zone identity must be passed through StoreFront to the Controller.
Considerations, requirements, and best practice

You can place the following items in a zone: Controllers, Machine Catalogs, host connections, users, and applications. If a
Machine Catalog uses a host connection, both the catalog and the connection should be in the same zone.
When you place items in a satellite zone it affects how the Site interacts with them and with other objects related to
them.
When Controller machines are placed into a satellite zone, it is assumed that those machines have good (local)
connectivity to hypervisors and VDA machines in the same satellite zone. Controllers in that satellite zone are then
used in preference to Controllers in the primary zone for handling those hypervisors and VDA machines.
When a hypervisor connection is placed into a satellite zone, it is assumed that all the hypervisors managed via that
hypervisor connection also reside in that satellite zone. Controllers in that satellite zone are then used in preference
to Controllers in the primary zone when communicating with that hypervisor connection.
When a machine catalog is placed into a satellite zone, it is assumed that all the VDA machines in that catalog are in
the satellite zone. Local Controllers are used in preference to Controllers in the primary zone when attempting to
register with the Site, after the Controller list auto-update mechanism has activated after the first registration of
each VDA.
NetScaler Gateway instances can also be associated with zones. T his is done as part of the StoreFront Optimal HDX
Routing configuration rather than, as for the other elements described here, as part of the XenApp or XenDesktop
Site configuration. When a NetScaler Gateway is associated with a zone, it is preferred to be used when HDX
connections to VDA machines in that zone are used.
When you create a production Site and then create the first Machine Catalog and Delivery Group, all items are in the
primary zone you cannot create satellite zones until after you complete that initial setup. (If you create an empty
Site, the primary zone will initially contain only a Controller; you can create satellite zones before or after creating a

Machine Catalog and Delivery Group.)
When you create the first satellite zone containing one or more items, all other items in your Site remain in the primary
zone.
T he primary zone is named 'Primary' by default; you can change that name. Although the Studio display indicates which
zone is the primary zone, it is best practice to use an easily-identifiable name for the primary zone. You can reassign the
primary zone (that is, make another zone the primary zone), but it should always contain the Site database and any high
availability servers.
T he Site database should always be in the primary zone.
After you create a zone, you can later move items from one zone to another. Note that this flexibility allows you to
potentially separate items that work best in close proximity - for example, moving a Machine Catalog to a different zone
than the connection (host) that creates the machines in the catalog, could affect performance. So, consider potential
unintended effects before moving items between zones. Keep a catalog and the host connection it uses in the same
zone.
For optimal performance, install Studio and Director only in the primary zone. If you want another Studio instance in a
satellite zone (for example, if a satellite zone containing Controllers is being used as failover in the event the primary
zone becomes inaccessible), run Studio as a locally-published application. You can also access Director from a satellite
zone because it is a web application.
Ideally, NetScaler Gateway in a satellite zone should be used for user connections coming into that zone from other
zones or external locations, although you can use it for connections within the zone.
Remember: T o use the zone preference feature, you must be using minimum StoreFront 3.7 and NetScaler Gateway
11.0-65.x.
For more technical details and performance considerations, see the Zones Deep Dive and Zones, Latency, and Brokering
Performance articles.
Connection quality limits

T he Controllers in the satellite zone perform SQL interactions directly with the Site database. T his imposes some limits on
the quality of the link between the satellite zone and the primary zone containing the Site database. T he specic limits are
relative to the number of VDAs and user sessions on those VDAs that are deployed in the satellite zone. So satellite zones
with only a few VDAs and sessions can function with a poorer-quality connection to the database than satellite zones
with large numbers of VDAs and sessions. Some guidelines are:
Number of sessions to be Assumed maximum Minimum acceptable Maximum acceptable

supported concurrent end user session bandwidth round-trip latency
launches
<50 20 1 Mbps 250 ms
50 500 25 1.5 Mbps 100 ms

500 1,000 30 2 Mbps 50 ms
1,000 3,000 60 8 Mbps 10 ms
>3,000 60 8 Mbps 5 ms
The impact of latency on brokering perf ormance
Although zones allow users to be on higher-latency links, providing that there is a local broker, the additional latency
inevitably impacts end-user experience. For most work that users do, they experience slowness caused by round trips
between Controllers in the satellite zone and the Site database.
For launching applications, extra delays occur while the session brokering process identies suitable VDAs to send session
launch requests to. For information on performance, see the links at the end of this article.
Create and manage zones

A Full Administrator can perform all zone creation and management tasks. However, you can also create a custom role that
allows you to create, edit, or delete a zone. Moving items between zones does not require zone-related permissions
(except zone read permission); however, you must have edit permission for the items you are moving. For example, to move
a Machine Catalog from one zone to another, you must have edit permission for that Machine Catalog. For more
information, see the Delegated Administration article.
If you use Provisioning Services: T he Provisioning Services console provided with this release is not aware of zones, so
Citrix recommends using Studio to create Machine Catalogs that you want to place in satellite zones. Use the Studio
wizard to create the catalog, specifying the correct satellite zone. T hen, use the Provisioning Services console to provision
machines in that catalog. (If you create the catalog using the Provisioning Services wizard, it will be placed in the primary
zone, and you will need to use Studio to move it to the satellite zone later.)
Create a zone
1. Select Conf iguration > Zones in the Studio navigation pane.

2. Select Create Zone in the Actions pane.
3. Enter a name for the zone, and a description (optional). T he name must be unique within the Site.
4. Select the items to place in the new zone. You can filter or search the list of items from which you can select. You can
also create an empty zone; simply do not select any items.
5. Click Save.
As an alternative to this method, you can select one or more items in Studio and then select Create Zone in the Actions
pane.

Change a zone name or description

2. Select a zone in the middle pane and then select Edit Zone in the Actions pane.
3. Change the zone name and/or description. If you change the name of the primary zone, make sure the zone remains
easily identifiable as the primary zone.
4. Click OK or Apply.
Move items f rom one zone to another zone

2. Select a zone in the middle pane, and then select one or more items.
3. Either drag the items to the destination zone or select Move Items in the Actions pane and then specify which zone to
move them to.
A conrmation message lists the items you selected and asks if you are sure you want to move all of them.
Remember: When a Machine Catalog uses a host connection to a hypervisor or cloud service, both the catalog and the
connection should be in the same zone. Otherwise, performance can be affected. If you move one, move the other, too.
Delete a zone
A zone must be empty before it can be deleted. You cannot delete the primary zone.

2. Select a zone in the middle pane.
3. Select Delete Zone from the Actions pane. If the zone is not empty (it contains items), you are asked to choose the
zone where those items will be moved.
4. Confirm the deletion.
Add a home zone f or a user
Conguring a home zone for a user is also known as adding a user to a zone.
1. Select Conf iguration > Zones in the Studio navigation pane and then select a zone in the middle pane.
2. Select Add Users to Zone in the Actions pane.
3. In the Add Users to Zone dialog box, click Add and then select the users and user groups to add to the zone. If you
specify users who already have a home zone, a message offers two choices: Yes = add only those users you specified
who do not have a home zone; No = return to the user selection dialog.
4. Click OK.
For users with a congured home zone, you can require that sessions launch only from their home zone:
1. Create or edit a Delivery Group.

2. On the Users page, select the Sessions must launch in a user's home zone, if conf igured check box.
All sessions launched by a user in that Delivery Group must launch from machines in that user's home zone. If a user in
the Delivery Group does not have a congured home zone, this setting has no effect.
Remove a home zone f or a user
T his procedure is also known as removing a user from a zone.

1. Select Conf iguration > Zones in the Studio navigation pane and then select a zone in the middle pane.
2. Select Remove Users f rom Zone in the Actions pane.
3. In the Add Users to Zone dialog box, click Remove and then select the users and groups to remove from the zone.
Note that this action removes the users only from the zone; those users remain in the Delivery Groups and Application
Groups to which they belong.
4. Confirm the removal when prompted.
Manage home zones f or applications
Conguring a home zone for an application is also known as adding an application to a zone. By default, in a multi-zone
environment, an application does not have a home zone.
An application's home zone is specied in the application's properties. You can congure application properties when you
add the application to a group or later, by selecting the application in Studio and editing its properties.
When creating a Delivery Group, creating an Application Group, or adding applications to existing groups, select
Properties on the Applications page of the wizard.
T o change an application's properties after the application is added, select Applications in the Studio navigation pane.
Select an application and then select Edit Application Properties in the Actions pane.
On the Zones page of the application's properties/settings:
If you want the application to have a home zone:

Select Use the selected zone to decide radio button and then select the zone from the dropdown.
If you want the application to launch only from the selected zone (and not from any other zone), select the check
box under the zone selection.
If you do not want the application to have a home zone:
Select the Do not conf igure a home zone radio button.
If you do not want the broker to consider any configured user zones when launching this application, select the
check box under the radio button. In this case, neither application or user home zones will be used to determine
where to launch this application.
Other actions that include specif ying zones
When you add a host connection or create a Machine Catalog (other than during Site creation), you can specify a zone
where the item will be assigned, if you have already created at least one satellite zone.
In most cases, the primary zone is the default. When using Machine Creation Services to create a Machine Catalog, the
zone that is congured for the host connection is automatically selected.
If the Site contains no satellite zones, the primary zone is assumed and the zone selection box does not appear.

May 22, 20 17
In this article:
Introduction
Where to find information about connection types
Host storage
Create a connection and resources
Edit connection settings
T urn maintenance mode on or off for a connection
Delete a connection
Rename or test a connection
View machine details on a connection
Manage machines on a connection
Edit storage
Delete, rename, or test resources
Use IntelliCache for XenServer connections
Connection timers
Introduction
You can optionally create your rst connection to hosting resources when you create a Site. Later, you can change that
connection and create other connections. Conguring a connection includes selecting the connection type from among
the supported hypervisors and cloud services. T he storage and network you select form the resources for that connection.
Read Only Administrators can view connection and resource details; you must be a Full Administrator to perform
connection and resource management tasks. For details, see the Delegated Administration article.
Where to nd inf ormation about connection types
You can use the supported virtualization platforms to host and manage machines in your XenApp or XenDesktop
environment. T he System requirements article lists the supported types. You can use the supported cloud deployment
solutions to host product components and provision virtual machines. T hese solutions pool computing resources to build
public, private, and hybrid Infrastructure as a Service (IaaS) clouds.
For details, see the following information sources.
Microsoft Hyper-V
Microsoft System Center Virtual Machine Manager virtualization environments article.

Microsoft documentation.
Microsoft Azure
Microsoft Azure virtualization environments article.


Microsoft Azure Resource Manager
Microsoft Azure Resource Manager virtualization environments article.

Amazon Web Services (AWS)
Citrix XenDesktop on AWS.

AWS documentation.
When you create a connection in Studio, you must provide the API key and secret key values. You can export the key file
containing those values from AWS and then import them. You must also provide the region, availability zone, VPC name,
subnet addresses, domain name, security group names, and credentials.
T he credentials file for the root AWS account (retrieved from the AWS console) is not formatted the same as
credentials files downloaded for standard AWS users. T herefore, Studio cannot use the file to populate the API key and
secret key fields. Ensure that you are using AWS IAM credentials files.
CloudPlatform
CloudPlatform documentation.
When you create a connection in Studio, you must provide the API key and secret key values. You can export the key file
containing those values from CloudPlatform and then import those values into Studio.
Citrix XenServer
Citrix XenServer documentation.

When you create a connection, you must provide the credentials for a VM Power Admin or higher-level user.
Citrix recommends using HT T PS to secure communications with XenServer. T o use HT T PS, you must replace the default
SSL certificate installed on XenServer; see CT X128656.
You can configure high availability if it is enabled on the XenServer. Citrix recommends that you select all servers in the
pool (from Edit High Availability) to allow communication with XenServer if the pool master fails.
You can select a GPU type and group, or pass through, if the XenServer supports vGPU. T he display indicates if the
selection has dedicated GPU resources.
Nutanix Acropolis
Nutanix virtualization environments article.

Nutanix documentation.
VMware
VMware virtualization environments article.

VMware product documentation.
Host storage
When provisioning machines, data is classied by type:
Operating system (OS) data, which includes master images.

T emporary data, which includes all non-persistent data written to MCS-provisioned machines, Windows page files, user
profile data, and any data that is synchronized with ShareFile. T his data is discarded each time a machine restarts.

Personal data stored on personal vDisks.
Providing separate storage for each data type can reduce load and improve IOPS performance on each storage device,
making best use of the hosts available resources. It also enables appropriate storage to be used for the different data
types persistence and resilience is more important for some data than others.
Storage can be shared (located centrally, separate from any host, used by all hosts) or local to a hypervisor. For example,
central shared storage could be one or more Windows Server 2012 clustered storage volumes (with or without attached
storage), or an appliance from a storage vendor. T he central storage might also provide its own optimizations such as
hypervisor storage control paths and direct access through partner plugins.
Storing temporary data locally avoids having to traverse the network to access shared storage. T his also reduces load
(IOPS) on the shared storage device. Shared storage can be more costly, so storing data locally can lower expenses. T hese
benets must be weighed against the availability of sufcient storage on the hypervisor servers.
When you create a connection, you choose one of two storage management methods: storage shared by hypervisors, or
storage local to the hypervisor.
Note: When using local storage on one or more XenServer hosts for temporary data storage, make sure that each storage
location in the pool has a unique name. (To change a name in XenCenter, right-click the storage and edit the name
property.)
Storage shared by hypervisors
T he storage shared by hypervisors method stores data that needs longer-term persistence centrally, providing centralized
backup and management. T hat storage holds the OS disks and the personal vDisk disks.
When you select this method, you can choose whether to use local storage (on servers in the same hypervisor pool) for
temporary machine data that does not require persistence or as much resilience as the data in the shared storage. T his is
called the temporary data cache. T he local disk helps reduce trafc to the main OS storage. T his disk is cleared after every
machine restart. T he disk is accessed through a write-through memory cache. Keep in mind that if you use local storage for
temporary data, the provisioned VDA is tied to a specic hypervisor host; if that host fails, the VM cannot start.
Exception: If you use Clustered Storage Volumes (CSV), Microsoft System Center Virtual Machine Manager does not allow
temporary data cache disks to be created on local storage.
When you create a connection, if you enable the option to store temporary data locally, you can then enable and
congure nondefault values for each VM's cache disk size and memory size when you create a Machine Catalog that uses
that connection. However, the default values are tailored to the connection type, and are sufcient for most cases. See
the Create Machine Catalogs article for details.
T he hypervisor can also provide optimization technologies through read caching of the disk images locally; for example,
XenServer offers IntelliCache. T his can also reduce network trafc to the central storage.
Storage local to the hypervisor
T he storage local to the hypervisor method stores data locally on the hypervisor. With this method, master images and
other OS data are transferred to all of the hypervisors used in the Site, both for initial machine creation and future image
updates. T his results in signicant trafc on the management network. Image transfers are also time-consuming, and the
images become available to each host at a different time.

When you select this method, you can choose whether to use shared storage for personal vDisks, to provide resilience and
support for backup and disaster recovery systems.
Create a connection and resources

You can optionally create the rst connection when you create the Site. T he Site creation wizard contains the connection-
related pages described below: Connection, Storage Management, Storage Selection, and Network.
If you are creating a connection after you create the Site, start with step 1 below.
Important: T he host resources (storage and network) must be available before you create a connection.
Select Conf iguration > Hosting in the Studio navigation pane.

Select Add Connections and Resources in the Actions pane.
T he wizard guides you through the following pages (specific page content depends on the selected connection type).
After completing each page, click Next until you reach the Summary page.
Connection
On the Connection page:
T o create a new connection select Create a new Connection. T o create a connection based on the same host

configuration as an existing connection, select Use an existing Connection and then choose the relevant connection
Select the hypervisor or cloud service you are using in the Connection type field.
T he connection address and credentials fields differ, depending on the selected connection type. Enter the requested
information.
Enter a connection name. T his name will appear in Studio.
Choose the tool you will use to create virtual machines: Studio tools (such as Machine Creation Services or Provisioning
Services) or other tools.
Storage management
For information about storage management types and methods, see Host storage.
If you are conguring a connection to a Hyper-V or VMware host, browse to and then select a cluster name. Other
connection types do not request a cluster name.
Select a storage management method: storage shared by hypervisors or storage local to the hypervisor.
If you choose storage shared by hypervisors, indicate if you want to keep temporary data on available local storage. (You
can specify nondefault temporary storage sizes in the Machine Catalogs that use this connection.) Exception: When
using Clustered Storage Volumes (CSV), Microsoft System Center Virtual Machine Manager does not allow temporary
data cache disks to be created on local storage, so configuring that storage management setup in Studio will fail.
If you choose storage local to the hypervisor, indicate if you want to manage personal data (personal vDisks) on shared
storage.

If you use shared storage on a XenServer hypervisor, indicate if you want to use IntelliCache to reduce the load on the
shared storage device. See Use IntelliCache for XenServer connections.
Storage selection
For more information about storage selection, see Host storage.
Select at least one host storage device for each available data type. T he storage management method you selected on
the previous page affects which data types are available for selection on this page. You must select at least one storage
device for each supported data type before you can proceed to the next page in the wizard.
T he lower portion of the Storage Selection page contains additional conguration options if you selected either of the
following on the previous page.
If you chose storage shared by hypervisors, and enabled the Optimize temporary data on available local storage
check box, you can select which local storage devices (in the same hypervisor pool) to use for temporary data.
If you chose storage local to the hypervisor, and enabled the Manage personal data centrally on shared storage
check box, you can select which shared devices to use for personal (PvD) data.
T he number of currently-selected storage devices is shown (in the graphic above, "1 storage device selected"). When you
hover over that entry, the selected device names appear (unless there are no devices congured).
1. Click Select to change the storage devices to use.

2. In the Select Storage dialog box, select or clear the storage device check boxes, and then click OK.

Network
Enter a name for the resources; this name appears in Studio to identify the storage and network combination associated
with the connection.
Select one or more networks that the VMs will use.
Summary
Review your selections; if you want to make changes, use return to previous wizard pages. When you complete your review,
click Finish.
Remember: If you chose to store temporary data locally, you can congure nondefault values for temporary data storage
when you create the Machine Catalog containing machines that use this connection. See the Create Machine Catalogs
article.
Edit connection settings

Do not use this procedure to rename a connection or to create a new connection. T hose are different operations. Change
the address only if the current host machine has a new address; entering an address to a different machine will break the
connection's Machine Catalogs.
You cannot change the GPU settings for a connection, because Machine Catalogs accessing this resource must use an
appropriate GPU-specic master image. Create a new connection.
1. Select Conf iguration > Hosting in the Studio navigation pane.

2. Select the connection and then select Edit Connection in the Actions pane.
3. Follow the guidance below for the settings available when you edit a connection.
4. When you are finished, click Apply to apply any changes you made and keep the window open, or click OK to apply
changes and close the window.
Connection Properties page:
T o change the connection address and credentials, select Edit settings and then enter the new information.
T o specify the high-availability servers for a XenServer connection, select Edit HA servers. Citrix recommends that you
select all servers in the pool to allow communication with XenServer if the pool master fails.
Advanced page:
For a Microsoft System Center Conguration Manager (ConfMgr) Wake on LAN connection type, which isused with
Remote PC Access, enter ConfMgr Wake Proxy, magic packets, and packet transmission information.
T he throttling threshold settings enable you to specify a maximum number of power actions allowed on a connection.
T hese settings can help when power management settings allow too many or too few machines to start at the same
time. Each connection type has specic default values that are appropriate for most cases and should generally not be
changed.
T he Simultaneous actions (all types) and Simultaneous Personal vDisk inventory updates settings specify two values:
a maximum absolute number that can occur simultaneously on this connection, and a maximum percentage of all machines
that use this connection. You must specify both absolute and percentage values; the actual limit applied is the lower of the

values.
For example, in a deployment with 34 machines, if Simultaneous actions (all types) is set to an absolute value of 10 and a
percentage value of 10, the actual limit applied is 3 (that is, 10 percent of 34 rounded to the nearest whole number, which is
less than the absolute value of 10 machines).
T he Maximum new actions per minute is an absolute number; there is no percentage value.
Note: Enter information in the Connection options eld only under the guidance of a Citrix Support representative.
Turn maintenance mode on or off for a connection

Turning on maintenance mode for a connection prevents any new power action from affecting any machine stored on the
connection. Users cannot connect to a machine when it is in maintenance mode. If users are already connected,
maintenance mode takes effect when they log off.

2. Select the connection. T o turn maintenance mode on, select Turn On Maintenance Mode in the Actions pane. T o turn
maintenance mode off, select Turn Of f Maintenance Mode.
You can also turn maintenance mode on or off for individual machines. Additionally, you can turn maintenance mode on or
off for machines in Machine Catalogs or Delivery Groups.
Delete a connection
Caution: Deleting a connection can result in the deletion of large numbers of machines and loss of data. Ensure that user
data on affected machines is backed up or no longer required.
Before deleting a connection, ensure that:
All users are logged off from the machines stored on the connection.
No disconnected user sessions are running.
Maintenance mode is turned on for pooled and dedicated machines.
All machines in Machine Catalogs used by the connection are powered off.
A Machine Catalog becomes unusable when you delete a connection that is referenced by that catalog. If this connection
is referenced by a catalog, you have the option to delete the catalog. Before you delete a catalog, make sure it is not used
by other connections.

2. Select the connection and then select Delete Connection in the Actions pane.
3. If this connection has machines stored on it, you are asked whether the machines should be deleted. If they are to be
deleted, specify what should be done with the associated Active Directory computer accounts.
Rename or test a connection


2. Select the connection and then select Rename Connection or Test Connection in the Actions pane.
View machine details on a connection

2. Select the connection and then select View Machines in the Actions pane.
T he upper pane lists the machines accessed through the connection. Select a machine to view its details in the lower pane.
Session details are also provided for open sessions.
Use the search feature to nd machines quickly. Either select a saved search from the list at the top of the window, or
create a new search. You can either search by typing all or part of the machine name, or you can build an expression to use
for an advanced search. To build an expression, click Unf old, and then select from the lists of properties and operators.
Manage machines on a connection

2. Select a connection and then select View Machines in the Action pane.
3. Select one of the following in the Actions pane. Some actions may not be available, depending on the machine state
and the connection host type.
Start: Starts the machine if it is powered off or suspended.

Suspend: Pauses the machine without shutting it down, and refreshes the list of machines.
Shut down: Requests the operating system to shut down.
Force shut down: Forcibly powers off the machine, and refreshes the list of machines.
Restart: Requests the operating system to shut down and then start the machine again. If the operating system
cannot comply, the desktop remains in its current state.
Enable maintenance mode: T emporarily stops connections to a machine. Users cannot connect to a machine in this
state. If users are connected, maintenance mode takes effect when they log off. (You can also turn maintenance mode
on or off for all machines accessed through a connection, as described above.)
Remove f rom Delivery Group: Removing a machine from a Delivery Group does not delete it from the Machine Catalog
that the Delivery Group uses. You can remove a machine only when no user is connected to it; turn on maintenance
mode to temporarily prevent users from connecting while you are removing the machine.
Delete: When you delete a machine, users no longer have access to it, and the machine is deleted from the Machine
Catalog. Before deleting a machine, ensure that all user data is backed up or no longer required. You can delete a
machine only when no user is connected to it; turn on maintenance mode to temporarily stop users from connecting
while you are deleting the machine.
For actions that involve machine shutdown, if the machine does not shut down within 10 minutes, it is powered off. If
Windows attempts to install updates during shutdown, there is a risk that the machine will be powered off before the
updates are complete.
Edit storage
You can display the status of servers that are used to store operating system, temporary, and personal (PvD) data for VMs

that use a connection. You can also specify which servers to use for storage of each data type.

2. Select the connection and then select Edit Storage in the Actions pane.
3. In the left pane, select the data type: operating system, personal vDisk, or temporary.
4. Select or clear the checkboxes for one or more storage devices for the selected data type.
5. Click OK.
Each storage device in the list includes its name and storage status. Valid storage status values are:
In use: T he storage is being used for creating new machines.

Superseded: T he storage is being used only for existing machines. No new machines will be added in this storage.
Not in use: T he storage is not being used for creating machines.
If you clear the check box for a device that is currently In use, its status changes to Superseded. Existing machines will
continue to use that storage device (and can write data to it), so it is possible for that location to become full even after it
stops being used for creating new machines.
Delete, rename, or test resources

2. Select the resource and then select the appropriate entry in the Actions pane: Delete Resources, Rename Resources,
or Test Resources.
Use IntelliCache for XenServer connections

Using IntelliCache, hosted VDI deployments are more cost-effective because you can use a combination of shared storage
and local storage. T his enhances performance and reduces network trafc . T he local storage caches the master image
from the shared storage, which reduces the amount of reads on the shared storage. For shared desktops, writes to the
differencing disks are written to local storage on the host and not to shared storage.
Shared storage must be NFS when using IntelliCache.

Citrix recommends that you use a high performance local storage device to ensure the fastest possible data transfer.
To use IntelliCache, you must enable it in both this product and XenServer.
When installing XenServer, select Enable thin provisioning (Optimized storage f or XenDesktop). Citrix does not
support mixed pools of servers that have IntelliCache enabled and servers that do not. For more information, see the
XenServer documentation.
In XenApp and XenDesktop, IntelliCache is disabled by default. You can change the setting only when creating a
XenServer connection; you cannot disable IntelliCache later. When you add a XenServer connection from Studio:
Select Shared as the storage type.
Select the Use IntelliCache check box.
Connection timers

You can use policy settings to congure three connection timers:
Maximum connection timer: Determines the maximum duration of an uninterrupted connection between a user device
and a virtual desktop. Use the Session connection timer and Session connection timer interval policy settings.
Connection idle timer: Determines how long an uninterrupted user device connection to a virtual desktop will be
maintained if there is no input from the user. Use the Session idle timer and Session idle timer interval policy settings.
Disconnect timer: Determines how long a disconnected, locked virtual desktop can remain locked before the session is
logged off. Use the Disconnected session timer and Disconnected session timer interval policy settings .
When you update any of these settings, ensure they are consistent across your deployment.
See the policy settings documentation for more information.

Local Host Cache
May 22, 20 17
To ensure that the XenApp and XenDesktop Site database is always available, Citrix recommends starting with a fault-
tolerant SQL Server deployment, by following high availability best practices from Microsoft. (T he Databases section in the
System requirements article lists the SQL Server high availability features supported in XenApp and XenDesktop.) However,
network issues and interruptions may result in users not being able to connect to their applications or desktops.
T he Local Host Cache (LHC) feature allows connection brokering operations in a XenApp or XenDesktop Site to continue
when an outage occurs. An outage occurs when:
T he connection between a Delivery Controller and the Site database fails in an on-premises Citrix environment.
T he WAN link between the Site and the Citrix control plane fails in a Citrix Cloud environment.
Local Host Cache is the most comprehensive high availability feature in XenApp and XenDesktop. It is a more powerful
alternative to the connection leasing feature that was introduced in XenApp 7.6.
Although this Local Host Cache implementation shares the name of the Local Host Cache feature in XenApp 6.x and earlier
XenApp releases, there are signicant improvements. T his implementation is more robust and immune to corruption.
Maintenance requirements are minimized, such as eliminating the need for periodic dsmaint commands. T his Local Host
Cache is an entirely different implementation technically; read on to learn how it works.
How it works
T he following graphic illustrates the Local Host Cache components and communication paths during normal operations.
During normal operations:
T he principal broker (Citrix Broker Service) on a Controller accepts connection requests from StoreFront, and
communicates with the Site database to connect users with VDAs that are registered with the Controller.

A check is made every two minutes to determine whether changes have been made to the principal broker's
configuration. T hose changes could have been initiated by PowerShell/Studio actions (such as changing a Delivery Group
property) or system actions (such as machine assignments).
If a change has been made since the last check, the principal broker uses the Citrix Config Synchronizer Service (CSS) to
synchronize (copy) information to a secondary broker (Citrix High Availability Service) on the Controller. All broker
configuration data is copied, not just items that have changed since the previous check. T he secondary broker imports
the data into a Microsoft SQL Server Express LocalDB database on the Controller. T he CSS ensures that the information
in the secondary broker's LocalDB database matches the information in the Site database. T he LocalDB database is re-
created each time synchronization occurs.
If no changes have occurred since the last check, no data is copied.
T he following graphic illustrates the changes in communications paths if the principal broker loses contact with the Site
database (an outage begins):
When an outage begins:
T he principal broker can no longer communicate with the Site database, and stops listening for StoreFront and VDA
information (marked X in the graphic). T he principal broker then instructs the secondary broker (High Availability Service)
to start listening for and processing connection requests (marked with a red dashed line in the graphic).
When the outage begins, the secondary broker has no current VDA registration data, but as soon as a VDA
communicates with it, a re-registration process is triggered. During that process, the secondary broker also gets current
session information about that VDA.
While the secondary broker is handling connections, the principal broker continues to monitor the connection to the Site
database. When the connection is restored, the principal broker instructs the secondary broker to stop listening for
connection information, and the principal broker resumes brokering operations. T he next time a VDA communicates with
the principal broker, a re-registration process is triggered. T he secondary broker removes any remaining VDA registrations
from the previous outage, and resumes updating the LocalDB database with configuration changes received from the
CSS.
In the unlikely event that an outage begins during a synchronization, the current import is discarded and the last known
conguration is used.

T he event log provides information about synchronizations and outages. See the "Monitor" section below for details.
You can also intentionally trigger an outage; see the "Force an outage" section below for details about why and how to do
this.
Sites with multiple Controllers
Among its other tasks, the CSS routinely provides the secondary broker with information about all Controllers in the zone.
(If your deployment does not contain multiple zones, this action affects all Controllers in the Site.) Having that information,
each secondary broker knows about all peer secondary brokers.
T he secondary brokers communicate with each other on a separate channel. T hey use an alphabetical list of FQDN names
of the machines they're running on to determine (elect) which secondary broker will be in charge of brokering operations in
the zone if an outage occurs. During the outage, all VDAs re-register with the elected secondary broker. T he non-elected
secondary brokers in the zone will actively reject incoming connection and VDA registration requests.
If an elected secondary broker fails during an outage, another secondary broker is elected to take over, and VDAs will re-
register with the newly-elected secondary broker.
During an outage, if a Controller is restarted:
If that Controller is not the elected primary broker, the restart has no impact.
If that Controller is the elected primary broker, a different Controller is elected, causing VDAs to re-register. After the
restarted Controller powers on, it automatically takes over brokering, which causes VDAs to re-register again. In this
scenario, performance may be affected during the re-registrations.
If you power off a Controller during normal operations and then power it on during an outage, Local Host Cache cannot be
used on that Controller if it is elected as the primary broker.
T he event log provides information about elections. See the "Monitor" section below.
Design considerations and requirements

Local Host Cache is supported for server-hosted applications and desktops, and static (assigned) desktops; it is not
supported for pooled VDI desktops (created by MCS or PVS).
T here is no time limit imposed for operating in outage mode. However, restore the site to normal operation as quickly as
possible.
What is unavailable or changes during an outage
You cannot use Studio or run PowerShell cmdlets.

Hypervisor credentials cannot be obtained from the Host Service. All machines are in the unknown power state, and no
power operations can be issued. However, VMs on the host that are powered-on can be used for connection requests.
An assigned machine can be used only if the assignment occurred during normal operations. New assignments cannot be
made during an outage.
Automatic enrollment and configuration of Remote PC Access machines is not possible. However, machines that were
enrolled and configured during normal operation are usable.
Server-hosted applications and desktop users may use more sessions than their configured session limits, if the resources
are in different zones.

By default, power-managed desktop VDAs in pooled Delivery Groups that have the "ShutdownDesktopsAfterUse" property
enabled are placed into maintenance mode when an outage occurs. You can change this default, to allow those desktops
to be used during an outage. However, you cannot rely on the power management during the outage. (Power management
resumes after normal operations resume.) Also, those desktops might contain data from the previous user, because they
have not been restarted.
To override the default behavior, you must enable it site-wide and for each affected Delivery Group. Run the following
PowerShell cmdlets.
Set-BrokerSite CleanMachinesDuringOutageUnnecessaryAllowed $true

Set-BrokerDesktopGroup < name> CleanMachinesDuringOutageUnnecessary $true
Enabling this feature in the Site and the Delivery Groups does not affect how the congured
ShutdownDesktopsAfterUse property works during normal operations.
RAM size
T he LocalDB service can use approximately 1.2 GB of RAM (up to 1 GB for the database cache, plus 200 MB for running SQL
Server Express LocalDB). T he High Availability Service can use up to 1 GB of RAM if an outage lasts for an extended interval
with many logons occurring (for example, 12 hours with 10K users). T hese memory requirements are in addition to the
normal RAM requirements for the Controller, so you might need to increase the total amount of RAM capacity.
Note that if you use a SQL Server Express installation for the Site database, the server will have two sqlserver.exe
processes.
CPU core and socket conguration
A Controller's CPU conguration, particularly the number of cores available to the SQL Server Express LocalDB, directly
affects Local Host Cache performance, even more so than memory allocation. T his CPU overhead is observed only during
the outage period when the database is unreachable and the High Availability service is active.
While LocalDB can use multiple cores (up to 4), its limited to only a single socket. Adding more sockets will not improve the
performance (for example, having 4 sockets with 1 core each). Instead, Citrix recommends using multiple sockets with
multiple cores. In Citrix testing, a 2x3 (2 sockets, 3 cores) conguration provided better performance than 4x1 and 6x1
congurations.
Storage
As users access resources during an outage, the LocalDB grows. For example, during a logon/logoff test running at 10
logons per second, the database grew by one MB every 2-3 minutes. When normal operation resumes, the local database is
recreated and the space is returned. However, the broker must have sufcient space on the drive where the LocalDB is
installed to allow for the database growth during an outage. Local Host Cache also incurs additional I/O during an outage:
approximately 3 MB of writes per second, with several hundred thousand reads.
Perf ormance
During an outage, one broker handles all the connections, so in Sites (or zones) that load balance among multiple
Controllers during normal operations, the elected broker might need to handle many more requests than normal during an
outage. T herefore, CPU demands will be higher. Every broker in the Site (zone) must be able to handle the additional load
imposed by LocalDB and all of the affected VDAs, because the broker elected during an outage could change.

VDI limits:
In a single-zone VDI deployment, up to 10,000 VDAs can be handled effectively during an outage.
In a multi-zone VDI deployment, up to 10,000 VDAs in each zone can be handled effectively during an outage, to a
maximum of 40,000 VDAs in the site. For example, each of the following sites can be handled effectively during an
outage:
A site with four zones, each containing 10,000 VDAs.
A site with seven zones, one containing 10,000 VDAs, and six containing 5,000 VDAs each.
During an outage, load management within the Site may be affected. Load evaluators (and especially, session count rules)
may be exceeded.
During the time it takes all VDAs to re-register with a broker, that broker might not have complete information about
current sessions. So, a user connection request during that interval could result in a new session being launched, even
though reconnection to an existing session was possible. T his interval (while the "new" broker acquires session information
from all VDAs during re-registration) is unavoidable. Note that sessions that are connected when an outage starts are not
impacted during the transition interval, but new sessions and session reconnections could be.
T his interval occurs whenever VDAs must re-register with a different broker:
An outage starts: When migrating from a principal broker to a secondary broker.

Broker failure during an outage: When migrating from a secondary broker that failed to a newly-elected secondary
broker.
Recovery from an outage: When normal operations resume, and the principal broker resumes control.
You can decrease the interval by lowering the Citrix Broker Protocol's HeartbeatPeriodMs registry value (default = 600000
ms, which is 10 minutes), but the interval cannot be eliminated entirely, no matter how quickly the VDAs register. For
example, the following command changes the heartbeat to ve minutes (300000 milliseconds):
New-ItemProperty -Path HKLM:\SOFT WARE\Citrix\DesktopServer -Name HeartbeatPeriodMs

-PropertyType DWORD Value 300000
T he time it takes to synchronize between brokers increases with the number of objects (such as VDAs, applications,
groups). For example, synchronizing 5000 VDAs might take ten minutes of more to complete. See the "Monitor" section
below for information about synchronization entries in the event log.
Manage Local Host Cache

SQL Server Express LocalDB
T he Microsoft SQL Server Express LocalDB that Local Host Cache uses is installed automatically when you install a
Controller or upgrade a Controller from a version earlier than 7.9. T here is no administrator maintenance needed for the
LocalDB. Only the secondary broker communicates with this database; you cannot use PowerShell cmdlets to change
anything about this database. T he LocalDB cannot be shared across Controllers.
T he SQL Server Express LocalDB database software is installed regardless of whether Local Host Cache is enabled.
To prevent its installation, install or upgrade the Controller using the XenDesktopServerSetup.exe command, and
include the /exclude "Local Host Cache Storage (LocalDB)" option. However, keep in mind that the Local Host Cache

feature will not work without the database, and you cannot use a different database with the secondary broker.
Note: Installation of this LocalDB database has no effect on whether or not you install SQL Server Express for use as the
site database.
Def ault settings af ter XenApp or XenDesktop installation and upgrade
T he following table shows the Local Host Cache and connection leasing settings after a new XenApp or XenDesktop
installation, and after an upgrade to XenApp or XenDesktop 7.12 (or later supported version).
Operation Number of Connection leasing Local Host Cache af ter Connection leasing af ter
VDAs bef ore operation operation operation
Install any - Disabled Enabled
Upgrade < 5K Enabled Disabled Enabled
Upgrade < 5K Disabled Enabled Disabled
Upgrade > 5K Enabled Disabled Enabled
Upgrade > 5K Disabled Disabled Disabled
Install: After a new XenApp or XenDesktop installation, Local Host Cache is disabled and connection leasing is enabled by
default.
Upgrade: T he number of VDAs in a Site affects the default Local Host Cache setting after an upgrade. T he connection
leasing setting does not change because of the upgrade.
If your site has fewer than 5,000 VDAs:
Local Host Cache is enabled if connection leasing was disabled before the upgrade. Connection leasing remains disabled.
Local Host Cache is disabled if connection leasing was enabled before the upgrade. Connection leasing remains enabled.
If your site has 5,000 or more VDAs:
Local Host Cache is disabled (regardless of the connection leasing setting), and connection leasing retains the same
setting it had before the upgrade.
Enable and disable Local Host Cache
To enable Local Host Cache, enter:
Set-BrokerSite -LocalHostCacheEnabled $true -ConnectionLeasingEnabled $f alse
T his cmdlet also disables the connection leasing feature. Do not enable both Local Host Cache and connection leasing.

To determine whether Local Host Cache is enabled, enter:
Get-BrokerSite
Check that the LocalHostCacheEnabled property is True, and that the ConnectionLeasingEnabled property is False.
To disable Local Host Cache (and enable connection leasing), enter:
Set-BrokerSite -LocalHostCacheEnabled $f alse -ConnectionLeasingEnabled $true
Force an outage
You might want to deliberately force a database outage.
If your network is going up and down repeatedly. Forcing an outage until the network issues resolve prevents
continuous transition between normal and outage modes.
T o test a disaster recovery plan.
While replacing or servicing the site database server.
To force an outage, edit the registry of each server containing a Delivery Controller.
In HKLM\Software\Citrix\DesktopServer\LHC, set OutageModeForced to 1. T his instructs the broker to enter outage

mode, regardless of the state of the database. (Setting the value to 0 takes the server out of outage mode.)
In a Citrix Cloud scenario, the connector enters outage mode, regardless of the state of the connection to the control
plane or primary zone.
Monitor
Event logs indicate when synchronizations and outages occur.
Cong Synchronizer Service
During normal operations, the following events can occur when the CSS copies and exports the broker conguration and
imports it to the LocalDB using the High Availability Service (secondary broker).
503: A change was found in the principal broker configuration, and an import is starting.
504: T he broker configuration was copied, exported, and then imported successfully to the LocalDB.
505: An import to the LocalDB failed; see below for more information.
High Availability Service
3502: An outage occurred and the secondary broker (High Availability Service) is performing brokering operations.
3503: An outage has been resolved and normal operations have resumed.
3504: Indicates which secondary broker is elected, plus other brokers involved in the election.
Troubleshoot
Several troubleshooting tools are available when an synchronization import to the LocalDB fails and a 505 event is posted.
CDF tracing: Contains options for the CongSyncServer and BrokerLHC modules. T hose options, along with other broker

modules, will likely identify the problem.
Report: You can generate and provide a report that details the failure point. T his report feature affects synchronization
speed, so Citrix recommends disabling it when not in use.
To enable and produce a CSS trace report, enter:
New-ItemProperty -Path HKLM:\SOFT WARE\Citrix\DesktopServer\LHC -Name EnableCssTraceMode -PropertyType

DWORD -Value 1
T he HT ML report is posted at
C:\Windows\ServiceProles\NetworkService\AppData\Local\Temp\CitrixBrokerCongSyncReport.htmll
After the report is generated, disable the reporting feature:
Set-ItemProperty -Path HKLM:\SOFT WARE\Citrix\DesktopServer\LHC -Name EnableCssTraceMode -Value 0
Export the broker conguration: Provides the exact conguration for debugging purposes.
Export-BrokerConguration | Out-File < le-pathname>
For example, Export-BrokerConguration | Out-File C:\BrokerCong.xml.

Connection leasing
May 22, 20 17
Important: Local Host Cache (LHC) is the preferred XenApp and XenDesktop high availability solution, instead of
connection leasing. See the Local Host Cache article for details about the feature, and how to enable it. Do not have both
features enabled at the same time.
To ensure that the Site database is always available, Citrix recommends starting with a fault-tolerant SQL Server
deployment by following high availability best practices from Microsoft. However, network issues and interruptions may
prevent Delivery Controllers from accessing the database, resulting in users not being able to connect to their applications
or desktop.
T he connection leasing feature supplements the SQL Server high availability best practices by enabling users to connect
and reconnect to their most recently used applications and desktops, even when the Site database is not available.
Although users may have a large number of published resources available, they often use only a few of them regularly.
When you enable connection leasing, each Controller caches user connections to those recently used applications and
desktops during normal operations (when the database is available).
T he leases generated on each Controller are uploaded to the Site database for periodic synchronization to other
Controllers on the Site. In addition to leases, each Controllers cache holds application, desktop, icon, and worker
information. T he lease and related information is stored on each Controllers local disk. If the database becomes
unavailable, the Controller enters leased connection mode and replays the cached operations when a user attempts to
connect or reconnect to a recently used application or desktop from StoreFront.
Connections are cached for a lease period of two weeks. So, if the database becomes unavailable, the desktops and
applications that the user launched in the previous two weeks remain accessible to that user through StoreFront. However,
desktops and applications that have not been launched during the previous two-week lease period are not accessible when
the database is unavailable. For example, if a user last launched an application three weeks ago, its lease has expired, and
that user cannot launch that application if the database becomes unavailable now. Leases for long-running active or
disconnected application or desktop sessions are extended so that they are not they are not considered expired.
By default, connection leasing affects the entire Site; however, you can revoke all leases for specic users, which prevents
them from accessing any applications or desktops when the Controller is in leased connection mode. Several other registry
settings apply on a Controller basis.
Considerations and limitations
While connection leasing can improve connection resiliency and user productivity, there are considerations related to the
availability, operation, and performance of other features.
Connection leasing is supported for server-hosted applications and desktops, and static (assigned) desktops; it is not
supported for pooled VDI desktops or for users who have not been assigned a desktop when the database becomes
unavailable.
When the Controller is in leased connection mode:

Administrators cannot use Studio, Director, or the PowerShell console.
Workspace Control is not available. When a user logs on to Citrix Receiver, sessions do not automatically reconnect; the
user must relaunch the application.

If a new lease is created immediately before the database becomes unavailable, but the lease information has not yet
been synchronized across all Controllers, the user might not be able to launch that resource after the database becomes
unavailable.
Server-hosted application and desktop users may use more sessions than their configured session limits. For example:
A session may not roam when a user launches it from one device (connecting externally through NetScaler Gateway)
when the Controller is not in leased connection mode and then connects from another device on the LAN when the
Controller is in leased connection mode.
Session reconnection may fail if an application launches just before the database becomes unavailable; in such cases,
a new session and application instance are launched.
Static (assigned) desktops are not power-managed. VDAs that are powered off when the Controller enters leased
connection mode remain unavailable until the database connection is restored, unless the administrator manually powers
them on.
If session prelaunch and session linger are enabled, new prelaunch sessions are not started. Prelaunched and lingering
sessions will not be ended according to configured thresholds while the database is unavailable.
Load management within the Site may be affected. Server-based connections are routed to the most recently used
VDA. Load evaluators (and especially, session count rules) may be exceeded.
T he Controller will not enter leased connection mode if you use SQL Server Management Studio to take the database
offline. Instead, use one of the following T ransact-SQL statements:
ALT ER DAT ABASE <database-name> SET OFFLINE WIT H ROLLBACK IMMEDIAT E
ALT ER DAT ABASE <database-name> SET OFFLINE WIT H ROLLBACK AFT ER <seconds>
Either statement cancels any pending transactions and causes the Controller to lose its connection with the database.
T he Controller then enters leased connection mode.
When connection leasing is enabled, there are two brief intervals during which users cannot connect or reconnect: (1) from
the time the database becomes unavailable to when the Controller enters leased connection mode, and (2) from the time
the Controller changes from leased connection mode to when database access is fully restored and the VDAs have re-
registered.
If you congure a nondefault session roaming value, session reconnection reverts to its default value when a Controller
enters leased connection node. For details, see Connection leasing and session roaming.
See the Zones article for information about where connection leasing data is kept.
For more considerations, see XenDesktop 7.6 Connection Leasing Design Considerations.
Congure and deploy
When configuring your deployment to accommodate connection leasing:

VDAs must be at minimum version 7.6, and the Machine Catalogs and Delivery Groups that use those machines must be
at that minimum level (or a later supported version).
T he Site database size requirements will increase.
Each Controller needs additional disk space for the cached lease files.
Connection leasing is enabled by default.
You can turn connection leasing off or on from the PowerShell SDK or the Windows registry. From the PowerShell SDK,
you can also remove current leases. T he following PowerShell cmdlets affect connection leasing; see the cmdlet help for
details.
Set-BrokerSite -ConnectionLeasingEnabled $true|$false - T urns connection leasing on or off. Default = $true

Get-BrokerServiceAddedCapability - Outputs ConnectionLeasing for the local Controller.
Get-BrokerLease - Retrieves either all or a filtered set of current leases.
Remove-BrokerLease - Marks either one or a filtered set of leases for deletion.
Update-BrokerLocalLeaseCache Updates the connection leasing cache on the local Controller. T he data is
resynchronized during the next synchronization.

May 22, 20 17
Note: T hese features are valid only for supported Windows server machines. T hey do not apply to Windows desktop OS
machines.
T he Microsoft virtual IP address feature provides a published application with a unique dynamically-assigned IP address for
each session. T he Citrix virtual loopback feature allows you to congure applications that depend on communications with
localhost (127.0.0.1 by default) to use a unique virtual loopback address in the localhost range (127.*).
Certain applications, such as CRM and Computer Telephony Integration (CT I), use an IP address for addressing, licensing,
identication, or other purposes and thus require a unique IP address or a loopback address in sessions. Other applications
may bind to a static port, so attempts to launch additional instances of an application in a multiuser environment will fail
because the port is already in use. For such applications to function correctly in a XenApp environment, a unique IP address
is required for each device.
Virtual IP and virtual loopback are independent features. You can use either or both.
Administrator action synopsis:

T o use Microsoft virtual IP, enable and configure it on the Windows server.
T o use Citrix virtual loopback, configure two settings in a Citrix policy.
Virtual IP
When virtual IP is enabled and configured on the Windows server, each configured application running in a session appears
to have a unique address. Users access these applications on a XenApp server in the same way they access any other
published application. A process requires virtual IP in either of the following cases:
T he process uses a hard-coded T CP port number
T he process uses Windows sockets and requires a unique IP address or a specified T CP port number
T o determine if an application needs to use virtual IP addresses:

1. Obtain the T CPView tool from Microsoft. T his tool lists all applications that bind specific IP addresses and ports.
2. Disable the Resolve IP Addresses feature so that you see the addresses instead of host names.
3. Launch the application and use T CPView to see which IP addresses and ports are opened by the application and which
process names are opening these ports.
4. Configure any processes that open the IP address of the server, 0.0.0.0, or 127.0.0.1.
5. T o ensure that an application does not open the same IP address on a different port, launch an additional instance of
the application.
How Microsof t Remote Desktop (RD) IP virtualization works

Virtual IP addressing must be enabled on the Microsoft server.
For example, in a Windows Server 2008 R2 environment, from Server Manager, expand Remote Desktop Services > RD
Session Host Connections to enable the RD IP Virtualization feature and congure the settings to dynamically assign IP
addresses using the Dynamic Host Conguration Protocol (DHCP) server on a per-session or per-program basis. See the
Microsoft documentation for instructions.
After the feature is enabled, at session start-up, the server requests dynamically-assigned IP addresses from the DHCP
server.
T he RD IP Virtualization feature assigns IP addresses to remote desktop connections per-session or per-program. If you

assign IP addresses for multiple programs, they share a per-session IP address.
After an address is assigned to a session, the session uses the virtual address rather than the primary IP address for the
system whenever the following calls are made: bindclosesocketconnect, WSAConnect, WSAAccept, getpeername,
getsockname, sendto, WSASendT o, WSASocketW, gethostbyaddr, getnameinfo, getaddrinfo
When using the Microsoft IP virtualization feature within the Remote Desktop session hosting conguration, applications
are bound to specic IP addresses by inserting a lter component between the application and Winsock function calls.
T he application then sees only the IP address it should use. Any attempt by the application to listen for TCP or UDP
communications is bound to its allocated virtual IP address (or loopback address) automatically, and any originating
connections opened by the application originate from the IP address bound to the application.
In functions that return an address (such as GetAddrInfo(), which is controlled by a Windows policy), if the local host IP
address is requested, virtual IP looks at the returned IP address and changes it to the virtual IP address of the session.
Applications that attempt to get the IP address of the local server through such name functions see only the unique virtual
IP address assigned to that session. T his IP address is often used in subsequent socket calls, such as bind or connect.
Often, an application requests to bind to a port for listening on the address 0.0.0.0. When an application does this and uses
a static port, you cannot launch more than one instance of the application. T he virtual IP address feature also looks for
0.0.0.0 in these call types and changes the call to listen on the specic virtual IP address, which enables more than one
application to listen on the same port on the same computer because they are all listening on different addresses. T he call
is changed only if it is in an ICA session and the virtual IP address feature is enabled. For example, if two instances of an
application running in different sessions both try to bind to all interfaces (0.0.0.0) and a specic port (such as 9000), they are
bound to VIPAddress1:9000 and VIPAddress2:9000 and there is no conict.
Virtual loopback
Enabling the Citrix virtual IP loopback policy settings allows each session to have its own loopback address for
communication. When an application uses the localhost address (default = 127.0.0.1) in a Winsock call, the virtual loopback
feature simply replaces 127.0.0.1 with 127.X.X.X, where X.X.X is a representation of the session ID + 1. For example, a session
ID of 7 is 127.0.0.8. In the unlikely event that the session ID exceeds the fourth octet (more than 255), the address rolls
over to the next octet (127.0.1.0), to the maximum of 127.255.255.255.
A process requires virtual loopback in either of the following cases:

T he process uses the Windows socket loopback (localhost) address (127.0.0.1)
T he process uses a hard-coded T CP port number
Use the virtual loopback policy settings for applications that use a loopback address for interprocess communication. No
additional configuration is required. Virtual loopback has no dependency on Virtual IP, so you do not have to configure the
Microsoft server.
Virtual IP loopback support. When enabled, this policy setting allows each session to have its own virtual loopback
address. T his setting is disabled by default. T he feature applies only to applications specified with the Virtual IP virtual
loopback programs list policy setting.
Virtual IP virtual loopback programs list. T his policy setting specifies the applications that use the virtual IP loopback
feature. T his setting applies only when the Virtual IP loopback support policy setting is enabled.
Related f eature
You can use the following registry settings to ensure that virtual loopback is given preference over virtual IP; this is called
preferred loopback. However, proceed with caution:
Preferred loopback is supported on Windows 2008 R2 only.

Use preferred loopback only if both Virtual IP and virtual loopback are enabled; otherwise, you may have unintended
results.
Editing the registry incorrectly can cause serious problems that may 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.
Run regedit on the servers where the applications reside.

HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Citrix\VIP (HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\VIP for
32-bit machines)
Name: PreferLoopback, T ype: REG_DWORD, Data: 1
Name: PreferLoopbackProcesses, T ype: REG_MULT I_SZ, Data: <list of processes>

May 22, 20 17
T he Delivery Controller is the server-side component that is responsible for managing user access, plus brokering and
optimizing connections. Controllers also provide the Machine Creation Services that create desktop and server images.
A Site must have at least one Controller. After you install the initial Controller, you can add more Controllers when you
create a Site, or later. T here are two primary benets from having more than one Controller in a Site.
Redundancy: As best practice, a production Site should always have at least two Controllers on different physical servers.
If one Controller fails, the others can manage connections and administer the Site.
Scalability: As Site activity grows, so does CPU utilization on the Controller and database activity. Additional Controllers
provide the ability to handle more users and more applications and desktop requests, and can improve overall
responsiveness.
Each Controller communicates directly with the Site database. In a Site with more than one zone, the Controllers in every
zone communicate with the Site database in the primary zone.
Important: Do not change the computer name or the domain membership of a Controller after the Site is congured.
How VDAs register with Controllers

Before a VDA can be used, it must register (establish communication) with a Delivery Controller in the Site. For information
about VDA registration, see VDA registration with Controllers.
(In the documentation for earlier XenApp and XenDesktop 7.x releases, information about VDA registration was included in
this article. T hat information has been enhanced and now resides in the article linked above.)
Add, remove, or move Controllers

To add, remove, or move a Controller, you must have the server role and database role permissions listed in the Databases
article.
Note: Installing a Controller on a node in an SQL clustering or SQL mirroring installation is not supported.
If your deployment uses database mirroring:
Before adding, removing, or moving a Controller, ensure that the principal and mirrored databases are both running. In
addition, if you are using scripts with SQL Server Management Studio, enable SQLCMD mode before executing the
scripts.
T o verify mirroring after adding, removing, or moving a Controller, run the PowerShell get-conf igdbconnection cmdlet
to ensure that the Failover Partner has been set in the connection string to the mirror.
After you add, remove, or move a Controller:
If auto-update is enabled, the VDAs will receive an updated list of Controllers within 90 minutes.
If auto-update is not enabled, ensure that the Controller policy setting or ListOfDDCs registry key are updated for all

VDAs. After moving a Controller to another Site, update the policy setting or registry key on both Sites.
Add a Controller
You can add Controllers when you create a Site and later. You cannot add Controllers installed with an earlier version of this
software to a Site that was created with this version.
1. Run the installer on a server containing a supported operating system. Install the Delivery Controller component and any
other core components you want. Complete the installation wizard.
2. If you have not yet created a Site, launch Studio; you are prompted to create a Site. On the Databases page in the Site
creation wizard, click the Select button and then add the address of the server where you installed the additional
Controller. Important: If you plan to generate scripts that will initialize the databases, add the Controllers before you
generate the scripts.
3. If you have already created a Site, point Studio to the server where you installed the additional Controller. Click Scale
your deployment and enter the Site address.
Remove a Controller
Removing a Controller from a Site does not uninstall the Citrix software or any other component; it removes the Controller
from the database so that it can no longer be used to broker connections and perform other tasks. If you remove a
Controller, you can later add it back to the same Site or to another Site. A Site requires at least one Controller, so you
cannot remove the last one listed in Studio.
When you remove a Controller from a Site, the Controller logon to the database server is not removed. T his avoids
potentially removing a logon that is used by other products' services on the same machine. T he logon must be removed
manually if it is no longer required; the securityadmin server role permission is needed to remove the logon.
Important: Do not remove the Controller from Active Directory until after you remove it from the Site.
1. Make sure the Controller is powered on so that Studio loads in less than one hour. Once Studio loads the Controller you
want to remove, power off the Controller when prompted to do so.
2. Select Conf iguration > Controllers in the Studio navigation pane and then select the Controller you want to remove.
3. Select Remove Controller in the Actions pane. If you do not have the correct database roles and permissions, you are
offered the option of generating a script that allows your database administrator to remove the Controller for you.
4. You might need to remove the Controllers machine account from the database server. Before doing this, check that
another service is not using the account.
After using Studio to remove a Controller, trafc to that Controller might linger for a short amount of time to ensure
proper completion of current tasks. If you want to force the removal of a Controller in a very short time, Citrix recommends
you shut down the server where it was installed, or remove that server from Active Directory. T hen, restart the other
Controllers on the Site to ensure no further communication with the removed Controller.
Move a Controller to another zone
If your Site contains more than one zone, you can move a Controller to a different zone. See the Zones article for
information about how this can affect VDA registration and other operations.
1. Select Conf iguration > Controllers in the Studio navigation pane and then select the Controller you want to move.
2. Select Move in the Actions pane.
3. Specify the zone where you want to move the Controller.

Move a Controller to another Site
You cannot move a Controller to a Site that was created with an earlier version of this software.
1. On the Site where the Controller is currently located (the old Site), select Conf iguration > Controllers in the Studio
navigation pane and then select the Controller you want to move.
2. Select Remove Controller in the Actions pane. If you do not have the correct database roles and permissions, you are
offered the option of generating a script that allows someone with those permissions (such as a database
administrator) to remove the Controller for you. A Site requires at least one Controller, so you cannot remove the last
one listed in Studio.
3. On the Controller you are moving, open Studio, reset the services when prompted, select Join existing site, and enter
the address of the new Site.
Move a VDA to another Site
If a VDA was provisioned using Provisioning Services or is an existing image, you can move a VDA to another Site (from Site
1 to Site 2) when upgrading, or when moving a VDA image that was created in a test Site to a production Site. VDAs
provisioned using Machine Creation Services (MCS) cannot be moved from one Site to another because MCS does not
support changing the ListOfDDCs a VDA checks to register with a Controller; VDAs provisioned using MCS always check the
ListOfDDCs associated with the Site in which they were created.
T here are two ways to move a VDA to another Site: using the installer or Citrix policies.
Installer: Run the installer and add a Controller, specifying the FQDN (DNS entry) of a Controller in Site 2.
Important: Specify Controllers in the installer only when the Controllers policy setting is not used.
Group Policy Editor: T he following example moves multiple VDAs between Sites.
1. Create a policy in Site 1 that contains the following settings, then filter the policy to the Delivery Group level to initiate a
staged VDA migration between the Sites.
Controllers - containing FQDNs (DNS entries) of one or more Controllers in Site 2.
Enable auto update of Controllers - set to disabled.
2. Each VDA in the Delivery Group is alerted within 90 minutes of the new policy. T he VDA ignores the list of Controllers it
receives (because auto-update is disabled); it selects one of the Controllers specified in the policy, which lists the
Controllers in Site 2.
3. When the VDA successfully registers with a Controller in Site 2, it receives the Site 2 ListOfDDCs and policy information,
which has auto-update enabled by default. Since the Controller with which the VDA was registered in Site 1 is not on the
list sent by the Controller in Site 2, the VDA re-registers, choosing among the Controllers in the Site 2 list. From then on,
the VDA is automatically updated with information from Site 2.

May 22, 20 17
Introduction
Before a VDA can be used, it must register (establish communication) with one or more Controllers on the site. T he VDA
nds a Controller by checking a list of Controllers called the ListofDDCs. T he ListOfDDCs on a VDA contains DNS entries
that point that VDA to Controllers on the site. For load balancing, the VDA automatically distributes connections across all
Controllers in the list.
Why is VDA registration so important?
From a security perspective, registration is a sensitive operation: youre establishing a connection between the Delivery
Controller and the VDA. For such a sensitive operation, the expected behavior is to reject the connection if everything is
not in perfect shape. You are effectively establishing two separate communication channels: VDA to Controller, and
Controller to VDA. T he connection uses Kerberos, so time synchronization and domain membership issues are
unforgiving. Kerberos uses Service Principal Names (SPNs), so you cannot use load balanced IP\hostname.
If a VDA does not have accurate and current Controller information as you add and remove Controllers in a site, the VDA
might reject session launches that were brokered by an unlisted Controller. Invalid entries can delay the startup of the
virtual desktop system software. A VDA won't accept a connection from an unknown and untrusted Controller.
In addition to the ListOfDDCs, the ListOfSIDs (Security IDs) indicates which machines in the ListOfDDCs are trusted. T he
ListOfSIDs can be used to decrease the load on Active Directory or to avoid possible security threats from a compromised
DNS server. For more information, see ListOfSIDs below.
If a ListOfDDCs species more than one Controller, the VDA attempts to connect to them in random order. T he
ListOfDDCs can also contain Controller groups. T he VDA attempts to connect to each Controller in a group before moving
to other entries in the ListOfDDCs.
XenApp and XenDesktop automatically test the connectivity to congured Controllers during VDA installation. Errors are
displayed if a Controller cannot be reached. If you ignore a warning that a Controller cannot be contacted (or when you do
not specify Controller addresses during VDA installation), messages remind you.
Methods for conguring Controller addresses

T he administrator chooses the conguration method to use when the VDA registers with a Controller for the rst time.
(T his is called the initial registration.) During the initial registration, a persistent cache is created on the VDA. During
subsequent registrations, the VDA retrieves the list of Controllers from this local cache, unless a conguration change is
detected.
T he easiest way to retrieve that list during subsequent registrations is by using the auto-update feature. Auto-update is
enabled by default. For more information, see Auto-update.
T here are several methods for conguring Controller addresses on a VDA.
Policy-based (LGPO or GPO)

Registry-based (manual, GPP, specified during VDA installation)
Active Directory OU-based (legacy OU discovery)
MCS-based (personality.ini)
You specify the initial registration method when you install a VDA. (If you disable auto-update, the method you select
during VDA installation will also be used for subsequent registrations.)
T he following graphic shows the Delivery Controller page of the VDA installation wizard.
Policy-based (LGPO\GPO)
Citrix recommends using GPO for initial VDA registration. It has the highest priority. (Auto-update is listed above as the
highest priority, but auto-update is used only after the initial registration.) Policy-based registration offers the centralizing
advantages of using Group Policy for conguration.
To specify this method, complete both of the following steps:
On the Delivery Controller page in the VDA installation wizard, select Do it later (advanced). T he wizard reminds you
several times to specify Controller addresses, even though you're not specifying them during VDA installation. (Because
VDA registration is that important!)
Enable or disable policy-based VDA registration through Citrix policy with the Virtual Delivery Agent Settings > Controllers
setting. (If security is your top priority, use the Virtual Delivery Agent Settings > Controller SIDs setting.)
T his setting is stored under HKLM\Software\Policies\Citrix\VirtualDesktopAgent (ListOfDDCs).
In the last step of the example in the auto-update section, we moved Controller B to a different Site. Auto-update takes
care of updating the caches for VDAs in the Site where Controller B previously resided. T he administrator for the Site where
Controller B now resides simply creates/updates the policy setting to add the FQDN of Controller B.
Registry-based

To specify this method, complete one of the following steps:
On the Delivery Controller page in the VDA installation wizard, select Do it manually. T hen, enter the FQDN of an
installed Controller and then click Add. If you've installed additional Controllers, add their addresses.
For a command-line VDA installation, use the /controllers option and specify the FQDNs of the installed Controllers.
T his information is usually stored in registry value ListOfDDCs under registry key
HKLM\Software\Citrix\VirtualDesktopAgent or HKLM\Software\Wow6432Node\Citrix\VirtualDesktopAgent.
You can also congure this registry key manually or use Group Policy Preferences (GPP). T his method might be preferable to
the policy-based method (for example, if you want conditional processing of different Controllers, such as: use XDC-001 for
computer names that begin with XDW-001-).
Update the ListOfDDCs registry key, which lists the FQDNs of all the Controllers in the Site. (T his key is the equivalent
of the Active Directory Site OU.)
HKEY_LOCAL_MACHINE\Software\Citrix\VirtualDesktopAgent\ListOfDDCs (REG_SZ)
If the HKEY_LOCAL_MACHINE\Software\Citrix\VirtualDesktopAgent registry location contains both the ListOfDDCs

and FarmGUID keys, ListOfDDCs is used for Controller discovery. FarmGUID is present if a site OU was specied during
VDA installation. (T his might be used in legacy deployments.)
Optionally, update the ListOfSIDs registry key (for more information, see ListOfSIDs below):
HKEY_LOCAL_MACHINE\Software\Citrix\VirtualDesktopAgent\ListOfSIDs (REG_SZ)
Remember: If you also enable policy-based VDA registration through Citrix policy, that conguration overrides settings you
specify during VDA installation, because it is a higher-priority method.
Active Directory OU-based (legacy)
T his method is supported primarily for backward compatibility and is not recommended. If youre still using it, Citrix suggests
changing to another method.
To specify this method, complete both of the following steps:
On the Delivery Controller page in the VDA installation wizard, select Choose locations f rom Active Directory.
Use the Set-ADControllerDiscovery.ps1 script (available on every Controller). Also, configure the FarmGuid registry entry
on each VDA to point to the right OU. T his setting can be configured using Group Policy.
For more details, see Active Directory OU-based discovery.
MCS-based
If you plan to use only MCS to provision VMs, you can instruct MCS to set up the list of Controllers. T his feature works with
auto-update: MCS injects the list of Controllers into the Personality.ini le during initial provisioning (when creating the
machine catalog). Auto-update keeps the list up-to-date.
T his method is not recommended for use in large environments. You can use this method if you:
Have a small environment

Will not move VDAs between sites
Use only MCS to provision VMs

Dont want to use Group Policy
To specify this method:
On the Delivery Controller page in the VDA installation wizard, select Let Machine Creation Services do it.
Recommendations
As best practice:
Use the Group Policy registration method for initial registration.

Use auto-update (enabled by default) to keep your list of Controllers up-to-date.
In a multi-zone deployment, use Group Policy for initial configuration (with at least two Controllers). Point VDAs to
Controllers local to (in) their zone. Use auto-update to keep them up-to-date. Auto-update automatically optimizes the
ListOfDDCs for VDAs in satellite zones.
Auto-update
Auto-update (introduced in XenApp and XenDesktop 7.6) is enabled by default. It is the most efcient method for keeping
your VDA registrations up-to-date. Although auto-update is not used for initial registration, the auto-update software
downloads and stores the ListOfDDCs in a persistent cache on the VDA when initial registration occurs. T his is done for
each VDA. (T he cache also holds machine policy information, which ensures that policy settings are retained across
restarts.)
Auto-update is supported when using MCS or PVS to provision machines, except for PVS server-side cache and for
persistent VMs that are manually provisioned.
To specify this method:
Enable or disable auto-update through a Citrix policy containing the setting: Virtual Delivery Agent Settings > Enable
auto update of Controllers. T his setting is enabled by default.
How it works:
Each time a VDA re-registers (for example, after a machine restart), the cache is updated. Each Controller also checks the
site database every 90 minutes. If a Controller has been added or removed since the last check, or if a policy change
occurred that affects VDA registration, the Controller sends an updated list to its registered VDAs and the cache is
updated. T he VDA accepts connections from all the Controllers in its most recently-cached list.
If a VDA receives a list that does not include the Controller it is registered with (in other words, that Controller was
removed from the site), the VDA re-registers, choosing among the Controllers in the ListOfDDCs.
For example:
A deployment has three Controllers: A, B, and C. A VDA registers with Controller B (which was specified during VDA
installation).
Later, two Controllers (D and E) are added to the Site. Within 90 minutes, VDAs receive updated lists and then accept
connections from Controllers A, B, C, D, and E. (T he load is not spread equally to all Controllers until the VDAs are
restarted.)
Later still, Controller B is moved to another Site. Within 90 minutes, VDAs in the original Site receive updated lists because
there has been a Controller change since the last check. T he VDA that originally registered with Controller B (which is no

longer on the list) re-registers, choosing among the Controllers in the current list (A, C, D, and E).
In a multi-zone deployment, auto-update in a satellite zone automatically caches all local Controllers rst. All Controllers in
the primary zone are cached in a backup group. If no local Controllers in the satellite zone are available, registration is
attempted with Controllers in the primary zone.
As shown in the following example, the cache le contains hostnames and a list of Security IDs (ListOfSIDs). T he VDA does
not query SIDs, which reduces the Active Directory load.
You can retrieve the cache le with a WMI call; however, it is stored in a location that's readable only by the SYST EM
account. Important: T his information is provided only for information purposes. DO NOT MODIFY T HIS FILE. Any
modications to this le or folder results in an unsupported conguration.
Get-WmiObject -Namespace Root\Citrix\DesktopInformation

-Class Citrix_VirtualDesktopInfo -Property PersistentDataLocation
If you need to manually congure the ListOfSIDs for security reasons (as distinct from reducing Active Directory load), you
cannot use the auto-update feature. For details, see ListOfSIDs below.
Exception to auto-update priority
Although auto-update usually has the highest priority of all VDA registration methods and overrides settings for other
methods, there is an exception. T he NonAutoListOfDDCs elements in the cache specify the initial VDA conguration
method. Auto-update monitors this information. If the initial registration method changes, the registration process skips
auto-update, and uses the next-highest congured priority method. T his can be helpful when you move a VDA to another
site (for example, during disaster recovery).
Conguration considerations
Controller addresses
Regardless of which method you use to specify Controllers, Citrix recommends using an FQDN address. An IP address
is not considered a trusted conguration, because its easier to compromise an IP than a DNS record. If you populate
the ListOfSIDs manually, you can use an IP in a ListOfDDCs. However, FQDN is still recommended.
Load balancing
As noted earlier, the VDA automatically distributes connections across all Controllers in the ListOfDDCs. Failover and
load balancing functionality is built into the Citrix Brokering Protocol (CBP). If you specify multiple Controllers in your

conguration, registration automatically fails over between them, if needed. With auto-update, automatic failover
occurs automatically for all VDAs.
For security reasons, you cannot use a network load balancer, such as NetScaler. VDA registration uses Kerberos
mutual authentication, where the client (VDA) must prove its identity to the service (Controller). However, the
Controller must prove its identity to the VDA. T his means that the VDA and the Controller are acting as server and
client at the same time. As noted at the beginning of this article, there are two communications channels: VDA ->
Controller and Controller -> VDA.
A component in this process is called Service Principal Name (SPN), which stored as a property in an Active Directory
computer object. When your VDA connects to a Controller, it must specify who it wants to communicate with; this
address is an SPN. If you use a load-balanced IP, mutual Kerberos authentication correctly recognizes that the IP does
not belong to the expected Controller.
For more information, see:
Introduction to Kerberos: https://blogs.technet.microsoft.com/askds/2008/03/06/kerberos-for-the-busy-

admin/
Mutual authentication using Kerberos: https://msdn.microsoft.com/en-us/library/ms677600
Auto-update replaces CNAME
T he auto-update feature replaces the CNAME (DNS alias) function from XenApp and XenDesktop versions earlier
than 7.x. CNAME functionality is disabled, beginning with XenApp and XenDesktop 7. Use auto-update instead of
CNAME. (If you must use CNAME, see CT X137960. For DNS aliasing to work consistently, do not use both auto-
update and CNAME at the same time.)
Controller groups
In certain scenarios, you might want to process Controllers in groups, with one group being preferred and the other
group used for a failover if all Controllers fail. Remember that Controllers are randomly selected from the list, so
grouping can help enforce preferential use.
Use parentheses to specify groups of controllers. For example, with four Controllers (two primary and two backup), a
grouping might be:
(XDC-001.cdz.lan XDC-002.cdz.lan) (XDC-003.cdz.lan XDC-004.cdz.lan).
In this example, the Controllers in the rst group (001 and 002) are processed rst. If they both fail, Controllers in the
second group (003 and 004) are processed.
ListOfSIDs
T he list of Controllers that a VDA can contact for registration is the ListOfDDCs. A VDA must also know which Controllers
to trust; VDAs do not automatically trust the Controllers in the ListOfDDCs. T he ListOfSIDs (Security IDs) identies the
trusted Controllers. VDAs will attempt to register only with trusted Controllers.
In most environments, the ListOfSIDs is generated automatically from the ListOfDDCs. You can use a CDF trace to read
the ListOfSIDs.

Generally, there is no need to manually modify the ListOfSIDs. T here are several exceptions. T he rst two exceptions are no
longer valid because newer technologies are available.
Separate roles f or Controllers: Before zones were introduced in XenApp and XenDesktop 7.7, the ListOfSIDs was
manually configured when only a subset of Controllers was used for registration. For example, if you were using XDC-001
and XDC-002 as XML brokers, and XDC-003 and XDC-004 for VDA registration, you specified all Controllers in the
ListOfSIDs, and XDC-003 and XDC-004 in the ListOfDDCs. T his is not a typical or recommended configuration and
should not be used in newer environments. Instead, use zones.
Reducing Active Directory load: Before the auto-update feature was introduced in XenApp and XenDesktop 7.6, the
ListOfSIDs was used to reduce the load on domain controllers. By pre-populating the ListOfSIDs, the resolution from
DNS names to SIDs could be skipped. However, the auto-update feature removes the need for this work, because this
persistent cache contains SIDs. Citrix recommends keeping the auto-update feature enabled.
Security: In some highly secured environments, the SIDs of trusted Controllers were manually configured to avoid
possible security threats from a compromised DNS server. However, if you do this, you must also disable the auto-update
feature; otherwise the configuration from persistent cache is used.
So, unless you have a specic reason, do not modify the ListOfSIDs.
If you must modify the ListOfSIDs, create a registry key named ListOfSIDs (REG_SZ) under
HKLM\Software\Citrix\VirtualDesktopAgent. T he value is a list of trusted SIDs, separated by spaces if you have more than
one.
In the following example, one Controller is used for VDA registration (ListOfDDCs), but two Controllers are used for
brokering (List OfSIDs).
Troubleshoot VDA registration issues

As noted previously, a VDA must be registered with a Delivery Controller to be considered when launching brokered sessions.
Unregistered VDAs can result in underutilization of otherwise available resources. T here are a variety of reasons a VDA
might not be registered, many of which an administrator can troubleshoot. Studio provides troubleshooting information in
the catalog creation wizard, and after you create a Delivery Group.
Identifying issues during machine catalog creation:
In the catalog creation wizard, after you add existing machines, the list of computer account names indicates

whether each machine is suitable for adding to the catalog. Hover over the icon next to each machine to display an
informative message about that machine.
If the message identies a problematic machine, you can either remove that machine (using the Remove button), or
add the machine. For example, if a message indicates that information could not be obtained about a machine
(perhaps because it had never registered with a Delivery Controller), you might choose to add the machine anyway.
A catalog's functional level controls which product features are available to machines in the catalog. Using features
introduced in new product versions may require a new VDA. Setting a functional level makes all features introduced in
that version (and later, if the functional level does not change) available to machines in the catalog. However,
machines in that catalog with an earlier VDA version will not be able to register.
Identifying issues after creating Delivery Groups:
After you create a Delivery Group, Studio displays details about machines associated with that group. T he details
pane for a Delivery Group indicates the number of machines that should be registered but are not. In other words,
there might be one or more machines that are powered on and not in maintenance mode, but are not currently
registered with a Controller. When viewing a "not registered, but should be" machine, review the Troubleshoot tab in
the details pane for possible causes and recommended corrective actions.
For more information about functional levels, see VDA versions and functional levels section in Create Machine Catalogs.
You can also use the Citrix Health Assistant to troubleshoot VDA registration and session launch. For details, see
CT X207624.

Sessions
May 22, 20 17
Maintaining session activity is critical to providing the best user experience. Losing connectivity due to unreliable networks,
highly variable network latency, and range limitations of wireless devices can lead to user frustration. Being able to move
quickly between workstations and access the same set of applications each time they log on is a priority for many mobile
workers such as health-care workers in a hospital.
Use the following features to optimize the reliability of sessions, reduce inconvenience, downtime, and loss of productivity;
using these features, mobile users can roam quickly and easily between devices.
Session reliability
ICA Keep-Alive
Workspace control
Session roaming
T he Logon interval section describes how to change the default setting.
You can also log a user off of a session, disconnect a session, and congure session prelaunch and linger; see the Manage
Delivery Groups article.
Session reliability
Session Reliability keeps sessions active and on the users screen when network connectivity is interrupted. Users continue
to see the application they are using until network connectivity resumes.
T his feature is especially useful for mobile users with wireless connections. For example, a user with a wireless connection
enters a railroad tunnel and momentarily loses connectivity. Ordinarily, the session is disconnected and disappears from the
users screen, and the user has to reconnect to the disconnected session. With Session Reliability, the session remains active
on the machine. To indicate that connectivity is lost, the users display freezes and the cursor changes to a spinning
hourglass until connectivity resumes on the other side of the tunnel. T he user continues to access the display during the
interruption and can resume interacting with the application when the network connection is restored. Session Reliability
reconnects users without reauthentication prompts.
Citrix Receiver users cannot override the Controller setting.
You can use Session Reliability with Transport Layer Security (T LS). T LS encrypts only the data sent between the user device
and NetScaler Gateway.
Enable and congure Session Reliability with the following policy settings:
T he Session reliability connections policy setting allows or prevents session reliability.

T he Session reliability timeout policy setting has a default of 180 seconds, or three minutes. Although you can extend
the amount of time Session Reliability keeps a session open, this feature is designed for user convenience and therefore
does not prompt the user for reauthentication. As you extend the amount of time a session is kept open, chances
increase that a user may get distracted and walk away from the user device, potentially leaving the session accessible to
unauthorized users.

Incoming session reliability connections use port 2598, unless you change the port number in the Session reliability port
number policy setting.
If you do not want users to be able to reconnect to interrupted sessions without having to reauthenticate, use the
Auto Client Reconnect feature. You can configure the Auto client reconnect authentication policy setting to prompt
users to reauthenticate when reconnecting to interrupted sessions.
If you use both Session Reliability and Auto Client Reconnect, the two features work in sequence. Session Reliability closes,
or disconnects, the user session after the amount of time you specify in the Session reliability timeout policy setting. After
that, the Auto Client Reconnect policy settings take effect, attempting to reconnect the user to the disconnected session.

With the Auto Client Reconnect feature, Citrix Receiver can detect unintended disconnections of ICA sessions and
reconnect users to the affected sessions automatically. When this feature is enabled on the server, users do not have to
reconnect manually to continue working.
For application sessions, Citrix Receiver attempts to reconnect to the session until there is a successful reconnection or the
user cancels the reconnection attempts.
For desktop sessions, Citrix Receiver attempts to reconnect to the session for a specied period of time, unless there is a
successful reconnection or the user cancels the reconnection attempts. By default, this period of time is ve minutes. To
change this period of time, edit this registry on the user device:
HKLM\Software\Citrix\ICA Client\TransportReconnectRetryMaxT imeSeconds; DWORD;<seconds>
where <seconds> is the number of seconds after which no more attempts are made to reconnect the session.
Enable and congure Auto Client Reconnect with the following policy settings:
Auto client reconnect. Enables or disables automatic reconnection by Citrix Receiver after a connection has been
interrupted.
Auto client reconnect authentication. Enables or disables the requirement for user authentication after automatic
reconnection.
Auto client reconnect logging. Enables or disables logging of reconnection events in the event log. Logging is disabled
by default. When enabled, the server's system log captures information about successful and failed automatic
reconnection events. Each server stores information about reconnection events in its own system log; the site does not
provide a combined log of reconnection events for all servers.
Auto Client Reconnect incorporates an authentication mechanism based on encrypted user credentials. When a user
initially logs on, the server encrypts and stores the user credentials in memory, and creates and sends a cookie containing
the encryption key to Citrix Receiver. Citrix Receiver submits the key to the server for reconnection. T he server decrypts the
credentials and submits them to Windows logon for authentication. When cookies expire, users must reauthenticate to
reconnect to sessions.
Cookies are not used if you enable the Auto client reconnection authentication setting. Instead, users are presented with a
dialog box to users requesting credentials when Citrix Receiver attempts to reconnect automatically.
For maximum protection of user credentials and sessions, use encryption for all communication between clients and the
Site.

Disable Auto Client Reconnect on Citrix Receiver for Windows by using the icaclient.adm le. For more information, see the
documentation for your Citrix Receiver for Windows version.
Settings for connections also affect Auto Client Reconnect:
By default, Auto Client Reconnect is enabled through policy settings at the Site level, as described above. User
reauthentication is not required. However, if a servers ICA T CP connection is configured to reset sessions with a broken
communication link, automatic reconnection does not occur. Auto Client Reconnect works only if the server disconnects
sessions when there is a broken or timed out connection. In this context, the ICA T CP connection refers to a server's
virtual port (rather than an actual network connection) that is used for sessions on T CP/IP networks.
By default, the ICA T CP connection on a server is set to disconnect sessions with broken or timed out connections.
Disconnected sessions remain intact in system memory and are available for reconnection by Citrix Receiver.
T he connection can be configured to reset or log off sessions with broken or timed-out connections. When a session is
reset, attempting to reconnect initiates a new session; rather than restoring a user to the same place in the application
in use, the application is restarted.
If the server is configured to reset sessions, Auto Client Reconnect creates a new session. T his process requires users to
enter their credentials to log on to the server.
Automatic reconnection can fail if Citrix Receiver or the plug-in submits incorrect authentication information, which
might occur during an attack or the server determines that too much time has elapsed since it detected the broken
connection.
ICA Keep-Alive
Enabling the ICA Keep-Alive feature prevents broken connections from being disconnected. When enabled, if the server
detects no activity (for example, no clock change, no mouse movement, no screen updates), this feature prevents Remote
Desktop Services from disconnecting that session. T he server sends keep-alive packets every few seconds to detect if the
session is active. If the session is no longer active, the server marks the session as disconnected.
Note: ICA Keep-Alive works only if you are not using Session Reliability. Session Reliability has its own mechanisms to
prevent broken connections from being disconnected. Congure ICA Keep-Alive only for connections that do not use
Session Reliability.
ICA Keep-Alive settings override keep-alive settings that are congured in Microsoft Windows Group Policy.
Enable and congure ICA Keep-Alive with the following policy settings:
ICA keep alive timeout. Specifies the interval (1-3600 seconds) used to send ICA keep-alive messages. Do not configure
this option if you want your network monitoring software to close inactive connections in environments where broken
connections are so infrequent that allowing users to reconnect to sessions is not a concern.
T he default interval is 60 seconds: ICA Keep-Alive packets are sent to user devices every 60 seconds. If a user device does
not respond in 60 seconds, the status of the ICA sessions changes to disconnected.
ICA keep alives. Sends or prevents sending ICA keep-alive messages.
Workspace control
Workspace control lets desktops and applications follow a user from one device to another. T his ability to roam enables a

user to access all desktops or open applications from anywhere simply by logging on, without having to restart the
desktops or applications on each device. For example, workspace control can assist health-care workers in a hospital who
need to move quickly among different workstations and access the same set of applications each time they log on. If you
congure workspace control options to allow it, these workers can disconnect from multiple applications at one client
device and then reconnect to open the same applications at a different client device.
Workspace control affects the following activities:
Logging on: By default, workspace control enables users to reconnect automatically to all running desktops and
applications when logging on, bypassing the need to reopen them manually. T hrough workspace control, users can open
disconnected desktops or applications, as well as any that are active on another client device. Disconnecting from a
desktop or application leaves it running on the server. If you have roaming users who need to keep some desktops or
applications running on one client device while they reconnect to a subset of their desktops or applications on another
client device, you can configure the logon reconnection behavior to open only the desktops or applications that the user
disconnected from previously.
Reconnecting: After logging on to the server, users can reconnect to all of their desktops or applications at any time by
clicking Reconnect. By default, Reconnect opens desktops or applications that are disconnected, plus any that are
currently running on another client device. You can configure Reconnect to open only those desktops or applications
that the user disconnected from previously.
Logging of f : For users opening desktops or applications through StoreFront, you can configure the Log Off command
to log the user off from StoreFront and all active sessions together, or log off from StoreFront only.
Disconnecting: Users can disconnect from all running desktops and applications at once, without needing to disconnect
from each individually.
Workspace control is available only for Citrix Receiver users who access desktops and applications through a Citrix
StoreFront connection. By default, workspace control is disabled for virtual desktop sessions, but is enabled for hosted
applications. Session sharing does not occur by default between published desktops and any published applications running
inside those desktops.
User policies, client drive mappings, and printer congurations change appropriately when a user moves to a new client
device. Policies and mappings are applied according to the client device where the user is currently logged on to the session.
For example, if a health care worker logs off from a client device in the emergency room of a hospital and then logs on to a
workstation in the hospitals x-ray laboratory, the policies, printer mappings, and client drive mappings appropriate for the
session in the x-ray laboratory go into effect at the session startup.
You can customize which printers appear to users when they change locations. You can also control whether users can
print to local printers, how much bandwidth is consumed when users connect remotely, and other aspects of their printing
experiences.
For information about enabling and conguring workspace control for users, see the StoreFront documentation.
Session roaming
By default, sessions roam between client devices with the user. When the user launches a session and then moves to
another device, the same session is used and applications are available on both devices. T he applications follow, regardless
of the device or whether current sessions exist. In many cases, printers and other resources assigned to the application also
follow.

While this default behavior offers many advantages, it might not be ideal in all cases. You can prevent session roaming using
the PowerShell SDK.
Example 1: A medical professional is using two devices, completing an insurance form on a desktop PC, and looking at
patient information on a tablet.
If session roaming is enabled, both applications appear on both devices (an application launched on one device is visible
on all devices in use). T his might not meet security requirements.
If session roaming is disabled, the patient record does not appear on the desktop PC, and the insurance form does not
appear on the tablet.
Example 2: A production manager launches an application on the PC in his ofce. T he device name and location determine
which printers and other resources are available for that session. Later in the day, he goes to an ofce in the next building
for a meeting that will require him to use a printer.
If session roaming is enabled, the production manager would probably be unable to access the printers near the meeting
room, because the applications he launched earlier in his office resulted in the assignment of printers and other
resources near that location.
If session roaming is disabled, when he logs on to a different machine (using the same credentials), a new session is
started, and nearby printers and resources will be available.
Congure session roaming
To congure session roaming, use the following entitlement policy rule cmdlets with the "SessionReconnection" property.
Optionally, you can also specify the "LeasingBehavior" property; see Connection leasing and session roaming below.
For desktop sessions:
Set-BrokerEntitlementPolicyRule <Delivery-Group-name> -SessionReconnection <value> -LeasingBehavior

Allowed|Disallowed
For application sessions:
Set-BrokerAppEntitlementPolicyRule <Delivery-Group-name> -SessionReconnection <value> -LeasingBehavior

Allowed|Disallowed
Where <value> can be one of the following:
Always. Sessions always roam, regardless of the client device and whether the session is connected or disconnected.
T his is the default value.
DisconnectedOnly. Reconnect only to sessions that are already disconnected; otherwise, launch a new session.
(Sessions can roam between client devices by first disconnecting them, or using Workspace Control to explicitly roam
them.) An active connected session from another client device is never used; instead, a new session is launched.
SameEndpointOnly. A user gets a unique session for each client device they use. T his completely disables roaming. Users
can reconnect only to the same device that was previously used in the session.
T he "LeasingBehavior" property is described below.
Ef f ects f rom other settings
Disabling session roaming is affected by the application limit "Allow only one instance of the application per user" in the
application's properties in the Delivery Group.

If you disable session roaming, then disable the "Allow only one instance ..." application limit.
If you enable the "Allow only one instance ..." application limit, do not configure either of the two values that allow new
sessions on new devices.
Connection leasing and session roaming
If you're not familiar with connection leasing, see the Connection leasing article.
When a Controller enters leased connection mode, session reconnection reverts to its default value, reconnecting the user
to only one of the active or disconnected sessions for the desktop or application.
For additional security, if you congured a nondefault session roaming value, and have multiple users who share the same
logon credentials on multiple devices, consider disabling the connection leasing feature for the Delivery Group that includes
that user account.
Why? In this scenario, one session is shared among all devices. T his could be undesirable if, for example, one person has
sensitive information displayed that is not meant to be seen by someone else who reconnects with the same credentials
while the Controller is in leased connection mode.
Disabling connection leasing in the entitlement policy eliminates this possibility: a user will not be able to see the session of
another user with the same logon, even when the Controller is in leased connection mode. Other entitlement policies can
remain as-is; individual user accounts can use the connection leasing functionality through separate entitlements.
To disable connection leasing in an entitlement policy, add the LeasingBehavior Disallowed property to the entitlement
policy cmdlet. If you disable connection leasing, you must manually delete any launch leases that have already been
created and cached for that entitlement policy; otherwise, users will still be able to reconnect during a database outage.
Logon interval
If a virtual machine containing a desktop VDA closes before the logon process completes, you can allocate more time to
the process. T he default for 7.6 and later versions is 180 seconds (the default for 7.0-7.5 is 90 seconds).
On the machine (or the master image used in a Machine Catalog), set the following registry key:
Key: HKLM\SOFT WARE\Citrix\PortICA
Value: AutoLogonT imeout
Type: DWORD
Specify a decimal time in seconds, in the range 0-3600.
If you change a master image, update the catalog.
Note: T his setting applies only to VMs with desktop (workstation) VDAs; Microsoft controls the logon timeout on machines
with server VDAs.

Use Search in Studio
May 22, 20 17
Use the Search feature to view information about specic machines, sessions, machine catalogs, applications, or Delivery
Groups.
1. Select Search in the Studio navigation pane.

Note: You cannot search within the machine catalogs or Delivery Groups tabs using the Search box. Use the Search node
in the navigation pane.
To display additional search criteria in the display, click the plus sign next to the Search drop-down elds. Remove search
criteria by clicking the minus button.
2. Enter the name or use the drop-down list to select another search option for the item you want to find.
3. Optionally, save your search by selecting Save as. T he search appears in the Saved searches list.
Alternatively, click the Expand Search icon (dual downward angle brackets) to display a drop-down list of search properties;
you can perform an advanced search by building an expression from the properties in the drop-down list.
T ips to enhance a search:

T o display additional characteristics to include in the display on which you can search and sort, right click any column and
select Select columns.
T o locate a user device connected to a machine, use Client (IP) and Is, and enter the device IP address.
T o locate active sessions, use Session State, Is, and Connected.
T o list all of the machines in a Delivery Group, select Delivery Groups in the navigation pane, then select the group, and
then select View Machines in the Actions pane.

Tags
May 22, 20 17
Introduction
Tags are strings that identify items such as machines, applications, desktops, Delivery Groups, Application Groups, and
policies. After creating a tag and adding it to an item, you can tailor certain operations to apply to only items that have a
specied tag.
T ailor search displays in Studio.
For example, to display only applications that have been optimized for testers, create a tag named test and then
add (apply) it to those applications. You can now lter the Studio search with the tag test.
Publish applications from an Application Group or specific desktops from a Delivery Group, considering only a subset of
the machines in selected Delivery Groups. T his is called a tag restriction.
With tag restrictions, you can use your existing machines for more than one publishing task, saving the costs
associated with deploying and managing additional machines. A tag restriction can be thought of as subdividing (or
partitioning) the machines in a Delivery Group. Its functionality is similar, but not identical, to worker groups in XenApp
releases earlier than 7.x.
Using an Application Group or desktops with a tag restriction or can be helpful when isolating and troubleshooting a
subset of machines in a Delivery Group.
See below for details and examples of using a tag restriction.
Schedule periodic restarts for a subset of machines in a Delivery Group.
Using a tag restriction for machines enables you to use new PowerShell cmdlets to congure multiple restart
schedules for subsets of machines in a Delivery Group. For examples and details, see the "Create multiple restart
schedules for machines in a Delivery Group" section in the Manage Delivery Groups article.
T ailor the application (assignment) of Citrix policies to a subset of machines in Delivery Groups, Delivery Group types, or
OUs that have (or do not have) a specified tag.
For example, if you want to apply a Citrix policy only to the more powerful workstations, add a tag named high
power to those machines. T hen, on the Assign Policy page of the Create Policy wizard, select that tag and also the
Enable checkbox. You can also add a tag to a Delivery Group and then apply a Citrix policy to that group. For details,
see the Create policies article and this blog post. (Note that the Studio interface for adding a tag to a machine has
changed since the blog post was published.)
You can apply tags to the following items:
Machines
Applications
Delivery Groups
Application Groups

You can congure a tag restriction can be congured when creating or editing the following in Studio:
A desktop in a shared Delivery Group

An Application Group
Tag restrictions for a desktop or an Application Group

A tag restriction involves several steps:
Create the tag and then add (apply) it to machines.

Create or edit a group with the tag restriction (in other words, "restrict launches to machines with tag x").
A tag restriction extends the broker's machine selection process. T he broker selects a machine from an associated Delivery
Group subject to access policy, congured user lists, zone preference, and launch readiness, plus the tag restriction (if
present). For applications, the broker falls back to other Delivery Groups in priority order, applying the same machine
selection rules for each considered Delivery Group.
Example 1
T his example introduces a simple layout that uses tag restrictions to limit which machines will be considered for certain
desktop and application launches. T he site has one shared Delivery Group, one published desktop, and one Application
Group congured with two applications.
T ags have been added to each of the three machines (VDA 101-103).
T he desktop in the shared Delivery Group was created with a tag restriction named "Red," so that desktop can be
launched only on machines in that Delivery Group that have the tag "Red": VDA 101 and 102.
T he Application Group was created with the "Orange" tag restriction, so each of its applications (Calculator and
Notepad) can be launched only on machines in that Delivery Group that have the tag "Orange": VDA 102 and 103.
Note that machine VDA 102 has both tags (Red and Orange), so it can be considered for launching the applications and the
desktop.
Example 2
T his example contains several Application Groups that were created with tag restrictions. T his results in the ability to deliver

more applications with fewer machines than would otherwise be needed if you used only Delivery Groups.
(T he "How to congure example 2" section shows the steps used to create and apply the tags, and then congure the tag
restrictions in this example.)
T his example uses ten machines (VDA 101-110), one Delivery Group (D01), and three Application Groups (A100, A200, A300).
By applying tags to each machine and then specifying tag restrictions when creating each Application Group:
Accounting users in the group can access the apps they need on five machines (VDA 101 105)
CAD designers in the group can access the apps they need on five machines (VDA 106-110)
Users in the group who need Office applications can access the Office apps on ten machines (VDA 101-110)
Only ten machines are used, with only one Delivery Group. Using Delivery Groups alone (without Application Groups) would
require twice as many machines, because a machine can belong to only one Delivery Group.
Manage tags and tag restrictions

Tags are created, added (applied), edited, and deleted from selected items through the Manage Tags action in Studio.
Exception: Tags used for policy assignments are created, edited, and deleted through the Manage Tags action in
Studio; however, tags are applied (assigned) when you create the policy; see the Create policies article for details.
Tag restrictions are congured when you create or edit desktops in Delivery Groups, and when you create and edit
Application Groups. For complete information about creating and editing groups, see the following articles:

Use the Manage Tags dialogs in Studio
In Studio, select the items you want to apply a tag to (one or more machines, applications, a desktop, a Delivery Group, or
an Application Group) and then select Manage Tags in the Actions pane. T he Manage Tags dialog box lists all the tags that
have been created in the Site, not just for the items you selected.
A check box containing a check mark indicates that tag has already been added to the selected items. (In the screen
capture below, the selected machine has the tag named "T ag1" applied.)
If you selected more than one item, a check box containing a hyphen indicates that some, but not all selected items
have that tag added.
T he following actions are available from the Manage Tags dialog box. Be sure to review the Cautions section.
To create a tag:
Click Create. Enter a name and description. Tag names must be unique and are not case-sensitive. T hen click OK.
(Creating a tag does not automatically apply it to any items you have selected. Use the check boxes to apply the tag.)
To add (apply) one or more tags:
Enable the check box next to the tag name. Note: If you selected multiple items and the check box next to a tag

contains a hyphen (indicating that some, but not all selected items already have the tag applied), changing it to a
check mark will affect all the selected machines.
If you attempt to add a tag to one or more machines, and that tag is currently used as a restriction in an Application
Group, you are warned that the action could result in making those machines available for launch. If that's what you
intended, proceed.
To remove one or more tags:
Clear the check box next to the tag name. Note: If you selected multiple items and the check box next to a tag
contains a hyphen (indicating that some, but not all selected items already have the tag applied), clearing the check
box will remove the tag from all the selected machines.
If you attempt to remove a tag from a machine that is using that tag as a restriction, a warning message will be
displayed, indicating that could affect which machines are considered for launch. If that's what you intended,
proceed.
To edit a tag:
Select a tag and then click Edit. Enter a new name and/or description. You can edit only one tag at a time.
To delete one or more tags:
Select the tags and then click Delete. T he Delete Tag dialog box indicates how many items currently use the selected
tags (for example "2 machines"). Click an item to display more information. For example, clicking a "2 machines" item
displays the names of the two machines that have that tag applied. Conrm whether you want to delete the tags.
You cannot use Studio to delete a tag that is used as a restriction. You must rst edit the Application Group and
remove the tag restriction or select a different tag.
When you're done in the Manage Tags dialog box, click Save.
Tip: To see if a machine has any tags applied:
Select Delivery Groups in the navigation pane. Select a Delivery Group in the middle pane and then select View
Machines in the Actions pane. Select a machine in the middle pane and then select the Tags tab on the Details pane
below.
Manage tag restrictions
Conguring a tag restriction is a multi-step process: You rst create the tag and add/apply it to machines. T hen, you add
the restriction to the Application Group or the desktop.
Create and apply the tag:
Create the tag and then add (apply) it to the machines that will be affected by the tag restriction, using the Manage
Tags actions described above.
To add a tag restriction to an Application Group:
Create or edit the Application Group. On the Delivery Groups page, select Restrict launches to machines with the
tag and then select the tag from the dropdown.

To change or remove the tag restriction on an Application Group:
Edit the group. On the Delivery Groups page, either select a different tag from the dropdown or remove the tag
restriction entirely by clearing Restrict launches to machines with the tag.
To add a tag restriction to a desktop:
Create or edit a Delivery Group. Click Add or Edit on the Desktops page. In the Add Desktop dialog box, select
Restrict launches to machines with the tag and then select the tag from the dropdown.
To change or remove the tag restriction on a Delivery Group:
Edit the group. On the Desktops page, click Edit. In the dialog box, either select a different tag from the dropdown or
remove the tag restriction entirely by clearing Restrict launches to machines with the tag.
Cautions when adding, removing, or deleting tags f rom items
A tag applied to an item can be used for different purposes, so keep in mind that adding, removing, and deleting a tag can
have unintended effects. You can use a tag to sort machine displays in the Studio search eld. You can use the same tag as
a restriction when conguring an Application Group or a desktop, which will limit launch consideration to only machines in
specied Delivery Groups that have that tag.
If you attempt to add a tag to one or more machines after that tag has been congured as a tag restriction for a desktop
or an Application Group, Studio warns you that adding that tag might make the machines available for launching additional
applications or desktops. If that is what you intended, proceed. If not, you can cancel the operation.
For example, let's say you create an Application Group with the "Red" tag restriction. Later, you add several other
machines in the same Delivery Groups used by that Application Group. If you then attempt to add the "Red" tag to
those machines, Studio will display a message similar to: "T he tag "Red" is used as a restriction on the following
Application Groups. Adding this tag might make the selected machines available to launch applications in this
Application Group." You can then conrm or cancel adding that tag to those additional machines.
Similarly, if a tag is being used in an Application Group to restrict launches, Studio warns that you cannot delete the tag
until you remove it as a restriction by editing the group. (If you were allowed to delete a tag that's used as a restriction in
an Application Group, that could result in allowing applications to launch on all machines in the Delivery Groups associated
with the Application Group.) T he same prohibition against deleting a tag applies if the tag is currently being used as a
restriction for desktop launches. After you edit the Application Group or desktops in the Delivery Group to remove that tag
restriction, you can delete the tag.
All machines may not have the same sets of applications. A user may belong to more than one Application Group, each with
a different tag restriction and different or overlapping sets of machines from Delivery Groups. T he following table lists how
machine considerations are decided.
When an applicat ion has been added t o T hese machines in t he select ed Delivery Groups are
considered f or launch
One Application Group with no tag restriction Any machine
One Application Group with tag restriction A Machines that have tag A applied

Two Application Groups, one with tag restriction A and the other Machines that have tag A and tag B; if none are available, then
with tag restriction B machines that have tag A or tag B
Two Application Groups, one with tag restriction A and the other Machines that have tag A; if none are available, then any machine
with no tag restriction
If you used a tag restriction in a machine restart schedule, any changes you make that affect tag applications or
restrictions will affect the next machine restart cycle. It will not affect any restart cycles that is in progress while the
changes are being made. (See the Mange Delivery Groups article.)
How to congure example 2
T he following sequence shows the steps to create and apply tags, and then congure tag restrictions for the Application
Groups illustrated in the second example above.
VDAs and applications have already been installed on the machines and the Delivery Group has been created.
Create and apply tags to the machines:
1. In Studio, select Delivery Group D01 and then select View Machines in the Action pane.
2. Select machines VDA 101-105 and then select Manage Tags in the Actions pane.
3. In the Manage T ags dialog box, click Create and then create a tag named CADApps. Click OK.
4. Click Create again and create a tag named OfficeApps. Click OK.
5. While still in the Manage T ags dialog box, add (apply) the newly-created tags to the selected machines by enabling the
check boxes next to each tag's name (CADApps and OfficeApps), and then close the dialog box.
6. Select Delivery Group D01, select View Machines in the Action pane.
7. Select machines VDA 106-110 and then select Manage Tags in the Actions pane.
8. In the Manage T ags dialog box, click Create and then create a tag named AcctgApps. Click OK.
9. Apply the newly-created AcctgApps tag and the OfficeApps tag to the selected machines by clicking the check boxes
next to each tag's name, and then close the dialog box.
Create the Application Groups with tag restrictions.
1. In Studio, select Applications in the navigation pane and then select Create Application Group in the Actions pane.
T he Create Application Group wizard launches.
2. On the Delivery Groups page of the wizard, select Delivery Group D01. Select Restrict launches to machines with
tag and then select the AcctgApps tag from the dropdown.
3. Complete the wizard, specifying the accounting users and the accounting applications. (When adding the application,
choose the "From Start menu" source, which will search for the application on the machines that have the AcctgApps
tag.) On the Summary page, name the group A100.
4. Repeat the preceding steps to create Application Group A200, specifying machines that have the CADApps tag, plus the
appropriate users and applications.
5. Repeat steps to create Application Group A300, specifying machines that have the OfficeApps tag, plus the appropriate
users and applications.

IPv4/IPv6 support
May 22, 20 17
T his release supports pure IPv4, pure IPv6, and dual-stack deployments that use overlapping IPv4 and IPv6 networks.
IPv6 communications are controlled with two Virtual Delivery Agent (VDA) connection-related Citrix policy settings:
A primary setting that enforces the use of IPv6: Only use IPv6 Controller registration.
A dependent setting that defines an IPv6 netmask: Controller registration IPv6 netmask.
When the Only use IPv6 Controller registration policy setting is enabled, VDAs register with a Delivery Controller for
incoming connections using an IPv6 address.
Dual-stack IPv4/IPv6 deployment

T he following gure illustrates a dual-stack IPv4/IPv6 deployment. In this scenario, a worker is a VDA installed on a
hypervisor or on a physical system, and is used primarily to enable connections for applications and desktops. Components
that support dual IPv6 and IPv4 are running on operating systems that use tunneling or dual protocol software.
T hese Citrix products, components, and features support only IPv4:

Provisioning Services
XenServer Version 6.x
VDAs not controlled by the Only use IPv6 Controller registration policy setting
XenApp versions earlier than 7.5, XenDesktop versions earlier than 7, and Director
In this deployment:

If a team frequently uses an IPv6 network and the administrator wants them to use IPv6 traffic, the administrator will
publish IPv6 desktops and applications for those users based on a worker image or Organizational Unit (OU) that has the
primary IPv6 policy setting turned on (that is, Only use IPv6 Controller registration is enabled).
If a team frequently uses an IPv4 network, the administrator will publish IPv4 desktops and applications for those users
based on a worker image or OU that has the primary IPv6 policy setting turned off (that is, Only use IPv6 Controller
registration is disabled), which is the default.
Pure IPv6 deployment

T he following gure illustrates a pure IPv6 deployment. In this scenario:
T he components are running on operating systems configured to support an IPv6 network.

T he primary Citrix policy setting (Only use IPv6 Controller registration) is enabled for all VDAs; they must register with the
Controller using an IPv6 address.
Policy settings f or IPv6
T wo Citrix policy settings affect support for a pure IPv6 or dual stack IPv4/IPv6 implementation. Configure the following
connection-related policy settings:
Only use IPv6 Controller registration: Controls which form of address the Virtual Delivery Agent (VDA) uses to register
with the Delivery Controller. Default = Disabled
When the VDA communicates with the Controller, it uses a single IPv6 address chosen in the following precedence:
global IP address, Unique Local Address (ULA), link-local address (only if no other IPv6 addresses are available).
When disabled, the VDA registers and communicates with the Controller using the machine's IPv4 address.
Controller registration IPv6 netmask: A machine can have multiple IPv6 addresses; this policy setting allows
administrators to restrict the VDA to only a preferred subnet (rather than a global IP, if one is registered). T his setting
specifies the network where the VDA will register: the VDA registers only on the first address that matches the specified

netmask. T his setting is valid only if the Only use IPv6 Controller registration policy setting is enabled. Default = Empty
string
Important: Use of IPv4 or IPv6 by a VDA is determined solely by these policy settings. In other words, to use IPv6
addressing, the VDA must be controlled by a Citrix policy with the Only use IPv6 Controller registration setting enabled.
Deployment considerations
If your environment contains both IPv4 and IPv6 networks, you will need separate Delivery Group congurations for the
IPv4-only clients and for the clients who can access the IPv6 network. Consider using naming, manual Active Directory
group assignment, or Smart Access lters to differentiate users.
Reconnection to a session may fail if the connection is initiated on an IPv6 network, and then attempts are made to
connect again from an internal client that has only IPv4 access.

Client folder redirection
May 22, 20 17
Client folder redirection changes the way client-side les are accessible on the host-side session. When you enable only
client drive mapping on the server, client-side full volumes are automatically mapped to the sessions as Universal Naming
Convention (UNC) links. When you enable client folder redirection on the server and the user congures it on the user device,
the portion of the local volume specied by the user is redirected.
Only the user-specied folders appear as UNC links inside sessions instead of the complete le system on the user device. If
you disable UNC links through the registry, client folders appear as mapped drives inside the session.
Client folder redirection is supported on Windows Desktop OS machines only.
Client folder redirection for an external USB drive will not be saved on detaching and reattaching the device.
Enable client folder direction on the server. T hen, on the client device, specify which folders to redirect (the application you
use to specify the client folder options is included with the Citrix Receiver supplied with this release.
1. On the server:
1. Create a key: HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Citrix\Client Folder Redirection.
2. Create a REG_DWORD value.
Name: CFROnlyModeAvailable
T ype: REG_DWORD
Data: Set to 1
2. On the user device:
1. Ensure the latest version of Citrix Receiver is installed.
2. From the Citrix Receiver installation directory, start CtxCFRUI.exe.
3. Select the Custom radio button and add, edit, or remove folders.
4. Disconnect and reconnect your sessions for the setting to take effect.

User proles
May 22, 20 17
By default, Citrix Prole management is installed silently on master images when you install the Virtual Delivery Agent, but
you do not have to use Prole management as a prole solution.
T o suit your users' varying needs, you can use XenApp and XenDesktop policies to apply different profile behavior to the
machines in each Delivery Group. For example, one Delivery Group might require Citrix mandatory profiles, whose template is
stored in one network location, while another Delivery Group requires Citrix roaming profiles stored in another location with
several redirected folders.
If other administrators in your organization are responsible for XenApp and XenDesktop policies, work with them to
ensure that they set any profile-related policies across your Delivery Groups.
Profile management policies can also be set in Group Policy, in the Profile management .ini file, and locally on individual
virtual machines. T hese multiple ways of defining profile behavior are read in the following order:
1. Group Policy (.adm or .admx files)
2. XenApp and XenDesktop policies in the Policy node
3. Local policies on the virtual machine that the user connects to
4. Profile management .ini file
For example, if you congure the same policy in both Group Policy and the Policy node, the system reads the policy
setting in Group Policy and ignores the XenApp and XenDesktop policy setting.
Whichever prole solution you choose, Director administrators can access diagnostic information and troubleshoot user
proles. For more information, see the Director documentation.
If you use the Personal vDisk feature, Citrix user proles are stored on virtual desktops' Personal vDisks by default. Do not
delete the copy of a prole in the user store while a copy remains on the Personal vDisk. Doing so creates a Prole
management error, and causes a temporary prole to be used for logons to the virtual desktop.
Automatic conguration
T he desktop type is automatically detected, based on the Virtual Delivery Agent installation and, in addition to the
conguration choices you make in Studio, sets Prole management defaults accordingly.
T he policies that Prole management adjusts are shown in the table below. Any non-default policy settings are preserved
and are not overwritten by this feature. Consult the Prole management documentation for information about each
policy. T he types of machines that create proles affect the policies that are adjusted. T he primary factors are whether
machines are persistent or provisioned, and whether they are shared by multiple users or dedicated to just one user.
Persistent systems have some type of local storage, the contents of which can be expected to persist when the system
turns off. Persistent systems may employ storage technology such as storage area networks (SANs) to provide local disk
mimicking. In contrast, provisioned systems are created "on the y" from a base disk and some type of identity disk. Local
storage is usually mimicked by a RAM disk or network disk, the latter often provided by a SAN with a high speed link. T he
provisioning technology is generally Provisioning Services or Machine Creation Services (or a third-party equivalent).
Sometimes provisioned systems have persistent local storage, which may be provided by Personal vDisks; these are classed
as persistent.
Together, these two factors dene the following machine types:
Both persistent and dedicated -- Examples are Desktop OS machines with a static assignment and a Personal vDisk

that are created with Machine Creation Services, desktops with Personal vDisks that are created with VDI-in-a-Box,
physical workstations, and laptops
Both persistent and shared -- Examples are Server OS machines that are created with Machine Creation Services
Both provisioned and dedicated -- Examples are Desktop OS machines with a static assignment but without a
Personal vDisk that are created with Provisioning Services
Both provisioned and shared -- Examples are Desktop OS machines with a random assignment that are created with
Provisioning Services and desktops without Personal vDisks that are created with VDI-in-a-Box
T he following Prole management policy settings are suggested guidelines for the different machine types. T hey work well
in most cases, but you may want to deviate from these as your deployment requires.
Important: Delete locally cached profiles on logoff, Profile streaming, and Always cache are enforced by the auto-
configuration feature. Adjust the other policies manually.
Persistent machines
Policy Both persistent and dedicated Both persistent and shared
Delete locally cached proles on logoff Disabled Enabled
Prole streaming Disabled Enabled
Always cache Enabled (note 1) Disabled (note 2)
Active write back Disabled Disabled (note 3)
Process logons of local administrators Enabled Disabled (note 4)
Provisioned machines
Policy Both provisioned and dedicated Both provisioned and shared
Delete locally cached proles on logoff Disabled (note 5) Enabled
Prole streaming Enabled Enabled
Always cache Disabled (note 6) Disabled
Active write back Enabled Enabled
Process logons of local administrators Enabled Enabled (note 7)

1. Because Profile streaming is disabled for this machine type, the Always cache setting is always ignored.
2. Disable Always cache. However, you can ensure that large files are loaded into profiles as soon as possible after logon by
enabling this policy and using it to define a file size limit (in MB). Any file this size or larger is cached locally as soon as
possible.
3. Disable Active write back except to save changes in profiles of users who roam between XenApp servers. In this case,
enable this policy.
4. Disable Process logons of local administrators except for Hosted Shared Desktops. In this case, enable this policy.
5. Disable Delete locally cached profiles on logoff. T his retains locally cached profiles. Because the machines are reset at
logoff but are assigned to individual users, logons are faster if their profiles are cached.
6. Disable Always cache. However, you can ensure that large files are loaded into profiles as soon as possible after logon by
enabling this policy and using it to define a file size limit (in MB). Any file this size or larger is cached locally as soon as
possible.
7. Enable Process logons of local administrators except for profiles of users who roam between XenApp and XenDesktop
servers. In this case, disable this policy.
Folder redirection
Folder redirection lets you store user data on network shares other than the location where the proles are stored. T his
reduces prole size and load time but it might impact network bandwidth. Folder redirection does not require that Citrix
user proles are employed. You can choose to manage user proles on your own, and still redirect folders.
Configure folder redirection using Citrix policies in Studio.

Ensure that the network locations used to store the contents of redirected folders are available and have the correct
permissions. T he location properties are validated.
Redirected folders are set up on the network and their contents populated from users' virtual desktops at logon.
Note: Configure folder redirection using only Citrix Policies or Active Directory Group Policy Objects, not both. Configuring
folder redirection using both policy engines may result in unpredictable behavior.
Advanced f older redirection
In deployments with multiple operating systems (OSs), you might want some of a user's prole to be shared by each OS.
T he rest of the prole is not shared and is used only by one OS. To ensure a consistent user experience across the OSs, you
need a different conguration for each OS. T his is advanced folder redirection. For example, different versions of an
application running on two OSs might need to read or edit a shared le, so you decide to redirect it to a single network
location where both versions can access it. Alternatively, because the Start Menu folder contents are structured differently
in two OSs, you decide to redirect only one folder, not both. T his separates the Start Menu folder and its contents on each
OS, ensuring a consistent experience for users.
If your deployment requires advanced folder redirection, you must understand the structure of your users' prole data and
determine which parts of it can be shared between OSs. T his is important because unpredictable behavior can result unless
folder redirection is used correctly.
T o redirect folders in advanced deployments:

Use a separate Delivery Group for each OS.
Understand where your virtual applications, including those on virtual desktops, store user data and settings, and
understand how the data is structured.
For shared profile data that can safely roam (because it is structured identically in each OS), redirect the containing
folders in each Delivery Group.
For non-shared profile data that cannot roam, redirect the containing folder in only one of the Desktop Groups, typically

the one with the most used OS or the one where the data is most relevant. Alternatively, for non-shared data that
cannot roam between OSs, redirect the containing folders on both systems to separate network locations.
Example advanced deployment - T his deployment has applications, including versions of Microsoft Outlook and Internet
Explorer, running on Windows 8 desktops and applications, including other versions of Outlook and Internet Explorer,
delivered by Windows Server 2008. T o achieve this, you have already set up two Delivery Groups for the two OSs. Users
want to access the same set of Contacts and Favorites in both versions of those two applications.
Important: T he following decisions and advice are valid for the OSs and deployment described. In your organization, the
folders you choose to redirect and whether your decide to share them depend on a number of factors that are unique to
your specific deployment.
Using policies applied to the Delivery Groups, you choose the following folders to redirect.
Folder Redirected in Windows 8? Redirected in Windows Server 2008?
My Documents Yes Yes
Application Data No No
Contacts Yes Yes
Desktop Yes No
Downloads No No
Favorites Yes Yes
Links Yes No
My Music Yes Yes
My Pictures Yes Yes
My Videos Yes Yes
Searches Yes No
Saved Games No No
Start Menu Yes No
For the shared, redirected folders:

After analyzing the structure of the data saved by the different versions of Outlook and Internet Explorer, you decide

it is safe to share the Contacts and Favorites folders
You know the structure of the My Documents, My Music, My Pictures, and My Videos folders is standard across OSs,
so it is safe to store these in the same network location for each Delivery Group
For the non-shared, redirected folders:
You do not redirect the Desktop, Links, Searches, or Start Menu folders folder in the Windows Server Delivery Group
because data in these folders is organized differently in the two OSs. It therefore cannot be shared.
T o ensure predictable behavior of this non-shared data, you redirect it only in the Windows 8 Delivery Group. You
choose this, rather than the Windows Server Delivery Group, because Windows 8 will be used more often by users in
their day-to-day work; they will only occasionally access the applications delivered by the server. Also, in this case the
non-shared data is more relevant to a desktop environment rather than an application environment. For example,
desktop shortcuts are stored in the Desktop folder and might be useful if they originate from a Windows 8 machine
but not from a Windows Server machine.
For the non-redirected folders:
You do not want to clutter your servers with users' downloaded files, so you choose not to redirect the Downloads
folder
Data from individual applications can cause compatibility and performance issues, so you decide not to redirect the
Application Data folder
For more information on folder redirection, see http://technet.microsoft.com/en-us/library/cc766489%28v=ws.10%29.aspx.
Folder redirection and exclusions
In Citrix Prole management (but not in Studio), a performance enhancement allows you to prevent folders from being
processed using exclusions. If you use this feature, do not exclude any redirected folders. T he folder redirection and
exclusion features work together, so ensuring no redirected folders are excluded allows Prole management to move them
back into the prole folder structure again, while preserving data integrity, if you later decide not to redirect them. For
more information on exclusions, see To include and exclude items.

May 22, 20 17
Citrix Insight Services (CIS) is a Citrix platform for instrumentation, telemetry, and business insight generation. Its
instrumentation and telemetry capabilities enable technical users (customers, partners, and engineers) to self-diagnose and
x problems and optimize their environments. For details and the latest information about CIS and how it works, see
https://cis.citrix.com (Citrix account credentials required).
T he features offered by Citrix Insight Services continue to grow and evolve, and now form an integral part of Citrix Smart
Tools. Citrix Smart Tools enables you to automate deployment tasks, health checks, and power management. For
information about the technologies, see the Citrix Smart Tools documentation.
All information uploaded to Citrix is used for troubleshooting and diagnostic purposes, as well as improving the quality,
reliability, and performance of products, subject to:
Citrix Insight Services Policy at https://cis.citrix.com/legal

Citrix Privacy Policy at http://www.citrix.com/about/legal/privacy.html
T his XenApp and XenDesktop release supports the following tools and technologies.
XenApp and XenDesktop install and upgrade analytics

Citrix Customer Experience Improvement Program
Citrix Smart T ools
Citrix Call Home (part of Citrix Smart T ools)
Citrix Scout
Install and upgrade analytics

When you use the full-product installer to deploy or upgrade XenApp or XenDesktop components, anonymous information
about the installation process is gathered and stored on the machine where you are installing/upgrading the component.
T his data is used to help Citrix improve its customers' installation experiences. For more information, see
http://more.citrix.com/XD-INSTALLER.
T he information is stored locally under %ProgramData%\Citrix\CTQs.
Automatic upload of this data is enabled by default in both the graphical and command line interfaces of the full-product
installer.
You can change the default value in a registry setting. If you change the registry setting before installing/upgrading, that
value will be used when you use the full-product installer.
You can override the default setting if you install/upgrade with the command line interface by specifying an option with
the command.
Registry setting that controls automatic upload of install/upgrade analytics (default = 1):
Location: HKLM:\Software\Citrix\MetaInstall
Name: SendExperienceMetrics
Value: 0 = disabled, 1 = enabled

Using PowerShell, the following cmdlet disables automatic upload of install/upgrade analytics:
New-ItemProperty -Path HKLM:\SOFT WARE\Citrix\MetaInstall -Name SendExperienceMetrics -PropertyType

DWORD -Value 0
To disable automatic uploads with the XenDesktopServerSetup.exe or XenDesktopVDASetup.exe command, include the
/disableexperiencemetrics option.
To enable automatic uploads with the XenDesktopServerSetup.exe or XenDesktopVDASetup.exe command, include the
/sendexperiencemetrics option.
Citrix Customer Experience Improvement Program

(CEIP)
When you participate in the Citrix Customer Experience Improvement Program (CEIP), anonymous statistics and usage
information are sent to Citrix to help Citrix improve the quality and performance of Citrix products. For more information,
see http://more.citrix.com/XD-CEIP.
Enrollment during Site creation or upgrade
You are automatically enrolled in CEIP when you create a XenApp or XenDesktop Site (after you install the rst Delivery
Controller). T he rst upload of data occurs approximately seven days after you create the Site. You can stop your
participation at any time after creating the Site; select the Conguration node in the Studio navigation pane (Product
Support tab) and follow the guidance.
When you upgrade a XenApp or XenDesktop deployment:
If you upgrade from a version that did not support CEIP, you are asked if you want to participate.
If you upgrade from a version that supported CEIP, and participation was enabled, CEIP will be enabled in the upgraded
Site.
If you upgrade from a version that supported CEIP, and participation was disabled, CEIP will be disabled in the upgraded
Site.
If you upgrade form a version that supported CEIP, and participation is unknown, you are asked if you want to
participate.
T he collected information is anonymous, so it cannot be viewed after it is uploaded to Citrix Insight Services.
Enrollment when installing a VDA
By default, you are automatically enrolled in CEIP when you install a Windows VDA. You can change this default in a registry
setting. If you change the registry setting before installing the VDA, that value will be used.
Registry setting that controls automatic upload of install/upgrade analytics (default = 1):
Location: HKLM:\Software\Citrix\Telemetry\CEIP
Name: Enabled
Value: 0 = disabled, 1 = enabled
By default, the "Enabled" property is hidden in the registry. When it remains unspecied, the automatic upload feature is

enabled.
Using PowerShell, the following cmdlet disables enrollment in CEIP:
New-ItemProperty -Path HKLM:\SOFT WARE\Citrix\Telemetry\CEIP -Name Enabled -PropertyType DWORD -Value 0
T he rst upload of data occurs approximately seven days after you install the VDA.
Enrollment when installing other products and components
You can also participate in CEIP when you install related Citrix products, components, and technologies, such as Provisioning
Services, AppDNA, Citrix License Server, Citrix Receiver for Windows, Universal Print Server, and Session Recording. See their
documentation for details about installation and participation default values.
Citrix Smart Tools

You can enable Smart Tools access when you install a Delivery Controller.
T he option to enable Smart Tools access (and participate in Call Home, if it is not already enabled) is selected by default.
Click Connect. A browser window opens and navigates automatically to a Smart Services web page, where you enter your
Citrix Cloud account credentials. (If you don't have a Citrix Cloud account, simply enter your Citrix account credentials, and a
new Citrix Cloud account is automatically created for you.) After you're authenticated, a certicate is silently installed in the
Smart Tools Agent directory.
To use the Smart Tools technologies, see the Smart Tools documentation.
Citrix Call Home

When you install certain components and features in XenApp or XenDesktop, you are offered the opportunity to
participate in Citrix Call Home. Call Home collects diagnostic data and then periodically uploads telemetry packages
containing that data directly to Citrix Insight Services (via HT T PS on default port 443) for analysis and troubleshooting.
In XenApp and XenDesktop, Call Home runs as a background service under the name Citrix Telemetry Service. For more
information, see http://more.citrix.com/XD-CALLHOME.
T he Call Home scheduling functionality is also available in Citrix Scout. For details, see Citrix Scout.
What is collected
Citrix Diagnostic Facility (CDF) tracing logs information that can be useful for troubleshooting. Call Home collects a subset
of CDF traces that can be helpful when troubleshooting common failures, for example, VDA registrations and
application/desktop launches. T his technology is known as always-on tracing (AOT ). Call Home does not collect any other
Event Tracing for Windows (ET W) information, nor can it be congured to do so.
Call Home also collects other information, such as:
Registries created by XenApp and XenDesktop under HKEY_LOCAL_MACHINE\SOFT WARE\Citrix

Windows Management Instrumentation (WMI) information under the Citrix namespace
List of processes running

Crash dumps of Citrix processes that are stored in %PROGRAM DAT A%\Citrix\CDF
T he trace information is compressed as it is collected. T he Citrix Telemetry Service retains a maximum of 10 MB of

compressed recent trace information, with a maximum time limit of eight days.
Compressing data allows Call Home to maintain a small footprint on the VDA.
T races are held in memory to avoid IOPs on provisioned machines.
T he trace buffer uses a circular mechanism to retain traces in memory.
HTM Call Home key datapoints

Call Home collects these key datapoints.
Congure and manage summary
You can enroll in Call Home when using the full-product installation wizard or later, using PowerShell cmdlets. When you
enroll, by default, diagnostics are collected and uploaded to Citrix every Sunday at approximately 3:00 AM, local time. T he
upload is randomized with a two hour interval from the specied time. T his means an upload using the default schedule
occurs between 3:00 AM and 5:00 AM.
If you do not want to upload diagnostic information on a scheduled bassis (or if you want to change a schedule), you can
use PowerShell cmdlets to manually collect and upload diagnostics or store them locally.
When you enroll in scheduled Call Home uploads and when you manually upload diagnostic information to Citrix, you
provide Citrix account or Citrix Cloud credentials. Citrix exchanges the credentials for an upload token that is used to
identify the customer and upload the data. T he credentials are not saved.
When an upload occurs, a notication is emailed to the address associated with the Citrix account.
Enable Call Home during component installation
During VDA installation or upgrade: When you install or upgrade a Virtual Delivery Agent using the graphical interface in
the full-product installer, you are asked if you want to participate in Call Home. T here are two options:
Participate in Call Home.

Do not participate in Call Home.
If you're upgrading a VDA and previously enrolled in Call Home, that wizard page won't appear.
During Controller installation or upgrade: When you install or upgrade a Delivery Controller using the graphical interface,
you are asked if you want to participate in Call Home and connect to Citrix Smart Tools. T here are three options:
Connect to Citrix Smart T ools, which includes the Call Home functionality via the Smart T ools agent. T his is the default
and recommended option. If you choose this option, the Smart T ools agent is configured. (T he Smart T ools agent is
installed, regardless of whether this option is selected.)
Participate only in Call Home, but do not connect to Smart T ools. If you choose this option, the Smart T ools agent is
installed, but not configured. Call Home functionality is provided through the Citrix T elemetry Service and Citrix Insight
Services.
Do not connect to Smart T ools or participate in Call Home.
When you're installing a Controller, you will not be able to congure information on the Call Home page in the installation
wizard if that server has an Active Directory GPO with the policy setting "Log on as a service" applied. For details, see
CT X218094.

If you're upgrading a Controller and previously enrolled in Call Home, the page will ask only about Smart Tools. If you're
already enrolled in Call Home and the Smart Agent is already installed, the wizard page won't appear.
For information about Smart Tools, see the Smart Tools documentation.
PowerShell cmdlets
T he PowerShell help provides comprehensive syntax, including descriptions of cmdlets and parameters that are not used in
these common use cases.
To use a proxy server for uploads, see Congure a proxy server.
Enable scheduled uploads
Diagnostic collections are automatically uploaded to Citrix. If you do not enter additional cmdlets for a custom schedule,
the default schedule is used.
$cred = Get-Credential
Enable-CitrixCallHome -Credential $cred
To conrm that scheduled uploads are enabled, enter Get-CitrixCallHome. It should return IsEnabled=True and
IsMasterImage=False.
Enable scheduled uploads f or machines created f rom a master image
Enabling scheduled uploads in a master image eliminates having to congure each machine that is created in the machine
catalog.
Enable-CitrixCallHome -Credential $cred -MasterImage
To conrm that scheduled uploads are enabled, enter Get-CitrixCallHome. It should return IsEnabled=True and
IsMasterImage=True.
Create a custom schedule
Ceate a daily or weekly schedule for diagnostic collections and uploads.
$timespan = New-T imeSpan Hours <hours> -Minutes <minutes>

Set-CitrixCallHomeSchedule T imeOfDay $timespan DayOfWeek <day> -UploadFrequency {Daily|Weekly}
Cancel scheduled uploads
After you cancel scheduled uploads, you can still upload diagnostic data using PowerShell cmdlets.
Disable-CitrixCallHome
To conrm that scheduled uploads are disabled, enter Get-CitrixCallHome. It should return IsEnabled=False and
IsMasterImage=False.
Examples
T he following cmdlet creates a schedule to bundle and upload data at 11:20 every evening. Note that the Hours parameter
uses a 24-hour clock. When the UploadFrequency parameter value is Daily, the DayOfWeek parameter is ignored, if
specied.

$timespan New-T imeSpan Hours 22 Minutes 20
Set-CitrixCallHomeSchedule T imeOfDay $timespan -UploadFrequency Daily
To conrm the schedule, enter Get-CitrixCallHomeSchedule, In the above example,it should return StartT ime=22:20:00,
DayOfWeek=Sunday (ignored), Upload Frequency=Daily.
T he following cmdlet creates a schedule to bundle and upload data at 11:20 every Wednesday evening.
$timespan New-T imeSpan Hours 22 Minutes 20

Set-CitrixCallHomeSchedule T imeOfDay $timespan DayOfWeek Wed -UploadFrequency Weekly
To conrm the schedule, enter Get-CitrixCallHomeSchedule, In the above example, it should return StartT ime=22:20:00,
DayOfWeek=Wednesday, Upload Frequency=Weekly.
Congure a proxy server f or Call Home uploads
Complete the following tasks on the machine where Call Home is enabled. Example diagrams in the following procedure
contain server address and port 10.158.139.37:3128. Your information will differ.
Step 1. Add proxy server information in your browser. In Internet Explorer, select Internet Options > Connections > LAN
settings. Select Use a proxy server f or your LAN" and enter the proxy server address and port number.
Step 2. In PowerShell, run netsh winhttp import proxy source=ie.
Step 3. Using a text editor, edit the TelemetryService.exe cong le, which is located in C:\Program Files\Citrix\Telemetry
Service. Add the information shown in the red box below.
Step 4 . Restart the Telemetry Service.
Run the Call Home cmdlets in PowerShell.

Manually collect and upload diagnostic inf ormation
You can use the CIS web site to upload a diagnostic information bundle to CIS. You can also use PowerShell cmdlets to
collect and upload diagnostic information to CIS.
To upload a bundle using the CIS web site:
1. Log on to Citrix Insight Services using your Citrix account credentials.

2. Select My Workspace.
3. Select Healthcheck and then navigate to the location of your data.
CIS supports several PowerShell cmdlets that manage data uploads. T his documentation covers the cmdlets for two
common cases:
Use the Start-CitrixCallHomeUpload cmdlet to manually collect and upload a diagnostic information bundle to CIS. (T he
bundle is not saved locally.)
Use the Start-CitrixCallHomeUpload cmdlet to manually collect data and store a diagnostic information bundle locally.
T his allows you to preview the data. T hen, at a later time, use the Send-CitrixCallHomeBundle cmdlet to manually upload
a copy of that bundle to CIS. (T he data you originally saved remains locally.)
T he PowerShell help provides comprehensive syntax, including descriptions of cmdlets and parameters that are not used in
these common use cases.
When you enter a cmdlet to upload data to CIS, you are prompted to conrm the upload. If the cmdlet times out before
the upload completes, check the status of the upload in the system event log. T he upload request may be rejected if the
service is already performing an upload.
Collect data and upload bundle to CIS
Start-CitrixCallHomeUpload [-Credential] <PSCredential> [-InputPath <String>] [-Description <String>] [-IncidentT ime

<String>] [-SRNumber <String>] [-Name <String>] [-UploadHeader <String>] [-AppendHeaders <String>] [-Collect
<String>] [<CommonParameters>]
Collect data and save it locally
Start-CitrixCallHomeUpload -OutputPath <String> [-InputPath <String>] [-Description <String>] [-IncidentT ime

<String>] [-SRNumber <String>] [-Name <String>] [-UploaderHeader <String>] [-AppendHeaders <String>] [-Collect
<String>] [<CommonParameters>]
Paramet er Descript ion
Credential Directs the upload to CIS.
InputPath Location of zip le to include in the bundle. This might be an additional le that Citrix
Support requests. Be sure to include the .zip extension.
OutputPath Location where the diagnostic information will be saved. This parameter is required when
saving Call Home data locally.
Description and Incident Time Free form information about the upload.

SRNumber Citrix Technical Support incident number.
Name Name that identies the bundle.
UploadHeader JSON-formatted string specifying the upload headers uploaded to CIS.
AppendHeaders JSON-formatted string specifying the appended headers uploaded to CIS.
Collect JSON-formatted string specifying which data to collect or omit, in the form {'collector':
{'enabled':Boolean}}", where Boolean is true or false.
Valid collector values are:
'wmi'
'process'
'registry
''crashreport'
'trace'
'localdata'
'sitedata'
'sfb'
By default, all collectors except 'sfb' are enabled.
The 'sfb' collector is designed to be used on demand to diagnose Skype for Business
issues. In addition to the 'enabled' parameter, the 'sfb' collector supports the 'account'
and 'accounts' parameters to specify target users. Use one of the forms:
"-Collect "{'sfb':{'account':'domain\\user1'}}"
-Collect "{'sfb':{'accounts':['domain\\user1', 'domain\\user2']}}"
Common Parameters See the PowerShell help.
Upload data that was previously saved locally
Send-CitrixCallHomeBundle -Credential <PSCredential> -Path <String> [<CommonParameters>]
T he Path parameter species the location of the previously-saved bundle.
Examples
T he following cmdlet requests an upload of Call Home data (excluding data from the WMI collector) to CIS. T his data
relates to registration failures for PVS VDAs, which was noted at 2:30 PM for Citrix Support case 123456. In addition to the
Call Home data, the le "c:\Diagnostics\ExtraData.zip" will be incorporated into the uploaded bundle.
C:\PS>Start-CitrixCallHomeUpload -InputPath "c:\Diagnostics\ExtraData.zip" -Description "Registration failures with

PVS VDAs" -IncidentT ime "14:30" -SRNumber 123456 -Name "RegistrationFailure-021812016" -Collect "{'wmi':
{'enabled':false}}" -UploadHeader "{'key1':'value1'}" -AppendHeaders "{'key2':'value2'}"

T he following cmdlet saves Call Home data related to Citrix Support case 223344, noted at 8:15 AM. T he data will be saved
in the le mydata.zip on a network share. In addition to the Call Home data, the le "c:\Diagnostics\ExtraData.zip" will be
incorporated into the saved bundle.
C:\PS>Start-CitrixCallHomeUpload -OutputPath \\mynetwork\myshare\mydata.zip -InputPath

"c:\Diagnostics\ExtraData.zip" -Description "Diagnostics for incident number 223344" -IncidentT ime "8:15" -
SRNumber 223344
T he following cmdlet uploads the data bundle you saved earlier.
$cred=Get-Credential
C:\PS>Send-CitrixCallHomeBundle Credential $cred -Path \\mynetwork\myshare\mydata.zip
Citrix Scout
For full details, see Citrix Scout.

Citrix Scout
May 22, 20 17
In this article:
Introduction
Prerequisites and considerations
Collect diagnostics
T race and reproduce
Schedule collections
Introduction
Citrix Scout collects diagnostics that can be used for proactive maintenance in your XenApp and XenDesktop deployment.
Citrix offers comprehensive, automated analysis through Citrix Insight Services. You can also use Scout to troubleshoot
issues, either on your own or with guidance from Citrix Support. You can upload collection les to Citrix for analysis and
guidance from Citrix Support. Or, you can save a collection locally for your own review, and then later upload the collection
le to Citrix for analysis.
Scout offers three main procedures:
Collect: Runs a one-time diagnostics collection on machines you select in a Site. T hen, you either upload the file
containing the collection to Citrix or save it locally.
Trace & Reproduce: Starts a manual trace on machines you select. T hen you re-create issues on those machines. After
re-creating the issue, the trace is stopped. T hen, Scout collects other diagnostics and uploads the file containing the
trace and the collection to Citrix, or saves the file locally.
Schedule: Schedules diagnostics collections to occur daily or weekly at a specified time on machines you select. T he file
containing each collection is automatically uploaded to Citrix.
T he graphical interface described in this article is the primary way to use Scout. Alternatively, you can use the PowerShell
interface to congure one-time or scheduled diagnostic collections and uploads. See Call Home.
Where to run Scout:
In an on-premises XenApp and XenDesktop deployment, run Scout from a Delivery Controller to capture diagnostics
from one or more Virtual Delivery Agents (VDAs) and Delivery Controllers. You can also run Scout from a VDA to collect
local diagnostics.
In a Citrix Cloud environment that uses the XenApp and XenDesktop Service, run Scout from a VDA to collect local
diagnostics.
What is collected
T he diagnostics collected by Scout include Citrix Diagnostic Facility (CDF) trace log les. A subset of CDF traces called
Always-on Tracing (AOT ) is also included. AOT information can be helpful when troubleshooting common issues such as VDA
registrations and application/desktop launches. No other Event Tracing for Windows (ET W) information is collected.
Collected information includes:

Registry entries created by XenApp and XenDesktop under HKEY_LOCAL_MACHINE\SOFT WARE\CIT RIX.
Windows Management Instrumentation (WMI) information under the Citrix namespace.
Processes that are running.
Crash dumps of Citrix processes that are stored in %PROGRAM DAT A%\Citrix\CDF.
About trace information:
T he trace information is compressed as it is collected, maintaining a small footprint on the machine.

On each machine, the Citrix T elemetry Service retains a maximum of 10 MB of compressed recent trace information,
with a maximum time limit of eight days.
T races are held in memory to avoid IOPs on provisioned machines.
T he trace buffer uses a circular mechanism to retain traces in memory.
For a list of the datapoints that Scout collects, see Scout key datapoints.
Prerequisites and considerations

Permissions:
You must be a local administrator and domain user for each machine you're collecting diagnostics from.
Use Run as administrator when launching Scout.
Version compatibility
T his version of Scout (3.x) is intended to be run on (minimum) XenApp and XenDesktop 7.14 Controllers and VDAs.
An earlier version of Scout is provided with earlier XenApp and XenDesktop deployments. For information about that earlier
version, see CT X130147.
If you upgrade a Controller or VDA earlier than 7.14, the earlier version of Scout is replaced with the current version. If you
do not upgrade all VDAs in a site, you can still use the current Scout release from an upgraded Controller. However, some
datapoints are omitted from collections.

Feature Scout 2.23 Scout 3.0
Support XenApp and XenDesktop

Yes Yes
7.14
Support XenDesktop 5.x, 7.1 to

Yes No
7.13
Support XenApp 6.x, 7.5 to 7.13 Yes No
Delivered with product 7.1 to 7.13 Beginning with 7.14
Can be downloaded from CT X

Yes No
article
Capture CDF traces Yes Yes
Capture Always-on-Traces (AOT ) No Yes
Allow collection of diagnostic Up to 10 machines at once (by

Unlimited (subject to resources availability)
data default)
Allow diagnostic data to be sent

Yes Yes
to Citrix
Allow diagnostic data to be saved

Yes Yes
locally
Support Citrix Cloud credentials No Yes
Support Citrix credentials Yes Yes
Support proxy server for uploads Yes Yes
Adjust schedules N/A Yes
Command line (local Controller PowerShell using Call Home cmdlets (any machine with
Script support
only) telemetry installed)
Verication tests
Before a diagnostic collection starts, verication tests run automatically for each selected machine to ensure that certain
requirements are met. If a test fails for a machine, Scout displays a message with suggested corrective action.

Scout must be able to communicate with the machine. Check the network connections.
T he Citrix T elemetry Service must be installed and running. T o check, run services.msc on the machine and verify that the
service state is Started.
Windows file print sharing must be enabled. See the Windows documentation for instructions.
WinRM must be enabled.
To enable WinRM, start Windows PowerShell on each machine. Using the "Run as administrator" option, enter Enable-
PSRemoting.
T hat cmdlet:
Starts the WinRM service.

Sets the startup type on the WinRM service to Automatic.
Creates a listener to accept requests on any IP address.
Enables a firewall exception for WS-Management communications.
Registers the Microsoft.PowerShell and Microsoft.PowerShell.Workflow session configurations, if they are not already
registered.
Registers the Microsoft.PowerShell32 session configuration on 64-bit computers, if it is not already registered.
Enables all session configurations.
Changes the security descriptor of all session configurations to allow remote access.
Restarts the WinRM service to make the preceding changes effective.
For complete cmdlet details, see https://msdn.microsoft.com/en-

us/powershell/reference/4.0/microsoft.powershell.core/enable-psremoting.
Install
By default, Scout is installed automatically as part of the Citrix Telemetry Service when you install a VDA or a Controller.
If you omit the Citrix Telemetry Service when you install a VDA, or remove the service later, run
TelemetryServiceInstaller_xx.msi from the x64\Virtual Desktop Components or x86\Virtual Desktop Components folder on
the XenApp or XenDesktop ISO.
Upload authorization
If you plan to upload diagnostic collections to Citrix, you must have a Citrix or Citrix Cloud account. (T hese are the
credentials you use to access Citrix downloads or access the Citrix Cloud Control Center.) After your account credentials are
validated, a token is issued.
If you authenticate with a Citrix account, the token-issuing process is not visible. You simply enter your account
credentials. After Citrix validates the credentials, you are allowed to continue in the Scout wizard.
If you authenticate with a Citrix Cloud account, you click a link to access Citrix Cloud using HT T PS with your default
browser. After entering your Citrix Cloud credentials, the token is displayed. Copy the token and then paste it into Scout.
You are then allowed to continue in the Scout wizard.
T he token is stored locally on the machine where you're running Scout. If you want to use that token the next time you
select Collect or Trace & Reproduce, select the Store token and skip this step in the f uture check box.
You must reauthorize each time you select Schedule on the Scout opening page. You cannot use a stored token when
creating or changing a schedule.

Use a proxy f or uploads
If you want to use a proxy server to upload collections to Citrix, you can instruct Scout to use the proxy settings
congured for your browser's Internet Properties, or you can specify the proxy server's IP address and port number.
Collect diagnostics
T he Collect procedure comprises selecting machines, starting the diagnostics collection, and then uploading the le
containing the collection to Citrix or saving it locally.
Step 1. Launch Scout
From the machine's Start menu: Citrix > Citrix Scout. On the opening page, click Collect.
Step 2. Select machines
T he Select machines page lists all the VDAs and Controllers in the Site. You can lter the display by machine name. Select
the check box next to each machine you want to collect diagnostics from, and then click Continue.
Scout automatically launches verication tests on each machine you selected, ensuring it meets the criteria listed in
Verication tests. If verication fails, a message is posted in the Status column, and that machine's check box is unselected.
You can either:
Resolve the issue and then select the machine's check box again. T his triggers a retry of the verification tests.
Skip that machine (leave its check box unselected). Diagnostics will not be collected from that machine.
When the verication tests complete, click Continue.
Step 3. Collect diagnostics f rom machines
T he summary lists all the machines from which diagnostics will be collected (the machines you selected that passed the
verication tests). Click Start Collecting.
During collection:
T he Status column indicates the current collection state for a machine.

T o stop an in-progress collection on a single machine, click Cancel in the Action column for that machine.
T o stop all in-progress collections, click Stop Collection in the lower right corner of the page. Diagnostics from machines
that have comp;leted collection are retained. T o resume the collection, click Retry in the Action column for each
machine.
When the collection completes for all selected machines, the Stop Collection button in the lower right corner changes
to Continue.
If a collection for a machine succeeds and you want to collect diagnostics again from a machine, click Collect Again in
that machine's Action column. T he newer collection overwrites the earlier.
If a collection fails, you can click Retry in the Action column. Only successful collections are uploaded or saved.
After the collection completes for all selected machines, do not click Back. If you click that button and confirm the
prompt, the collection is lost.
When the collection completes, click Continue.

Step 4 . Save or upload the collection
Choose whether to upload the le containing the collected diagnostics to Citrix, or save it on the local machine.
If you choose to upload the le now, continue with Step 5.
If you choose to save the le locally:
A Windows Save dialog box appears. Navigate to the desired location.

When the local save completes, the pathname of the file is displayed and linked. You can view the file. You can upload
the file later from Citrix; see CT X136396 for Citrix Insight Services, or Smart T ools support.
Click Done to return to the Scout opening page. You do not need to complete any further steps in this procedure.
Step 5. Authenticate f or uploads and optionally specif y proxy
Review Upload authorization for details of this process.
If you have not previously authenticated through Scout, continue with this step.
If you previously authenticated through Scout, the stored authorization token is used by default. If this is OK with you,
choose this option and click Continue. You are not prompted for credentials for this collection; continue with Step 6.
If you previously authenticated, but want to reauthorize and have a new token issued, click Change/Reauthorize and
continue with this step.
Choose whether you want to use Citrix credentials or Citrix Cloud credentials to authenticate the upload. Click Continue.
T he credentials page appears only if you're not using a stored token.
On the credentials page:
If you want to use a proxy server for the file upload, click Conf igure proxy. You can instruct Scout to use the proxy
settings configured for your browser's internet properties, or you can enter the proxy server's IP address and port
number. Close the proxy dialog box.
For a Citrix Cloud account, click Generate token. Your default browser will launch to a Citrix Cloud page where a token is
displayed. Copy the token, and then paste it on the Scout page.
For a Citrix account, enter your credentials.
When you're done, click Continue.
Step 6. Provide inf ormation about the upload
Enter upload details:
T he name field contains the default name for the file that will contain the collected diagnostics. T his should suffice for
most collections, although you can change the name. (If you delete the default name and leave the name field empty,
the default name will be used.)
Optionally, specify an 8-digit Citrix Support case number.
In the optional Description field, describe the issue and indicate when the issue occurred, if applicable.
When you're done, click Start Upload.
During the upload, the lower left portion of the page approximates what percentage of the upload has completed.
To cancel an in-progress upload, click Stop Upload.

When the upload completes, the URL of its location is displayed and linked. You can follow the link to the Citrix location to
view the analysis of the upload, or you can copy the link.
Click Done to return to the Scout opening page.
Trace and reproduce

T he Trace and Reproduce procedure comprises selecting machines, starting a trace on those machines, reproduce issues on
those machines, completing the diagnostics collection, and then uploading the le containing the traces and collection to
Citrix, or saving it locally.
T his procedure is similar to the standard Collect procedure. However, it allows you to start a trace on machines and then re-
create issues on those machines. All diagnostics collections include AOT trace information; this procedure adds CDF traces
to help troubleshooting.
From the machine's Start menu: Citrix > Citrix Scout. On the opening page, click Trace & Reproduce.
T he Select machines page lists all the VDAs and Controllers in the Site. You can lter the display by machine name. Select
the check box next to each machine you want to collect traces and diagnostics from, and then click Continue.
Scout launches verication tests on each of the machines you selected, ensuring it meets the criteria listed in Verication
tests. If verication fails for a machine, a message is posted in the Status column, and that machine's check box is
unselected. You can either:
Skip that machine (leave its check box unselected). Diagnostics and traces will not be collected from that machine.
Step 3. Trace
T he summary lists all the machines from which traces will be collected. Click Start Tracing.
On one or more of the selected machines, reproduce the issues you experienced. Trace collection continues while you're
doing that. When you're done reproducing the issue, click Continue in Scout. T hat stops the trace.
After you stop the trace, indicate whether you reproduced the issue during the trace.
Step 4 . Collect diagnostics f rom machines
Click Start Collecting.
During collection:
T he Status column indicates the current collection state for a machine.

T o stop an in-progress collection on a single machine, click Cancel in the Action column for that machine.
T o stop all in-progress collections, click Stop Collection in the lower right corner of the page. Diagnostics from

machines that have completed collection are retained. T o resume the collection, click Retry in the Action column for
each machine.
When the collection completes for all selected machines, the Stop Collection button in the lower right corner changes
to Continue.
If a collection for a machine succeeds and you want to collect diagnostics again from a machine, click Collect Again in
that machine's Action column. T he newer collection overwrites the earlier.
If a collection fails, you can click Retry in the Action column. Only successful collections are uploaded or saved.
After the collection completes for all selected machines, do not click the Back button. If you click that button and
confirm the prompt, the collection is lost.
When the collection completes, click Continue.
Step 5. Save or upload the collection
Choose whether to upload the le containing the collected diagnostics to Citrix, or save it on the local machine.
If you choose to upload the le now, continue with Step 6.
If you choose to save the le locally:
A Windows Save dialog box appears. Select the desired location.

When the local save completes, the pathname of the file is displayed and linked. You can view the file. Remember: You
can upload the file later from Citrix; see CT X136396 for Citrix Insight Services, or Citrix Smart T ools.
Click Done to return to the Scout opening page. You do not need to complete any further steps in this procedure.
Step 6. Authenticate f or uploads and optionally specif y proxy
Review Upload authorization for details of this process.
If you have not previously authenticated through Scout, continue with this step.
If you previously authenticated through Scout, the stored authorization token is used by default. If this is OK with you,
choose this option and click Continue. You are not prompted for credentials for this collection; continue with Step 7.
If you previously authenticated, but want to reauthorize and have a new token issued), click Change/Reauthorize and
continue with this step.
Choose whether you want to use Citrix credentials or Citrix Cloud credentials to authenticate the upload. Click
Continue. T he credentials page appears only if you're not using a stored token.
If you want to use a proxy server for the file upload, click Conf igure proxy. You can instruct Scout to use the proxy
settings configured for your browser's Internet Properties, or you can enter the proxy server's IP address and port
Step 7. Provide inf ormation about the upload

Enter upload details:
T he name field contains the default name for the file that will contain the collected diagnostics. T his should suffice for
most collections, although you can change the name. (If you delete the default name and leave the name field empty,
the default name will be used.)
Optionally, specify an 8-digit Citrix Support case number.
In the optional Description field, describe the issue and indicate when the issue occurred, if applicable.
When you're done, click Start Upload.
During the upload, the lower left portion of the page approximates what percentage of the upload has completed.
To cancel an in-progress upload, click Stop Upload.
When the upload completes, the URL of its location is displayed and linked. You can follow the lik to the Citrix location to
view the analysis of the upload, or you can copy the link.
Click Done to return to the Scout opening page.
Schedule collections
T he Schedule procedure comprises selecting machines and then setting or canceling the schedule. Scheduled collections are
automatically uploaded to Citrix. (You can save scheduled collections locally using the PowerShell interface. See Citrix Call
Home.)
From the machine's Start menu: Citrix > Citrix Scout. On the opening page, click Schedule.
T he Select machines page lists all the VDAs and Controllers in the Site. You can lter the display by machine name.
When you installed VDAs and Controllers using the graphical interface, you were offered the opportunity to
participate in Call Home. For details, see Citrix Call Home. (Call Home includes scheduling functionality equivalent to
Scout.) Scout displays those settings, by default. You can use this version of Scout to start scheduled collections for
the rst time, or change a previously-congured schedule.
Keep in mind that although you enabled/disabled Call Home on a per-machine basis, setting a schedule in Scout uses
the same commands, but affects all the machines you select.
Select the check box next to each machine you want to collect diagnostics from, and then click Continue.
Scout launches verication tests on each of the machines you selected, ensuring it meets the criteria listed in Verication
tests. If verication fails for a machine, a message is posted in the Status column, and that machine's check box is
unselected. You can either:
Skip that machine (leave its check box unselected). Diagnostics (or traces) will not be collected from that machine.

T he summary page lists the machines to which schedules will be applied Click Continue.
Step 3. Set schedule
Indicate when you want diagnostics to be collected. Remember: T he schedule affects all the selected machines.
T o configure a weekly schedule for the selected machines, click Weekly. Choose the day of the week and enter the time
of day (24-hour clock) when the diagnostics collection will begin.
T o configure a daily schedule for the selected machines, click Daily. Enter the time of day (24-hour clock) when the
diagnostics collection will begin.
T o cancel an existing schedule for the selected machines (and not replace it with another), click Of f . T his cancels any
schedule that was previously configured for those machines.
Click Continue.
Step 4 . Authenticate f or uploads and optionally specif y proxy
Review Upload authorization for details of this process. Remember: You cannot use a stored token to authenticate when
working with a Scout schedule.
Choose whether you want to use Citrix credentials or Citrix Cloud credentials to authenticate the upload. Click Continue.
If you want to use a proxy server for the file upload, click Configure proxy. You can instruct Scout to use the proxy
settings configured for your browser's Internet Properties, or you can enter the proxy server's IP address and port
Review the congured schedule. Click Done to return to the Scout opening page.
When each scheduled collection occurs, each selected machine's Windows application log contains entries about the
collection and upload.

Monitor
May 22, 20 17
Administrators and help-desk personnel can monitor XenApp and XenDesktop Sites using a variety of features and tools.
Using these tools, you can monitor
User sessions and session use

Logon performance
Connections and machines, including failures
Load evaluation
Historical trends
Infrastructure
Citrix Director
Director is a real-time web tool you can use to monitor, troubeleshoot, and perform support tasks for end users.
For details, see the Director articles.
Session Recording
Session Recording allows you to record the on-screen activity of any users session, over any type of connection, from any
server running XenApp subject to corporate policy and regulatory compliance. Session Recording records, catalogs, and
archives sessions for retrieval and playback.
Session Recording uses exible policies to trigger recordings of application sessions automatically. T his enables IT to
monitor and examine user activity of applications such as nancial operations and healthcare patient information
systems supporting internal controls for regulatory compliance and security monitoring. Similarly, Session Recording also
aids in technical support by speeding problem identication and time-to-resolution.
For details, see the Session Recording articles.
Conguration Logging
Conguration Logging is a feature that allows administrators to keep track of administrative changes to a Site.
Conguration Logging can help administrators diagnose and troubleshoot problems after conguration changes are made,
assist change management and track congurations, and report administration activity.
You can view and generate reports about logged information from Studio. You can also view logged items in Director with
the Trend View interface to provide notications of conguration changes. T his feature is useful for administrators who do
not have access to Studio.
T he Trends View gives historical data of conguration changes over a period of time so administrators can assess what
changes were made to the Site, when they were made, and who made them to nd the cause of an issue. T his view sorts
conguration information into three categories.
Connection Failures
Failed Desktop Machines
Failed Server Machines

For details about how to enable and congure Conguration Logging, see the Conguration Logging article. T he Director
articles describe how to view logged information from that tool.
Event logs
XenApp and XenDesktop services log events that occur. Event logs can be used to monitor and troubleshoot operations.
For details, see the Event logs article. Individual feature articles might also contain event information.

Session Recording
May 22, 20 17
Session Recording allows you to record the on-screen activity of any user session hosted from a VDA for Server OS or
Desktop OS, over any type of connection, subject to corporate policy and regulatory compliance. Session Recording
records, catalogs, and archives sessions for retrieval and playback.
Session Recording uses exible policies to trigger recordings of application sessions automatically. T his enables IT to
monitor and examine user activity of applications - such as nancial operations and healthcare patient information systems
- supporting internal controls for regulatory compliance and security monitoring. Similarly, Session Recording also aids in
technical support by speeding problem identication and time-to-resolution.
Benets
Enhanced security through logging and monitoring. Session Recording allows organizations to record on-screen user
activity for applications that deal with sensitive information. T his is especially critical in regulated industries such as health
care and nance. Where personal information that must not be recorded is involved, policy controls allow selective
recording.
Powerf ul activity monitoring. Session Recording captures and archives screen updates, including mouse activity and the
visible output of keystrokes in secured video recordings to provide a record of activity for specic users, applications, and
servers.
Session Recording is not designed or intended to contribute to the collection of evidence for legal proceedings. Citrix
recommends that organizations using Session Recording use other techniques for evidence collection, such as conventional
video records combined with traditional text-based eDiscovery tools.
Faster problem resolution. When users call with a problem that is hard to reproduce, help desk support staff can enable
recording of user sessions. When the issue recurs, Session Recording provides a time-stamped visual record of the error,
which can then be used for faster troubleshooting.

Get started with Session Recording
May 22, 20 17
After you perform the following steps, you can begin recording and reviewing XenApp and XenDesktop sessions.
1. Become familiar with the Session Recording components.

2. Select the deployment scenario for your environment.
3. Verify the installation requirements.
4. Install the Windows roles and features prerequisites.
5. Install Session Recording.
6. Configure the Session Recording components to permit recording and viewing of sessions.
Session Recording consists of ve components:
Session Recording Agent. A component installed on each VDA for Server OS or Desktop OS to enable recording. It is
responsible for recording session data.
Session Recording Server. A server that hosts:
T he Broker. An IIS 6.0+ hosted Web application that handles the search queries and file download requests from the
Session Recording Player, handles policy administration requests from the Session Recording Policy Console, and
evaluates recording policies for each XenApp and XenDesktop session.
T he Storage Manager. A Windows service that manages the recorded session files received from each Session
Recording-enabled computer running XenApp and XenDesktop.
Administrator Logging. An optional subcomponent installed with Session Recording Server to log the administration
activities. All the logging data is stored in a separate SQL Server database named CitrixSessionRecordingLogging.
Session Recording Player. A user interface that users access from a workstation to play recorded XenApp and
XenDesktop session files.
Session Recording Database. A component that manages the SQL Server database for storing recorded session data.
When this component is installed, it creates a database named CitrixSessionRecording. You cannot change the name.
Session Recording Policy Console. A console used to create policies to specify which sessions are recorded.
T his illustration shows the Session Recording components and their relationship with each other:
In the deployment example illustrated here, the Session Recording Agent, Session Recording Server, Session Recording
Database, Session Recording Policy Console, and Session Recording Player all reside behind a security rewall. T he Session
Recording Agent is installed on a VDA for Server OS or Desktop OS. A second server hosts the Session Recording Policy
Console, a third server acts as the Session Recording Server, and a fourth server hosts the Session Recording Database. T he
Session Recording Player is installed on a workstation. A client device outside the rewall communicates with the VDA for
Server OS on which the Session Recording Agent is installed. Inside the rewall, the Session Recording Agent, Session
Recording Policy Console, Session Recording Player, and Session Recording Database all communicate with the Session
Recording Server.

Plan your deployment
May 22, 20 17
Limitations and caveats
Session Recording does not support Desktop Composition Redirection (DCR) display mode. By default, Session Recording
disables DCR in a session if the session is to be recorded by recording policy. You can congure this behavior in Session
Recording Agent properties.
Depending upon your environment, you can deploy the Session Recording components in different scenarios.
A Session Recording deployment does not have to be limited to a single site. With the exception of the Session Recording
Agent, all components are independent of the server site. For example, you can congure multiple sites to use a single
Session Recording Server.
Alternatively, if you have a large site with many agents and plan to record many graphically intense applications (for
example, AutoCAD applications), or you have many sessions to record, a Session Recording Server can experience a high
performance demand. To alleviate performance issues, you can install multiple Session Recording Servers on different
computers and point the Session Recording Agents to the different computers. Keep in mind that an agent can point to
only one server at a time.
Suggested server site deployment
Use this type of deployment for recording sessions for one or more sites. T he Session Recording Agent is installed on each
VDA for Server OS in a site. T he site resides in a data center behind a security firewall. T he Session Recording Administration
components (Session Recording Database, Session Recording Server, and Session Recording Policy Console) are installed on
other servers and the Session Recording Player is installed on a workstation, all behind the firewall but not in the data
center. Outside the firewall, in an unsecured network environment, are XenApp clients, such as a workstation, mobile
devices, and a laptop computer.

Important deployment notes
T o enable Session Recording components to communicate with each other, ensure that you install them in the same
domain or across trusted domains that have a transitive trust relationship. T he system cannot be installed into a
workgroup or across domains that have an external trust relationship.
Due to its intense graphical nature and memory usage when playing back large recordings, Citrix does not recommend
installing the Session Recording Player as a published application.
T he Session Recording installation is configured for T LS/HT T PS communication. Ensure that you install a certificate on
the Session Recording Server and that the root certificate authority (CA) is trusted on the Session Recording
components.
If you install the Session Recording Database on a stand-alone server running SQL Server 2016 Express Edition, SQL
Server 2014 Express Edition, SQL Server 2012 Express Edition, or SQL Server 2008 R2 Express Edition, the server must have
T CP/IP protocol enabled and SQL Server Browser service running. T hese settings are disabled by default, but they must
be enabled for the Session Recording Server to communicate with the database. For information about enabling these
settings, see the Microsoft articles Enable T CP/IP Network Protocol for SQL Server and SQL Server Browser Service.
Consider the effects of session sharing when planning your Session Recording deployment. Session sharing for published
applications can conflict with Session Recording policy rules for published applications. Session Recording matches the
active policy with the first published application that a user opens. After the user opens the first application, any
subsequent applications opened during the same session continue to follow the policy that is in force for the first
application. For example, if a policy states that only Microsoft Outlook should be recorded, the recording commences
when the user opens Outlook. However, if the user opens a published Microsoft Word second (while Outlook is running),
Word also is recorded. Conversely, if the active policy does not specify that Word should be recorded, and the user
launches Word before Outlook (which should be recorded, according to the policy), Outlook is not recorded.
T hough you can install the Session Recording Server on a Delivery Controller, Citrix does not recommend you do so
because of performance issues.
You can install the Session Recording Policy console on a Delivery Controller.
You can install both the Session Recording Server and Session Recording Policy console on the same system.

Security recommendations
May 22, 20 17
Session Recording is designed to be deployed within a secure network and accessed by administrators, and as such, is
secure. Out-of-the-box deployment is designed to be simple and security features such as digital signing and encryption can
be congured optionally.
Communication between Session Recording components is achieved through Internet Information Services (IIS) and
Microsoft Message Queuing (MSMQ). IIS provides the web services communication link between each Session Recording
component. MSMQ provides a reliable data transport mechanism for sending recorded session data from the Session
Recording Agent to the Session Recording Server.
Warning
Editing the registry incorrectly can cause serious problems that might require you to reinstall your operating system. Citrix cannot
Consider these security recommendations when planning your deployment:
Ensure that you properly isolate the different administrator roles in the corporate network, in the Session Recording
system, or on individual machines. By not doing so, security threats that can impact the system functionality or abuse
the system might occur. Citrix recommends that you assign different administrator roles to different persons or
accounts that you do not allow general session users to have administrator privileges to the VDA system.
XenApp and XenDesktop administrators should not grant VDA local admin role to any users of published apps or
desktops. If the local admin role is a requirement, protect the Session Recording Agent components with Windows
mechanisms or 3rd-party solutions.
Separately assign the Session Recording database administrator and Session Recording policy administrator.
Citrix recommends that you do not assign VDA administrator privileges to general session users, especially when using
Remote PC Access.
Session Recording Server local administration account must be strictly protected.
Control access to machines installed with Session Recording Player. If a user is not authorized as the Player role, do
not grant that user local administrator role for any player machine. Disable anonymous access.
Citrix recommends using a physical machine as a storage server for Session Recording.
Session Recording records session graphics activities without regard to the sensitivity of the data. Under certain
circumstances, sensitive data (including but not limited to user credentials, privacy information, and third-party screens)
might be recorded unintentionally. T ake the following measures to prevent risks:
+ Disable core memory dump for VDAs unless for specic troubleshooting cases.
To disable core memory dump:
1. Right-click My Computer, and then click Properties.

2. Click the Advanced tab, and then under Startup and Recovery, click Settings.
3. Under Write Debugging Inf ormation, select (none).

See the Microsoft article at https://support.microsoft.com/en-us/kb/307973.
+ Session owners should notify attendees that online meetings and remote assistance software might get recorded
if a desktop session is being recorded.
+ Ensure that logon credentials or security information does not appear in all local and Web applications published or
used inside the corporation or they are recorded by Session Recording.
+ Users should close any application that might expose sensitive information before switching to a remote ICA
session.
+ We recommend only automatic authentication methods (for example, single sign on, smartcard) for accessing
published desktops or Software as a Service (SaaS) applications.
Session Recording relies on certain hardware and hardware infrastructure (for example, corporate network devices,
operation system) to function properly and to meet security needs. T ake measures at the infrastructure levels to
prevent damage or abuse to those infrastructures and make the Session Recording function secure and reliable.
Properly protect and keep network infrastructure supporting Session Recording available.
Citrix recommends using a third-party security solution or Windows mechanism to protect Session Recording
components. Session Recording components include:
On Session Recording Server
Processes: SsRecStoragemanager.exe and SsRecAnalyticsService.exe
Services: CitrixSsRecStorageManager and CitrixSsRecAnalyticsService
All files in Session Recording Server installation folder
Registry keys at HOT KEY_LOCAL_MACHINE\Software\Citrix\SmartAuditor\Server
On Session Recording Agent
Process: SsRecAgent.exe
Service: CitrixSmAudAgent
All files in Session Recording Agent installation folder
Registry keys at HOT KEY_LOCAL_MACHINE\Software\Citrix\SmartAuditor\Agent
Set the access control list (ACL) for Message Queuing (MSMQ) on the Session Recording Server to restrict VDA or VDI
machines that can send MSMQ data to the Session Recording Server and prevent unauthorized machines from sending
data to the Session Recording Server.
1) Install server feature Directory Service Integration on each Session Recording Server and VDA or VDI machine
where Session Recording is enabled, and then restart the Message Queuing service.
2) From the Windows Start menu on each Session Recording Server, open Administrative Tools > Computer
Management.
3) Open Services and Applications > Message Queuing > Private Queues.
4) Click on the private queue citrixsmauddata to open the Properties page and select the Security tab.

5) Add the computers or security groups of the VDAs that will send MSMQ data to this server and grant them the
Send Message permission.

Properly protect the event log for the Session Record Server and Session Recording Agents. We recommend leveraging a
Windows or third-party remote logging solution to protect the event log or redirect the event log to the remote server.
Ensure that servers running the Session Recording components are physically secure. If possible, lock these computers in
a secure room to which only authorized personnel can gain direct access.
Isolate servers running the Session Recording components on a separate subnet or domain.
Protect the recorded session data from users accessing other servers by installing a firewall between the Session
Recording Server and other servers.
Keep the Session Recording Admin Server and SQL database up to date with the latest security updates from Microsoft.
Restrict non-administrators from logging on to the administration machine.
Strictly limit who is authorized to make recording policy changes and view recorded sessions.
Install digital certificates, use the Session Recording file signing feature, and set up T LS communications in IIS.
Set up MSMQ to use HT T PS as its transport by setting the MSMQ protocol listed in Session Recording Agent
Properties to HT T PS. For more information, see T roubleshoot MSMQ.
Use T LS 1.1 or T LS 1.2 (recommended) and disable SSLv2, SSLv3, T LS 1.0 on the Session Recording Server and Session
Recording Database. For more information, see the Microsoft article at http://support.microsoft.com/default.aspx?
scid=kb;en-us;187498.
Disable RC4 cipher suites for T LS on the Session Recording Server and Session Recording Database:
1. Using the Microsoft Group Policy Editor, navigate to Computer Conf iguration > Administrative Templates >

Network > SSL Conf iguration Settings.
2. Set the SSL Cipher Suite Order policy to Enabled. By default, this policy is set to Not Conf igured.
3. Remove any RC4 cipher suites.
Use playback protection. Playback protection is a Session Recording feature that encrypts recorded files before they are
downloaded to the Session Recording Player. By default, this option is enabled and is in Session Recording Server
Properties.
Follow NSIT guidance for cryptographic key lengths and cryptographic algorithms.
Configure T LS 1.2 support for Session Recording.
Citrix recommends using T LS 1.2 as the communication protocol to ensure the end-to-end security of the Session
Recording components.
To conf igure TLS 1.2 support of Session Recording:
1. Log on to the computer hosting the Session Recording Server, install the proper SQL Server client component and
driver, and set strong cryptography for .NET Framework (version 4 or later)
a. Install the Microsoft ODBC Driver 11 (or a later version) for SQL Server.
b. Apply the latest hotfix rollup of .NET Framework.
c. Install ADO.NET - SqlClient based on your version of .NET Framework. For more information,
see https://support.microsoft.com/en-us/kb/3135244.
d. Add a DWORD value SchUseStrongCrypto = 1 under
HKEY_LOCAL_MACHINE\SOFT WARE\Microsoft\.NetFramework\v4.0.30319 and
HKEY_LOCAL_MACHINE\SOFT WARE\Wow6432Node\Microsoft\.NetFramework\v4.0.30319.
e. Restart the computer.
2. Log on to the computer hosting the Session Recording Policy Console to apply the latest hotfix rollup of .NET
Framework and set strong cryptography for .NET Framework (version 4 or later). T he method for setting strong
cryptography is same as substeps 1-d and 1-e. You can omit these steps if you choose to install the Session Recording
Policy Console on the same computer as the Session Recording Server.
To congure the T LS 1.2 support for SQL Server with versions earlier than 2016, see https://support.microsoft.com/en-
us/kb/3135244. To leverage T LS 1.2, congure HT T PS as the communication protocol for the Session Recording
components.
For information about conguring the Session Recording security features, see Knowledge Center article CT X200868.

Scalability considerations
May 22, 20 17
Installing and running Session Recording requires few additional resources beyond what is necessary to run XenApp.
However, if you plan to use Session Recording to record a large number of sessions or if the sessions you plan to record will
result in large session les (for example, graphically intense applications), consider the performance of your system when
planning your Session Recording deployment.
For more information about building a highly scalable Session Recording system, see Knowledge Center article CT X200869.
Hardware recommendations
Consider how much data you will be sending to each Session Recording Server and how quickly the servers can process and
store this data. T he rate at which your system can store incoming data must be higher than the data input rate.
To estimate your data input rate, multiply the number of sessions recorded by the average size of each recorded session
and divide by the period of time for which you are recording sessions. For example, you might record 5,000 Microsoft
Outlook sessions of 20MB each over an 8-hour work day. In this case, the data input rate is approximately 3.5Mbps. (5,000
sessions times 20MB divided by 8 hours, divided by 3,600 seconds per hour.)
You can improve performance by optimizing the performance of a single Session Recording Server or by installing multiple
Session Recording Servers on different machines.
Disk and storage hardware
Disk and storage hardware are the most important factors to consider when planning a Session Recording deployment. T he
write performance of your storage solution is especially important. T he faster data can be written to disk, the higher the
performance of the system overall.
Storage solutions suitable for use with Session Recording include a set of local disks controlled as RAID arrays by a local
disk controller or by an attached Storage Area Network (SAN).
Note: Session Recording should not be used with Network-Attached Storage (NAS), due to performance and security
problems associated with writing recording data to a network drive.
For a local drive setup, a disk controller with built-in cache memory enhances performance. A caching disk controller must
have a battery backup facility to ensure data integrity in case of a power failure.
Network capacity
A 100Mbps network link is suitable for connecting a Session Recording Server. A gigabit Ethernet connection might improve
performance, but does not result in 10 times greater performance than a 100Mbps link.
Ensure that network switches used by Session Recording are not shared with third-party applications that might compete
for available network bandwidth. Ideally, network switches are dedicated for use with the Session Recording Server.
Computer processing capacity
Consider the following specications for the computer on which a Session Recording Server is installed:
A dual CPU or dual-core CPU is recommended

4GB of RAM is recommended

Exceeding these specications does not signicantly improve performance.
Deploy multiple Session Recording servers
If a single Session Recording Server does not meet your performance needs, you can install more Session Recording Servers
on different machines. In this type of deployment, each Session Recording Server has its own dedicated storage, network
switches, and database. To distribute the load, point the Session Recording Agents in your deployment to different Session
Recording Servers.
Database scalability
T he Session Recording Database requires Microsoft SQL Server 2016, Microsoft SQL Server 2014, Microsoft SQL Server
2012, or Microsoft SQL Server 2008 R2. T he volume of data sent to the database is very small because the database stores
only metadata about the recorded sessions. T he les of the recorded sessions themselves are written to a separate disk.
Typically, each recorded session requires only about 1KB of space in the database, unless the Session Recording Event API is
used to insert searchable events into the session.
T he Express Editions of Microsoft SQL Server 2016, Microsoft SQL Server 2014, Microsoft SQL Server 2012, and Microsoft
SQL Server 2008 R2 impose a database size limitation of 10GB. At 1KB per recording session, the database can catalog
about four million sessions. Other editions of Microsoft SQL Server have no database size restrictions and are limited only
by available disk space. As the number of sessions in the database increases, performance of the database and speed of
searches diminishes only negligibly.
If you are not making customizations through the Session Recording Event API, each recorded session generates four
database transactions: two when recording starts, one when the user logs onto the session being recorded, and one when
recording ends. If you use the Session Recording Event API to customize sessions, each searchable event recorded
generates one transaction. Because even the most basic database deployment can handle hundreds of transactions per
second, the processing load on the database is unlikely to be stressed. T he impact is light enough that the Session
Recording Database can run on the same SQL Server as other databases, including the XenApp or XenDesktop data store
database.
If your Session Recording deployment requires many millions of recorded sessions to be cataloged in the database, follow
Microsoft guidelines for SQL Server scalability.

Install, upgrade, and uninstall Session Recording
May 22, 20 17
T his chapter details how to install Session Recording by using the XenApp/XenDesktop installer. It contains the following
sections:
Note: If you are using Windows Server 2012 or later, Citrix recommends that you install Session Recording using the
XenApp/XenDesktop installer, instructions for which are provided below. If you are using Windows Server 2008, Citrix
recommends that you install Session Recording using the msi package, instructions for which are provided here.
Installation checklist
Install the Session Recording Administration components
Congure Director to use the Session Recording Server
Install the Session Recording Agent
Install the Session Recording Player
Automate installations
Upgrade Session Recording
Uninstall Session Recording
Installation checklist
As of version 7.14, you can install the Session Recording components by using the XenApp/XenDesktop installer.
Before you start the installation, complete this list:
Step
Select the machines on which you want to install each Session Recording component and ensure that each
computer meets the hardware and software requirements for the component or components to be
installed on it.
Use your Citrix account credentials to access the XenApp and XenDesktop download page and download
the product ISO le. Unzip the ISO le or burn a DVD of it.
To use the T LS protocol for communication between the Session Recording components, install the correct
certicates in your environment.
Install any hotxes required for the Session Recording components. T he hotxes are available from
the Citrix Support.

Congure Director to create and activate the Session Recording policies. For more information,
see Congure Director to use the Session Recording Server.
Note:
Citrix recommends that you divide the published applications into separate Delivery Groups based on your recording
policies because session sharing for published applications can conflict with active policies if they are in the same Delivery
Group. Session Recording matches the active policy with the first published application that a user opens.
If you are planning to use Machine Creation Services (MCS) or Provisioning Services, prepare a unique QMId. Failure to
comply can cause recording data losses.
SQL Server requires that T CP/IP is enabled, the SQL Server Browser service is running, and Windows Authentication is
used.
T o use HT T PS, configure server certificates for T LS/HT T PS.
Install the Session Recording Administration

components
Citrix recommends you install the Session Recording Administration, Session Recording Agent, and Session Recording Player
components on separate servers. T he Session Recording Administration components include the Session Recording
Database, Session Recording Server, and Session Recording Policy Console. You can choose which of these components to
install on a server.
Step 1: Download the product sof tware and launch the wizard
1. If you have not downloaded the XenApp and XenDesktop ISO yet, use your Citrix account credentials to access the
XenApp and XenDesktop download page and download the product ISO file. Unzip the ISO file or burn a DVD of it.
2. Use a local administrator account to log on to the machine where you are installing the Session Recording Administration
components. Insert the DVD in the drive or mount the ISO file. If the installer does not launch automatically, double-click
the AutoSelect application or the mounted drive.
Step 2: Choose which product to install

Step 3: Select Session Recording

Select the Session Recording entry.
Step 4: Read and accept the license agreement

On the Sof tware License Agreement page, read the license agreement, accept it, and then click Next.
Step 5: Select the components to install and the installation location

On the Core Components page:
Location: By default, components are installed in C:\Program Files\Citrix. T he default location works for most
deployments. You can specify a custom installation location.
Component: By default, all the check boxes next to the components that can be installed are selected. T he installer
knows whether it is running on a Desktop OS or a Server OS. It allows the Session Recording Administration components
to be installed on a Server OS only, and it does not allow the Session Recording Agent to be installed on a machine that
has no VDA installed in advance. If you install the Session Recording Agent on a machine that has no VDA installed in
advance, T he Session Recording Agent option is unavailable.
Select Session Recording Administration and click Next.

Step 6: Select the f eatures to install

On the Features page:
By default, all the check boxes next to the features that can be installed are selected. Installing all these features on a
single server is fine for a proof of concept. However, for a large production environment, Citrix recommends you install
the Session Recording Policy Console on a separate server and the Session Recording Server, Session Recording
Administrator Logging and Session Recording Database on another separate server. Note that the Session Recording
Administrator Logging is an optional subfeature of the Session Recording Server. You must select the Session Recording
Server before you can select the Session Recording Administrator Logging.
T o add another feature on the same server after you select and install a feature or features on it, you can only run the
msi package but cannot run the installer again.
Select the feature or features you want to install and click Next.
Step 6.1: Install the Session Recording Database

Important: Session Recording Database is not an actual database. It is a component responsible for creating and
conguring the required databases in the Microsoft SQL Server instance during installation. Session Recording supports
three solutions for database high availability based on Microsoft SQL Server. For more information, see Install Session
Recording with database high availability.
T here are typically three types of deployments for the Session Recording Database and Microsoft SQL Server:

Deployment 1: Install the Session Recording Server and Session Recording Database on the same machine and the
Microsoft SQL Server on a remote machine. (Recommended)
Deployment 2: Install the Session Recording Server, Session Recording Database, and Microsoft SQL Server on the same
machine.
Deployment 3: Install the Session Recording Server on a machine and install both the Session Recording Database and
Microsoft SQL Server on another machine. (Not recommended)
1. On the Features page, select Session Recording Database and click Next.
2. On the Database and Server Conguration page, specify the instance name and database name of the Session
Recording Database and the computer account of the Session Recording Server.

On the Database and Server Conguration page:
Instance name: If the database instance is not a named instance as you configured when you set up the instance, you
can use only the computer name of the SQL Server. If you have named the instance, use computer-name\instance-
name as the database instance name. T o determine the server instance name you are using, run select @@servername
on the SQL Server; the return value is the exact database instance name.
Database name: T ype a custom database name in the Database name text box or use the default database name
preset in the text box. Click Test connection to test the connectivity to the SQL Server instance and the validity of the
database name.
Important
A custom database name must contain only A-Z, a-z, and 0-9, and cannot exceed 123 characters.
You must have the securityadmin and dbcreator server role permissions of the database. If you do not have the
permissions, you can:
Ask the database administrator to assign the permissions for the installation. After the installation completes, the
securityadmin and dbcreator server role permissions are no longer necessary and can be safely removed.
Or, use the SessionRecordingAdministrationx64.msi package (unzip the ISO file, and you can find this msi package
under \x64\Session Recording). During the msi installation, a dialog box prompts for the credentials of a database

administrator with the securityadmin and dbcreator server role permissions. Enter the correct credentials and then
click OK to continue the installation.
T he installation creates the new Session Recording Database and adds the machine account of the Session
Recording Server as db_owner.
Session Recording Server computer account

Deployments 1 and 2: T ype localhost in the Session Recording Server computer account field.
Deployment 3: T ype the name of the computer hosting the Session Recording Server in the format of
domain\computer-name. T he Session Recording Server computer account is the user account for accessing the
Session Recording Database.
Click Next.
3. Review the prerequisites and conrm the installation.
T he Summary page shows your installation choices. You can click Back to return to the earlier wizard pages and make
changes. Or, click Install to start the installation.
4. Complete the installation.

T he Finish Installation page shows green check marks for all the prerequisites and components that have been installed
and initialized successfully.
Click Finish to complete the installation of the Session Recording Database.
Step 6.2: Install the Session Recording Server

1. On the Features page, select Session Recording Server and Session Recording Administrator Logging. Click Next.

Note:
T he Session Recording Administrator Logging is an optional subfeature of the Session Recording Server. You must select
the Session Recording Server before you can select the Session Recording Administrator Logging.
Citrix recommends you install the Session Recording Administrator Logging together with the Session Recording Server
at the same time. If you dont want the Administrator Logging feature to be enabled, you can disable it on a later page.
However, if you choose not to install this feature at the beginning but want to add it later, you can only manually add it
by using the SessionRecordingAdministrationx64.msi package.
2. On the Database and Server Conguration page, specify the congurations.

On the Database and Server Conguration page:
Instance name: T ype the name of your SQL Server in the Instance name text box. If you are using a named instance,
type computer-name\instance-name; otherwise, type computer-name only. FQDN of the SQL Server is not supported.
Database name: T ype a custom database name in the Database name text box or use the default database name
CitrixSessionRecording that is preset in the text box.
You must have the securityadmin and dbcreator server role permissions of the database. If you do not have the
permissions, you can:
Ask the database administrator to assign the permissions for the installation. After the installation completes, the
securityadmin and dbcreator server role permissions are no longer necessary and can be safely removed.
Or, use the SessionRecordingAdministrationx64.msi package to install the Session Recording Server. During the msi
installation, a dialog box prompts for the credentials of a database administrator with the securityadmin and
dbcreator server role permissions. Enter the correct credentials and then click OK to continue the installation.
After typing the correct instance name and database name, click Test connection to test the connectivity to the
Session Recording Database.
Enter the Session Recording Server computer account, and then click Next.
3. On the Administration Logging Conguration page, specify congurations for the Administration Logging feature.

On the Administration Logging Conguration page:
The Administration Logging database is installed on the SQL Server instance: T his text box is not editable. T he
SQL Server instance name of the Administration Logging database is automatically grabbed from the instance name
that you typed on the Database and Server Conf iguration page.
Administrator Logging database name: If you choose to install the Session Recording Administrator Logging feature,
type a custom database name for the Administrator Logging database in this text box or use the default database
name CitrixSessionRecordingLogging that is preset in the text box.
After typing the Administrator Logging database name, click Test connection to test the connectivity to the
Administrator Logging database.
Enable Administration Logging: By default, the Administration Logging feature is enabled. You can disable it by clearing
the check box.
Enable mandatory blocking: By default, mandatory blocking is enabled. the normal features might be blocked if logging
fails. You can disable mandatory blocking by clearing the check box.
Click Next to continue the installation.


Click Finish to complete the installation of the Session Recording Server.
Note: T he Session Recording Server default installation uses HT T PS/T LS to secure communications. If T LS is not
congured in the default IIS site of the Session Recording Server, use HT T P. To do so, cancel the selection of SSL in the IIS
Management Console by navigating to the Session Recording Broker site, opening the SSL settings, and clearing the
Require SSL check box.
Step 6.3: Install the Session Recording Policy Console

1. On the Features page, select Session Recording Policy Console and click Next.



T he Finish Installation page shows green check marks for all the prerequisites and component that have been installed
Click Finish to complete your installation of the Session Recording Policy Console.
Step7: Install Broker_PowerShellSnapIn_x64.msi
Important: Broker_PowerShellSnapIn_x64.msi cannot be automatically installed by the installer. You must nd the
Broker_PowerShellSnapIn_x64.msi in the XenApp/XenDesktop ISO (under \layout\image-full\x64\Citrix Desktop Delivery
Controller) and follow the instructions to install it manually.
Congure Director to use the Session Recording

Server
You can use the Director console to create and activate the Session Recording policies.
1. For an HT T PS connection, install the certificate to trust the Session Recording Server in the T rusted Root Certificates
of the Director server.
2. T o configure the Director server to use the Session Recording Server, run
the C:\inetpub\wwwroot\Director\tools\DirectorConf ig.exe /conf igsessionrecording command.

3. Enter the IP address or FQDN of the Session Recording Server and the port number and connection type (HT T P/HT T PS)
that the Session Recording Agent uses to connect to the Session Recording Broker on the Director server.
Install the Session Recording Agent

You must install the Session Recording Agent on the VDA or VDI machine on which you want to record sessions.
Use a local administrator account to log on to the machine where you are installing the Session Recording Agent
component. Insert the DVD in the drive or mount the ISO le. If the installer does not launch automatically, double-click the
AutoSelect application or the mounted drive.


On the Sof tware License Agreement page, read the license agreement, accept it, and then click Next
Step 5: Select the component to install and the installation location

Select Session Recording Agent and click Next.
Step 6: Specif y the Agent conguration

On the Agent Conguration page:
If you have installed the Session Recording Server in advance, enter the name of the computer where you installed the
Session Recording Server and the protocol and port information for the connection to the Session Recording Server. If
you have not installed Session Recording yet, you can modify such information later in Session Recording Agent
Properties.
Note: T here is a limitation with the test connection function of the installer. It does not support the HT T PS requires T LS
1.2 scenario. If you use the installer in this scenario, test connection fails but you can ignore the failure and click Next to
continue the installation. It does not affect normal functioning.
Step 7: Review the prerequisites and conrm the installation

Step 8: Complete the installation

Click Finish to complete the installation of the Session Recording Agent.
Note: When Machine Creation Services (MCS) or Provisioning Services (PVS) creates multiple VDAs with the congured
master image and Microsoft Message Queuing (MSMQ) installed, those VDAs can have the same QMId under certain
conditions. T his might cause various issues, for example:
Sessions might not be recorded even if the recording agreement is accepted.

T he Session Recording Server might not be able to receive session logoff signals and consequently, sessions might
always be in Live status.
As a workaround, create a unique QMId for each VDA and it differs depending on the deployment methods.
No extra actions are required if Desktop OS VDAs with the Session Recording agent installed are created with PVS 7.7 or
later and MCS 7.9 or later in the static desktop mode that is, for example, congured to make all changes persistent with a
separate Personal vDisk or the local disk of your VDA.
For Server OS VDAs created with MCS or PVS and Desktop OS VDAs that are congured to discard all changes when a user

logs off, use the GenRandomQMID.ps1 script to modify the QMId on system startup. Modify the power management
strategy to ensure that enough VDAs are running before user logon attempts.
To use the GenRandomQMID.ps1 script, do the following:
1. Make sure that the execution policy is set to RemoteSigned or Unrestricted in PowerShell.
2. Create a scheduled task, set the trigger as on system startup, and run with the SYST EM account on the PVS or
MCS master image machine.
3. Add the command as a startup task.
powershell .exe -le C:\GenRandomQMID.ps1
Summary of the GenRandomQMID.ps1 script:
1. Remove the current QMId from the registry.

2. Add SysPrep = 1 to HKEY_LOCAL_MACHINE\SOFT WARE\Microsoft\MSMQ\Parameters.
3. Stop related services, including CitrixSmAudAgent and MSMQ.
4. T o generate a random QMId, start the services that stopped previously.
GENRANDOMQMID.PS1 for reference COPY

# Remove old QMId from regist ry and set SysPrep ag for MSMQ
Remove-It empropert y -Pat h HKLM:Soft ware\Microsoft \MSMQ\Paramet ers\MachineCache -Name QMId -Force
Set -It emPropert y -Pat h HKLM:Soft ware\Microsoft \MSMQ\Paramet ers -Name "SysPrep" -Type DWord -Value 1
# Get dependent services
$depServices = Get -Service -name MSMQ -dependent services | Select -Propert y Name
# Rest art MSMQ t o get a new QMId
Rest art -Service -force MSMQ
# St art dependent services
if ($depServices -ne $null) {
foreach ($depService in $depServices) {
$st art Mode = Get -WmiObject win32_service -lt er "NAME = '$($depService.Name)'" | Select -Propert y St art Mode
if ($st art Mode.St art Mode -eq "Aut o") {
St art -Service $depService.Name
Install the Session Recording Player

Install the Session Recording Player on the Session Recording Server or one or more workstations in the domain for users
who view session recordings.

Use a local administrator account to log on to the machine where you are installing the Session Recording Player
component. Insert the DVD in the drive or mount the ISO le. If the installer does not launch automatically, double-click the
AutoSelect application or the mounted drive.


On the Sof tware License Agreement page, read the license agreement, accept it, and then click Next
Step 5: Select the component to install and the installation location

Select Session Recording Player and click Next.
Step 6: Review the prerequisites and conrm the installation

Step 7: Complete the installation

Click Finish to complete the installation of the Session Recording Player.
Automate installations
To install Session Recording Agent on multiple servers, write a script that uses silent installation.
T he following command line installs the Session Recording Agent and creates a log le to capture the installation
information.
For 64 -bit systems:
msiexec /i SessionRecordingAgentx64.msi /q /l*vx yourinstallationlog SESSIONRECORDINGSERVERNAME=yourservername

SESSIONRECORDINGBROKERPROTOCOL=yourbrokerprotocol SESSIONRECORDINGBROKERPORT =yourbrokerport
Note: T he SessionRecordingAgentx64.msi le in the XenApp/XenDesktop ISO is under \layout\image-full\x64\Session

Recording.

For 32-bit systems:
msiexec /i SessionRecordingAgent.msi /q /l*vx yourinstallationlog SESSIONRECORDINGSERVERNAME=yourservername

SESSIONRECORDINGBROKERPROTOCOL=yourbrokerprotocol SESSIONRECORDINGBROKERPORT =yourbrokerport
Note: T he SessionRecordingAgent.msi le in the XenApp/XenDesktop ISO is under \layout\image-full\x86\Session

Recording.
where:
yourservername is the NetBIOS name or FQDN of the computer hosting the Session Recording Server. If not specied,
this value defaults to localhost.
yourbrokerprotocol is HT T P or HT T PS that Session Recording Agent uses to communicate with Session Recording Broker.
If not specied, this value defaults to HT T PS.
yourbrokerport is the port number that Session Recording Agent uses to communicate with Session Recording Broker. If
not specied, this value defaults to zero, which directs Session Recording Agent to use the default port number for your
selected protocol: 80 for HT T P or 443 for HT T PS.
/l*v species verbose logging.
yourinstallationlog is the location of your installation log le.
/q species the quiet mode.
Upgrade Session Recording

You can upgrade certain deployments to later versions without having to rst set up new machines or sites. You can
upgrade from Session Recording 7.6.0 (or later) to the latest release of Session Recording.
Note: For Windows Server 2012 and later, Citrix recommends you upgrade by using the XenApp/XenDesktop installer. For
Windows Server 2008, Citrix recommends you upgrade by using the msi package.
Requirements, preparation, and limitations
Note: You cannot upgrade from a Technology Preview version.
You must use the Session Recording installer's graphical or command-line interface to upgrade the Session Recording
components on the machine where you installed the components.
Before beginning any upgrade activity, back up the database named CitrixSessionRecording in the SQL Server instance,
so that you can restore it if any issues are discovered after the database upgrade.
In addition to being a domain user, you must be a local administrator on the machines where you are upgrading the
Session Recording components.
If the Session Recording Server and Session Recording Database are not installed on the same server, you must have the
database role permission to upgrade the Session Recording Database; otherwise, you can
Ask the database administrator to assign the securityadmin and dbcreator server role permissions for the upgrade.
After the upgrade completes, the securityadmin and dbcreator server role permissions are no longer necessary and
can be safely removed.
Or, use the SessionRecordingAdministrationx64.msi package to upgrade. During the msi upgrade, a dialog box prompts

for the credentials of a database administrator with the securityadmin and dbcreator server role permissions. Enter
the correct credentials and then click OK to continue the upgrade.
If you do not plan to upgrade all the Session Recording Agents at the same time, Session Recording Agent 7.6.0 (or later)
can work with the latest (current) release of Session Recording Server. However, some new features and bug fixes might
not take effect.
Any sessions launched during the upgrade of Session Recording Server are not recorded.
T he Graphics Adjustment option in Session Recording Agent Properties is enabled by default after a fresh installation
or upgrade to keep compatible with the Desktop Composition Redirection mode. You can disable this option manually
after a fresh installation or upgrade.
T he Administrator Logging feature is not installed after you upgrade Session Recording from a previous release that
doesn't contain this feature. T o add this new feature, modify the installation after the upgrade.
If there are live recording sessions when the upgrade process starts, there is very little chance that the recording can be
completed.
Review the upgrade sequence below, so that you can plan and mitigate potential outages.
Upgrade sequence
1. If the Session Recording Database and Session Recording Server are installed on different servers, stop the Session
Recording Storage Manager service manually on the Session Recording Server, and then upgrade the Session Recording
Database first.
2. Ensure that the Session Recording Broker is running with the IIS service. Upgrade the Session Recording Server. If the
Session Recording Database and Session Recording Server are installed on the same server, the Session Recording
Database will also be upgraded.
3. T he Session Recording service is back online automatically when the upgrade of the Session Recording Server is
completed.
4. Upgrade the Session Recording Agent (on the master image).
5. Upgrade the Session Recording Policy Console with or after the Session Recording Server.
6. Upgrade the Sessoin Recording Player.
Uninstall Session Recording

To remove the Session Recording components f rom a server or workstation, use the uninstall or remove
programs option available f rom the Windows Control Panel. To remove the Session Recording Database, you must
have the same securityadmin and dbcreator SQL Server role permissions as when you installed it.
For security reasons, the Administrator Logging Database is not removed after the components are uninstalled.

Congure Session Recording
May 22, 20 17
Congure Session Recording to play and record

sessions
After you install the Session Recording components, perform the following steps to configure Session Recording to record
XenApp or XenDesktop sessions and allow users to view them:
Authorize users to play recordings
Authorize users to administer recording policies
Set an active recording policy to record sessions
Configure custom policies
Configure the Session Recording Player to connect to the Session Recording Server
Authorize users to play recorded sessions
When you install Session Recording, no user has the permission to play recorded sessions. You must assign the permission to
each user, including the administrator. A user without the permission to play recorded sessions receives the following error
message when trying to play a recorded session:
1. Log on as an administrator to the computer hosting the Session Recording Server.

2. Start the Session Recording Authorization Console.
3. In the Session Recording Authorization Console, select Player.
4. Add the users and groups you want to authorize to view recorded sessions and they will populate the right pane.

Authorize users to administer recording policies
When you install Session Recording, domain administrators grant the permission to control the recording policies by default.
You can change the authorization setting.
1. Log on as an administrator to the machine hosting the Session Recording Server.

2. Start the Session Recording Authorization Console and select PolicyAdministrators.
3. Add the users and groups who can administer recording policies.
Set the active recording policy to record sessions
T he active recording policy species session recording behavior on all VDAs or VDI s that have Session Recording Agent
installed and connected to the Session Recording Server. When you install Session Recording, the active recording policy is
Do not record. Sessions cannot be recorded until you change the active recording policy.
Important: A policy can contain many rules, but only one active policy can be running at a time.
1. Log on as an authorized Policy Administrator to the server where the Session Recording Policy Console is installed.
2. Start the Session Recording Policy Console.
3. If the Connect to Session Recording Server dialog box appears, ensure that the name of the computer hosting the
Session Recording Server, the protocol, and the port number are correct.
4. In the Session Recording Policy Console, expand Recording Policies. T his displays the recording policies available when
you install Session Recording, with a check mark indicating which policy is active:
Do not record. T his is the default policy. If you do not specify another policy, no sessions are recorded.
Record everyone with notif ication. If you choose this policy, all sessions are recorded. A window appears to notify
recording occurrence.
Record everyone without notif ication. If you choose this policy, all sessions are recorded. No window appears to
notify recording occurrence.
5. Select the policy you want to make active.
6. From the menu bar, choose Action > Activate Policy.
Session Recording allows you to create your own recording policy. When you create recording policies, they appear in the
Recording Policies folder of the Session Recording Policy Console.
T he generic recording policy might not fit your requirements. You can configure policies and rules based on users, VDA and
VDI servers, Delivery Groups, and applications. For more information about custom policies, see Create custom recording
policies.
Note: T he Administrator Logging feature of Session Recording allows you to log the recording policy changes. For more
information, see Log administration activities.
Congure the Session Recording Player
Before a Session Recording Player can play sessions, you must congure it to connect to the Session Recording Server that

stores the recorded sessions. Each Session Recording Player can be congured with the ability to connect to multiple
Session Recording Servers, but can connect to only one Session Recording Server at a time. If the Player is congured with
the ability to connect to multiple Session Recording Servers, users can change which Session Recording Server the Player
connects to by selecting a check box on the Connections tab at Tools > Options.
1. Log on to the workstation where the Session Recording Player is installed.

2. Start the Session Recording Player.
3. From the Session Recording Player menu bar, choose Tools > Options.
4. On the Connections tab, click Add.
5. In the Hostname field, type the name or IP address of the computer hosting the Session Recording Server and select
the protocol. By default, Session Recording is configured to use HT T PS/SSL to secure communications. If SSL is not
configured, select HT T P.
6. T o configure the Session Recording Player with the ability to connect to multiple Session Recording Servers, repeat
Steps 4 and 5 for each Session Recording Server.
7. Ensure that you select the check box for the Session Recording Server you want to connect to.
Congure the connection to the Session Recording Server
T he connection between the Session Recording Agent and the Session Recording Server is typically congured when the
Session Recording Agent is installed. To congure this connection after the Session Recording Agent is installed, use Session
Recording Agent Properties.
1. Log on to the server where the Session Recording Agent is installed.

2. From the Start menu, choose Session Recording Agent Properties.
3. Click the Connections tab.
4. In the Session Recording Server field, type the server name or its IP address.
5. In the Session Recording Storage Manager message queue section, select the protocol that is used by the Session
Recording Storage Manager to communicate and modify the default port number if necessary.
6. In the Message lif e field, accept the default 7,200 seconds (two hours) or type a new value for the number of seconds
each message is retained in the queue if there is a communication failure. After this period of time elapses, the message
is deleted and the file is playable until the point where the data is lost.
7. In the Session Recording Broker section, select the communication protocol that the Session Recording Broker uses to
communicate and modify the default port number if necessary.
8. When prompted, restart the Session Recording Agent Service to accept the changes.

Grant access rights to users
May 22, 20 17
Important
For security reasons, grant users only the rights they need to perform specic functions, such as viewing recorded sessions.
You grant rights to Session Recording users by assigning them to roles using the Session Recording Authorization Console
on the Session Recording Server. Session Recording users have three roles:
Player. Grants the right to view recorded XenApp sessions. T here is no default membership in this role.
PolicyQuery. Allows the servers hosting the Session Recording Agent to request recording policy evaluations. By default,
authenticated users are members of this role.
PolicyAdministrator. Grants the right to view, create, edit, delete, and enable recording policies. By default,
administrators of the computer hosting the Session Recording Server are members of this role.
Session Recording supports users and groups dened in Active Directory.
Assign users to roles
1. Log on to the computer hosting the Session Recording Server, as an administrator or as a member of the Policy
Administrator role.
2. Start the Session Recording Authorization Console.
3. Select the role to which you want to assign users.
4. From the menu bar, choose Action > Assign Windows Users and Groups.
5. Add the users and groups.
Any changes made to the console take effect during the update that occurs once every minute.

Create and activate recording policies
May 22, 20 17
Use the Session Recording Policy Console to create and activate policies that determine which sessions are recorded.
You can activate system policies available when Session Recording is installed or create and activate your own custom
policies. Session Recording system policies apply a single rule to all users, published applications, and servers. Custom policies
specifying which users, published applications, and servers are recorded.
T he active policy determines which sessions are recorded. Only one policy is active at a time.
System policies
Session Recording provides these system policies:
Do not record. T his is the default policy. If you do not specify another policy, no sessions are recorded.
Record everyone with notif ication. If you choose this policy, all sessions are recorded. A pop-up window appears to
notify recording occurrence.
Record everyone without notif ication. If you choose this policy, all sessions are recorded. No pop-up window appears
to notify recording occurrence.
System policies cannot be modied or deleted.
Activate a policy
1. Log on to the server where the Session Recording Policy Console is installed.
3. If you are prompted by a Connect to Session Recording Server pop-up window, ensure that the name of the Session
Recording Server, protocol, and port are correct. Click OK.
4. In the Session Recording Policy Console, expand Recording Policies.
5. Select the policy you want to make the active policy.
6. From the menu bar, choose Action > Activate Policy.
Create custom recording policies
When you create your own policy, you make rules to specify which users and groups, published applications, and servers
have their sessions recorded. A wizard within the Session Recording Policy Console helps you create rules. To obtain the list
of published applications and servers, you must have the site administrator read permission. Congure that on this site's
Delivery Controller.
For each rule you create, you specify a recording action and rule criteria. T he recording action applies to sessions that meet
the rule criteria.
For each rule, choose one recording action:
Do not record. (Choose Disable session recording in the Rules wizard.) T his recording action specifies that sessions
that meet the rule criteria are not recorded.
Record with notif ication. (Choose Enable session recording with notif ication in the Rules wizard.) T his recording
action specifies that sessions that meet the rule criteria are recorded. A pop-up window appears to notify recording
occurrence.

Record without notif ication. (Choose Enable session recording without notif ication in the Rules wizard.) T his
recording action specifies that sessions that meet the rule criteria are recorded. Users are unaware that they are being
recorded.
For each rule, choose at least one of the following items to create the rule criteria:
Users or Groups. Creates a list of users or groups to which the recording action of the rule applies.
Published Resources. Creates a list of published applications or desktops to which the recording action of the rule
applies. In the Rules wizard, choose the XenApp/XenDesktop site or sites on which the applications or desktops are
available.
Delivery Groups or Machines. Creates a list of Delivery Groups or machines to which the recording action of the rule
applies. In the Rules wizard, choose the location of the Delivery Groups or machines.
IP Address or IP Range. Creates a list of IP addresses or ranges of IP addresses to which the recording action of the
rule applies. On the Select IP Address and IP Range screen, add a valid IP address or IP range for which recording will be
enabled or disabled.
When you create more than one rules in a recording policy, some sessions might match the criteria for more than one rules.
In these cases, the rule with the highest priority is applied to the sessions.
T he recording action of a rule determines its priority:
Rules with the Do not record action have the highest priority
Rules with the Record with notif ication action have the next highest priority
Rules with the Record without notif ication action have the lowest priority
Some sessions might not meet any rule criteria in a recording policy. For these sessions, the recording action of the policies
fallback rule applies. T he recording action of the fallback rule is always Do not record. T he fallback rule cannot be modied
or deleted.
Congure custom policies
1. Log on as an authorized Policy Administrator to the server where the Session Recording Policy Console is installed.
2. Start the Session Recording Policy Console and select Recording Policies in the left pane. From the menu bar,
choose Action > Add New Policy.
3. Right-click the New policy and select Add Rule.
4. Select a recording option - In the Rules wizard, select Disable session recording, Enable Session Recording with
notif ication (or without notif ication), and then click Next.
5. Select the rule criteria - You can choose one or any combination of the options:
Users or Groups
Published resources
Delivery Groups or Machines
IP Address or IP Range
6. Edit the rule criteria - T o edit, click the underlined values. T he values are underlined based on the criteria you chose in the
previous step.
Note that if you choose the Published Resources underlined value, the Site Address is the IP address, a URL, or a
machine name if the Controller is on a local network. T he Name of Application list shows the display name.
7. Follow the wizard to finish the configuration.
Use Active Directory groups

Session Recording allows you to use Active Directory groups when creating policies. Using Active Directory groups instead
of individual users simplies creation and management of rules and policies. For example, if users in your companys nance
department are contained in an Active Directory group named Finance, you can create a rule that applies to all members of
this group by selecting the Finance group in the Rules wizard when creating the rule.
White list users
You can create Session Recording policies that ensure that the sessions of some users in your organization are never
recorded. T his is called white listing these users. White listing is useful for users who handle privacy-related information or
when your organization does not want to record the sessions of a certain class of employees.
For example, if all managers in your company are members of an Active Directory group named Executive, you can ensure
that these users sessions are never recorded by creating a rule that disables session recording for the Executive group.
While the policy containing this rule is active, no sessions of members of the Executive group are recorded. T he sessions of
other members of your organization are sessions recorded based on other rules in the active policy.
Use IP address or IP range rule criteria
You can use client IP addresses as rule criteria for policy matching. For example, if you want to record sessions from clients
with specic IP addresses or within an IP range, use the Rules wizard to create a rule that applies only to those clients.
Create a new policy
Note: When using the Rules wizard, you might be prompted to click on underlined value to edit when no underlined value
appears. Underlined values appear only when applicable. If no underline values appear, ignore the step.
1. Log on to the server where Session Recording Policy Console is installed.

4. In the Session Recording Policy Console, select Recording Policies.
5. From the menu, choose Add New Policy. A policy called New Policy appears in the left pane.
6. Right-click the new policy and choose Rename from the menu.
7. T ype a name for the policy you are about to create and press Enter or click anywhere outside the new name.
8. Right-click the policy, choose Add New Rule from the menu to launch the Rules wizard.
9. Follow the instructions to create the rules for this policy.
Modif y a policy
5. Select the policy you want to modify. T he rules for the policy appear in the right pane.
6. T o add a new rule, modify a rule, or delete a rule:
From the menu bar, choose Action > Add New Rule. If the policy is active, a pop-up window appears requesting
confirmation of the action. Use the Rules wizard to create a new rule.
Select the rule you want to modify, right-click, and choose Properties. Use the Rules wizard to modify the rule.
Select the rule you want to delete, right-click, and choose Delete Rule.

Delete a policy
Note: You cannot delete a system policy or a policy that is active.
5. In the left pane, select the policy you want to delete. If the policy is active, you must activate another policy.
6. From the menu bar, choose Action > Delete Policy.
7. Select Yes to confirm the action.
Note: Limitation regarding prelaunched application sessions:
If the active policy tries to match an application name, the applications launched in the prelaunched session are not
matched, which results in the session not being recorded.
If the active policy records every application, when a user logs on to Citrix Receiver for Windows (at the same time that a
prelaunched session is established), a recording notification appears and the prelaunched (empty) session and any
applications to be launched in that session going forward are recorded.
As a workaround, publish applications in separate Delivery Groups according to their recording policies. Do not use an
application name as a recording condition. T his ensures that prelaunched sessions can be recorded. However, notications
still appear.
Understand rollover behavior
When you activate a policy, the previously active policy remains in effect until the users session ends. However, in some
cases, the new policy takes effect when the le rolls over. Files roll over when they have reached the maximum size. For
more information about the maximum le size for recordings, see Specify le size for recordings.
T he following table details what happens when you apply a new policy while a session is being recorded and a rollover
occurs:
If the previous And the new policy

Af ter a rollover the policy will be:
policy was: is:
Do not record Any other policy No change. T he new policy takes effect only when the user logs on
to a new session.
Record without Do not record Recording stops.

notification
Record with Recording continues and a notification message appears.

notification
Record with Do not record Recording stops.

notification
Record without Recording continues. No message appears the next time a user logs
notification on.

Create notication messages
May 22, 20 17
If the active recording policy species that users are notied when their sessions are recorded, a pop-up window appears
displaying a notication message after the users type their credentials. T he default notication message is "Your activity
with one or more of the programs you recently started is being recorded. If you object to this condition, close the
programs." T he users can click OK to dismiss the window and continue their sessions.
T he default notication message appears in the language of the operating system of the computers hosting the Session
Recording Server.
You can create custom notications in languages you choose; however, you can have only one notication message for
each language. Your users see notication messages in the languages of their preferred local settings.
Create a new notication message
1. Log on to the computer hosting the Session Recording Server.

2. From the Start menu, choose Session Recording Server Properties.
3. In Session Recording Server Properties, click the Notif ications tab.
4. Click Add.
5. Choose the language for the message and type the new message. You can create only one message for each language.
After accepting and activating, the new message appears in the Language-specific notification messages box.
Note: T he Administrator Logging feature of Session Recording allows you to log the Session Recording server policy
changes. For more information, see Log administration activities.

Disable or enable recording
May 22, 20 17
You install the Session Recording Agent on each VDA for Server OS for which you want to record sessions. Within each
agent is a setting that enables recording for the server on which it is installed. After recording is enabled, Session Recording
evaluates the active recording policy that determines which sessions are recorded.
When you install the Session Recording Agent, recording is enabled. Citrix recommends that you disable Session Recording
on servers that are not recorded because they experience a small impact on performance, even if no recording takes place.
Disable or enable recording on a server

3. Under Session Recording, select or clear the Enable session recording f or this Server OS VDA check box to specify
whether or not sessions can be recorded for this server.
4. When prompted, restart the Session Recording Agent Service to accept the change.
Note: When you install Session Recording, the active policy is Do not record (no sessions are recorded on any server). T o
begin recording, use the Session Recording Policy Console to activate a different policy.
Enable custom event recording
Session Recording allows you to use third-party applications to insert custom data, known as events, into recorded
sessions. T hese events appear when the session is viewed using the Session Recording Player. T hey are part of the recorded
session le and cannot be modied after the session is recorded.
For example, an event might contain the following text: "User opened a browser." Each time a user opens a browser during
a session that is being recorded, the text is inserted into the recording at that point. When the session is played using the
Session Recording Player, the viewer can locate and count the times that the user opened a browser by noting the number
of markers that appear in the Events and Bookmarks list in the Session Recording Player.
To insert custom events into recordings on a server:
Use Session Recording Agent Properties to enable a setting on each server where you want to insert custom events.
You must enable each server separately; you cannot globally enable all servers in a site.
Write applications built on the Event API that runs within each user's XenApp session (to inject the data into the
recording).
T he Session Recording installation includes an event recording COM application (API) that allows you to insert text from
third-party applications into a recording. You can use the API from many programming languages including Visual Basic, C++,
or C#. T he Session Recording Event API .dll is installed as part of the Session Recording installation. You can nd it at
C:\Program Files\Citrix\SessionRecording\Agent\Bin\Interop.UserApi.dll.
To enable custom event recording on a server, do the following:

3. In Session Recording Agent Properties, click the Recording tab.
4. Under Custom event recording, select the Allow third party applications to record custom data on this

server check box.

Enable or disable live session playback and playback
protection
May 22, 20 17
Enable or disable live session playback
Using Session Recording Player, you can view a session after or while it is being recorded. Viewing a session that is being
recorded is similar to seeing actions happening live; however, there is actually a delay of one to two seconds when the data
propagates from the XenApp or XenDesktop server.
Some functionality is not available when you view sessions that are not recorded completely:
A digital signature cannot be assigned until recording is complete. If digital signing is enabled, you can view live playback
sessions, but they are not digitally signed and you cannot view certificates until the session is completed.
Playback protection cannot be applied until recording is complete. If playback protection is enabled, you can view live
playback sessions, but they are not encrypted until the session is completed.
You cannot cache a file until recording is complete.
By default, live session playback is enabled.

3. In Session Recording Server Properties, click the Playback tab.
4. Select or clear the Allow live session playback check box.
Enable or disable playback protection
As a security precaution, Session Recording automatically encrypts recorded les before they are downloaded for viewing in
the Session Recording Player. T his playback protection prevents recorded les from being copied and viewed by anyone
other than the user who downloaded the le. T he les cannot be played back on another workstation or by another user.
Encrypted les are identied with an .icle extension; unencrypted les are identied with an .icl extension. T he les remain
encrypted while they reside in the cache on the workstation where the Session Recording Player is installed until they are
opened by an authorized user.
Citrix recommends that you use HT T PS to protect the transfer of data.
By default, playback protection is enabled.

3. In Session Recording Server Properties, click the Playback tab.
4. Select or clear the Encrypt session recording f iles downloaded f or playback check box.

Enable and disable digital signing
May 22, 20 17
If you install certicates on the computers on which the Session Recording components are installed, you can enhance the
security of your Session Recording deployment by assigning digital signatures to Session Recording.
By default, digital signing is disabled. After you select the certicate to sign the recordings, Session Recording grants the
read permission to the Session Recording Storage Manager Service.
Enable digital signing

3. In Session Recording Server Properties, click the Signing tab.
4. Browse to the certificate that enables secure communication among the computers on which the Session Recording
components are installed.
Disable digital signing

3. In Session Recording Server Properties, click the Signing tab.
4. Click Clear.

Specify where recordings are stored
May 22, 20 17
Use Session Recording Server Properties to specify where recordings are stored and where archived recordings are restored.
Note: T o archive files or restore deleted files, use the icldb command.
Specif y the location f or recorded les
By default, recordings are stored in the drive:\SessionRecordings directory of the computer hosting the Session Recording
Server. You can change the directory where the recordings are stored, add additional directories to load-balance across
multiple volumes, or make use of additional space. Multiple directories in the list indicate that recordings are load-balanced
across the directories. You can add a directory multiple times. Load balancing cycles through the directories.

3. In Session Recording Server Properties, click the Storage tab.
4. Use the File storage directories list to manage the directories where recordings are stored.
After you select the directories, Session Recording grants its service with Full Control permission to these directories.
You can create le storage directories on the local drive, the SAN volume, or a location specied by a UNC network path.
Network mapped drive letters are not supported. Do not use Session Recording with Network-Attached Storage (NAS), due
to serious performance and security problems associated with writing recording data to a network drive.
Specif y a restore directory f or archived les
By default, archived recordings are restored to the drive:\SessionRecordingsRestore directory of the computer hosting the
Session Recording Server. You can change the directory where the archived recordings are restored.

3. In Session Recording Server Properties, click the Storage tab.
4. In the Restore directory f or archived f iles field, type the directory for the restored archive files.

Specify le size for recordings
May 22, 20 17
As recordings grow in size, the les can take longer to download and react more slowly when you use the seek slider to
navigate during playback. To control le size, specify a threshold limit for a le. When the recording reaches this limit, Session
Recording closes the le and opens a new one to continue recording. T his action is called a rollover.
Important: T he rollover setting does not apply to VDI desktop sessions for XenDesktop 7.8 and Session Recording Agent.
In those cases, each recording le has a maximum size of 1GB and activities are not recorded after the limit is reached.
You can specify two thresholds for a rollover:
File size. When the file reaches the specified number of megabytes, Session Recording closes the file and opens a new
one. By default, files roll over after reaching 50 megabytes; however, you can specify a limit from 10 megabytes to one
gigabyte.
Duration. After the session records for the specified number of hours, the file is closed and a new file is opened. By
default, files roll over after recording for 12 hours; however, you can specify a limit from one to 24 hours.
Session Recording checks both elds to determine which event occurs rst to determine when to roll over. For example, if
you specify 17MB for the le size and six hours for the duration and the recording reaches 17MB in three hours, Session
Recording reacts to the 17MB le size to close the le and open a new one.
To prevent the creation of many small les, Session Recording does not roll over until at least one hour elapses (this is the
minimum number that you can enter) regardless of the value specied for the le size. T he exception to this rule is if the le
size surpasses one gigabyte.
Specif y the maximum le size f or recordings

3. In Session Recording Server Properties, click the Rollover tab.
4. Enter an integer between 10 and 1,024 to specify the maximum file size in megabytes.
5. Enter an integer between 1 and 24 to specify the maximum recording duration in hours.

Log administration activities
May 22, 20 17
Session Recording Administrator Logging logs the following activities:
Changes to recording policies on Session Recording Policy Console or Citrix Director.
Changes in Session Recording Server Properties.
Downloads of recordings in Session Recording Player.
Recording a session by Session Recording after policy query.
Unauthorized attempts to access the Administrator Logging service.
Warning
Disable or enable Administrator Logging
After installation, you can disable or enable the Session Recording Administrator Logging feature in Session Recording
Server Properties.
1. As an administrator, log on to the server where Session Recording Administrator Logging is installed.
3. Click the Logging tab.
When Session Recording Administrator Logging is disabled, no new activities are logged. You can query the existing logs
from the web-based UI.
When mandatory blocking is enabled, the following activities are blocked if the logging fails. A system event is also logged
with an Event ID 6001:
Changes to recording policies on Session Recording Policy Console or Citrix Director.

Changes in Session Recording Server Properties.
T he recording of sessions is not impacted by the mandatory blocking setting.
Grant access rights to users
For security reasons, grant users only the rights they need to perform specic functions, such as querying logs of
Administrator Logging.
You grant rights to the users by assigning them to roles using Session Recording Authorization Console on the Session
Recording Server. Administrator Logging has two roles:
LoggingWriter. Grants the right to write the Administrator Logging logs. By default, local administrators and Network

Service are members of this role.
Note: Modifying the default LoggingWriter membership might cause log writing failure.
LoggingReader. Grants the right to query the Administrator Logging logs. T here is no default membership in this role.
To assign users to roles
1. As an administrator, log on to the computer hosting the Session Recording Server.

2. Start Session Recording Authorization Console.
3. Select the role to which you want to assign users.
4. From the menu bar, choose Action > Assign Windows Users and Groups.
5. Add users and groups.
Any changes made to the console take effect during the update that occurs once every minute.
Congure an Administrator Logging service account
By default, Administrator Logging is running as a web application in Internet Information Services (IIS), and its identity is
Network Service. To enhance the security level, you can change the identity of this web application to a service account or
a specic domain account.

2. In IIS Manager, click Application Pools.
3. In Application Pools, right-click SessionRecordingLoggingAppPool and choose Advanced Settings.
4. Change the attribute identity to the specific account that you want to use.
5. Grant the db_owner permission to the account for the database CitrixSessionRecordingLogging on Microsoft SQL
Server.
6. Grant the read permission to the account for the registry key
at HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\SmartAuditor\Server.
Disable or enable the recording action logging
By default, Administrator Logging logs every recording action after the policy query completes. T his might generate a large
amount of loggings. To improve the performance and save the storage, disable this kind of logging in Registry.

2. Open the Registry Editor.
3. Browse to HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\SmartAuditor\Server.
4. Set the value of EnableRecordingActionLogging to:
0 disable the recording action logging
1 enable the recording action logging
Query Administrator Logging data
Session Recording provides a web-based UI to query all the Administrator Loggings.
On the computer hosting the Session Recording Server:
1. From the Start menu, choose Session Recording Administrator Logging.

2. Enter the credentials of a LoggingReader user.

On other computers:
1. Open a web browser and visit the web page for Administrator Logging.
For HTTPS: https:// servername/SessionRecordingLoggingWebApplication/, where servername is the name of the

computer hosting the Session Recording Server.
For HTTP: http:// servername/SessionRecordingLoggingWebApplication/, where servername is the name of the

computer hosting the Session Recording Server.
2. Enter the credentials of a LoggingReader user.

Install Session Recording with database high
availability
May 22, 20 17
Session Recording supports the following solutions for database high availability based on Microsoft SQL Server. T he
databases can automatically fail over when the hardware or software of a principal or primary SQL Server fails, which
ensures that Session Recording continues to work as expected.
Always On Availability Groups
T he Always On Availability Groups feature is a high-availability and disaster-recovery solution that provides an
enterprise-level alternative to database mirroring. Introduced in SQL Server 2012, Always On Availability Groups
maximizes the availability of a set of user databases for an enterprise. Always On Availability Groups requires that the
SQL Server instances reside on the Windows Server Failover Clustering (WSFC) nodes. For more information,
see http://msdn.microsoft.com/en-us/library/hh510230.
SQL Server clustering
T he Microsoft SQL clustering technology allows one server to automatically take over the tasks and responsibilities
of the server that has failed. However, setting up this solution is complicated and the automatic failover is typically
slower than alternatives such as SQL Server database mirroring. For more information, see
https://msdn.microsoft.com/en-us/library/ms189134.aspx.
SQL Server database mirroring
Database mirroring ensures that an automatic failover occurs in seconds if the active database server fails. T his
solution is more expensive than the other two solutions because full SQL Server licenses are required on each
database server. You cannot use the SQL Server Express edition in a mirrored environment. For more information,
see https://msdn.microsoft.com/en-us/library/ms189852.aspx.
Methods f or installing Session Recording with database high availability
To install Session Recording with database high availability, do either of the following:
Install the Session Recording Server components first and then configure database high availability for the created
databases.
You can install the Session Recording Administration components with databases configured to be installed on the
prepared SQL Server instance and then configure database high availability for the created databases.
For Always On Availability Groups and clustering, you must manually change the SQL Server instance name to the
name of the availability group listener or SQL Server network in
HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\SmartAuditor\Server.
For database mirroring, you must manually add the failover partners for databases in
HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\SmartAuditor\Server.
Configure database high availability for empty databases first and then install the Session Recording Administration
components.
You can create two empty databases as the Session Recording Database and the Administrator Logging Database in
the expected primary SQL Server instance and configure high availability. T hen enter the SQL Server instance name when

installing the Session Recording Server components:
T o use the Always On Availability Groups solution, enter the name of your availability group listener
T o use the database mirroring solution, enter the name of your principal SQL Server
T o use the clustering solution, enter the network name of your SQL Server

Congure Session Recording with load balancing
May 22, 20 17
In this release, Session Recording provides an experimental feature to support load balancing across the Session Recording
Servers. To use this feature, congure load balancing on Citrix NetScaler so that the Session Recording Servers can achieve
load balancing and automatic failover.
Changes to Session Recording in support of load balancing
All Session Recording Servers share the same folder to store recording files.
Install the entire Session Recording Administration components (including the Session Recording Database, Session
Recording Server, and Session Recording Policy Console) on the same server, and install only the Session Recording Server
component on all other servers. In this way, all Session Recording Servers use the same Session Recording Database and
the same Session Recording Policy Console.
Congure load balancing

To implement this experimental feature, you must perform the following steps on Citrix NetScaler and on the various
Session Recording components:
Congure load balancing (Citrix NetScaler part)

Congure load balancing servers
Add the Session Recording Servers to the load balancing servers in Citrix NetScaler.
Congure load balancing services
1. Add a load balancing service for each needed protocol on each load balancing server.
2. (Recommended) Select the relevant protocol monitor to bind each service monitor.
Congure load balancing virtual servers
1. Create virtual servers with the same NetScaler VIP address based on the needed protocols and bind the virtual servers to
the relevant load balancing services.
2. Configure persistence on each virtual server.
3. (Recommended) Choose LEAST BANDWIT H or LEAST PACKET S as the load balancing method rather than the default
method (LEAST CONNECT ION).
Congure load balancing (Session Recording part)

On each server where you installed the Session Recording Server or the entire Session Recording Administration
components, do the following:
1. If you choose the Administrator Logging feature, Citrix recommends that you enter the same Administrator Logging
database name when you install each Session Recording Server.
2. After sharing the Read/Write permission of the file storage folder with all Session Recording Server machine accounts,
change to use the file storage folder as the shared folder in Session Recording Server Properties. For more
information, see Specify where recordings are restored.

3. Modify the Session Recording Server registry (HKEY_LOCAL_MACHINE\Software\Citrix\SmartAuditor\Server).
On each Session Recording Server, add a key for enabling load balancing:
KeyName: EnableLB;
KeyValue: 1 (D_WORD, meaning enable)
On each computer where only the Session Recoding Server component is installed, change the key value of
DatabaseName to the name of the shared Session Recording Database.
4. If you choose the HT T P or the HT T PS protocol for the Session Recording Storage Manager message queue, create a
Host for the NetScaler VIP address, add redirection in C:\Windows\System32\msmq\Mapping\sample_map on each
Session Recording Server, and restart the Message Queuing service.
T he redirection is similar to:
<redirections xmlns="msmq-queue-redirections.xml">
<redirection>
<from>[Protocol]://[NSFQDN]:[Port]/msmq/private$/CitrixSmAudData</from>
<to>[Protocol]://[FQDN]/msmq/private$/CitrixSmAudData</to>
</redirection>
<redirection>
<from>[Protocol]://[NSFQDN]/msmq/private$/CitrixSmAudData</from>
<to>[Protocol]://[FQDN]/msmq/private$/CitrixSmAudData</to>
</redirection>
</redirections>
Where [Protocol] is the chosen protocol for the Session Recording Storage Manager message queue (HT T P or HT T PS),
[NSFQDN] is the created FQDN of the NetScaler VIP address, [Port] is the chosen port number of the Session Recording
Storage Manager message queue, and [FQDN] is the FQDN of the local host.
On the machine where you installed the Session Recording Agent, do the following in Session Recording Agent Properties:
If you choose the HT T P or the HT T PS protocol for the Session Recording Storage Manager message queue, enter the
FQDN of the NetScaler VIP address in the Session Recording Server text box.
If you choose the default T CP protocol for the Session Recording Storage Manager message queue, enter the
NetScaler VIP address in the Session Recording Server text box.
On the machine where you installed the Session Recording Player, do the following:
Add the NetScaler VIP address or its FQDN as the connected Session Recording Server.
On the SQL Server where you installed the Session Recording Database, do the following:
Add all the Session Recording Server machine accounts to the shared Session Recording Database and assign them with
the db_owner permission.

View recordings
May 22, 20 17
Use Session Recording Player to view, search, and bookmark recorded XenApp or XenDesktop sessions.
If sessions are recorded with the live playback feature enabled, you can view sessions that are in progress, with a delay of a
few seconds, as well as sessions that are completed.
Sessions that have a longer duration or larger le size than the limits congured by your Session Recording administrator
appear in more than one session le.
Note: A Session Recording administrator must grant users the right to access the recorded sessions of VDAs for Server OS.
If you are denied access to viewing sessions, contact your Session Recording administrator.
When Session Recording Player is installed, the Session Recording administrator typically sets up a connection between the
Session Recording Player and a Session Recording Server. If this connection is not set up, the rst time you perform a search
for les, you are prompted to set it up. Contact your Session Recording administrator for setup information.
Launch the Session Recording Player
1. Log on to the workstation where Session Recording Player is installed.

2. From the Start menu, choose Session Recording Player.
T he Session Recording Player appears.
T his illustration shows the Session Recording Player with callouts indicating its major elements. T he functions of these
elements are described throughout the following articles.
Display or hide window elements
T he Session Recording Player has window elements that toggle on and off.

3. From the Session Recording Player menu bar, choose View.
4. Choose the elements that you want to display. Selecting an element causes it to appear immediately. A check mark
indicates that the element is selected.
Change Session Recording Servers
If the Session Recording administrator sets up your Session Recording Player with the ability to connect to multiple Session
Recording Servers, you can select the Session Recording Server that the Session Recording Player connects to. T he Session
Recording Player can connect to only one Session Recording Server at a time.

3. From the Session Recording Player menu bar, choose Tools > Options > Connections .
4. Select the Session Recording Server to which you want to connect.

Open and play recordings
May 22, 20 17
You can open session recordings in Session Recording Player in three ways:
Perform a search using the Session Recording Player. Recorded sessions that meet the search criteria appear in the
search results area.
Access recorded session files directly from your local disk drive or a shared drive.
Access recorded session files from a Favorites folder
When you open a le that was recorded without a digital signature, a warning message appears telling you that the origin
and integrity of the le were not veried. If you are condent of the integrity of the le, click Yes in the warning window to
open the le.
Note: T he Administrator Logging feature of Session Recording allows you to log the downloads of recordings in the
Session Recording Player. For more information, see Log administration activities.
Open and play a recording in the search results area

3. Perform a search.
4. If the search results area is not visible, select Search Results in the Workspace pane.
5. In the search results area, select the session you want to play.
6. Do any of the following:
Double-click the session
Right-click and select Play
From the Session Recording Player menu bar, choose Play > Play
Open and play a recording by accessing the le
Recorded session file names begin with an i_, followed by a unique alphanumeric file ID, followed by the .icl and .icle file
extension: .icl for recordings without playback protection applied, .icle for recordings with playback protection applied.
Session Recording saves recorded session files in a directory structure that incorporates the date the session was recorded.
For example, the file for a session recorded on December 22, 2014, is saved in folder path 2014\12\22.
3. Do any of the following:
From the Session Recording Player menu bar, choose File > Open and browse for the file
Using Windows Explorer, navigate to the file and drag the file into the Player window
Using Windows Explorer, navigate to and double-click the file
If you created Favorites in the Workspace pane, select Favorites and open the file from the Favorites area in the
same way you open files from the search results area
Use f avorites
Creating the Favorites folders allows you to quickly access recordings that you view frequently. T hese Favorites folders
reference recorded session les that are stored on your workstation or on a network drive. You can import and export
these les to other workstations and share these folders with other Session Recording Player users.

Note: Only users with the access rights to Session Recording Player can download the recorded session files associated
with the Favorites folders. Contact your Session Recording administrator for access rights.
To create a Favorites subfolder:

3. In the Session Recording Player window, select the Favorites folder in your Workspace pane.
4. From the menu bar, choose File > Folder > New Folder. A new folder appears under the Favorites folder.
5. T ype the folder name, then press Enter or click anywhere to accept the new name.
Use the other options that appear in the File > Folder menu to delete, rename, move, copy, import, and export the folders.

Search for recorded sessions
May 22, 20 17
Session Recording Player allows you to perform quick searches, perform advanced searches, and specify options that apply
to all searches. Results of searches appear in the search results area of the Session Recording Player.
Note: T o display all available recorded sessions, up to the maximum number of sessions that might appear in a search,
perform a search without specifying any search parameters.
Perf orm a quick search

3. Define your search criteria:
Enter a search criterion in the Search field. T o assist you:
Move the mouse pointer over the Search label to display a list of parameters to use as a guideline
Click the arrow to the right of the Search field to display the text for the last 64 searches you performed
Use the drop-down list to the right of the Search field to select a period or duration specifying when the session was
recorded.
4. Click the binocular icon to the right of the drop-down list to start the search.
Perf orm an advanced search
T ip: Advanced searches might take up to 20 seconds to return results containing more than 150,000 entities. Citrix
recommends using more accurate search conditions such as a date range or user to reduce the result number.
3. In the Session Recording Player window, click Advanced Search on the tool bar or choose Tools > Advanced Search.
4. Define your search criteria on the tabs of the Advanced Search dialog box:
Common allows you to search by domain or account authority, site, group, VDA for Server OS, application, or file ID.
Date/Time allows you to search date, day of week, and time of day.
Events allows you to search on custom events that your Session Recording administrator inserted to the sessions.
Other allows you to search by session name, client name, client address, and recording duration. It also allows you to
specify, for this search, the maximum number of search results displayed and whether or not archived files are included
in the search.
As you specify search criteria, the query you are creating appears in the pane at the bottom of the dialog box.
5. Click Search to start the search.
Tip: You can save and retrieve advanced search queries. Click Save in the Advanced Search dialog box to save the current
query. Click Open in the Advanced Search dialog box to retrieve a saved query. Queries are saved as files with an .isq
extension.
Set search options
Session Recording Player search options allow you to limit the maximum number of session recordings that appear in search
results and to specify whether or not search results include archived session files.

3. From the Session Recording Player menu bar, choose Tools > Options > Search.
4. In the Maximum result to display field, type the number of search results you want to display. A maximum of 500
results can be displayed.
5. T o set whether or not archived files are included in searches, select or clear Include archived f iles.

Play recorded sessions
May 22, 20 17
After you open a recorded session in the Session Recording Player, you can navigate through the recorded sessions using
these methods:
Use the player controls to play, stop, pause, and increase or decrease playback speed
Use the seek slider to move forward or backward
If you have inserted markers into the recording or if the recorded session contains custom events, you can also navigate
through the recorded session by going to those markers and events.
Note:
During playback of a recorded session, a second mouse pointer might appear. T he second pointer appears at the point in
the recording when the user navigated within Internet Explorer and clicked an image that was originally larger than the
screen but was scaled down automatically by Internet Explorer. While only one pointer appears during the session, two
might appear during playback.
T his version of Session Recording does not support SpeedScreen Multimedia Acceleration for XenApp or the Flash
quality adjustment policy setting for XenApp. When this option is enabled, playback displays a black square.
Session Recording cannot record the Lync webcam video when using the HDX RealT ime Optimization Pack.
When you record a session with a resolution higher than or equal to 4096 x 4096, there might be fragments in the
recording appearance.
You cannot record Windows 7 desktop sessions correctly when Legacy Graphics Mode is enabled by the XenDesktop
site policy and Disk-based Caching is enabled by the Citrix Receiver for Windows policy. T hose recordings show a black
screen.
As a workaround, disable Disk-based Caching with GPO on the machines where you installed Citrix Receiver for
Windows. For more information about disabling Disk-based Caching, see CT X123169 and Configure with the Group
Policy Object administrative template.
Session Recording does not support the Framehawk display mode. Sessions in Framehawk display mode cannot be
recorded and played back correctly. Sessions recorded in Framehawk display mode might not contain the sessions'
activities.
Use player controls
You can click the player controls in the lower part of the Player window or access them by choosing Play from the Session
Recording Player menu bar. Use Player controls to:
Play the selected session file.
Pause playback.
Stop playback. If you click Stop, then Play, the recording restarts at the beginning of the file.
Halve the current playback speed down to a minimum of one-quarter normal speed.

Double the current playback speed up to a maximum of 32 times normal speed.
Use the seek slider
Use the seek slider in the lower part of the Player window to jump to a different position within the recorded session. You
can drag the seek slider to the point in the recording you want to view or click anywhere on the slider bar to move to that
location.
You can also use the following keyboard keys to control the seek slider:
Key: Seek action:
Home Seek to the beginning.
End Seek to the end.
Right Arrow Seek forward five seconds.
Lef t Arrow Seek backward five seconds.
Move mouse wheel one notch Seek forward 15 seconds.

down
Move mouse wheel one notch up Seek backward 15 seconds.
Ctrl + Right Arrow Seek forward 30 seconds.
Ctrl + Lef t Arrow Seek backward 30 seconds.
Page Down Seek forward one minute.
Page Up Seek backward one minute.
Ctrl + Move mouse wheel one Seek forward 90 seconds.

notch down
Ctrl + Move mouse wheel one Seek backward 90 seconds.

notch up
Ctrl + Page Down Seek forward six minutes.
Ctrl + Page Up Seek backward six minutes.

Note: T o adjust the speed of the seek slider: From the Session Recording Player menu bar, choose Tools > Options >
Player and drag the slider to increase or decrease the seek response time. A faster response time requires more memory.
T he response might be slow depending on the size of the recordings and your machine's hardware.
Change the playback speed
You can set Session Recording Player to play recorded sessions in exponential increments from one-quarter normal
playback speed to 32 times normal playback speed.
3. From the Session Recording Player menu bar, choose Play > Play Speed.
4. Choose a speed option.
T he speed adjusts immediately. A number indicating the increased or decreased speed appears below the Player window
controls. T ext indicating the exponential rate appears briefly in green in the Player window.
Highlight the idle periods of recorded sessions
Idle periods of a recorded session are the portions in which no action takes place. T he Session Recording Player can
highlight the idle periods of recorded sessions when played back. T he option is On by default.
Note that idle periods are not highlighted when playing back the live sessions with Session Recording Player.

3. From the Session Recording Player menu bar, choose View > Idle Periods and check or uncheck the option box.
Skip over spaces where no action occurred
Fast review mode allows you to set Session Recording Player to skip the portions of recorded sessions in which no action
takes place. T his setting saves time for playback viewing; however, it does not skip animated sequences such as animated
mouse pointers, flashing cursors, or displayed clocks with second hand movements.
3. From the Session Recording Player menu bar, choose Play > Fast Review Mode.
T he option toggles on and off. Each time you choose it, its status appears briefly in green in the Player window.

Use events and bookmarks
May 22, 20 17
You can use events and bookmarks to help you navigate through recorded sessions.
Events are inserted to sessions as they are recorded, using the Event API and a third-party application. Events are saved as
part of the session le. You cannot delete or alter them using the Session Recording Player.
Bookmarks are markers you insert into the recorded sessions using the Session Recording Player. Bookmarks are associated
with the recorded session until you delete them, but they are not saved as part of the session le. By default, each
bookmark is labeled with the text Bookmark, but you can change this to any text annotation up to 128 characters long.
Events and bookmarks appear as dots in the lower part of the Player window. Events appear as yellow dots; bookmarks
appear as blue dots. Moving the mouse over these dots displays the text label associated with them. You can also display
the events and bookmarks in the Events and Bookmarks list of the Session Recording Player. T hey appear in this list with
their text labels and the times in the recorded session at which they appear, in chronological order.
You can use events and bookmarks to help you navigate through recorded sessions. By going to an event or bookmark, you
can skip to the point in the recorded session where the event or bookmark is inserted.
Display events and bookmarks in the list
T he Events and Bookmarks list displays the events and bookmarks inserted in the recorded session that is currently
playing. It can show events only, bookmarks only, or both.
3. Move the mouse pointer to the Events and Bookmarks list area and right-click to display the menu.
4. Choose Show Events Only, Show Bookmarks Only, or Show All.
Insert a bookmark

3. Begin playing the recorded session to which you want to add a bookmark.
4. Move the seek slider to the position where you want to insert the bookmark.
5. Move the mouse pointer into the Player window area and right-click to display the menu.
6. Add a bookmark with the default Bookmark label or create an annotation:
T o add a bookmark with the default Bookmark label, choose Add Bookmark.
T o add a bookmark with a descriptive text label that you create, choose Add Annotation. T ype the text label you
want to assign to the bookmark, up to 128 characters. Click OK.
Add or change an annotation
After a bookmark is created, you can add an annotation to it or change its annotation.
3. Begin playing the recorded session containing the bookmark.
4. Ensure that the events and bookmarks list is displaying bookmarks.
5. Select the bookmark in the Events and Bookmarks list and right-click to display the menu.

6. Choose Edit Annotation.
7. In the window that appears, type the new annotation and click OK.
Delete a bookmark

3. Begin playing the recorded session containing the bookmark.
4. Ensure that the events and bookmarks list is displaying bookmarks.
5. Select the bookmark in the events and bookmarks list and right-click to display the menu.
6. Choose Delete.
Go to an event or bookmark
Going to an event or bookmark causes the Session Recording Player to go to the point in the recorded session where the
event or bookmark is inserted.
3. Begin playing a session recording containing events or bookmarks.
4. Go to an event or bookmark:
In the lower part of the Player window, click the dot representing the event or bookmark to go to the event or
bookmark.
In the Events and Bookmarks list, double-click the event or bookmark to go to it. T o go to the next event or
bookmark, select any event or bookmark from the list, right-click to display the menu, and choose Seek to Bookmark.

Change the playback display
May 22, 20 17
Options allow you to change how recorded sessions appear in the Player window. You can pan and scale the image, show
the playback in full screen, display the Player window in a separate window, and display a red border around the recorded
session to differentiate it from the Player window background.
Display the Player window in f ull screen

3. From the Session Recording Player menu bar, choose View > Player Full Screen.
4. T o return to the original size, press ESC or F11.
Display the Player window in a separate window

3. From the Session Recording Player menu bar, choose View > Player in Separate Window. A new window appears
containing the Player window. You can drag and resize the window.
4. T o embed the Player window in the main window, choose View > Player in Separate Window, or press F10.
Scale the session playback to t the Player window

3. From the Session Recording Player menu bar, choose Play > Panning and Scaling > Scale to Fit.
Scale to Fit (Fast Rendering) shrinks images while providing good quality. Images are drawn quicker than using the
High Quality option but the images and texts are not sharp. Use this option if you are experiencing performance
issues when using the High Quality mode.
Scale to Fit (High Quality) shrinks images while providing high quality. Using this option can cause the images to be
drawn more slowly than the Fast Rendering option.
Pan the image

3. From the Session Recording Player menu bar, choose Play > Panning and Scaling > Panning. T he pointer changes to
a hand and a small representation of the screen appears in the top right of the Player window.
4. Drag the image. T he small representation indicates where you are in the image.
5. T o stop panning, choose one of the scaling options.
Display a red border around Session Recording

3. From the Session Recording Player menu bar, choose Tools > Options > Player.
4. Select the Show border around session recording check box.
Tip: If the Show border around session recording check box is not selected, you can temporarily view the red border

by clicking and holding down the left mouse button while the pointer is in the Player window.

Cache recorded session les
May 22, 20 17
Each time you open a recorded session le, the Session Recording Player downloads the le from the location where the
recordings are stored. If you download the same les frequently, you can save download time by caching the les on your
workstation. Cached les are stored on your workstation in this folder:
userprole\AppData\Local\Citrix\SessionRecording\Player\Cache
You can specify how much disk space is used for the cache. When the recordings ll the specied disk space, Session
Recording deletes the oldest, least used recordings to make room for new recordings. You can empty the cache at any time
to free up disk space.
Enable caching

3. From the Session Recording Player menu bar, choose Tools > Options > Cache.
4. Select the Cache downloaded f iles on local machine check box.
5. If you want to limit the amount of disk space used for caching, select the Limit amount of disk space to use check
box and specify the number of megabytes to be used for cache.
6. Click OK.
Empty caches

3. From the Session Recording Player menu bar, choose Tools > Options > Cache.
4. Select the Cache downloaded f iles on local machine check box.
5. In the Session Recording Player, choose Tools > Options > Cache.
6. Click Purge Cache and OK to confirm the action.

Troubleshoot Session Recording
May 22, 20 17
T he troubleshooting information contains solutions to some issues you might encounter during and after installing the
Session Recording components:
Components failing to connect to each other

Sessions failing to record
Problems with the Session Recording Player or Session Recording Policy Console
Issues involving your communication protocol
Warning
Session Recording Agent cannot connect
When the Session Recording Agent cannot connect, the Exception caught while sending poll messages to Session
Recording Broker event message is logged, followed by the exception text. T he exception text provides reasons why the
connection failed. T he reasons include:
The underlying connection was closed. Could not establish a trust relationship f or the SSL/TLS secure channel.
T his exception means that the Session Recording Server is using a certicate that is signed by a CA that the server on
which the Session Recording Agent resides does not trust, or have a CA certicate for. Alternatively, the certicate might
have expired or been revoked.
Resolution: Verify that the correct CA certicate is installed on the server hosting the Session Recording Agent or use a
CA that is trusted.
The remote server returned an error: (4 03) f orbidden. T his is a standard HT T PS error displayed when you attempt
to connect using HT T P (nonsecure protocol). T he computer hosting the Session Recording Server rejects the connection
because it accepts only secure connections.
Resolution: Use Session Recording Agent Properties to change the Session Recording Broker protocol to HTTPS.
The Session Recording Broker returned an unknown error while evaluating a record policy query. Error code 5
(Access Denied). For more inf ormation, see the Event log on the Session Recording Server. T his error occurs when
sessions are started and a request for a record policy evaluation is made. T he error is a result of the Authenticated Users
group (this is the default member) being removed from the Policy Query role of the Session Recording Authorization
Console.
Resolution: Add the Authenticated Users group back into this role, or add each server hosting each Session Recording Agent
to the PolicyQuery role.
The underlying connection was closed. A connection that was expected to be kept alive was closed by the

server. T his error means that the Session Recording Server is down or unavailable to accept requests. T his could be due to
IIS being ofine or restarted, or the entire server might be ofine.
Resolution: Verify that the Session Recording Server is started, IIS is running on the server, and the server is connected to
the network.
Installation of Session Recording Server components f ails
T he installation of the Session Recording Server components fails with error codes 2503 and 2502.
Resolution:
Check the access control list (ACL) of folder C:\windows\Temp to ensure that the Local Users and Groups have write
permission for this folder. If not, manually add write permission.
Session Recording Server cannot connect to the Session Recording Database
When the Session Recording Server cannot connect to the Session Recording Database, you might see a message similar
to one of the following:
Event Source:
A network-related or instance-specic error occurred while establishing a connection to SQL Server. T his error
appears in the applications event log with ID 2047 in the Event Viewer of the computer hosting the Session Recording
Server.
Citrix Session Recording Storage Manager Description: Exception caught while establishing database connection.
T his error appears in the applications event log in the Event Viewer of the computer hosting the Session Recording Server.
Unable to connect to the Session Recording Server. Ensure that the Session Recording Server is running. T his error
message appears when you launch the Session Recording Policy Console.
Resolution:
T he Express Edition of Microsoft SQL Server 2008 R2, Microsoft SQL Server 2012, Microsoft SQL Server 2014, or
Microsoft SQL Server 2016 is installed on a stand-alone server and does not have the correct services or settings
configured for Session Recording. T he server must have T CP/IP protocol enabled and SQL Server Browser service running.
See the Microsoft documentation for information about enabling these settings.
During the Session Recording installation (administration portion), incorrect server and database information was given.
Uninstall the Session Recording Database and reinstall it, supplying the correct information.
T he Session Recording Database Server is down. Verify that the server has connectivity.
T he computer hosting the Session Recording Server or the computer hosting the Session Recording Database Server
cannot resolve the FQDN or NetBIOS name of the other. Use the ping command to verify the names can be resolved.
Check the firewall configuration on the Session Recording Database to ensure that the SQL Server connections are
allowed. For more information, see the Microsoft article at https://msdn.microsoft.com/en-us/library/cc646023.aspx.
Logon f ailed f or user 'NT_AUTHORITY\ANONYMOUS LOGON'. T his error message means that the services are logged
on incorrectly as .\administrator.
Resolution: Restart the services as local system user and restart the SQL services.
Sessions are not recording
If your application sessions are not recording successfully, start by checking the application event log in the Event Viewer
on the VDA for Server OS that runs the Session Recording Agent and Session Recording Server. T his might provide valuable

diagnostic information.
If sessions are not recording, these issues might be the cause:
Component connectivity and certif icates. If the Session Recording components cannot communicate with each
other, this can cause session recordings to fail. T o troubleshoot recording issues, verify that all components are
configured correctly to point to the correct computers and that all certificates are valid and correctly installed.
Non-Active Directory domain environments. Session Recording is designed to run in a Microsoft Active Directory
domain environment. If you are not running in an Active Directory environment, you might experience recording issues.
Ensure that all Session Recording components are running on computers that are members of an Active Directory
domain.
Session sharing conf licts with the active policy. Session Recording matches the active policy with the first published
application that a user opens. Subsequent applications opened during the same session continue to follow the policy
that is in force for the first application. T o prevent session sharing from conflicting with the active policy, publish the
conflicting applications on separate VDAs for Server OS.
Recording is not enabled. By default, installing the Session Recording Agent on a VDA for Server OS enables the server
for recording. Recording will not occur until an active recording policy is configured to allow this.
The active recording policy does not permit recording. For a session to be recorded, the active recording policy must
permit the sessions for the user, server, or published application to be recorded.
Session Recording services are not running. For sessions to be recorded, the Session Recording Agent service must be
running on a VDA for Server OS and the Session Recording Storage Manager service must be running on the computer
hosting the Session Recording Server.
MSMQ is not conf igured. If MSMQ is not correctly configured on the server running the Session Recording Agent and
the computer hosting the Session Recording Server, recording problems might occur.
Unable to view live session playback
If you experience difculties when viewing recordings using the Session Recording Player, the following error message
might appear:
Download of recorded session le f ailed. Live session playback is not permitted. The server has been congured
to disallow this f eature. T his error indicates that the server is congured to disallow the action.
Resolution: In Session Recording Server Properties, choose the Playback tab and select the Allow live session
playback check box.
Recordings are corrupt or incomplete
If recordings are corrupted or incomplete when you view them using the Session Recording Player, you might also see
warnings in the Event logs on the Session Recording Agent.
Event Source: Citrix Session Recording Storage Manager
Description: Data lost while recording le <icl le name>
T his usually happens when Machine Creation Services (MCS) or Provisioning Services (PVS) is used to create VDAs with
a master image congured and Microsoft Message Queuing (MSMQ) installed. In this condition, the VDAs have the
same QMId for MSMQ.
As a workaround, create a unique QMId for each VDA. For more information, see here.

Session Recording Player might report an internal error with this message - "The f ile being played has reported that
an internal system error (error code: 9) occurred during its original recording. The f ile can still be played up to
the point that the recording error occurred" when playing back a certain recording file.
T his is usually caused by insufficient Session Recording Agent buffer size when recording graphic intensive sessions.
As a workaround, change the registry value of

HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\SmartAuditor\SmAudBufferSizeMB to a higher one in the Session
Recording Agent, and then restart the machine.
Test connection of the database instance f ailed when installing the Session Recording Database or Session
Recording Server
When you install the Session Recording Database or Session Recording Server, the test connection fails with the error
message Database connection test f ailed. Please correct Database instance name even if the database instance
name is correct.
In this case, make sure that the current user has the public SQL Server role permission to correct the permission limitation
failure.
Administrator Logging
In Windows Server 2008 R2 SP1, before you install the Administrator Logging feature, install .Net Framework 3.5 Features
> WCF Activation > HTTP Activation, and then install .Net Framework 4.5 or a later version. Ensure that you don't install
these two requirements in reverse order. If you fail to comply, Administrator Logging might not work as expected. You might
experience operation blocking when trying to change Session Recording congurations with the Server Properties Console
or update Session Recording policies with Policy Console with mandatory logging enabled.
To resolve this issue:
1. Open the Internet Information Services (IIS) Manager and navigate to the Application Pools node.
2. Right-click SessionRecordingLoggingAppPool and open the Basic Settings dialog box.
3. Change the .NET Framework version to .NET Framework v4.0.

Verify component connections
May 22, 20 17
During the setup of Session Recording, the components might not connect to other components. All the components
communicate with the Session Recording Server (Broker). By default, the Broker (an IIS component) is secured using the IIS
default Web site certicate. If one component cannot connect to the Session Recording Server, the other components
might also fail when attempting to connect.
T he Session Recording Agent and Session Recording Server (Storage Manager and Broker) log connection errors in the
applications event log in the Event Viewer of the computer hosting the Session Recording Server, while the Session
Recording Policy Console and Session Recording Player display connection error messages on screen when they fail to
connect.
Verif y Session Recording Agent is connected

3. In Session Recording Agent Properties, click Connection.
4. Verify that the value for Session Recording Server is the correct server name of the computer hosting the Session
Recording Server.
5. Verify that the server given as the value for Session Recording Server can be contacted by your VDA for Server OS.
Note: Check the application event log for errors and warnings.
Verif y that Session Recording Server is connected
Caution: Using Registry Editor can cause serious problems that might require you to reinstall the operating
system. Citrix cannot guarantee that problems resulting f rom incorrect use of Registry Editor can be solved. Use
Registry Editor at your own risk.

2. Open the Registry Editor.
3. Browse to HKEY_LOCAL_MACHINE\SOFT WARE\Citrix\SmartAuditor\Server.
4. Verify that the value of SmAudDatabaseInstance correctly references the Session Recording Database you installed
on your SQL Server instance.
Verif y that Session Recording Database is connected
1. Using a SQL Management tool, open your SQL instance that contains the Session Recording Database you installed.
2. Open the Security permissions of the Session Recording Database.
3. Verify the Session Recording Computer Account has access to the database. For example, if the computer hosting the
Session Recording Server is named SsRecSrv in the MIS domain, the computer account in your database should be
configured as MIS\SsRecSrv$. T his value is configured during the Session Recording Database installation.
Test IIS connectivity
Testing connections to the Session Recording Server IIS site by using a Web browser to access the Session Recording
Broker Web page can help you determine whether problems with communication between Session Recording components
stem from miscongured protocol conguration, certication issues, or problems starting Session Recording Broker.

To verify IIS connectivity for the Session Recording Agent:

2. Launch a Web browser and type the following address:
For HT T PS: https://servername/SessionRecordingBroker/RecordPolicy.rem?wsdl, where servername is the name
of the computer hosting the Session Recording Server
For HT T P: http://servername/SessionRecordingBroker/RecordPolicy.rem?wsdl, where servername is the name of
the computer hosting the Session Recording Server
3. If you are prompted for NT LAN Manager (NT LM) authentication, log on with a domain administrator account.
To verify IIS connectivity for the Session Recording Player:

For HT T PS: https://servername/SessionRecordingBroker/Player.rem?wsdl, where servername is the name of the
computer hosting the Session Recording Server
For HTTP: http://servername/SessionRecordingBroker/Player.rem?wsdl, where servername is the name of the
computer hosting the Session Recording Server
To verify IIS connectivity for the Session Recording Policy Console:
For HT T PS: https://servername/SessionRecordingBroker/PolicyAdministration.rem?wsdl, where servername is
the name of the computer hosting the Session Recording Server
For HT T P: http://servername/SessionRecordingBroker/PolicyAdministration.rem?wsdl, where servername is the
name of the computer hosting the Session Recording Server
If you see an XML document within your browser, this verifies that the computer running the Session Recording Policy
Console is connected to the computer hosting the Session Recording Server using the configured protocol.
Troubleshoot certicate issues
If you are using HT T PS as your communication protocol, the computer hosting the Session Recording Server must be
congured with a server certicate. All component connections to the Session Recording Server must have root certicate
authority (CA). Otherwise, attempted connections between the components fail.
You can test your certicates by accessing the Session Recording Broker Web page as you would when testing IIS
connectivity. If you are able to access the XML page for each component, the certicates are congured correctly.
Here are some common ways certicate issues cause connections to fail:
Invalid or missing certif icates. If the server running the Session Recording Agent does not have a root certificate to
trust the server certificate, cannot trust and connect to the Session Recording Server over HT T PS, causing connectivity
to fail. Verify that all components trust the server certificate on the Session Recording Server.
Inconsistent naming. If the server certificate assigned to the computer hosting the Session Recording Server is created
using a fully qualified domain name (FQDN), then all connecting components must use the FQDN when connecting to
the Session Recording Server. If a NetBIOS name is used, configure the components with a NetBIOS name for the

Session Recording Server.
Expired certif icates. If a server certificate expired, connectivity to the Session Recording Server through HT T PS fails.
Verify the server certificate assigned to the computer hosting the Session Recording Server is valid and has not expired.
If the same certificate is used for the digital signing of session recordings, the event log of the computer hosting the
Session Recording Server provides error messages that the certificate expired or warning messages when it is about to
expire.

Search for recordings if the Session Recording Player
fails
May 22, 20 17
If you experience difculties when searching for recordings using the Session Recording Player, the following error
messages might appear:
Search f or recorded session f iles f ailed. The remote server name could not be resolved: servername. where
servername is the name of the server to which the Session Recording Player is attempting to connect. T he Session
Recording Player cannot contact the Session Recording Server. T wo possible reasons for this are an incorrectly typed
server name or the DNS cannot resolve the server name.
Resolution: From the Player menu bar, choose Tools > Options > Connections and verify that the server name in the
Session Recording Servers list is correct. If it is correct, from a command prompt, run the ping command to see if the
name can be resolved. When the Session Recording Server is down or ofine, the search for recorded session les failed
error message is Unable to contact the remote server.
Unable to contact the remote server. T his error occurs when the Session Recording Server is down or offline.
Resolution: Verify that the Session Recording Server is connected.
Access denied. An access denied error can occur if the user was not given permission to search for and download
recorded session files.
Resolution: Assign the user to the Player role using the Session Recording Authorization Console.
Access denied when the Player role is assigned. T his error usually occurs when you install the Session Recording
Player on the same machine with the Session Recording Server, and you've enabled UAC. When you assign the Domain
Admins or Administrators user group as the Player role, a non-built-in administrator user who is included in that group
might fail to pass the role-based check when searching recording files with the Session Recording Player.
Resolutions:
+ Run Session Recording Player as administrator.
+ Assign specic users as Player role rather than the entire group.
+ Install Session Recording Player in a separate machine rather than Session Recording Server.
Search f or recorded session f iles f ailed. The underlying connection was closed. Could not establish a trust
relationship f or the SSL/TLS secure channel. T his exception is caused by the Session Recording Server using a
certificate that is signed by a CA that the client device does not trust or have a CA certificate for.
Resolution: Install the correct or trusted CA certicate workstation where the Session Recording Player is installed.
The remote server returned an error: (4 03) f orbidden. T his error is a standard HT T PS error that occurs when you
attempt to connect using HT T P (nonsecure protocol). T he server rejects the connection because, by default, it is
configured to accept only secure connections.
Resolution: From the Session Recording Player menu bar, choose Tools > Options > Connections. Select the server
from the Session Recordings Servers list, and then click Modif y. Change the protocol from HTTP to HTTPS.
Troubleshoot MSMQ

If your users see the notication message but the viewer cannot nd the recordings after performing a search in the
Session Recording Player, there could be a problem with MSMQ. Verify that the queue is connected to the Session
Recording Server (Storage Manager) and use a Web browser to test for connection errors (if you are using HT T P or HT T PS
as your MSMQ communication protocol).
To verify that the queue is connected:
1. Log on to the server hosting the Session Recording Agent and view the outgoing queues.
2. Verify that the queue to the computer hosting the Session Recording Server has a connected state.
If the state is waiting to connect, there are a number of messages in the queue, and the protocol is HT T P or HT T PS
(corresponding to the protocol selected on the Connections tab in Session Recording Agent Properties), perform
Step 3.
If the state is connected and there are no messages in the queue, there might be a problem with the server hosting
the Session Recording Server. Skip Step 3 and perform Step 4.
3. If there are a number of messages in the queue, launch a Web browser and type the following address:
For HT T PS: https://servername/msmq/private$/CitrixSmAudData, where servername is the name of the computer
hosting the Session Recording Server
For HT T P: http://servername/msmq/private$/CitrixSmAudData, where servername is the name of the computer
hosting the Session Recording Server
If the page returns an error such as The server only accepts secure connections, change the MSMQ protocol listed in
Session Recording Agent Properties to HT T PS. Otherwise, if the page reports a problem with the Web site security
certicate, there might be a problem with a trust relationship for the T LS secure channel. In that case, install the correct
CA certicate or use a CA that is trusted.
4. If there are no messages in the queue, log on to the computer hosting the Session Recording Server and view private
queues. Select citrixsmauddata. If there are a number of messages in the queue (Number of Messages Column), verify
that the Session Recording StorageManager service is started. If it is not, restart the service.

Change your communication protocol
May 22, 20 17
For security reasons, Citrix does not recommend using HT T P as a communication protocol. T he Session Recording
installation is congured to use HT T PS. To use HT T P instead of HT T PS, you must change several settings.
Use HTTP as the communication protocol
1. Log on to the computer hosting the Session Recording Server and disable secure connections for Session Recording
Broker in IIS.
2. Change the protocol setting from HT T PS to HT T P in Session Recording Agent Properties on each server where
the Session Recording Agent is installed:
1. Log on to each server where the Session Recording Agent is installed.
3. In Session Recording Agent Properties, choose the Connections tab.
4. In the Session Recording Broker area, select HTTP from the Protocol drop-down list and click OK to accept the
change. If you are prompted to restart the service, click Yes.
3. Change the protocol setting from HT T PS to HT T P in the Session Recording Player settings:
1. Log on to each workstation where the Session Recording Player is installed.
3. From the Session Recording Player menu bar, choose Tools > Options > Connections, select the server, and
choose Modif y.
4. Select HTTP from the Protocol drop-down list and click OK twice to accept the change and exit the dialog box.
4. Change the protocol setting from HT T PS to HT T P in the Session Recording Policy Console:
2. From the Start menu, choose Session Recording Policy Console.
3. Select HTTP from the Protocol drop-down list and click OK to connect. If the connection is successful, this setting is
remembered the next time you start the Session Recording Policy Console.
Revert to HTTPS as the communication protocol
1. Log on to the computer hosting the Session Recording Server and enable secure connections for the Session Recording
Broker in IIS.
2. Change the protocol setting from HT T P to HT T PS in Session Recording Agent Properties on each server where
the Session Recording Agent is installed:
1. Log on to each server where the Session Recording Agent is installed.
3. In Session Recording Agent Properties, choose the Connections tab.
4. In the Session Recording Broker area, select HTTPS from the Protocol drop-down list and click OK to accept the
change. If you are prompted to restart the service, click Yes.
3. Change the protocol setting from HT T P to HT T PS in the Session Recording Player settings:
1. Log on to each workstation where the Session Recording Player is installed.
3. From the Session Recording Player menu bar, choose Tools > Options > Connections, select the server, and
choose Modif y.
4. Select HTTPS from the Protocol drop-down list and click OK twice to accept the change and exit the dialog box.
4. Change the protocol setting from HT T P to HT T PS in the Session Recording Policy Console:

2. From the Start menu, choose Session Recording Policy Console.
3. Select HTTPS from the Protocol drop-down list and click OK to connect. If the connection is successful, this setting
is remembered the next time you start the Session Recording Policy Console.

Reference: Manage your database records
May 22, 20 17
T he ICA Log database (ICLDB) utility is a database command-line utility used to manipulate the session recording database
records. T his utility is installed during the Session Recording installation in the
drive:\Program Files\Citrix\SessionRecording\Server\Bin directory at the server hosting the Session Recording Server
software.
Quick ref erence chart
T he following table lists the commands and options that are available for the ICLDB utility. Type the commands using the
following format:
icldb [version | locate | dormant | import | archive | remove | removeall] command-options [/l] [/f ] [/s] [/?]
Note: More extensive instructions are available in the help associated with the utility. T o access the help, from a command
prompt, type drive:\Program Files\Citrix\SessionRecording\Server\Bin directory, type icldb /?. T o access help for specific
commands, type icldb command /?.
Command Description
archive Archives the session recording files older than the retention period specified.
Use this command to archive les.
dormant Displays or counts the session recording files that are considered dormant. Dormant files are
session recordings that were not completed due to data loss.
Use this command to verify if you suspect that you are losing data. You can verify if the
session recording les are becoming dormant for the entire database, or only recordings
made within the specied number of days, hours, or minutes.
import Imports session recording files into the Session Recording database.
Use this command to rebuild the database if you lose database records.
Additionally, use this command to merge databases (if you have two databases, you can
import the les from one of the databases).
locate Locates and displays the full path to a session recording file using the file ID as the criteria.
Use this command when you are looking for the storage location of a session recording le.
It is also one way to verify if the database is up-to-date with a specic le.
remove Removes the references to session recording files from the database.
Use this command (with caution) to clean up the database. Specify the retention period to
be used as the criteria.
You can also remove the associated physical le.

removeall Removes all of the references to session recording files from the Session Recording
Command Description
Database and returns the database to its original state. T he actual physical files are not
deleted; however you cannot search for these files in the Session Recording Player.
Use this command (with caution) to clean up the database. Deleted references can be
reversed only by restoring from your backup.
version Displays the Session Recording Database schema version.
/l Logs the results and errors to the Windows event log.
/f Forces the command to run without prompts.
/s Suppresses the copyright message.
/? Displays help for the commands.

Conguration Logging
May 22, 20 17
Configuration Logging captures Site configuration changes and administrative activities to the Database. You can use the
logged content to:
Diagnose and troubleshoot problems after configuration changes are made; the log provides a breadcrumb trail
Assist change management and track configurations
Report administration activity
You set Conguration Logging preferences, display conguration logs, and generate HT ML and CSV reports from Citrix
Studio. You can lter conguration log displays by date ranges and by full text search results. Mandatory logging, when
enabled, prevents conguration changes from being made unless they can be logged. With appropriate permission, you can
delete entries from the conguration log. You cannot use the Conguration Logging feature to edit log content.
Conguration Logging uses a PowerShell SDK and the Conguration Logging Service. T he Conguration Logging Service
runs on every Controller in the Site; if one Controller fails, the service on another Controller automatically handles logging
requests.
By default, the Conguration Logging feature is enabled, and uses the database that is created when you create the Site
(the Site Conguration database). You can specify a differnt location for the database. T he Conguration Logging
Database supports the same high availability features as the Site Conguration Database.
Access to Conguration Logging is controlled through Delegated Administration, with the Edit Logging Preferences and
View Conguration Logs permissions.
Conguration logs are localized when they are created. For example, a log created in English will be read in English,
regardless of the locale of the reader.
What is logged
Conguration changes and administrative activities initiated from Studio, Director, and PowerShell scripts are logged.
Examples of logged conguration changes include working with (creating, editing, deleting assigning):
Machine catalogs
Delivery Groups (including changing power management settings)
Administrator roles and scopes
Host resources and connections
Citrix policies through Studio
Examples of logged administrative changes include:
Power management of a virtual machine or a user desktop

Studio or Director sending a message to a user
T he following operations are not logged:
Autonomic operations such as pool management power-on of virtual machines.

Policy actions implemented through the Group Policy Management Console (GPMC); use Microsoft tools to view logs of

those actions.
Changes made through the registry, direct access of the database, or from sources other than Studio, Director, or
PowerShell.
When the deployment is initialized, Configuration Logging becomes available when the first Configuration Logging
Service instance registers with the Configuration Service. T herefore, the very early stages of configuration are not
logged (for example, when the database schema is obtained and applied, when a hypervisor is initialized).
Manage Conguration Logging

By default, Conguration Logging uses the database that is created when you create a Site (also known as the Site
Conguration database). Citrix recommends that you use a separate location for the Conguration Logging database (and
the Monitoring database) for the following reasons:
T he backup strategy for the Configuration Logging database is likely to differ from the backup strategy for the Site
Configuration database.
T he volume of data collected for Configuration Logging (and the Monitoring Service) might adversely affect the space
available to the Site Configuration database.
It splits the single point of failure for the three databases.
Note: Product editions that do not support Conguration Logging do not have a Logging node in Studio.
Enable and disable Conguration Logging and

mandatory logging
By default, Conguration Logging is enabled, and mandatory logging is disabled.
1. Select Logging in the Studio navigation pane.

2. Select Pref erences in the Actions pane. T he Configuration Logging dialog box contains database information and
indicates whether Configuration Logging and mandatory logging are enabled or disabled.
3. Select the desired action:
To enable Conguration Logging, select the Enable radio button. T his is the default setting. If the database cannot
be written to, the logging information is discarded, but the operation continues.
To disable Conguration Logging, select the Disable radio button. If logging was previously enabled, existing logs
remain readable with the PowerShell SDK.
To enable mandatory logging, select the Prevent changes to the site conguration when the database is not
available radio button. No conguration change or administrative activity that would normally be logged will be
allowed unless it can be written in the Conguration Logging database. You can enable mandatory logging only when
Conguration Logging is enabled, that is, when the Enable radio button is selected. If the Conguration Logging
Service fails, and high availability is not in use, mandatory logging is assumed. In such cases, operations that would
normally be logged are not performed.
To disable mandatory logging, select the Allow changes when to the site conguration when the database is
not available radio button. Conguration changes and administrative activities are allowed, even if the database used

for Conguration Logging cannot be accessed. T his is the default setting.
Change the Conguration Logging database location

Note: You cannot change the database location when mandatory logging is enabled, because the location change includes
a brief disconnect interval that cannot be logged.
1. Create a database server, using a supported SQL Server version.

3. Select Pref erences in the Actions pane.
4. In the Logging Preferences dialog box, select Change logging database.
5. In the Change Logging Database dialog box, specify the location of the server containing the new database server. Valid
formats are listed in the Databases article.
6. T o allow Studio to create the database, click OK. When prompted, click OK, and the database will be created
automatically. Studio attempts to access the database using the current Studio user's credentials; if that fails, you are
prompted for the database user's credentials. Studio then uploads the database schema to the database. (T he
credentials are retained only during database creation.)
7. T o create the database manually, click Generate database script. T he generated script includes instructions for
manually creating the database. Ensure that the database is empty and that at least one user has permission to access
and change the database before uploading the schema.
T he Conguration Logging data in the previous database is not imported to the new database. Logs cannot be aggregated
from both databases when retrieving logs. T he rst log entry in the new Conguration Logging database will indicate that a
database change occurred, but it does not identify the previous database.
Display conguration log content

When initiating conguration changes and administrative activities, the high level operations created by Studio and Director
are displayed in the upper middle pane in Studio. A high level operation results in one or more service and SDK calls, which
are low level operations. When you select a high level operation in the upper middle pane, the lower middle pane displays
the low level operations.
If an operation fails before completion, the log operation might not be completed in the Database; for example, a start
record will have no corresponding stop record. In such cases, the log indicates that there is missing information. When you
display logs based on time ranges, incomplete logs are shown if the data in the logs matches the criteria. For example, if all
logs for the last ve days are requested and a log exists with a start time in the last ve days but has no end time, it is
included.
When using a script that calls PowerShell cmdlets, if you create a low level operation without specifying a parent high level
operation, Conguration Logging will create a surrogate high level operation.
To display conguration log content, select Logging in the Studio navigation pane. By default, the display in the center
pane lists the log content chronologically (newest entries rst), separated by date.
To f ilter
the display Complete this action

by
Search Enter text in the Search box at the top of the middle pane. T he filtered display includes the number of
results search results. T o return to the standard logging display, clear the text in the Search box.
Column Click a column heading to sort the display by that field.

heading
A date Select an interval from the drop down list box next to the Search box at the top of the middle pane.
range
Generate reports
You can generate CSV and HT ML reports containing conguration log data.
T he CSV report contains all the logging data from a specified time interval. T he hierarchical data in the database is
flattened into a single CSV table. No aspect of the data has precedence in the file. No formatting is used and no human
readability is assumed. T he file (named MyReport) simply contains the data in a universally consumable format. CSV files
are often used for archiving data or as a data source for a reporting or data manipulation tool such as Microsoft Excel.
T he HT ML report provides a human-readable form of the logging data for a specified time interval. It provides a
structured, navigable view for reviewing changes. An HT ML report comprises two files, named Summary and Details.
Summary lists high level operations: when each operation occurred, by whom, and the outcome. Clicking a Details link
next to each operation takes you to the low level operations in the Details file, which provides additional information.
To generate a conguration log report, select Logging in the Studio navigation pane, and then select Create custom
report in the Actions pane.
Select the date range for the report.

Select the report format: CSV, HT ML, or both.
Browse to the location where the report should be saved.
Delete conguration log content

To delete the conguration log, you must have certain Delegated Administration and SQL Server database permissions.
Delegated Administration You must have a Delegated Administration role that allows the deployment
configuration to be read. T he built-in Full administrator role has this permission. A custom role must have Read Only or
Manage selected in the Other permissions category.
To create a backup of the conguration logging data before deleting it, the custom role must also have Read Only or
Manage selected in the Logging Permissions category.
SQL Server database You must have a SQL server login with permission to delete records from the database. T here
are two ways to do this:
Use a SQL Server database login with a sysadmin server role, which allows you to perform any activity on the database
server. Alternatively, the serveradmin or setupadmin server roles allow you to perform deletion operations.
If your deployment requires additional security, use a non-sysadmin database login mapped to a database user who
has permission to delete records from the database.

1. In SQL Server Management Studio, create a SQL Server login with a server role other than 'sysadmin.'
2. Map the login to a user in the database; SQL Server automatically creates a user in the database with the same
name as the login.
3. In Database role membership, specify at least one of the role members for the database user:
ConfigurationLoggingSchema_ROLE or dbowner.
For more information, see the SQL Server Management Studio documentation.
To delete the conguration logs:

2. Select Delete logs in the Actions pane.
3. You are asked if you want to create a backup of the logs before they are deleted. If you choose to create a backup,
browse to the location where the backup archive should be saved. T he backup is created as a CSV file.
After the conguration logs are cleared, the log deletion is the rst activity posted to the empty log. T hat entry provides
details about who deleted the logs, and when.

Event logs
May 22, 20 17
T he following articles contain lists and descriptions of events that can be logged by XenApp and XenDesktop services.
T his information is not comprehensive; readers should check individual feature articles for additional event information.
HTML Citrix Broker Service events
HTML Citrix FMA Service SDK events
HTML Citrix Conguration Service events
HTML Citrix Delegated Administration Service events

Director
Jun 0 6, 20 17
In this article:
About Director
Deploy and congure Director
Install Director
Install Director for XenApp 6.5
Log on to Director
Use Director with Integrated Windows Authentication
About Director
Director is a monitoring and troubleshooting console for XenApp and XenDesktop.
Director can access:
Real-time data from the Broker Agent using a unified console integrated with Analytics, Performance Manager, and
Network Inspector.
Analytics includes performance management for health and capacity assurance, and historical trending and network

analysis, powered by NetScaler Insight Center or NetScaler MAS, to identify bottlenecks due to the network in your
XenApp or XenDesktop environment.
Historical data stored in the Monitor database to access the Configuration Logging database.
ICA data from the NetScaler Gateway using NetScaler Insight Center or NetScaler MAS.
Gain visibility into end-user experience for virtual applications, desktops, and users for XenApp or XenDesktop.
Correlate network data with application data and real-time metrics for effective troubleshooting.
Integrate with XenDesktop 7 Director monitoring tool.
Personal vDisk data that allows for runtime monitoring showing base allocation and gives help desk administrators the
ability to reset the Personal vDisk (to be used only as a last resort).
T he command line tool CtxPvdDiag.exe is used to gather the user log information into one file for troubleshooting.
Director uses a troubleshooting dashboard that provides real-time and historical health monitoring of the XenApp or
XenDesktop Site. T his feature allows you to see failures in real time, providing a better idea of what the end users are
experiencing.
Interface views
Director provides different views of the interface tailored to particular administrators. Product permissions determine what
is displayed and the commands available.
For example, help desk administrators see an interface tailored to help desk tasks. Director allows help desk administrators
to search for the user reporting an issue and display activity associated with that user, such as the status of the user's
applications and processes. T hey can resolve issues quickly by performing actions such as ending an unresponsive
application or process, shadowing operations on the user's machine, restarting the machine, or resetting the user prole.
In contrast, full administrators see and manage the entire Site and can perform commands for multiple users and machines.
T he Dashboard provides an overview of the key aspects of a deployment, such as the status of sessions, user logons, and
the Site infrastructure. Information is updated every minute. If issues occur, details appear automatically about the number
and type of failures that have occurred.
Deploy and congure Director
Director is installed by default as a website on the Delivery Controller. For prerequisites and other details, see the System
requirements documentation for this release.
T his release of Director is not compatible with XenApp deployments earlier than 6.5 or XenDesktop deployments earlier
than 7.
When Director is used in an environment containing more than one Site, be sure to synchronize the system clocks on all the
servers where Controllers, Director, and other core components are installed. Otherwise, the Sites might not display
correctly in Director.
Tip: If you intend to monitor XenApp 6.5 in addition to XenApp 7.5 or XenDesktop 7.x Sites, Citrix recommends installing
Director on a separate server from the Director console that is used to monitor XenApp 6.5 Sites.
Important: T o protect the security of user names and passwords sent using plain text through the network, Citrix strongly
recommends that you allow Director connections using only HT T PS, and not HT T P. Certain tools are able to read plain text
user names and passwords in HT T P (unencrypted) network packets, which can create a potential security risk for users.
To congure permissions

To log on to Director, administrators with permissions for Director must be Active Directory domain users and must have the
following rights:
Read rights in all Active Directory forests to be searched (see Advanced configuration).
Configured Delegated Administrator roles (see Delegated Administration and Director).
T o shadow users, administrators must be configured using a Microsoft group policy for Windows Remote Assistance. In
addition:
When installing VDAs, ensure that the Windows Remote Assistance feature is enabled on all user devices (selected by
default).
When you install Director on a server, ensure that Windows Remote Assistance is installed (selected by default).
However, it is disabled on the server by default. T he feature does not need to be enabled for Director to provide
assistance to end users. Citrix recommends leaving the feature disabled to improve security on the server.
T o enable administrators to initiate Windows Remote Assistance, grant them the required permissions by using the
appropriate Microsoft Group Policy settings for Remote Assistance. For information, see CT X127388: How to Enable
Remote Assistance for Desktop Director.
For user devices with VDAs earlier than 7, additional configuration is required. See Configure permissions for VDAs earlier
than XenDesktop 7.
Install Director
Install Director using the full-product Installer for XenApp and Desktop, which checks for prerequisites, installs any missing
components, sets up the Director website, and performs basic conguration. T he default conguration provided by the
installer handles typical deployments. If Director was not included during installation, use the installer to add Director. To
add any additional components, rerun the installer and select the components to install. For information on using the
installer, see Install core components in the installation documentation. Citrix recommends that you install using the
product installer only, not the .MSI le.
When Director is installed on the Controller, it is automatically congured with localhost as the server address, and Director
communicates with the local Controller by default.
To install Director on a dedicated server that is remote from a Controller, you are prompted to enter the FQDN or IP
address of a Controller.

Note: Click Add to add the Controller to be monitored.
Director communicates with that specied Controller by default. Specify only one Controller address for each Site that you
monitor. Director automatically discovers all other Controllers in the same Site and falls back to those other Controllers if
the Controller you specied fails.
Note: Director does not load balance among Controllers.
To secure the communications between the browser and the Web server, Citrix recommends that you implement T LS on
the IIS website hosting Director. Refer to the Microsoft IIS documentation for instructions. Director conguration is not
required to enable T LS.
Install Director f or XenApp 6.5
T o install Director for XenApp 6.5 follow these steps. T ypically, Director is installed on a separate computer from the
XenApp Controllers.
1. Install Director from the XenApp installation media. If Director is already installed for XenDesktop, skip this step and
proceed to the next step.
2. Use the IIS Manager Console on each Director server to update the list of XenApp server addresses in the application
settings as described in the To add Sites to Director section in Advanced configuration.
Supply the server address of one Controller per XenApp Site: any of the other Controllers in a XenApp site are then used
automatically for failover. Director does not load balance among Controllers.
Important: For XenApp addresses, be sure to use the setting Service.AutoDiscoveryAddressesXA, not the default setting
Service.AutoDiscoveryAddresses.
3. T he Director WMI Provider installer is located at the Support\DirectorWMIProvider folder on the DVD. Install it on all
appropriate XenApp servers (Controllers and workers where sessions are running).

If winrm is not configured, run the winrm qc command.
4. Configure each XenApp worker server to accept WinRM queries as described in Configure permissions.
5. Configure a firewall exception for port 2513, used for communication between Director and XenApp.
6. T o secure the communications between the browser and the web server, Citrix recommends that you implement T LS on
the IIS website hosting Director.
Refer to the Microsoft IIS documentation for instructions. No Director configuration is required to enable T LS.
Note: To allow Director to nd all the XenApp workers in the farm, you must add a reverse DNS zone for the subnets
where the XenApp servers reside on the DNS servers used by the farm.
Log on to Director
T he Director website is located at https or http://<Server_FQDN>/Director.
If one of the Sites in a multi-site deployment is down, the logon for Director takes a little longer while it attempts to
connect to the Site that is down.
Use Director with Integrated Windows Authentication
With Integrated Windows Authentication, domain-joined users gain direct access to Director without re-keying their
credentials on the Director logon page. T he prerequisites for working with Integrated Windows Authentication and
Director are:
Enable Integrated Windows Authentication on the IIS website that hosts Director. When you install Director,
Anonymous and Forms Authentication are enabled. T o work with Integrated Windows Authentication and Director,
disable Anonymous Authentication and enable Windows Authentication. Forms Authentication must remain set to
Enabled for authentication of non-domain users.
1. Start IIS manager.
2. Go to Sites > Def ault Web Site > Director.
3. Select Authentication.
4. Right-click Anonymous Authentication, and select Disable.
5. Right-click Windows Authentication, and select Enable.
Configure Active Directory delegation permission for the Director machine. T his is only required if Director and the
Delivery Controller are installed on separate machines.
1. On the Active Directory machine, open the Active Directory Management Console.
2. In the Active Directory Management Console navigate to Domain Name > Computers. Select the Director machine.
3. Right-click and select Properties.

4. In Properties, select the Delegation tab.
5. Select the option, Trust this computer f or delegation to any service (Kerberos only).
T he browser that is used to access Director must support Integrated Windows Authentication. T his might require
additional configuration steps in Firefox and Chrome. For more information, refer to the browser documentation.
T he Monitoring Service must be running Microsoft .NET Framework 4.5.1 or a later supported version listed in the System
Requirements for Director. For more information, see System Requirements.
When a user logs off Director or if the session times out, the logon page is displayed. From the logon page, the user can set
the Authentication type to Automatic logon or User credentials.
Usage data collection notice

T he Director Service starts collecting analytics on Director usage anonymously after Director is installed. Statistics and
information regarding the usage of the Trends page and its tabs are collected.
Data collection is enabled by default when you install Director. To opt out, edit the registry key,
HKEY_LOCAL_MACHINE\Software\Citrix\MetaInstall on the machine where Director is installed, as described in the Install
and upgrade analytics section in Citrix Insight Services.
Director f eature compatibility
Within each Site, although you can use earlier versions of VDA or Delivery Controller, all the features in the latest version of
Director might not be available. In addition, feature availability depends on the Site license edition. Citrix recommends
having Director, Delivery Controller and VDA at the same version.
Note: After you upgrade a Delivery Controller, you are prompted to upgrade the Site when you open Studio. For more
information, see the Upgrade Sequence section in Upgrade a deployment.
T he table below lists Director features and the minimum version of Delivery Controller (DC), VDA and any other dependent
components required along with License Edition.
Director Dependencies - min version

Feature Edition
Version required
Application-centric troubleshooting DC 7.13 || VDA 7.13 All
7.14 Disk Monitoring

DC 7.14 || VDA 7.14 All
GPU Monitoring
Application-centric troubleshooting DC 7.13 || VDA 7.13 Platinum

7.13
Transport protocol on Session Details panel DC 7.x || VDA 7.13 All
User-friendly Connection and Machine

All
failure descriptions

Increased historical data availability in
Enterprise
Enterprise edition DC 7.12 || VDA 7.x
7.12
Custom Reporting Platinum
Automate Director notications with SNMP

Platinum
traps
Resource utilization reporting All
DC 7.11 || VDA 7.11

Alerting extended for CPU, memory and ICA
Platinum
RT T conditions
Export report improvements All

7.11
DC 7.11 || VDA 7.x
Automate Director notications with
Platinum
Citrix Octoblu
DC 7.11 || VDA 7.x || MAS

Integration with NetScaler MAS Platinum
version 11.1 Build 49.16
7.9 Logon Duration breakdown DC 7.9 || VDA 7.x All
Proactive monitoring and alerting DC 7.7 || VDA 7.x Platinum
DC 7.7 || VDA 7.x || SCOM 2012

SCOM Integration Platinum
R2 || PowerShell 3.0 or higher*
7.7
Windows Authentication Integration DC 7.x || VDA 7.x All
Desktop and Server OS Usage DC 7.7 || VDA 7.x Platinum
*Director and SCOM server must have the same PowerShell version

Advanced conguration
May 22, 20 17
In this article:
Recommended conguration for Director to work in a multi-forest environment
Add Sites to Director
Disable the visibility of running applications in the Activity Manager
Director can support multi-forest environments spanning a forest conguration where users, Domain Delivery Controllers
(DDC), VDAs, and Directors are located in different forests. T his requires proper setup of trust relationships among the
forests and conguration settings.
Recommended conguration f or Director to work in a multi-f orest environment
T he recommended conguration requires creation of outgoing and incoming forest trust relationships among the forests
with domain-wide authentication.
T he trust relationship from the Director enables you to troubleshoot issues in user sessions, VDAs and Domain Controllers
located in different forests.
Advanced configuration required for Director to support multiple forests is controlled through settings defined in Internet
Information Services (IIS) Manager.
Important: When you change a setting in IIS, the Director service automatically restarts and logs off users.
To congure advanced settings using IIS:
1. Open the Internet Information Services (IIS) Manager console.

2. Go to the Director website under the Default website.
3. Double-click Application Settings.
4. Double-click a setting to edit it.
Platinum licenses retain data for 90 days by default. For more information on congurations see Data granularity and
retention.

Director uses Active Directory to search for users and to look up additional user and machine information. By default,
Director searches the domain or forest in which:
T he administrator's account is a member.

T he Director web server is a member (if different).
Director attempts to perform searches at the forest level using the Active Directory global catalog. If you do not have
permissions to search at the forest level, only the domain is searched.
Searching or looking up data from another Active Directory domain or forest requires that you explicitly set the domains or
forests to be searched. Congure the following setting:
Connector.ActiveDirectory.Domains = (user),(server)
T he value attributes user and server represent the domains of the Director user (the administrator) and Director server,
respectively.
To enable searches from an additional domain or forest, add the name of the domain to the list, as shown in this example:
Connector.ActiveDirectory.Domains = (user),(server),<domain1>,<domain2>
For each domain in the list, Director attempts to perform searches at the forest level. If you do not have permissions to
search at the forest level, only the domain is searched.
Note: In an environment with multiple forests, Director does not show the session details of users from other forests who
have been assigned to the XenDesktop Delivery Group using the domain local group.
Add Sites to Director
If Director is already installed, congure it to work with multiple Sites. To do this, use the IIS Manager Console on each
Director server to update the list of server addresses in the application settings.
Add an address of a Controller from each Site to the following setting:

Service.AutoDiscoveryAddresses = SiteAController,SiteBController
where SiteAController and SiteBController are the addresses of Delivery Controllers from two different Sites.
For XenApp 6.5 Sites, add an address of a Controller from each XenApp farm to the following setting:
Service.AutoDiscoveryAddressesXA = FarmAController,FarmBController
where FarmAController and FarmBController are the addresses of XenApp Controllers from two different farms.
For XenApp 6.5 Sites, another way to add a Controller from a XenApp farm:
DirectorConfig.exe /xenapp FarmControllerName
Disable the visibility of running applications in the Activity Manager
By default, the Activity Manager in Director displays a list of all running applications for a user's session. T his information
can be viewed by all administrators that have access to the Activity Manager feature in Director. For Delegated
Administrator roles, this includes Full Administrator, Delivery Group Administrator, and Help Desk Administrator.

To protect the privacy of users and the applications they are running, you can disable the Applications tab from listing
running applications.
1. On the VDA, modify the registry key located at
HKEY_LOCAL_MACHINE\Software\Citrix\Director\T askManagerDataDisplayed. By default, the key is set to 1. Change
the value to 0, which means the information is not be displayed in the Activity Manager.
2. On the server with Director installed, modify the setting that controls the visibility of running applications. By default, the
value is "true", which allows visibility of running applications in the Applications tab. Change the value to "false", which
disables visibility. T his option affects only the Activity Manager in Director, not the VDA.
Modify the value of the following setting:
UI.TaskManager.EnableApplications = false
Important: T o disable the view of running applications, Citrix recommends making both changes to ensure that the data is
not displayed in Activity Manager.

Monitor deployments
May 22, 20 17
In this article:
Monitor Sites
Monitor sessions
Filter data to troubleshoot failures
Monitor historical trends across a Site
Monitor hotxes
Control user machine power states
Prevent connections to machines
Monitor Sites
With full administrator permissions, when you open Director, the Dashboard provides a centralized location to monitor the
health and usage of a Site.
If there are currently no failures and no failures have occurred in the past 60 minutes, panels stay collapsed. When there are
failures, the specic failure panel automatically appears.

Note: Depending on your organization's license and your Administrator privileges, some options or features might not be
available.
Panel Description
User Connection failures over the last 60 minutes. Click the categories next to the total number to view
Connection metrics for that type of failure. In the adjacent table, that number is broken out by Delivery Groups.
Failures Connection failures includes failures caused by application limits being reached. For more information
on application limits, see Applications.
Failed T otal failures in the last 60 minutes broken out by Delivery Groups. Failures broken out by types,
Desktop OS including failed to start, stuck on boot, and unregistered. For Server OS machines, failures also include
Machines or machines reaching maximum load.
Failed Server
OS Machines
Licensing License Server alerts display alerts sent by the License Server and the actions required to resolve the
Status alerts.
Requires License Server Version 11.12.1 or later.
Delivery Controller alerts display the details of the licensing state as seen by the Controller and are
sent by the Controller.
Requires Controller for XenApp 7.6 or XenDesktop 7.6 or later.
You can set the threshold for alerts in Studio.
Sessions Connected sessions across all Delivery Groups for the last 60 minutes.
Connected
Average Logon data for the last 60 minutes. T he large number on the left is the average logon duration across
Logon the hour.
Duration Logon data for VDAs earlier than XenDesktop 7.0 is not included in this average.
For more information, see Diagnose user logon issues.
Infrastructure Lists your Site's infrastructure - hosts and Controllers.
For infrastructure from XenServer or VMware, you can view performance alerts.
For example, you can congure XenCenter to generate performance alerts when CPU, network I/O, or
disk I/O usage go over a specied threshold on a managed server or virtual machine. By default, the
alert repeat interval is 60 minutes, but you can congure this as well. For details, in the Citrix XenServer
7.0 Administrator's Guide, see XenCenter Performance Alerts.
Note: If no icon appears for a particular metric, this indicates that this metric is not supported by the type of host you are
using. For example, no health information is available for System Center Virtual Machine Manager (SCVMM) hosts, AWS and
CloudStack.
Continue to troubleshoot issues using these options (which are documented below):

Control user machine power
Monitor sessions
If a session becomes disconnected, it is still active and its applications continue to run, but the user device is no longer
communicating with the server.
Action Description
View a user's currently connected From the Activity Manager and User Details views, view the user's currently
machine or session connected machine or session and a list of all machines and sessions to which this
user has access. To access this list, click the session switcher icon in the user title
bar. For more information, see Restore sessions.
View the total number of From the Dashboard, in the Sessions Connected pane, view the total number of
connected sessions across all connected sessions across all Delivery Groups for the last 60 minutes. T hen click
Delivery Groups the large total number, which opens the Filters view, where you can display
graphical session data based on selected Delivery Groups and ranges and usage
across Delivery Groups.
End idle sessions T he Sessions Filters view displays data related to all active sessions. Filter the
sessions based on Associated User, Delivery Group, Session State, and Idle T ime
greater than a threshold time period. From the ltered list, select sessions to log
off or disconnect. For more information, see Troubleshoot applications.
View data over a longer period of On the Trends view, select the Sessions tab to drill down to more specic usage
time data for connected and disconnected sessions over a longer period of time (that
is, session totals from earlier than the last 60 minutes). To view this information,
click View historical trends
Note: If the user device is running a legacy Virtual Delivery Agents (VDA), such as a VDA earlier than version 7, or a Linux
VDA, Director cannot display complete information about the session. Instead, it displays a message that the information is
not available.
View the transport protocol in use for the HDX connection type for the current session in the Session Details panel. T his
information is available for sessions launched on VDAs Version 7.13 or later.

For HDX Connection type,
T he Protocol is displayed as UDP, if EDT is used for the HDX connection.
T he Protocol is displayed as TCP, if T CP is used for the HDX connection.
For RDP Connection type, the Protocol is displayed as n/a.
When adaptive transport is congured, the session transport protocol dynamically switches between EDT (over UDP) and
TCP, based on the network conditions. If the HDX session cannot be established using EDT, it falls back to the TCP
protocol.
For more information about adaptive transport conguration, see Adaptive Transport.
Filter data to troubleshoot f ailures
When you click numbers on the Dashboard or select a predened lter from the Filters menu, the Filters view opens to
display the data based on the selected machine or failure type.
Predened lters cannot be edited, but you can save a predened lter as a custom lter and then modify it. Additionally,
you can create custom ltered views of machines, connections, and sessions across all Delivery Groups.
1. Select a view:
Machines. Select Desktop OS Machines or Server OS Machines. T hese views show the number of configured
machines. T he Server OS Machines tab also includes the load evaluator index, which indicates the distribution of
performance counters and tool tips of the session count if you hover over the link.
Sessions. You can also see the session count from the Sessions view. Use the idle time measurements to identify
sessions that are idle beyond a threshold time period.
Connections. Filter connections by different time periods, including last 60 minutes, last 24 hours, or last 7 days.
Application Instances. T his view displays the properties of all application instances on VDAs of Server and Desktop
OS. T he session idle time measurements are available for Application instances on VDAs of Server OS.
2. For Filter by, select the criteria.
3. Use the additional tabs for each view, as needed, to complete the filter.

4. Select additional columns, as needed, to troubleshoot further.
5. Save and name your filter.
6. T o access filters from multiple Director servers, store the filters on a shared folder accessible from those servers:
T he shared folder must have modify permissions for accounts on the Director server.
T he Director servers must be configured to access the shared folder. T o do this, run IIS Manager. In Sites > Def ault
Web Site > Director> Application Settings, modify the Service.UserSettingsPath setting to reflect the UNC path
of the shared folder.
7. T o open the filter later, from the Filters menu, select the filter type (Machines, Sessions, Connections, or Application
Instances), and then select the saved filter.
8. If needed, for Machines or Connections views, use power controls for all the machines you select in the filtered list. For
the Sessions view, use the session controls or option to send messages.
9. In the Machines and Connections views, click the Failure Reason of a failed machine or connection to get a detailed
description of the failure and actions recommended to troubleshoot the failure. T he failure reasons and the
recommended actions for Machine and Connection failures are available in the Citrix Director 7.12 Failure Reasons
T roubleshooting Guide.
10. In the Machines view, click on a machine name link to go to the corresponding Machine Details page. T his page displays
the details of the machine, provides power controls, displays the CPU, memory, disk monitoring, and GPU monitoring
graphs. Also, click View Historical Utilization to see the resource utilization trends for the machine. For more
information, see T roubleshoot machines.
11. In the Application Instances view, sort or filter based on Idle Time greater than a threshold time period. Select the idle
application instances to end. Log off or Disconnect of an application instance ends all active application instances in the
same session. For more information, see T roubleshoot applications.
Note: T he Application Instances filter page and idle time measurements in the Sessions filter pages are available if
Director, Delivery Controller(s), and VDAs are version 7.13 or later.
Monitor historical trends across a Site
T he Trends view accesses historical trend information for sessions, connection failures, machine failures, logon
performance, load evaluation, capacity management, machine usage and resource utilization for each Site. To locate this
information, click Trends Menu.
T he zoom-in drill down feature lets you navigate through trend charts by zooming in on a time period (clicking on a data
point in the graph) and drilling down to see the details associated with the trend. T his feature enables you to better
understand the details of who or what has been affected by the trends being displayed.
To change the default scope of each graph, apply a different lter to the data.
Choose a time period for which you require the historical trend information; time period availability depends on your
Director deployment as follows:
T rend reports of up to last year (365 days) are available in Platinum licensed Sites.
T rend reports of up to last month (31 days) are available in Enterprise licensed Sites.
T rend reports of up to last 7 days in non-Platinum and non-Enterprise licensed Sites.
Note:
In all Director deployments, Sessions, failures, and logon performance trend information is available as graphs and tables
when the time period is set to Last month or shorter. When the time period is set to Last Year, the trend information is
available as graphs but not as tables.

T he default values of the trends data grooming retention by the Monitoring Service are available in the Data granularity
and retention section in Accessing data using the API. Customers on Platinum licensed Sites can change the grooming
retention to their desired number of retention days.
Action Description
View trends for sessions From the Sessions tab, select the Delivery Group and time period to view more
detailed information about the concurrent session count.
View trends for connection failures From the Failures tab, select the connection, machine type, failure type, Delivery
Group, and time period to view a graph containing more detailed information
about the user connection failures across your Site.
View trends for machine failures From the Desktop OS Machine Failures tab or Server OS Machines tab, select
the failure type, Delivery Group, and time period to view a graph containing
more detailed information about the machine failures across your Site.
View trends for logon performance From the Logon Performance tab, select the Delivery Group and time period to
view a graph containing more detailed information about the duration of user
logon times across your Site and whether the number of logons affects the
performance. T his view also shows the average duration of the logon phases,
such as brokering duration and VM start time.
T his data is specically for user logons and does not include users trying to
reconnect from disconnected sessions.
T he table below the graph shows Logon Duration by User Session. T he
administrator can choose the columns to display and sort the report by any of
the columns.
View trends for load evaluation From the Load Evaluator Index tab, view a graph containing more detailed
information about the load that is distributed among Server OS machines. T he
lter options for this graph include the Delivery Group or Server OS machine in a
Delivery Group, Server OS machine (available only if Server OS machine in a
Delivery Group was selected), and range.
View hosted applications usage T he availability of this feature depends on your organization's license.
From the Capacity Management tab, select Hosted Applications Usage tab,
select the Delivery Group and time period to view a graph displaying peak
concurrent usage and a table displaying application based usage. From the
Application Based Usage table, you can choose a specic application to see
details and a list of users who are using, or have used, the application.
View desktop and server OS usage T he Trends view shows the usage of Desktop OS by Site and by Delivery group.

When you select Site, usage is shown per Delivery group. When you select
Delivery group, usage is shown per User.
T he Trends view also shows the usage of Server OS by Site, by Delivery group,
and by Machine. When you select Site, usage is shown per Delivery group. When
you select Delivery group, usage is shown per Machine and per User. When
Machine is selected usage is shown per User.
View virtual machine usage From the Machine Usage tab, select Desktop OS Machines or Server OS
Machines to obtain real-time view of your VM usage, enabling you to quickly
assess your Sites capacity needs.
Desktop OS availability - displays the current state of Desktop OS machines
(VDIs) by availability for the entire Site or specic Delivery Group.
Server OS availability - displays the current state of Server OS machines by
availability for the entire Site or specic Delivery Group.
From the Resource Utilization tab, select Desktop OS Machines or Server OS

Machines to obtain insight into historical trends data for CPU and memory
usage, and IOPS and disk latency for each VDI machine for better capacity
planning.
T his feature requires Delivery Controller(s) and VDAs version 7.11 or later.
Graphs show data for average CPU, average memory, average IOPS, disk
latency, and peak concurrent sessions. You can drill down to the machine, and
view data and charts for the top 10 processes consuming CPU. Filter by Delivery
Group and T ime period. CPU, memory usage, and peak concurrent sessions
graphs are available for the last 2 hours, 24 hours, 7 days, month, and year. T he
average IOPS and disk latency graphs are available for the last 24 hours, month,
View resource utilization and year.
Note:
T he Monitoring policy setting, Enable Process Monitoring, must be set to

"Allowed" to collect and display data in the T op 10 Processes table on the
Historic Machine Utilization page. T he policy is set to "Prohibited" by default.
All resource utilization data is collected by default. T his can be disabled using
the Enable Resource Monitoring policy setting.
T he table below the graphs shows the resource utilization data per machine.
Note: Average IOPS shows the daily averages. Peak IOPS is calculated as the
highest of the IOPS averages for the selected time range. (An IOPS average is
the hourly average of IOPS collected during the hour on the VDA).
Note: T he availability of this feature depends on your organization's license and

your administrator permissions. T his feature requires Delivery
Controller(s) version 7.11 or later.
From the Network tab, monitor your network analysis, which provides a user,
View network analysis data application, and desktop contextual view of the network. With this feature,
Director provides advanced analytics of ICA trafc in your deployment through

HDX Insight reports from NetScaler Insight Center or NetScaler MAS. For more
information, see Congure network analysis.
T he Custom Reports tab provides a user interface for generating Custom

Reports containing real-time and historical data from the Monitoring database
in tabular format.
Note: T his feature requires Delivery Controller(s) version 7.12 or later.
From the list of previously saved Custom Report queries, you can execute to
export the report in CSV format, copy and share the corresponding OData
query, or edit the query.
You can create a new Custom Report query based on machines, connections,
Create customized reports sessions, or application instances. Specify lter conditions based on elds such
as machine, delivery group, or time period. Specify additional columns required in
your Custom Report. Preview displays a sample of the report data. Saving the
Custom Report query adds it to the list of saved queries.
You can create a new Custom Report query based on a copied OData query. To
do this, select the OData Query option and paste the copied OData query. You
can save the resultant query for execution later.
Note: T he column names in Preview and Export report generated using OData
queries are not localized, but appear in English.
T he ag icons on the graph indicate signicant events or actions for that specic time range. Hover the mouse over the
ag and click to list events or actions.
Note: HDX connection logon data is not collected for VDAs earlier than 7. For earlier VDAs, the chart data is displayed as 0.
Export reports
You can export trends data to generate regular usage and capacity management reports. Export supports PDF, Excel, and
CSV report formats. Reports in PDF and Excel formats contain trends represented as graphs and tables. CSV format reports
contain tabular data that can be processed to generate views or can be archived.
To export a report:
1. Go to the Trends tab.

2. Set filter criteria and time period and click Apply. T he trend graph and table are populated with data.
3. Click Export and enter name and format of the report.
Director generates the report based on the lter criteria you select. If you change the lter criteria, click Apply before you
click Export.
Note: Export of a large amount of data causes a signicant increase in memory and CPU consumption in the Director
server, the Delivery Controller, and the SQL servers. T he supported number of concurrent export operations and the amount
of data that can be exported is set to default limits to achieve optimal Export performance.
Note

Export of a large amount of data causes a signicant increase in memory and CPU consumption in the Director server, the Delivery
Controller, and the SQL servers. T he supported number of concurrent export operations and the amount of data that can be
exported is set to default limits to achieve optimal Export performance.
Supported Export limits
Exported PDF and Excel reports contain complete graphical chart for the selected lter criteria, however tabular data in all
report formats is truncated beyond the default limits on the number of rows or records in the table. T he default number of
records supported is dened based on the report format.
You can change the default limit by conguring the Director Application Settings in Internet Information Services (IIS).
Report f ormat Def ault number of Fields in Director Application Settings Max number of
records supported records
supported
PDF 500 UI.ExportPdfDrilldownLimit 5000
Excel 100,000 UI.ExportExcelDrilldownLimit 100,000
CSV 100,000 (10,000,000 in UI.ExportCsvDrilldownLimit 100,000

Sessions tab)
To change the limit of the number of records you can export:
1. Open the IIS Manager console.

4. Edit the field or add a new field.
Adding these eld values in Application Settings, overrides the default values.
Warning: Setting eld values higher than the max number of records supported, can impact the performance of Export and
is not supported.
Error Handling
T his section gives you information on dealing with errors that you might encounter during Export operation.
Director has timed out
T his error could occur due to network issues or high resource usage on the Director server or with the Monitor Service.
T he default timeout duration is 100 seconds. To increase the timeout duration of the Director Service, set the value
of Connector.DataServiceContext .Timeout eld in Director Application Settings in Internet Information Services
(IIS):

4. Edit the value Connector.DataServiceContext .Timeout.
Monitor has timed out
T his error could occur due to network issues or high resource usage with the Monitor Service or on the SQL server.
To increase the timeout duration of the Monitor Service, run the following PowerShell commands on the Delivery
Controller:
command COPY
asnp Citrix.*
Get-Mo nito rCo nguratio n
Set-Mo nito rCo nguratio n -Mo nito rQueryT imeo utSeco nds <t imeout value>
Max concurrent Export or Preview operations ongoing
Director supports one instance of Export or Preview. If you get the Max concurrent Export or Preview operations
ongoing error, try the next Export operation again later.
It is possible to increase the number of concurrent Export or Preview operations, however this can impact the
performance of Director and is not supported:
4. Edit the value UI.ConcurrentExportLimit.
Insuf f icient disk space in Director
Each Export operation requires a maximum of 2GB hard disk space in the Windows Temp folder. Retry Export after
clearing space or adding more hard disk space on the Director server.
Monitor hotxes
To view the hotxes installed on a specic machine VDA (physical or VM), choose the Machine Details view.
Control user machine power states

To control the state of the machines that you select in Director, use the Power Control options. T hese options are
available for Desktop OS machines, but might not be available for Server OS machines.
Note: T his functionality is not available for physical machines or machines using Remote PC Access.
Command Function
Restart Performs an orderly (soft) shutdown of the VM and all running processes are halted individually before
restarting the VM. For example, select machines that appear in Director as "failed to start," and use this
command to restart them.
Force Restarts the VM without first performing any shut-down procedure. T his command works in the same
Restart way as unplugging a physical server and then plugging it back in and turning it back on.
Shut Performs an orderly (soft) shutdown of the VM; all running processes are halted individually.
Down
Force Shuts down the VM without first performing any shut-down procedure. T his command works in the same
Shutdown way as unplugging a physical server. It might not always shut down all running processes, and you risk
losing data if you shut down a VM in this way.
Suspend Suspends a running VM in its current state and stores that state in a file on the default storage
repository. T his option allows you to shut down the VM's host server and later, after rebooting it, resume
the VM, returning it to its original running state.
Resume Resumes a suspended VM and restores its original running state.
Start Starts a VM when it is off (also called a cold start).
If power control actions fail, hover the mouse over the alert, and a pop-up message appears with details about the failure.
Use maintenance mode to prevent new connections temporarily while the appropriate administrator performs maintenance
tasks on the image.
When you enable maintenance mode on machines, no new connections are allowed until you disable it. If users are
currently logged on, maintenance mode takes effect as soon as all users are logged off. For users who do not log off, send
a message informing them that machines will be shut down at a certain time, and use the power controls to force the
machines to shut down.
1. Select the machine, such as from the User Details view, or a group of machines in the Filters view.
2. Select Maintenance Mode, and turn on the option.
If a user tries to connect to an assigned desktop while it is in maintenance mode, a message appears indicating that the
desktop is currently unavailable. No new connections can be made until you disable maintenance mode.

Alerts and notications
May 22, 20 17
In this article:
Monitor alerts
Create alerts policies
Alerts policies conditions
Congure alerts policies with Octoblu webhooks
Congure alerts policies with SNMP traps
SCOM alerts
Congure SCOM integration
Monitor alerts
Alerts are displayed in Director on the dashboard and other high level views with warning and critical alert symbols. Alerts are
available for Platinum licensed Sites. Alerts update automatically every minute; you can also update alerts on demand.
A warning alert (amber triangle) indicates that the warning threshold of a condition has been reached or exceeded.
A critical alert (red circle) shows that the critical threshold of a condition has been reached or exceeded.
You can view more detailed information on alerts by selecting an alert from the sidebar, clicking the Go to Alerts link at the
bottom of the sidebar or by selecting Alerts from the top of the Director page.

In the Alerts view, you can lter and export alerts. For example, Failed Server OS machines for a specic Delivery Group over
the last month, or all alerts for a specic user. For more information, see Export reports.
Citrix alerts. Citrix alerts are alerts monitored in Director that originate from Citrix components. You can congure Citrix
alerts within Director in Alerts > Citrix Alerts Policy. As part of the conguration, you can set notications to be sent by
email to individuals and groups when alerts exceed the thresholds you have set up. Congure the notication as emails to
individuals and groups, Octoblu webhooks, and SNMP traps. For more information on setting up Citrix Alerts, see Create
alerts policies.
SCOM alerts. SCOM alerts display alert information from Microsoft System Center 2012 Operations Manager (SCOM) to
provide a more comprehensive indication of data center health and performance within Director. For more information, see
SCOM alerts and Congure SCOM integration.
T he number of alerts displayed next to the alerts icons before you expand the sidebar, are the combined sum of Citrix and
SCOM alerts.
Create alerts policies

To create a new alerts policy, for example to generate an alert when a specic set of session count criteria are met:
1. Go to Alerts > Citrix Alerts Policy and select, for example, Server OS Policy.
2. Click Create.
3. Name and describe the policy, then set the conditions that have to be met for the alert to be triggered. For example,
specify Warning and Critical counts for Peak Connected Sessions, Peak Disconnected Sessions, and Peak Concurrent
T otal Sessions. Warning values must not be higher than Critical values. For more information, see Alerts policies
conditions.
4. Set the Re-alert interval. If the conditions for the alert are still met, then the alert is triggered again at this time interval
and, if set up in the alert policy, an email notification is generated. A dismissed alert does not generate an email
notification at the re-alert interval.
5. Set the Scope. For example, set for a specific Delivery Group.
6. In Notification preferences, specify who should be notified by email when the alert is triggered. You have to specify an
email server in the Email Server Conf iguration tab in order to set email Notification preferences in Alerts Policies.
7. Click Save.
For information about Octoblu webhook conguration, see Congure alerts policies with Octoblu webhooks.
For information about SNMP trap conguration, see Congure alerts policies with SNMP traps.
Creating a policy with 20 or more Delivery Groups dened in the Scope might take approximately 30 seconds to complete
the conguration. A spinner is displayed during this time.
Creating more than 50 policies for up to 20 unique Delivery Groups (1000 Delivery Group targets in total), might result in an
increase in response time (over 5 seconds).
Alerts policies conditions
Alert policy Description and recommended actions

condition
Peak Connected Number of peak connected sessions.

Sessions
Check Director Session T rends view for peak connected sessions.
Check to ensure that there is enough capacity to accommodate the session load.
Add new machines if needed.
Peak Disconnected Number of peak disconnected sessions.

Sessions
Check Director Session T rends view for peak disconnected sessions.
Check to ensure that there is enough capacity to accommodate session load.
Log off disconnected sessions if needed.
Peak Concurrent Total Number of peak concurrent sessions.

Sessions
Check Director Session T rends view in Director for peak concurrent sessions.

Check to ensure that there is enough capacity to accommodate session load.
Log off disconnected sessions if needed.
Percentage of CPU usage.
Identify the processes or resources consuming CPU.

End the process if necessary. Ending the process causes unsaved data to be lost.
If all is working as expected, add additional CPU resources in the future.
CPU
Note: T he policy setting, Enable resource monitoring, is allowed by default for the
monitoring of CPU and memory performance counters on machines with VDAs. If this policy
setting is disabled, alerts with CPU and memory conditions are not triggered. For more
information, see Monitoring policy settings.
Percentage of Memory usage.
Identify the processes or resources consuming memory.

End the process if necessary. Ending the process causes unsaved data to be lost.
If all is working as expected, add additional memory in the future.
Memory
Note: T he policy setting, Enable resource monitoring, is allowed by default for the
monitoring of CPU and memory performance counters on machines with VDAs. If this policy
setting is disabled, alerts with CPU and memory conditions are not triggered. For more
information, see Monitoring policy settings.
Connection Failure Percentage of connection failures over the last hour. Calculated based on the total failures to
Rate total connections attempted.
Check Director Connection Failures T rends view for events logged from the Configuration
log.
Determine if applications or desktops are reachable.
Connection Failure Number of connection failures over the last hour.

Count
Check Director Connection Failures T rends view for events logged from the Configuration
log.
Determine if applications or desktops are reachable.
Average ICA round-trip time.
Check NetScaler HDX Insight or MAS for a breakdown of the ICA RT T to determine the
root cause. For more information, see the NetScaler Insight Center - HDX
ICA RT T (Average)
Insight or NetScaler MAS - Analytics: HDX Insight documentation.
If NetScaler is not available, check the Director User Details view for the ICA RT T and
Latency, and determine if it is a network problem or XenApp and XenDesktop issue.

Number of sessions that exceed the threshold ICA round-trip time.
Check NetScaler HDX Insight or MAS for the number of sessions with high ICA RT T . For
ICA RT T (No. of
more information, see the NetScaler Insight Center - HDX Insight or NetScaler
Sessions)
MAS - Analytics: HDX Insight documentation.
If NetScaler is not available, work with the network team to determine the root cause.
Percentage of sessions that exceed the average ICA round-trip time.
Check NetScaler HDX Insight or MAS for the number of sessions with high ICA RT T . For
ICA RT T (% of
more information, see the NetScaler Insight Center - HDX Insight or NetScaler
Sessions)
MAS - Analytics: HDX Insight documentation.
If NetScaler is not available, work with the network team to determine the root cause.
ICA round-trip time that is applied to sessions launched by the specified user. T he alert is
ICA RT T (User)
triggered if ICA RT T is higher than the threshold in at least one session.
Failed Machines Number of failed Desktop OS machines.

(Desktop OS)
Failures can occur for various reasons as shown in the Director Dashboard and Filters views.
Run Citrix Scout diagnostics to determine the root cause. For more information, see
T roubleshoot user issues.
Failed Machines Number of failed Server OS machines.

(Server OS)
Failures can occur for various reasons as shown in the Director Dashboard and Filters views.
Run Citrix Scout diagnostics to determine the root cause.
Average Logon Average logon duration for logons that occurred over the last hour.
Duration
Check the Director Dashboard to get up-to-date metrics regarding the logon duration. A
large number of users logging in during a short timeframe can increase the logon duration.
Check the baseline and break down of the logons to narrow down the cause.
Logon Duration (User) Logon duration for logons for the specified user that occurred over the last hour.
Load Evaluator Index Value of the Load Evaluator Index over the last 5 minutes.
Check Director for Server OS Machines that might have a peak load (Max load).
View both Dashboard (failures) and T rends Load Evaluator Index report.
Congure alerts policies with Octoblu webhooks
Apart from email notications, you can congure alerts policies with Octoblu webhooks to initiate IoT services.

Examples of IoT services that can utilize alerts include sending SMS notications to support staff or integrating with
custom incident resolution platforms to help in tracking notications.
You can congure an alert policy with a HT T P callback or a HT T P POST using PowerShell cmdlets. T hey are extended to
support webhooks.
For information on the creation of a new Octoblu workow and obtaining the corresponding webhook URL, see
the Octoblu Developer Hub.
To congure an Octoblu webhook URL for a new alert policy or an existing policy, use the following PowerShell cmdlets.
Create a new alerts policy with webhook URL:
command COPY
$policy = New-Monit orNot icat ionPolicy -Name <Policy name> -Descript ion <Policy descript ion> -Enabled $t rue -Webhook <Webhoo
Add a webhook URL to an existing alerts policy:
command COPY
Set -Monit orNot icat ionPolicy - Uid <Policy id> -Webhook <Webhook URL>
For help on the PowerShell commands, use the PowerShell help, for example:
command COPY
Get -Help <Set -Monit orNot icat ionPolicy>
For more information on conguring alert policies with PowerShell, see Director 7.7: Managing and Conguring Alerts and
Notications Using Powershell in Advanced Concepts.
Notications generated from the alert policy trigger the webhook with a POST call to the webhook URL. T he POST
message contains the notication information in JSON format:
{"NoticationId" : <Notication Id>,
"Target" : <Notication Target Id>,

"Condition" : <Condition that was violated>,
"Value" : <T hreshold value for the Condition>,
"T imestamp": <T ime in UTC when notication was generated>,
"PolicyName": <Name of the Alert policy>,
"Description": <Description of the Alert policy>,
"Scope" : <Scope of the Alert policy>,
"NoticationState": <Notication state critical, warning, healthy or dismissed>,
"Site" : <Site name>}
Congure alerts policies with SNMP traps
When an alert congured with an SNMP trap triggers, the corresponding SNMP trap message is forwarded to the
congured network listener for further processing. Citrix alerts support traps of SNMP version 2 and later. Currently, the
trap message can be forwarded to one listener.
To congure SNMP traps, use the following PowerShell cmdlets:
Get the current SNMP server configuration:
command COPY
Get-MonitorNoticationSnmpServerConguration
Set server configuration for SNMP version 2:
command COPY
Set -Monit orNot icat ionSnmpServerCongurat ion -ServerName <Server IP> -Port Number <Port ID> -SnmpSender <Sender name> -
Set server configuration for SNMP version 3:
command COPY

$aut hpass = "<aut hent icat ion password>" | Convert To-SecureSt ring -AsPlainText -Force
$privpass = "<Privacy password>" | Convert To-SecureSt ring -AsPlainText -Force
Set -Monit orNot icat ionSnmpServerCongurat ion -ServerName <Server IP> -Port Number <Port ID> -SnmpSender <Sender name> -
Enable SNMP trap for an existing alert policy:
command COPY
Set-MonitorNoticationPolicy -IsSnmpEnabled $true -Uid <Policy ID>
Create a new alert policy with SNMP trap configuration:
command COPY
$policy = New-Monit orNot icat ionPolicy -Name <Policy name> -IsSnmpEnabled $t rue -Descript ion <Policy descript ion> -Enabled $t ru
T he structure of the OIDs in the SNMP trap messages from Director is as follows:
1.3.6.1.4 .1.384 5.100.1.<UID>
Here, <UID> is generated serially for every alert policy dened in Director. T he OIDs are hence unique to each user
environment.
Use 1.3.6.1.4 .1.384 5.100.1 to filter all trap messages from Director.
Use 1.3.6.1.4 .1.384 5.100.1.<UID> to filter and handle traps messages for specific alerts.
Use the following cmdlet to get the UIDs for the alert policies dened in your environment:
command COPY
Get-MonitorNoticationPolicy
You can forward the SNMP traps to SCOM. To do this, congure SCOM with the Delivery Controller to listen to the trap

messages.
SCOM alerts
SCOM integration with Director lets you view alert information from Microsoft System Center 2012 Operations Manager
(SCOM) on the Dashboard and in other high level views in Director.
SCOM alerts are displayed on-screen alongside Citrix alerts. You can access and drill down into SCOM alerts from SCOM tab
in the side bar.
You can view historical alerts up to one month old, sort, lter, and export the ltered information to CSV, Excel, and PDF
report formats. For more information, see Export reports.
Congure SCOM integration
SCOM integration uses remote PowerShell 3.0 or later to query data from the SCOM Management Server and it maintains
a persistent runspace connection in the user's Director session. Director and SCOM server must have the same PowerShell
version.
T he requirements for SCOM integration are:

System Center 2012 R2 Operations Manager
PowerShell 3.0 or later(PowerShell version on Director and the SCOM server must match)
Quad Core CPU with 16 GB RAM (recommended)
A primary Management Server for SCOM must be configured in the Director web.config file. You can do this using the
DirectorConfig tool.
Citrix recommends that the Director administrator account is configured as a SCOM Operator role so that they can
retrieve full alert information in Director. If this is not possible, a SCOM administrator account can be configured in the
web.config file using the DirectorConfig tool, however it is not recommended.
Citrix recommends that you do not configure more than 10 Director administrators per SCOM Management Server. T his
is to ensure that the SCOM Management Server is moderately loaded for optimal performance.
On the Director server:

1. On the Director server, type Enable-PSRemoting to enable PowerShell remoting.
2. Add the SCOM Management Server to the TrustedHosts list. Open an elevated PowerShell prompt in From an elevated
PowerShell command line, and execute the following command(s):
a. Get the current list of TrustedHosts
command COPY
Get -It em WSMAN:\localhost \Client \Trust edHost s
b. Add the FQDN of the SCOM Management Server to the list of TrustedHosts. <Old Values> represents the existing
set of entries returned from Get-Item cmdlet.
command COPY
Set -It em WSMAN:\localhost \Client \Trust edHost s -Value "<FQDN SCOM Management Server>,<Old Values>"
3. Congure SCOM using the DirectorCong tool.
command COPY
C:\inet pub\wwwroot \Direct or\t ools\Direct orCong.exe /congscom
On the SCOM Management server:
1. Assign Director administrators to a SCOM administrator role.
a. Open the SCOM Management console and go to Administration > Security > User Roles.
b. In User Roles, you can create a new User Role or modify an existing one. T here are four categories of SCOM
operators. T hese roles dene the nature of access to SCOM data. For example, a read-only SCOM operator does not
see the Administration pane and cannot discover or manage rules, machines or accounts. A SCOM Operator role is a
full administrator role.
Note:
If a Director administrator is assigned to non-operator role the following operations are not available to the Director
administrator.
i. If there are multiple management servers congured and the primary management server is not available, the

Director administrator cannot connect to secondary management server.
T he primary management server is the server congured in the Director web.cong le, that is the same server as
the one specied in step 3. above with the DirectorCong tool. T he secondary management servers are peer
management servers of the primary server.
ii. While ltering alerts, the Director administrator cannot search for the alert Source. T his requires an operator
level permission.
c. To modify any User Role, right click on the role, then click Properties.
d. In the User Role Properties dialog, you can add or remove Director administrators from the specied user role.
2. Add Director administrators to the Remote Management Users group on the SCOM Management server. T his allows the
Director administrators to establish a remote PowerShell connection.
3. Type Enable-PSRemoting to enable PowerShell remoting.
4. Set the WS-Management properties limits:
a. Modify MaxConcurrentUsers:
In CLI:
command COPY
winrm set winrm/cong/winrs @{MaxConcurrent Users = "20"}
In PS:
command COPY
Set -It em WSMan:\localhost \Shell\MaxConcurrent Users 20
b. Modify MaxShellsPerUser:
In CLI:
command COPY

winrm set winrm/cong/winrs @{MaxShellsPerUser="20"}
In PS:
command COPY
Set -It em WSMan:\localhost \Shell\MaxShellsPerUser 20
c. Modify MaxMemoryPerShellMB:
In CLI:
command COPY
winrm set winrm/cong/winrs @{MaxMemoryPerShellMB="1024"}
In PS:
command COPY
Set -It em WSMan:\localhost \Shell\MaxMemoryPerShellMB 1024
5. To ensure SCOM integration works in mixed domain environments, set the following registry entry.
Path: HKLM:\SOFT WARE\Microsoft\Windows\CurrentVersion\Policies\System
Key: LocalAccountTokenFilterPolicy
Type: DWord
Value: 1
Warning: Editing the registry 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.
Once SCOM integration is set up you might see the message "Cannot get the latest SCOM alerts. View the Director server

event logs for more information". T he server event logs help identify and correct the problem. Causes can include:
Loss of network connectivity at the Director or SCOM machine.

T he SCOM service is not available or too busy to respond.
Failed authorization due to a change in permissions for the configured user.
An error in Director while processing the SCOM data.
PowerShell version mismatch between Director and SCOM server.

Delegated Administration and Director
May 22, 20 17
Delegated Administration uses three concepts: administrators, roles, and scopes. Permissions are based on an
administrator's role and the scope of this role. For example, an administrator might be assigned a Help Desk administrator
role where the scope involves responsibility for end-users at one Site only.
For information about creating delegated administrators, see the main Delegated Administration document.
Administrative permissions determine the Director interface presented to administrators and the tasks they can perform.
Permissions determine:
T he views the administrator can access, collectively referred to as a view.
T he desktops, machines, and sessions that the administrator can view and interact with.
T he commands the administrator can perform, such as shadowing a user's session or enabling maintenance mode.
T he built-in roles and permissions also determine how administrators use Director:
Administrator Permissions in Director

Role
Full Full access to all views and can perform all commands, including shadowing a user's session, enabling
Administrator maintenance mode, and exporting trends data.
Delivery Group Full access to all views and can perform all commands, including shadowing a user's session, enabling
Administrator maintenance mode, and exporting trends data.
Read Only Can access all views and see all objects in specified scopes as well as global information. Can
Administrator download reports from HDX channels and can export T rends data using the Export option in the
T rends view.
Cannot perform any other commands or change anything in the views.
Help Desk Can access only the Help Desk and User Details views and can view only objects that the
Administrator administrator is delegated to manage. Can shadow a user's session and perform commands for that
user. Can perform maintenance mode operations. Can use power control options for Desktop OS
Machines.
Cannot access the Dashboard, Trends, Alerts, or Filters views. Cannot use power control options for
Server OS machines.
Machine No access. T his administrator is not supported for Director and cannot view data. T his user can
Catalog access the Machine Details page (Machine-based search).
Administrator
Host No access. T his administrator is not supported for Director and cannot view data.
Administrator
To congure custom roles f or Director administrators

In Studio, you can also congure Director-specic, custom roles to more closely match the requirements of your
organization and delegate permissions more exibly. For example, you can restrict the built-in Help Desk administrator role
so that this administrator cannot log off sessions.
If you create a custom role with Director permissions, you must also give that role other generic permissions:
Delivery Controller permission to log on to Director.
Permissions to Delivery Groups to view the data related to those Delivery Groups in Director.
Alternatively, you can create a custom role by copying an existing role and include additional permissions for different views.
For example, you can copy the Help Desk role and include permissions to view the Dashboard or Filters pages.
Select the Director permissions for the custom role, which include:
Perform Kill Application running on a machine

Perform Kill Process running on a machine
Perform Remote Assistance on a machine
Perform Reset vDisk operation
Reset user profiles
View Client Details page
View Dashboard page
View Filters page
View Machine Details page
View T rends page
View User Details page
In this example, Shadowing (Perform Remote Assistance on a machine) is turned off.
In addition, from the list of permissions for other components, consider these permissions:
From Delivery Groups:

Enable/disable maintenance mode of a machine using Delivery Group membership.
Perform power operations on Windows Desktop machines using Delivery Group membership.
Perform session management on machines using Delivery Group membership.

Secure Director deployment
May 22, 20 17
T his article highlights areas that might have an impact on system security when deploying and conguring Director.
Congure Microsof t Internet Inf ormation Services (IIS)
You can congure Director with a restricted IIS conguration. Note that this is not the default IIS conguration.
Filename extensions
You can disallow unlisted le name extensions.
Director requires these le name extensions in Request Filtering:
.aspx
.css
.html
.js
.png
.svc
Director requires the following HT T P verbs in Request Filtering. You can disallow unlisted verbs.
GET
POST
HEAD
Director does not require:
ISAPI filters
ISAPI extensions
CGI programs
FastCGI programs
Important:
Director requires Full T rust. Do not set the global .NET trust level to High or lower.
Director maintains a separate application pool. T o modify the Director settings, select the Director Site and modify.
Congure user rights
When Director is installed, its application pools are granted the logon right Log on as a service and the privileges Adjust
memory quotas for a process, Generate security audits, and Replace a process level token. T his is normal installation
behavior when application pools are created.
You do not need to change these user rights. T hese privileges are not used by Director and are automatically disabled.
Director communications
In a production environment, Citrix recommends using the Internet Protocol security (IPsec) or HT T PS protocols to secure
data passing between Director and your servers. IPsec is a set of standard extensions to the Internet Protocol that

provides authenticated and encrypted communications with data integrity and replay protection. Because IPsec is a
network-layer protocol set, higher level protocols can use it without modication. HT T PS uses the Transport Layer Security
(T LS) protocols to provide strong data encryption.
Note:
Citrix strongly recommends that you do not enable unsecured connections to Director in a production environment.
Secure communications from Director requires configuration for each connection separately.
T he SSL protocol is not recommended. Use T LS instead.
You must secure communications with NetScaler using T LS, not IPsec.
To secure communications between Director and XenApp/XenDesktop servers (for monitoring and reports), refer to
Securing endpoints using T LS.
To secure communications between Director and NetScaler (for NetScaler Insight), refer to Congure network analysis.
To secure communications between Director and License server, refer to Secure the License Administration Console.
Director security separation
If you deploy any web applications in the same web domain (domain name and port) as Director, then any security risks in
those web applications could potentially reduce the security of your Director deployment. Where a greater degree of
security separation is required, Citrix recommends that you deploy Director in a separate web domain.

Congure permissions for VDAs earlier than
XenDesktop 7
May 22, 20 17
If users have VDAs earlier than XenDesktop 7 installed on their devices, Director supplements information from the
deployment with real-time status and metrics through Windows Remote Management (WinRM).
In addition, use this procedure to congure WinRM for use with Remote PC in XenDesktop 5.6 Feature Pack1.
By default, only local administrators of the desktop machine (typically domain administrators and other privileged users)
have the necessary permissions to view the real-time data.
For information about installing and conguring WinRM, see CT X125243.
To enable other users to view the real-time data, you must grant them permissions. For example, suppose there are several
Director users (HelpDeskUserA, HelpDeskUserB, and so on) who are members of an Active Directory security group called
HelpDeskUsers. T he group has been assigned the Help Desk administrator role in Studio, providing them with the required
Delivery Controller permissions. However, the group also needs access to the information from the desktop machine.
T o provide the necessary access, you can configure the required permissions in one of two ways:
Grant permissions to the Director users (impersonation model)
Grant permissions to the Director service (trusted subsystem model)
To grant permissions to the Director users (impersonation model)
By default, Director uses an impersonation model: T he WinRM connection to the desktop machine is made using the
Director user's identity. It is therefore the user that must have the appropriate permissions on the desktop.
You can congure these permissions in one of two ways (described later in this document):
1. Add users to the local Administrators group on the desktop machine.

2. Grant users the specific permissions required by Director. T his option avoids giving the Director users (for example, the
HelpDeskUsers group) full administrative permissions on the machine.
To grant permissions to the Director service (trusted subsystem model)
Instead of providing the Director users with permissions on the desktop machines, you can congure Director to make
WinRM connections using a service identity and grant only that service identity the appropriate permissions.
With this model, the users of Director have no permissions to make WinRM calls themselves. T hey can only access the data
using Director.
T he Director application pool in IIS is congured to run as the service identity. By default, this is the APPPOOL\Director
virtual account. When making remote connections, this account appears as the server's Active Directory computer account;
for example, MyDomain\DirectorServer$. You must congure this account with the appropriate permissions.
If multiple Director websites are deployed, you must place each web server's computer account into an Active Directory
security group that is congured with the appropriate permissions.
To set Director to use the service identity for WinRM instead of the user's identity, congure the following setting, as

described in Advanced conguration:
Service.Connector.WinRM.Identity = Service
You can congure these permissions in one of two ways:
1. Add the service account to the local Administrators group on the desktop machine.
2. Grant the service account the specific permissions required by Director (described next). T his option avoids giving the
service account full administrative permissions on the machine .
To assign permissions to a specic user or group
T he following permissions are required for Director to access the information it requires from the desktop machine through
WinRM:
Read and execute permissions in the WinRM RootSDDL

WMI namespace permissions:
root/cimv2 - remote access
root/citrix - remote access
root/RSOP - remote access and execute
Membership of these local groups:
Performance Monitor Users
Event Log Readers
T he CongRemoteMgmt.exe tool, used to automatically grant these permissions, is on the installation media in the
x86\Virtual Desktop Agent and x64\Virtual Desktop Agent folders and on the installation media in the tools folder. You
must grant permissions to all Director users.
To grant the permissions to an Active Directory security group, user, computer account, or for actions like End Application
and End Process, run the tool with administrative privileges from a command prompt using the following arguments:
ConfigRemoteMgmt.exe /configwinrmuser domain\name

where name is a security group, user, or computer account.
To grant the required permissions to a user security group:
ConfigRemoteMgmt.exe /configwinrmuser domain\HelpDeskUsers

To grant the permissions to a specic computer account:
ConfigRemoteMgmt.exe /configwinrmuser domain\DirectorServer$

For End Process, End Application, and Shadow actions:
ConfigRemoteMgmt.exe /configwinrmuser domain\name /all

To grant the permissions to a user group:
ConfigRemoteMgmt.exe /configwinrmuser domain\HelpDeskUsers /all

To display help for the tool:
ConfigRemoteMgmt.exe

Congure network analysis
May 22, 20 17
Note: T he availability of this feature depends on your organization's license and your administrator permissions.
Director integrates with NetScaler Insight Center or NetScaler MAS to provide network analysis and performance
management:
Network analysis leverages HDX Insight reports from NetScaler Insight Center or NetScaler MAS to provide an
application and desktop contextual view of the network. With this feature, Director provides advanced analytics of ICA
traffic in your deployment.
Performance management provides historical retention and trend reporting. With historical retention of data versus the
real-time assessment, you can create T rend reports, including capacity and health trending.
After you enable this feature in Director, HDX Insight reports provide Director with additional information:
T he Network tab in the T rends page shows latency and bandwidth effects for applications, desktops, and users across
your entire deployment.
T he User Details page shows latency and bandwidth information specific to a particular user session.
Limitations:
ICA session Round T rip T ime (RT T ) shows data correctly for Receiver for Windows 3.4 or later and the Receiver for Mac
11.8 or later. For earlier versions of these Receivers, the data does not display correctly.
In the T rends view, HDX connection logon data is not collected for VDAs earlier than 7. For earlier VDAs, the chart data
is displayed as 0.
To enable network analysis, you must install and congure NetScaler Insight Center or NetScaler MAS in Director. Director
requires NetScaler MAS Version 11.1 Build 49.16 or later. Insight Center and MAS are Virtual appliances that run on the Citrix
XenServer. Using network analysis, Director communicates and gathers the information that is related to your deployment.
For more information, see the NetScaler Insight Center or NetScaler MAS documentation.
1. On the server where Director is installed, locate the DirectorConfig command line tool in
C:\inetpub\wwwroot\Director\tools, and run it with parameter /confignetscaler from a command prompt.
2. When prompted, enter the NetScaler Insight Center or NetScaler MAS machine name (FQDN or IP address), enter the
username, password, HT T P or HT T PS connection type, and choose NetScaler Insight or NetScaler MAS integration.
3. T o verify the changes, log off and log back on.

Troubleshoot user issues
May 22, 20 17
Use the Director's Help Desk view (Activity Manager page) to view information about the user:
Check for details about the user's logon, connection, and applications.
Shadow the user's machine.
T roubleshoot the issue with the recommended actions in the following table, and, if needed, escalate the issue to the
appropriate administrator.
Troubleshooting tips
User's issue See these suggestions:
Logon takes a long time or fails intermittently or repeatedly Diagnose user logon issues
Application is slow or won't respond Resolve application failures
Connection failed Restore desktop connections
Session is slow or not responding Restore sessions
Video is slow or poor quality Run HDX channel system reports
Note: T o make sure that the machine is not in maintenance mode, from the User Details view, review the Machine Details
panel.
Search tips
When you type the user's name in a Search eld, Director searches for users in Active Directory for users across all sites
congured to support Director.
When you type a multiuser machine name in a Search eld, Director displays the Machine Details for the specied machine.
When you type an endpoint name in a Search eld, Director uses the unauthenticated (anonymous) and authenticated
sessions that are connected to a specic endpoint, which enables troubleshooting unauthenticated sessions. Ensure that
endpoint names are unique to enable troubleshooting of unauthenticated sessions.
T he search results also include users who are not currently using or assigned to a machine.
Searches are not case-sensitive.

Partial entries produce a list of possible matches.
After you type a few letters of a two-part name (username, family name and first name, or display name), separated by a
space, the results include matches for both strings. For example, if you type jo rob, the results might include strings such
as John Robertson or Robert, Jones.
To return to the landing page, click the Director logo.

Access Citrix Insight Services
You can access Citrix Insight Services (CIS) from the User drop-down in Director to access additional diagnostic insights. T he
data available in CIS comes from sources including Call Home and Citrix Scout.
Upload troubleshooting inf ormation to Citrix Technical Support
Run Citrix Scout from a single Delivery Controller or VDA to capture key data points and Citrix Diagnosis Facility (CDF) traces
to troubleshoot selected computers. Scout offers the ability to securely upload the data to Citrix Insight Services (CIS)
platform to assist Citrix Technical Support on troubleshooting. Citrix Technical Support uses the CIS platform to reduce the
time to resolve customer-reported issues.
Scout is installed with XenApp or XenDesktop components. Depending on the version of Windows, Scout appears in the
Windows Start Menu or Start Screen when you install or upgrade to XenDesktop 7.1, XenDesktop 7.5, XenApp 7.5,
XenDesktop 7.6, XenApp 7.6, XenDesktop 7.7, or XenApp 7.7.
To start Scout, from the Start Menu or Start Screen, select Citrix > Citrix Scout.
For information on using and conguring Scout, and for frequently asked questions, see CT X130147.

Diagnose user logon issues
May 22, 20 17
Use Logon Duration data to troubleshoot user logon issues. In the User Details view, the duration is displayed as a number
value below which the time the logon occurred is displayed and a graph of the phases of the logon process.
Logon Duration panel in the User Details view
As users logon to XenApp and XenDesktop, the Monitor Service tracks the phases of the logon process from the time the
user connects from Citrix Receiver to the time when the desktop is ready to use. T he large number on the left is the total
logon time and is calculated by combining the time spent establishing the connection and obtaining a desktop from the
Delivery Controller with the time spent to authenticate and logon to a virtual desktop. T he duration information is
presented in seconds (or fractions of seconds) in the local time of the Administrators web browser.
Use these general steps to troubleshoot user logon issues:
1. From the User Details view, troubleshoot the logon state using the Logon Duration panel.
If the user is logging on, the view reflects the process of logging on.
If the user is currently logged on, the Logon Duration panel displays the time it took for the user to log on to the
current session.
2. Examine the phases of the logon process.
Logon process phase Description
Brokering T ime taken to decide which desktop to assign to the user.
VM start If the session required a machine start, this is the time

taken to start the virtual machine.
HDX connection T ime taken to complete the steps required in setting up

the HDX connection from the client to the virtual
machine.
Authentication T ime taken to complete authentication to the remote

session.

GPOs If Group Policy settings are enabled on the virtual
machines, this is the time taken to apply group policy
objects.
Login scripts If logon scripts are congured for the session, this is the
time taken for the logon scripts to be executed.
Prole load If prole settings are congured for the user or the virtual
machine, this is the time taken for the prole to load.
Interactive Session T his is the time taken to "hand off " keyboard and mouse
control to the user after the user prole has been loaded.
It is normally the longest duration out of all the phases of
the logon process and is calculated as follows:
Interactive Session duration = Desktop Ready Event

T imestamp (EventId 1000 on VDA) - User Prole Loaded
Event T imestamp (EventId 2 on VDA)
T he total logon time is not an exact sum of these phases. For example, some phases occur in parallel, and in some phases,
additional processing occurs that might result in a longer logon duration than the sum.
Note: T he Logon Duration graph shows the logon phases in seconds. Any duration values below one second are displayed
as sub-second values. T he values above one second are rounded to the nearest 0.5 second. T he graph has been designed
to show the highest y-axis value as 200 seconds. Any value higher than 200 seconds is shown with the actual value
displayed above the bar.
Troubleshooting tips
To identify unusual or unexpected values in the graph, compare the amount of time taken in each phase of the current
session with the average duration for this user for the last seven days, and the average duration for all users in this Delivery
Group for the last seven days.
Escalate as needed. For example, if the VM startup is slow, the issue could be in the hypervisor, so you can escalate it to the
hypervisor administrator. Or, if the brokering time is slow, you can escalate the issue to the Site administrator to check the
load balancing on the Delivery Controller.
Examine unusual differences, including:
Missing (current) logon bars

Major discrepancy between the current duration and this user's average duration. Causes could include:
A new application was installed.
An operating system update occurred.
Configuration changes were made.
Profile size of the user is high. In this case, the Profile Load will be high.
Major discrepancy between the user's logon numbers (current and average duration) and the Delivery Group average

duration.
If needed, click Restart to observe the user's logon process to troubleshoot issues, such as VM Start or Brokering.

Shadow users
May 22, 20 17
From Director, use the shadow user feature to view and work directly on a user's virtual machine or session. T he user must
be connected to the machine that you want to shadow. Verify this by checking the machine name listed in the user title
bar.
1. In the User Details view, select the user session.
2. Activate shadowing for the selected user session:
For machine monitoring, in the Activity Manager view, click Shadow.
For session monitoring, in the User Details view, locate the Session Details panel and click Shadow.
3. After the connection initializes, a dialog box prompts you to open or save the .msrcincident file.
4. Open the incident file with the Remote Assistance Viewer, if not already selected by default. A confirmation prompt
appears on the user device.
5. Instruct the user to click Yes to start the machine or session sharing.
For additional control, ask the user to share keyboard and mouse control.
Streamline Microsof t Internet Explorer browsers f or shadowing
Congure your Microsoft Internet Explorer browser to automatically open the downloaded Microsoft Remote Assistance
(.msra) le with the Remote Assistance client.
To do this, you must enable the Automatic prompting for le downloads setting in the Group Policy editor:
Computer Conguration > Administrative Templates > Windows Components > Internet Explorer > Internet Control Panel >
Security Page > Internet Zone > Automatic prompting for le downloads.
By default, this option is enabled for Sites in the Local intranet zone. If the Director Site is not in the Local intranet zone,
consider manually adding the Site to this zone.

Send messages to users
May 22, 20 17
From Director, send a message to a user who is connected to one or more machines. For example, use this feature to send
immediate notices about administrative actions such as impending desktop maintenance, machine logoffs and restarts, and
profile resets.
1. In the Activity Manager view, select the user and click Details.
2. In the User Details view, locate the Session Details panel and click Send Message.
3. T ype your message information in the Subject and Message fields, and click Send.
If the message is sent successfully, a conrmation message appears in Director. If the user's machine is connected, the
message appears there.
If the message is not sent successfully, an error message appears in Director. Troubleshoot the problem according to the
error message. When you have nished, type the subject and message text again and click Try again.

Resolve application failures
May 22, 20 17
In the Activity Manager view, click the Applications tab. You can view all the applications on all machines to which this user
has access, including local and hosted applications for the currently connected machine, and the current status of each.
Note: If the Applications tab is greyed out, contact an administrator with the permission to enable the tab.
T he list includes only those applications that were launched within the session.
For Server OS machines and Desktop OS machines, applications are listed for each disconnected session. If the user is not
connected, no applications are displayed.
Action Description
End the application that is not responding Choose the application that is not responding and click End
Application. Once the application is terminated, ask the user to launch
it again.
End processes that are not responding If you have the required permission, click the Processes tab. Select a
process that is related to the application or using a high amount of
CPU resources or memory, and click End Process.
However, if you do not have the required permission to terminate the

process, attempting to end a process will fail.
Restart the user's machine For Desktop OS machines only, for the selected session, click Restart.
Alternatively, from the Machine Details view, use the power controls
to restart or shut down the machine. Instruct the user to log on again
so that you can recheck the application.
For Server OS machines, the restart option is not available. Instead, log
off the user and let the user log on again.
Put the machine into maintenance mode If the machine's image needs maintenance, such as a patch or other
updates, put the machine into maintenance mode. From the Machine
Details view, click Details and turn on the maintenance mode option.
Escalate to the appropriate administrator.

Restore desktop connections
May 22, 20 17
From Director, check the user's connection status for the current machine in the user title bar.
If the desktop connection failed, the error that caused failure is displayed and can help you decide how to troubleshoot.
Action Description
Ensure that the On the User Details page, make sure maintenance mode is turned off.
machine is not in
maintenance mode
Restart the user's Select the machine and click Restart. Use this option if the user's machine is unresponsive or
machine unable to connect, such as when the machine is using an unusually high amount of CPU
resources, which can make the CPU unusable.

Restore sessions
May 22, 20 17
If a session becomes disconnected, it is still active and its applications continue to run, but the user device is no longer
communicating with the server.
In the User Details view, troubleshoot session failures in the Session Details panel. You can view the details of the current
session, indicated by the session ID.
Action Description
End Click the Applications tab. Select any application that is not responding and click End Application.
applications or Similarly, select any corresponding process that is not responding and click End Process. Also, end
processes that processes that are consuming an unusually high amount of memory or CPU resources, which can
are not make the CPU unusable.
responding
Disconnect the Click Session Control and then select Disconnect. T his option is available only for brokered Server OS
Windows machines. For non-brokered sessions, the option is disabled.
session
Log off the Click Session Control and then select Log Off.
user from the
session
To test the session, the user can attempt to log back onto it. You can also shadow the user to more closely monitor this
session.
Note: If user devices are running VDAs earlier than XenDesktop 7, Director cannot display complete information about the
session; instead, it displays a message that the information is not available. T hese messages might appear in the User
Details page and Activity Manager.

Run HDX channel system reports
May 22, 20 17
In the User Details view, check the status of the HDX channels on the user's machine in the HDX panel. T his panel is
available only if the user machine is connected using HDX.
If a message appears indicating that the information is not currently available, wait for one minute for the page to refresh,
or select the Refresh button. HDX data takes a little longer to update than other data.
Click an error or warning icon for more information.
Tip: You can view information about other channels in the same dialog box by clicking the left and right arrows in the left
corner of the title bar.
HDX channel system reports are used mainly by Citrix Support to troubleshoot further.
1. In the HDX panel, click Download System Report.

2. You can view or save the .xml report file.
T o view the .xml file, click Open. T he .xml file appears in the same window as the Director application.
T o save the .xml file, click Save. T he Save As window appears, prompting you for a location on the Director machine to
download the file to.

Reset a Personal vDisk
May 22, 20 17
Caution: When you reset the disk, the settings revert to their factory default values and all data on it is deleted, including
applications. T he profile data is retained unless you modified the Personal vDisk default (of redirecting profiles from the C:
drive), or you are not using a third-party profile solution.
To reset, the machine with the Personal vDisk must be running; however, the user does not have to be logged on to it.
T his option is available only for Desktop OS machines; it is disabled for Server OS machines.
1. From the Help Desk view, choose the targeted Desktop OS machine.
2. From this view or in the Personalization panel of the User Details view, click Reset Personal vDisk.
3. Click Reset. A message appears warning that the user will be logged off. After the user is logged off (if the user was
logged on), the machine restarts.
If the reset is successful, the Personal vDisk status field value in the Personalization panel of the User Details view is
Running. If the reset is unsuccessful, a red X to the right of the Running value appears. When you point to this X,
information about the failure appears.

Reset a user prole
May 22, 20 17
Caution: When a profile is reset, although the user's folders and files are saved and copied to the new profile, most user
profile data is deleted (for example, the registry is reset and application settings might be deleted).
1. From Director, search for the user whose profile you want to reset and select this user's session.
2. Click Reset Prof ile.
3. Instruct the user to log off from all sessions.
4. Instruct the user to log back on. T he folders and files that were saved from the user's profile are copied to the new
profile.
Important: If the user has profiles on multiple platforms (such as Windows 8 and Windows 7), instruct the user to log
back on first to the same desktop or app that the user reported as a problem. T his ensures that the correct profile is
reset.
If the profile is a Citrix user profile, the profile is already reset by the time the user's desktop appears. If the profile is a
Microsoft roaming profile, the folder restoration might still be in progress for a brief time. T he user must stay logged on
until the restoration is complete.
Note: T he preceding steps assume you are using XenDesktop (Desktop VDA). If you are using XenApp (Server VDA) you
need to be logged on to perform the profile reset. T he user then needs to log off, and log back on to complete the profile
reset.
If the profile is not successfully reset (for example, the user cannot successfully log back on to the machine or some of the
files are missing), you must manually restore the original profile.
T he folders (and their les) from the user's prole are saved and copied to the new prole. T hey are copied in the listed
order:
Desktop
Cookies
Favorites
Documents
Pictures
Music
Videos
Note: In Windows 8 and later, cookies are not copied when profiles are reset.
How reset proles are processed
Any Citrix user prole or Microsoft roaming prole can be reset. After the user logs off and you select the reset command
(either in Director or using the PowerShell SDK), Director rst identies the user prole in use and issues an appropriate
reset command. Director receives the information through Prole management, including information about the prole size,
type, and logon timings.
T his diagram illustrates the process following the user log on.

1. T he reset command issued by Director specifies the profile type. T he Profile management service then attempts to reset
a profile of that type and looks for the appropriate network share (user store). If the user is processed by Profile
management, but receives a roaming profile command, it is rejected (or vice versa).
2. If a local profile is present, it is deleted.
3. T he network profile is renamed.
4. T he next action depends on whether the profile being reset is a Citrix user profile or a Microsoft roaming profile.
For Citrix user profiles, the new profile is created using the Profile management import rules, and the folders are
copied back to the network profile, and the user can log on normally. If a roaming profile is used for the reset, any
registry settings in the roaming profile are preserved in the reset profile.
Note: You can configure Profile management so that a template profile overrides the roaming profile, if required.
For Microsoft roaming profiles, a new profile is created by Windows, and when the user logs on, the folders are copied
back to the user device. When the user logs off again, the new profile is copied to the network store.
To manually restore a prole af ter a f ailed reset
1. Instruct the user to log off from all sessions.

2. Delete the local profile if one exists.
3. Locate the archived folder on the network share that contains the date and time appended to the folder name, the
folder with a .upm_datestamp extension.
4. Delete the current profile name; that is, the one without the upm_datestamp extension.
5. Rename the archived folder using the original profile name; that is, remove the date and time extension. You have
returned the profile to its original, pre-reset state.

Troubleshoot applications
May 22, 20 17
You can troubleshoot applications and sessions by using the idle time metric to identify instances that are idle beyond a
specic time limit.
Typical use cases for application-based troubleshooting are in the healthcare sector, where employees share application
licenses. T here, you must end idle sessions and application instances to purge the XenApp and XenDesktop environment, to
recongure poorly performing servers, or to maintain and upgrade applications.
T he Application Instances lter page lists all application instances on VDAs of Server and Desktop OS. T he associated idle
time measurements are displayed for application instances on VDAs of Server OS that have been idle for at least 10
minutes.
Note: T he Application Instances metrics are available on Sites of all license editions.
Use this information to identify the application instances that are idle beyond a specic time period and log off or
disconnect them as appropriate. To do this, select Filters > Application Instances and select a pre-saved lter or choose
All Application Instances and create your own lter.
An example of a lter would be as follows. As Filter by criteria, choose Published Name (of the application) and Idle Time.
T hen, set Idle Time to greater than or equal to a specic time limit and save the lter for reuse. From the ltered list,
select the application instances you want to end. From the Session Control drop-down, choose Logof f or Disconnect.
Note: Logging off or disconnecting an application instance logs off or disconnects the current session, thereby ending all
application instances that belong to the same session.
You can identify idle sessions from the Sessions lter page using the session state and the session idle time metric. Sort by
the Idle Time column or dene a lter to identify sessions that are idle beyond a specic time limit. Idle time is listed for
sessions on VDAs of Server OS that have been idle for at least 10 minutes.

T he Idle time is displayed as N/A when the session or application instance
has not been idle for more than 10 minutes,

is launched on a VDA of Desktop OS, or
is launched on a VDA running Version 7.12 or earlier.

Troubleshoot machines
May 22, 20 17
In the Filters > Machines view, select Desktop OS Machines or Server OS Machines to see the machines congured in
the Site. T he Server OS Machines tab includes the load evaluator index , which indicates the distribution of performance
counters and tool tips of the session count if you hover over the link.
Click the Failure Reason of a failed machine to get a detailed description of the failure and actions recommended to
troubleshoot the failure. T he failure reasons and the recommended actions for machine and connection failures are
available in the Citrix Director 7.12 Failure Reasons Troubleshooting Guide.
Click the machine name link to go to the Machine Details page. T he Machine Details page lists the machine details,
infrastructure details, and details of the hotxes applied on the machine. T he Machine Utilization panel displays the
machine utilization graphs.
Machine-based real-time resource utilization
T he Machine Utilization panel displays graphs showing real-time utilization of CPU and memory . In addition, disk and GPU
monitoring graphs are available for Sites with Delivery Controller(s) and VDA versions 7.14 or later.
Disk monitoring graphs, average IOPS, and disk latency are important performance measurements that help you monitor
and troubleshoot issues related to VDA disks. T he Average IOPS graph displays the average number of reads and writes to
a disk. Select Disk Latency to see a graph of the delay between a request for data and its return from the disk, measured
in milliseconds.

Select GPU Utilization to see percentage utilization of the GPU, the GPU memory, and of the Encoder and the Decoder to
troubleshoot GPU-related issues on Server or Desktop OS VDAs. T he GPU Utilization graphs are available only for VDAs
running 64-bit Windows with NVIDIA Tesla M60 GPUs, and running Display Driver version 369.17 or later.
T he VDAs must have HDX 3D Pro enabled to provide GPU acceleration. For more information, see GPU acceleration for
Windows Desktop OS and GPU acceleration for Windows Server OS.
When a VDA accesses more than one GPU, the utilization graph displays the average of the GPU metrics collected from the
individual GPUs. T he GPU metrics are collected for the entire VDA and not for individual processes.
Machine-based historical resource utilization
In the Machine Utilization panel, click View Historical Utilization to view the historical usage of resources on the
selected machine.
T he utilization graphs include critical performance counters of CPU, memory, peak concurrent sessions, average IOPS, and
disk latency.
Note: T he Monitoring policy setting, Enable Process Monitoring, must be set to Allowed to collect and display data in the
Top 10 Processes table on the Historic Machine Utilization page. T he collection is prohibited by default.
T he CPU and memory utilization, average IOPS, and disk latency data is collected by default. You can disable the collection
by using the Enable Resource Monitoring policy setting.
1. From the Machine Utilization panel in the Machine Details view, select View Historical Utilization. T his opens the
Historical Machine Utilization page.
2. Set Time Period to view usage for the last 2 hours, 24 hours, 7 days, month, or year.
Note: Average IOPS and disk latency usage data are available only for the last 24 hours, month, and year ending now.
Custom end time is not supported.

3. Click Apply and select the required graphs.
4. Hover over different sections of the graph to view more information for the selected time period.
For example, if you select Last 2 hours, the baseline period is the 2 hours prior to the selected time range. View the CPU,
memory, and session trend over the last 2 hours and the baseline time.
If you select Last month, the baseline period is the previous month. Select to view the Average IOPS and disk latency over
the last month and the baseline time.
5. Click Export to export the resource utilization data for the selected period. For more information, see Export reports
section in Monitor Deployments.
6. Below the graphs, the table lists the top 10 processes based on CPU or memory utilization. You can sort by any of the
columns, which show Application Name, User Name, Session ID, Average CPU, Peak CPU, Average Memory, and Peak
Memory over the selected time range. T he IOPS and Disk Latency columns cannot be sorted.
Note: T he session ID for system processes is displayed as "0000".

7. To view the historical trend on the resource consumption of a particular process, drill into any of the Top 10 processes.

SDKs and APIs
May 22, 20 17
Several SDKs and APIs are available with this release. For details, see SDK. T hat article links to reference guides for:
Delivery Controller SDK. Also, see Delivery Controller SDK below.

Monitor Service OData API. Also, see the Monitor Service OData API articles.
StoreFront SDK.
T he Citrix Group Policy SDK allows you to display and congure Group Policy settings and lters. It uses a PowerShell
provider to create a virtual drive that corresponds to the machine and user settings and lters. T he provider appears as an
extension to New-PSDrive. To use the Group Policy SDK, either Studio or the XenApp and XenDesktop SDK must be
installed. See Group Policy SDK for more information.
Delivery Controller SDK

Beginning with version 7.x, XenApp and XenDesktop share a unied architecture and management: the FlexCast
Management Architecture. T his means that XenApp provides many features previously only available in XenDesktop;
elements of the SDK that relate to common features therefore apply equally to both XenApp and XenDesktop, even
though the commands themselves refer only to XenDesktop.
Dif f erences between the XenDesktop 5 and XenDesktop 7 SDKs
If you are familiar with the XenDesktop 5 SDK, the following list summarizes the differences in 7.x versions of the XenApp
and XenDesktop SDK.
New high-level SDK XenDesktop 7 provides a new high-level SDK that enables you to script and automate site
creation and maintenance quickly and easily. T he high-level SDK insulates you from much of the complexity of the low-
level SDKs, so you can create a new Site simply by running two cmdlets.
New low-level SDKs Individual low-level SDKs are provided for the new XenDesktop 7 services, including a dedicated
and enhanced SDK for the Delegated Administration Service (DAS), which was previously part of the Broker SDK in
XenDesktop 5. T here are also SDKs for new features including the Monitor Service, Environment T est, and Configuration
Logging.
Windows Server OS Machine Catalogs and Delivery Groups You can use the XenDesktop 7 SDK to deliver cost-
effective applications and desktops hosted on server operating systems.
Desktop OS Machine applications Desktop OS Machine applications have changed significantly at the SDK level. If
you have existing scripts for running applications on Desktop OSs, you will have to update these scripts for XenDesktop
7, because there is little backwards compatibility.
Apply settings to machines in Delivery Groups In XenDesktop 7, using configuration slots, you can apply settings
to machines in a specific delivery group, rather than to all machines in a site. T his enables you to configure, for a given
delivery group, which settings apply to that group. A number of pre-defined configuration slots are provided that contain
different types of settings, such as settings for StoreFront addresses for use with Receiver or App-V publishing server
locations. You can use one collection of settings from a slot to affect only a particular delivery group, and a different
collection of settings from the same slot to affect another delivery group. You can use names appropriate to your
particular deployment; for example, "Sales Department policy."
Catalog types replaced In XenDesktop 7, catalog types have been replaced by catalogs with individual properties.

However, for backwards compatibility, you can still use existing scripts that employ catalog types, such as single image
(pooled) and thin clone (dedicated) etc., but internally these are converted into sets of properties. Caution: Backwards
compatibility with XenDesktop 5 catalog types has been maintained where possible and practicable. However, when
writing new scripts, do not use catalog types; instead, specify catalogs with individual properties.
Desktop object replaced In XenDesktop 5, the Desktop object is one of the main types of SDK object used in
Broker SDK scripts. T he Desktop object describes both the machine and the session on the machine. In XenDesktop 7,
this object is replaced by the Session object and the Machine object, both of which have been expanded to do the work
of the Desktop object. However, for backwards compatibility, you can still use existing scripts that employ the Desktop
object. Caution: Backwards compatibility with XenDesktop 5 has been maintained where possible and practicable.
However, when writing new scripts, do not use the Desktop object; instead, specify Session and Machine objects.
Dif f erences in policy rules
T here are differences between the SDK and the Studio console in terms of policy rules. Entitlement and assignment policy
rules are independent entities in the SDK; in the console, these entities are not visible as they are seamlessly merged with
the Delivery Group. Also, access policy rules are less restrictive in the SDK.
Use the Delivery Controller SDK
T he SDK comprises of a number of PowerShell snap-ins installed automatically by the installation wizard when you install
the Delivery Controller or Studio component.
Permissions: You must run the shell or script using an identity that has Citrix administration rights. Although members of the
local administrators group on the Controller automatically have full administrative privileges to allow XenApp or XenDesktop
to be installed, Citrix recommends that for normal operation, you create Citrix administrators with the appropriate rights,
rather than use the local administrators account. If you are running Windows Server 2008 R2, you must run the shell or
script as a Citrix administrator, and not as a member of the local administrators group.
To access and run the cmdlets:
1. Start a shell in PowerShell 3.0: Open Studio, select the PowerShell tab, and then click Launch PowerShell.
2. T o use SDK cmdlets within scripts, set the execution policy in PowerShell. For more information about PowerShell
execution policy, see the Microsoft documentation.
3. Add the snap-ins you require into the PowerShell environment using the Add -PSSnapin cmdlet in the Windows
PowerShell console.
V1 and V2 denote the version of the snap-in (XenDesktop 5 snap-ins are version 1; XenDesktop 7 snap-ins are version
2. For example, to install XenDesktop 7 snap-ins, type Add-PSSnapin Citrix.ADIdentity.Admin.V2). To import all the
cmdlets, type: Add-PSSnapin Citrix.*.Admin.V*
After adding the snap-ins, you can access the cmdlets and their associated help.
NOTE: To see the current XenApp and XenDesktop PowerShell cmdlet help:
1. From the PowerShell console, add the Citrix snap-ins: Add PSSnapin Citrix.*.Admin.V*.
2. Follow the instructions in PowerShell Integrated Scripting Environment (ISE).
Group Policy SDK

To use the Group Policy SDK, either Studio or the XenApp and XenDesktop SDK must in installed.
To add the Group Policy SDK, type Add-PSSnapin citrix.common.grouppolicy. (To access help, type: help New-PSDrive -
path localgpo:/)
To create a virtual drive and load it with settings, type: New-PSDrive < Standard Parameters > [-PSProvider]
CitrixGroupPolicy -Controller < string> where the Controller string is the fully qualied domain name of a Controller in the
Site you want to connect to and load settings from.

Monitor Service OData API
May 22, 20 17
In addition to using the Citrix Director console to display historical data, you can query data using the Monitor Service's API.
You can use the API to:
Analyze historical trends for future planning
Perform detailed troubleshooting of connection and machine failures
Extract information for feeding into other tools and processes; for example, using Microsoft Excel's PowerPivot tables
to display the data in different ways
Build a custom user interface on top of the data that the API provides
T he Monitor Service API uses the Open Data (OData) protocol, which is a Web protocol for querying and updating data,
built upon Web technologies such as HT T P. For more information about the OData protocol, see: http://www.odata.org.
T he Monitor Service API is built on top of SQL Server databases using Windows Communication Foundation (WCF) Data
Services that are populated during processing and consolidation. T wo endpoints are exposed using WCF with
wsHttpBinding. T he base address is: http:// {dc-host}/Citrix/Monitor/OData/v2. You can also use T LS to secure endpoints;
see Securing endpoints using T LS for more information.
1. T he Data endpoint exposes read-only access directly to the database entities and can be accessed using the OData
query language. T his endpoint allows highly flexible access in terms of filtering and column selection. T he Data API URI is:
http://{dc-host}/Citrix/Monitor/OData/v2/Data. For more information about accessing the Monitor Service data, see
Accessing data using the API.
2. T he Methods endpoint exposes service operations that are used by Citrix Director to retrieve data that requires complex
grouping and high performance standards, such as queries on the Dashboard and T rends pages. T he Methods API URI is:
http://{dc-host}/Citrix/Monitor/OData/v2/Methods. Methods are used only in Director itself so are not used by the
majority of Citrix customers. T hey are therefore not documented here.
What's new in this release?
T he version of the API included with XenApp and XenDesktop 7.6 provides the following new features:
Hotf ix inventory. Using the User Details view or Machine view in Director, you can see a list of all the Citrix hotfixes
that have been installed on a machine. You can use the API to extract this data and create custom reports (for example,
the state of installed hotfixes over an entire site) or pull it into an analytics engine. New classes have been introduced
and the Machine class has been extended to support tracking Citrix hotfixes installed on the controller and VDAs.
Anonymous session troubleshooting. Sessions can be run as a set of pooled local user accounts. T he API has a new
IsAnonymous property for the Session class (default value FALSE).
Hosted application usage reporting. Director provides new capacity reports that show the usage of hosted
applications over time. T he API allows you to report on the details of each application instance running in a user session.
All the updates to data are fully documented in the API Reference at http://support.citrix.com/help/monitorserviceapi/7.6/.
T he GetSessionSummary method has been deprecated at this release.

Accessing data using the API
May 22, 20 17
T he following types of data are available through the Monitor Service API:
Data relating to connection failures

Machines in a failure state
Session usage
Logon duration
Load balancing data
Hotfixes applied to a machine
Hosted application usage
For a full description of the data objects, see http://blogs.citrix.com/2013/08/27/xendesktop-7-monitor-service-what-

data-is-available/.
To use the Monitor Service OData API, you must be a XenApp or XenDesktop administrator. To call the API, you require
read-only privileges; however, the data returned is determined by XenApp or XenDesktop administrator roles and
permissions. For example, Delivery Group Administrators can call the Monitor Service API but the data they can obtain is
controlled by Delivery Group access set up using Citrix Studio. For more information about XenApp or XenDesktop
administrator roles and permissions, see Delegated Administration.
Querying the data
T he Monitor Service API is a REST -based API that can be accessed using an OData consumer. OData consumers are
applications that consume data exposed using the OData protocol. OData consumers vary in sophistication from simple
web browsers to custom applications that can take advantage of all the features of the OData Protocol. For more
information about OData consumers, see: http://www.odata.org/ecosystem#consumers.
Every part of the Monitor Service data model is accessible and can be ltered on the URL. OData provides a query language
in the URL format you can use to retrieve entries from a service. For more information, see: http://msdn.microsoft.com/en-
us/library/ff478141.aspx.
T he query is processed on the server side and can be ltered further using the OData protocol on the client side.
T he data modeled falls into three categories: aggregate data (the summary tables), current state of objects (machines,
sessions, etc.), and log data, which is really historical events (connections, for example).
Note: Enums are not supported in the OData protocol; integers are used in their place. T o determine the values returned by
the Monitor Service OData API, see http://support.citrix.com/help/monitorserviceapi/7.6/.
Aggregation of data values
T he Monitor Service collects a variety of data, including user session usage, user logon performance details, session load
balancing details, and connection and machine failure information. Data is aggregated differently depending on its
category. Understanding the aggregation of data values presented using the OData Method APIs is critical to interpreting
the data. For example:
Connected Sessions and Machine Failures occur over a period of time. T herefore, they are exposed as maximums over a
time period.

LogOn Duration is a measure of the length of time, therefore is exposed as an average over a time period.
LogOn Count and Connection Failures are counts of occurrences over a period of time, therefore are exposed as sums
over a time period.
Concurrent data evaluation
Sessions must be overlapping to be considered concurrent. However, when the time interval is 1 minute, all sessions in that
minute (whether or not they overlap) are considered concurrent: the size of the interval is so small that the performance
overhead involved in calculating the precision is not worth the value added. If the sessions occur in the same hour, but not in
the same minute, they are not considered to overlap.
Correlation of summary tables with raw data
T he data model represents metrics in two different ways.:

T he summary tables represent aggregate views of the metrics in per minute, hour, and day time granularities.
T he raw data represents individual events or current state tracked in the session, connection, application and other
objects.
When attempting to correlate data across API calls or within the data model itself, it is important to understand the
following concepts and limitations:
No summary data f or partial intervals. Metrics summaries are designed to meet the needs of historical trends over
long periods of time. T hese metrics are aggregated into the summary table for complete intervals. T here will be no
summary data for a partial interval at the beginning (oldest available data) of the data collection nor at the end. When
viewing aggregations of a day (Interval=1440), this means that the first and most recent incomplete days will have no
data. Although raw data may exist for those partial intervals, it will never be summarized. You can determine the earliest
and latest aggregate interval for a particular data granularity by pulling the min and max SummaryDate from a particular
summary table. T he SummaryDate column represents the start of the interval. T he Granularity column represents the
length of the interval for the aggregate data.
Correlating by time. Metrics are aggregated into the summary table for complete intervals as described above. T hey
can be used for historical trends, but raw events may be more current in the state than what has been summarized for
trend analysis. Any time-based comparison of summary to raw data needs to take into account that there will be no
summary data for partial intervals that may occur or for the beginning and ending of the time period.
Missed and latent events. Metrics that are aggregated into the summary table may be slightly inaccurate if events are
missed or latent to the aggregation period. Although the Monitor Service attempts to maintain an accurate current
state, it does not go back in time to recompute aggregation in the summary tables for missed or latent events.
Connection High Availability. During connection HA there will be gaps in the summary data counts of current
connections, but the session instances will still be running in the raw data.
Data retention periods. Data in the summary tables is retained on a different grooming schedule from the schedule for
raw event data. Data may be missing because it has been groomed away from summary or raw tables. Retention periods
may also differ for different granularities of summary data. Lower granularity data (minutes) is groomed more quickly
than higher granularity data (days). If data is missing from one granularity due to grooming, it may be found in a higher
granularity. Since the API calls only return the specific granularity requested, receiving no data for one granularity does
not mean the data doesn't exist for a higher granularity for the same time period.
Time zones. Metrics are stored with UT C time stamps. Summary tables are aggregated on hourly time zone boundaries.
For time zones that don't fall on hourly boundaries, there may be some discrepancy as to where data is aggregated.
Data granularity and retention

T he granularity of aggregated data retrieved by Director is a function of the time (T ) span requested. T he rules are as
follows:
0 < T <= 1 hour uses per-minute granularity
0 < T <= 30 days uses per-hour granularity
T > 31 days uses per-day granularity
Requested data that does not come from aggregated data comes from the raw Session and Connection information. T his
data tends to grow fast, and therefore has its own grooming setting. Grooming ensures that only relevant data is kept long
term. T his ensures better performance while maintaining the granularity required for reporting. Customers on Platinum
licensed Sites can change the grooming retention to their desired number of retention days, otherwise the default is used.
To access the settings, run the following PowerShell commands on the Delivery Controller:
command COPY
asnp Citrix.*
Get-Mo nito rCo nguratio n
Set-Mo nito rCo nguratio n -<setting name> <value>
T he following settings are used to control grooming:
Setting name Af f ected grooming Def ault Def ault

value value Non
Platinum Platinum
(days)
1 GroomSessionsRetentionDays Session and 90 7

Connection records
retention after Session
termination
2 GroomFailuresRetentionDays MachineFailureLog and 90 7

ConnectionFailureLog
records
3 GroomLoadIndexesRetentionDays LoadIndex records 90 7

4 GroomDeletedRetentionDays Machine, Catalog, 90 7
DesktopGroup and
Hypervisor entities that
have a LifecycleState
of 'Deleted'.
T his also deletes any

related Session,
SessionDetail, Summary,
Failure or LoadIndex
records.
5 GroomSummariesRetentionDays DesktopGroupSummary, 90 7
FailureLogSummary and
LoadIndexSummary
records. Aggregated
data - daily granularity.
6 GroomMachineHotxLogRetentionDays Hotxes applied to the 90 90

VDA and Controller
machines
7 GroomMinuteRetentionDays Aggregated data 3 3

minute granularity
8 GroomHourlyRetentionDays Aggregated data - 32 7

hourly granularity
9 GroomApplicationInstanceRetentionDays Application Instance 90 0

history
10 GroomNoticationLogRetentionDays Notication Log records 90
11 GroomResourceUsageRawDataRetentionDays Resource utilization 1 1

data raw data
12 GroomResourceUsageMinuteDataRetentionDays Resource utilization 7 7

summary data minute
granularity
13 GroomResourceUsageHourDataRetentionDays Resource utilization 30 7

summary data - hour
granularity
14 GroomResourceUsageDayDataRetentionDays Resource utilization 90 7

summary data day
granularity
15 GroomProcessUsageRawDataRetentionDays Process utilization data 1 1

raw data
16 GroomProcessUsageMinuteDataRetentionDays Process utilization data 3 3

minute granularity
17 GroomProcessUsageHourDataRetentionDays Process utilization data 7 7

hour granularity
18 GroomProcessUsageDayDataRetentionDays Process utilization data 30 7

day granularity
19 GroomSessionMetricsDataRetentionDays Session metrics data 7 7
20 GroomMachineMetricDataRetentionDays Machine metrics data 3 3
21 GroomMachineMetricDaySummaryDataRetentionDays Machine metrics 90 7

summary data
22 GroomApplicationErrorsRetentionDays Application error data 1 1
23 GroomApplicationFaultsRetentionDays Application failure data 1 1
Note: GroomApplicationErrorsRetentionDays and GroomApplicationFaultsRetentionDays do not function in product

version 7.14.
Caution: Modifying values on the Monitor Service database requires restarting the service for the new values to take
effect. You are advised to make changes to the Monitor Service database only under the direction of Citrix Support.
Notes on grooming retention:
Customers on Platinum licensed Sites can change the grooming retention to their desired number of retention days.
Otherwise, the default is used.
Customers on Enterprise licensed Sites - grooming begins at day 32.
Customers on non-Platinum and non-Enterprise Sites - grooming begins at day 8.

Retaining data for long periods will have the following implications on table sizes:
Hourly data. If hourly data is allowed to stay in the database for up to two years, a site of 1000 delivery groups could
cause the database to grow as follows:
1000 delivery groups x 24 hours/day x 365 days/year x 2 years = 17,520,000 rows of data. T he performance impact of
such a large amount of data in the aggregation tables is signicant. Given that the dashboard data is drawn from this
table, the requirements on the database server may be large. Excessively large amounts of data may have a dramatic
impact on performance.
Session and event data. T his is the data that is collected every time a session is started and a
connection/reconnection is made. For a large site (100K users), this data will grow very fast. For example, two years'
worth of these tables would gather more than a T B of data, requiring a high-end enterprise-level database.

Securing endpoints using TLS
May 22, 20 17
T his document explains how to use T LS to secure the Monitor Service OData API endpoints. If you choose to use T LS, you
must congure T LS on all Delivery Controllers in the site; you cannot use a mixture of T LS and non-T LS.
To secure Monitor Service endpoints using T LS, you must perform the following conguration. Some steps need to be done only
once per site, others must be run from every machine hosting the Monitor Service in the site. T he steps are described below.
Part 1: Certicate registration with the system
1. Create a certificate using a trusted certificate manager. T he certificate must be associated with the port on the machine
that you wish to use for OData T LS.
2. Configure the Monitor Service to use this port for T LS communication. T he steps depend on your environment and how this
works with certificates. T he following example shows how to configure port 449:
Associate the certificate with a port:

netsh http add sslcert ipport=0.0.0.0:449 certhash=97bb629e50d556c80528f4991721ad4f28fb74e9
appid=' {00000000-0000-0000-0000-000000000000}'
T ip: In a PowerShell command window, ensure you put single quotes around the GUID in the appID, as shown above, or the
command will not work. Note that a line break has been added to this example for readability only.
Part 2: Modif y the Monitor Service conguration settings
1. From any Delivery Controller in the site, run the following PowerShell commands once. T his removes the Monitor Service
registration with the Configuration Service.
asnp citrix.*
$serviceGroup = get-configregisteredserviceinstance -servicetype Monitor | Select -First 1 ServiceGroupUid
remove-configserviceGroup -ServiceGroupUid $serviceGroup.ServiceGroupUid

2. Do the following on all Controllers in the site:
Using a cmd prompt, locate the installed Citrix Monitor directory (typically in C:\Program Files\Citrix\Monitor\Service).
Within that directory run:
Citrix.Monitor.Exe -CONFIGUREFIREWALL -ODataPort 449 -RequireODataSsl
Run the following PowerShell commands:
asnp citrix.* (if not already run within this window)
get-MonitorServiceInstance | register-ConfigServiceInstance
Get-ConfigRegisteredServiceInstance -ServiceType Config | Reset-MonitorServiceGroupMembership

Examples
May 22, 20 17
T he following examples show how to export Monitor Service data using the OData API.
Example 1 - Raw XML
1. Place the URL for each data set into a web browser that is running with the appropriate administrative permissions for
the XenApp or XenDesktop Site. Citrix recommends using the Chrome browser with the Advanced Rest Client add-in.
2. View the source.
Example 2 - PowerPivot with Excel
T hese instructions assume that you have already installed Microsoft Excel and PowerPivot.
Open Excel (running with the appropriate administrative permissions for the XenApp or XenDesktop Site).
If you are using Excel 2010:
1. Click the PowerPivot tab.

2. Click PowerPivot Window.
3. Click From Data Feeds in the ribbon.
4. Choose a Friendly Connection Name (for example: XenDesktop Monitoring Data) and enter the data feed url: http://{dc-
host}/Citrix/Monitor/OData/v2/Data (or https: if you are using T LS).
5. Click Next.
6. Select the tables you want to import into Excel and click Finish. T he data is retrieved.
7. You can now use PowerPivot to view and analyze the data with PivotT ables and PivotCharts. For more information, see
the Learning Center: http://www.microsoft.com/en-us/bi/LearningCenter.aspx
If you are using Excel 2013:
1. Click the Data tab.

2. Choose From Other Sources > From OData Data Feed
3. Enter the data feed url: http://{dc-host}/Citrix/Monitor/OData/v1/Data (or https: if you are using T LS) and click Next.
4. Select the tables you want to import into Excel and click Next.
5. Accept name defaults or customize names and click Finish.
6. Choose Connection Only or Pivot Report. T he data is retrieved.
7. You can now use PowerPivot to view and analyze the data with PivotT ables and PivotCharts. For more information, see
the Learning Center: http://www.microsoft.com/en-us/bi/LearningCenter.aspx
Example 3 - LINQPad
T hese instructions assume that you have already installed LINQPad.
1. Run LinqPad with the appropriate administrative permissions for the XenApp or XenDesktop Site.
T ip: the easiest way is to download, install and run on the Delivery Controller.
2. Click the Add connection link.
3. Choose WCF Data Services 5.1 (OData 3) and click Next.
4. Enter the data feed URL: http://{dc-host}/Citrix/Monitor/OData/v2/Data (or https: if you are using T LS). If necessary,
enter the username and password to access the Delivery Controller. Click OK.

5. You can now run LINQ queries against the data feed and export the data as needed. For example, right-click Catalogs
and choose Catalogs.Take(100). T his returns the first 100 Catalogs in the database. Choose Export>Export to Excel
with formatting.
For further worked examples of how to use the API with LINQPad, see http://blogs.citrix.com/2014/01/14/creating-
director-custom-reports-for-monitoring-xendesktop/.

XD714

Uploaded by

Copyright:

Available Formats

XD714

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

XD714

Uploaded by

Copyright:

Available Formats

XenApp and XenDesktop 7.

T hird party notices

Install and congure

Install core components

Install using the command line

Install VDAs using scripts

Create machine catalogs

Manage machine catalogs

Create Delivery Groups

Manage Delivery Groups

Create Application Groups

Manage Application Groups

https://docs.citrix.com 1999-2017 Citrix Systems, Inc. All rights reserved. p.1

Local App Access and URL redirection

XenApp Secure Browser

Upgrade and migrate

Migrate XenApp 6.x

Integrate XenApp and XenDesktop with NetScaler Gateway

T ransport Layer Security (T LS)

Federated Authentication Service

Best practices, security considerations, and default operations

Printing policies and preferences

Maintain the printing environment

Auto client reconnect and session reliability

https://docs.citrix.com 1999-2017 Citrix Systems, Inc. All rights reserved. p.2

GPU acceleration for Windows Desktop OS

GPU acceleration for Windows Server OS

OpenGL Software Accelerator

Network traffic priorities

USB and client drive considerations

HT ML5 multimedia redirection

Compare, prioritize, model, and troubleshoot policies

Default policy settings

Policy settings reference

Connections and resources

Local Host Cache

Virtual IP and virtual loopback

VDA registration with Controllers

Use Search in Studio

Client folder redirection

Citrix Insight Services

https://docs.citrix.com 1999-2017 Citrix Systems, Inc. All rights reserved. p.3

Alerts and notifications

Delegated Administration and Director

Secure Director deployment

Configure permissions for VDAs earlier than XenDesktop 7

Configure network analysis

T roubleshoot user issues

SDKs and APIs

FIPS Sample Deployments

Citrix SCOM Management Pack for XenApp and XenDesktop

Citrix SCOM Management Pack for License Server

https://docs.citrix.com 1999-2017 Citrix Systems, Inc. All rights reserved. p.4

Important notice about XenApp and XenDesktop

About this release

Install or upgrade a XenApp or XenDesktop Site

Install or upgrade VDAs in an existing Site

For instructions, see Prepare to install or Upgrade a deployment.

https://docs.citrix.com 1999-2017 Citrix Systems, Inc. All rights reserved. p.5

Citrix Receiver for Windows