Professional Documents
Culture Documents
Contents
Install............................................................................................................
12
18
21
25
Remove components.............................................................................
27
Install
Component overview
Installing a XenDesktop environment includes the following core components:
The Delivery Controller is responsible for managing user access, plus brokering and
optimizing connections. Controllers also provide the Machine Creation Services that
create desktop and server images for Virtual Machines (VMs).
A Site can have more than one Controller for high availability of components and
services, as well as workload balancing for larger deployments. A Site is the name you
give to a product deployment. It comprises the Controllers and the other core
components and VDAs, Host connections (if used), plus the machine catalogs and
Delivery Groups you create and manage. A Site does not necessarily correspond to
geographical location, although it can.
The Controller communicates with the Site Configuration Database to obtain session
and configuration information. By default, this Database is installed when you install
the Controller and is configured when you create a Site. This Site Configuration
Database stores configuration changes recorded by the Configuration Logging Service,
plus trend and performance data that is used by the Monitoring Service and displayed
by Citrix Director. Citrix recommends that you specify different locations for the
Configuration Logging and Monitoring databases if you use these features and store
more than seven days of data. You can configure different databases for each of these
services after you have create a Site.
Administrators, help desk, and other support personnel use Citrix Director to monitor
the deployment.
StoreFront authenticates users to Sites and manages stores of applications and desktops
that users access.
You can install the core components on the same server or on different servers. For
example, to manage a smaller deployment remotely, you can install Studio on a different
machine than the server where you installed the Controller. To accommodate future
expansion, consider installing components on separate servers; for example, install the
License Server and Director on different servers.
Install
In addition to the core components, an environment requires a Virtual Delivery Agent (VDA)
on each VM on the Host, on standalone virtual or physical machines, and on servers that
host applications or desktops. The VDA registers for communication with the Controller,
then manages the HDX connection with user devices.
If you are using separate standalone virtual or physical machines, you install a VDA on
each machine.
There are two general types of VDAs: one for Windows servers and another for Windows
desktops. The VDA for Windows Desktop OS is used in full deployments and Remote PC
Access deployments. The VDA for Windows Desktop OS also offers an HDX 3D Pro version
that is optimized for applications and desktops that use a GPU for hardware acceleration.
When you install a VDA, Citrix Receiver is also installed by default. Citrix Receiver provides
secure on-demand access to documents, applications, and desktops from any user device.
The Components in this release topic illustrates a typical deployment.
When you install the VDA, a new local user group called Direct Access Users is
automatically created. On a VDA for Windows Desktop OS, this group applies only to
RDP connections; on a VDA for Windows Server OS, this group applies to ICA and
RDP connections.
When you install a VDA for Windows Server OS, the installer automatically installs
and enables Remote Desktop Services role services, if they are not already installed
and enabled.
For Remote PC Access configurations, install the VDA for Windows Desktop OS on
each physical office PC that users will access remotely.
Install
See the HDX 3D Pro documentation for information about using the HDX 3D Pro
version of the VDA.
After installing components and creating a Site, follow the guidance in Studio to create
machine catalogs and Delivery Groups. Citrix also recommends you change the location of
the Configuration Logging and the Monitoring Databases. See Change secondary database
locations. If you chose during component installation to configure firewall port exceptions
manually, do so now.
Read the Known Issues and System requirements topics. Review the procedure for the
installation task to learn about choices and information you will specify during
installation.
Be sure that each operating system has the latest updates; otherwise, prerequisite
installation can take significantly longer to complete.
Be sure that the Controller and Host servers have synchronized system clocks.
Synchronization is required by the Kerberos infrastructure that secures
communication between the machines.
If you plan to install a component in a location other than the default C:\Program
Files\Citrix, make sure that location has execute permissions for network service.
Decide where to install the Site Configuration Database. By default, Microsoft SQL
Server 2012 Express is installed when you install the Controller. If you want to use a
different supported SQL Server edition, you do not have to install it before you install
the core components; however, it must be installed before you create the Site. Review
database considerations in the Plan documentation, and set up any mirror, cluster, or
other supported redundancy infrastructure.
Consider whether you will move the Configuration Logging and Monitoring databases
after you create the Site. If needed, install SQL Server software on those servers, plus
any redundancy infrastructure.
Set up your virtual infrastructure, if you will be using hosted Virtual Machines (VMs).
When you configure a full deployment Site later, you specify Host information. See the
host platform documentation for setup instructions, and the Integrate documentation
for host deployment information.
Configure your Active Directory domain. See the Microsoft documentation for
instructions.
The servers where you will install the core components must be in the same forest.
As well as being a domain user, you must be a local administrator on the machines
where you are installing core components. After you create a full deployment Site,
that user account is automatically made a Full Administrator.
Install
If you install the license server, that user account is automatically made a full
administrator on the license server.
When you create objects before, during, and after installation, it is best practice to
specify unique names for each object (for example networks, groups, catalogs,
resources).
Install one or more core components: Delivery Controller, Citrix Studio, Citrix Director,
License Server, and StoreFront.
Install additional core components to extend your deployment. For example, installing
Studio on a separate system allows you to manage a deployment remotely.
Customize a VDA by updating Controller addresses, port numbers, and Windows Firewall
port exceptions.
Install a Universal Print Server, which provisions network session printers. (The
Controller already has the Universal Print Server functionality; you need only install the
Universal Print Server on the print servers in your environment.)
By default, all components are selected. Clear the checkboxes of the components
you do not want to install on this server.
(Appears only when you are installing a Controller.) The Microsoft SQL Server 2012
Express feature is enabled by default, and that database software will be installed.
If you plan to use a supported SQL Server version on another server, clear the
checkbox. If you are not installing the Controller, you might be asked to specify the
address of an existing Controller that the components you are installing can
communicate with. If SQL Server is already installed on this server, this option does
not appear.
(Appears only when you are installing Director.) The Windows Remote Assistance
feature is always installed when you install Director; you enable or disable the
feature on this page. Windows Remote Assistance lets administrators and support
personnel help with common IT issues.
6. The Firewall page lists the ports used by each component being installed. You can print
this list. By default, these ports are opened automatically if the Windows Firewall
Service is running, even if the firewall is not enabled. If you use a third-party firewall
or no firewall, or you prefer to open the ports manually after installation, select
Manually.
Component
Port number
Controller
Director
License Server
StoreFront
TCP 80, 443
For complete port information, see CTX101810.
7. The Summary page lists the information you provided on previous pages, plus the
prerequisites that will be installed automatically. After you verify the information and
click Install, the display indicates installation progress. If a component does not install
successfully, the process stops and an error message appears. Components that
installed successfully are retained; you do not need to reinstall them.
If you installed Studio, it starts automatically by default after the installation
completes. You can disable this option. (If you install core components on a
non-domain-joined server, you cannot create a Site, so the option to start Studio is not
available.)
Manually, by typing the Fully Qualified Domain Name (FQDN) of a Controller, then
clicking Add. Although you can specify a Controller that is not currently in the
domain, a VDA can connect only to a Controller in the domain. Also, you can test
the connection only for Controllers in the domain.
Later, by rerunning the installer, using Citrix policies, setting registry values, or by
using Active Directory OUs.
Citrix Group Policy settings that specify Controller locations override settings provided
during installation.
After you initially specify the Controller location, you can use the auto-update feature
to update VDAs when additional Controllers are installed. See Manage your Delivery
Controller environment.
7. On the Features page, select the features you want to enable:
Description
Optimize performance
Personal vDisk
Port number
Controller
TCP 3389.
Windows opens
this port
automatically if
the feature is
enabled on the
previous page,
even if you
choose Manually
on this page.
UDP
16500-16509
10
Controller addresses.
11
Install one or more core components: Delivery Controller, Citrix Studio, Citrix Director,
License Server, and StoreFront.
Install a Universal Print Server, which provisions network session printers. (The
Controller already has the Universal Print Server functionality; you need only install the
Universal Print Server on the print servers in your environment.)
You can also remove previously-installed XenDesktop 7 components, using the /remove or
/removeall options. For more information, see Remove components.
To see command execution progress and return values, you must be the original
administrator or use 'Run as administrator.' For more information, see Microsoft command
documentation.
12
Option
Description
/help or /h
/quiet
/logpath path
/noreboot
/remove
/configure_firewall
CONTROLLER - Controller
DESKTOPSTUDIO - Studio
DESKTOPDIRECTOR - Director
STOREFRONT - StoreFront
/tempdir directory
/nosql
/enableremoteassistance
13
Description
/h or /help
/quiet
/logpath path
/noreboot
/remove
/removeall
/reconfig
/portnumber port
/components
component[,component]
14
/tempdir directory
/site_guid guid
/controllers "controller
[controller] [...]"
/xa_server_location url
/enable_remote_assistance
/enable_hdx_ports
15
/baseimage
/enable_hdx_3d_pro
/enable_real_time_transport
/masterimage
/isvirtual
/nodesktopexperience
/nocitrixwddm
/servervdi
/installwithsecurebootenable
d
/h or /help
/quiet
/noreboot
/controllers
/portnumber port
/enable_hdx_ports
17
On a supported 32-bit operating system: From the \x86\Universal Print Server\ on the
Citrix installation media, run UpsServer_x86.msi.
On a supported 64-bit operating systems: From the \x64\Universal Print Server\ on the
Citrix installation media, run UpsServer_x64.msi.
The scripts need Everyone Read access to the network share where the VDA installation
command, XenDesktopVdaSetup.exe, is located.
Logging details are stored on each local machine. If you also want to 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. The folder title indicates if the
operation was successful with the prefix PASS or FAIL. You can use standard directory
search tools to quickly find a failed installation or removal in the central log share, rather
than searching locally on the target machines. For more information, see the
Troubleshooting section below.
18
Specify the version of the VDA to install: SET DESIREDVERSION. For example, in
XenDesktop 7, the version can be specified as 7.0; the 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 location from which the installer will be invoked. Point
to the root of the layout (the highest point of the tree): the appropriate version of
the installer (32-bit or 64-bit) will be 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.
The /quiet and /noreboot options are included by default in the script and are
required: SET COMMANDLINEOPTIONS=/QUIET /NOREBOOT.
3. Using Group Policy Startup Scripts, assign the script to the OU in Active Directory where
your machines are located. This OU should contain only machines on which you want to
install the VDA. When the machines in the OU are restarted, the script runs on all of
them, installing a VDA on each machine that has a supported operating system.
19
Troubleshooting
The script generates internal log files that describe script execution progress. The script
copies a Kickoff_VDA_Startup_Script log to the central log share within seconds of starting
the deployment to the machine, so that you can verify that the overall process is working.
If this log is not copied to the central log share as expected, you can troubleshoot further
by inspecting the local machine: the script places two debugging log files in the %temp%
folder on each machine, for early troubleshooting:
Kickoff_VDA_Startup_Script_<DateTimeStamp>.log
VDA_Install_ProcessLog_<DateTimeStamp>.log
Review the content of these logs to ensure that the script is:
20
Running as expected.
Correctly configured to point to the ROOT of the DEPLOYSHARE (contains the file named
AutoSelect.exe).
Create a Site
After you install the core components, Citrix Studio offers the following Site creation
choices:
Create a deployment Configures a full deployment Site or a basic Site (basic Sites
are usually created by advanced users).
If you create a full 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.
From the Studio Welcome page, you can also add a Delivery Controller to another Site. For
information about that task, see Adding a Controller.
The following table summarizes the type of information you provide when creating a Site.
21
Basic Site
Remote PC
Access Site
Site name
Database
License
Host
Network
Storage
App-V Publishing
Users
Machine Accounts
Create a Site
By default, the locally installed instance of SQL Server 2012 Express is used to
create the Database, and its location is provided. The default database name is
'Citrix<site-name>'.
To use another installed database server, enter its server name and database name.
You can test the connection to the database.
Database type
What to enter
Standalone or
mirror
servername
servername,port-number
Other
cluster-name
A clustered database.
availability-group-listener
An Always-On database.
After you click Next and are alerted that the services could not connect to a database,
indicate that you want Studio to create it.
If your database is locked down and you do not have edit permission, click Generate
database script. This generates two scripts that your database administrator can use to
set up the database and optionally, database mirroring. These scripts must be run
before you can finish creating the Site.
5. On the Licensing page:
If you installed the License Server on the same server as the Delivery Controller,
the License server field is filled in for you.
If the License Server is not installed on the same server as the Controller, specify
the license server address in the form name:[port], where name is a Fully Qualified
Domain Name (FQDN), NetBIOS, or IP address; FQDN is the recommended format. If
you omit the port number, the default is 27000.
You cannot proceed until a successful connection is made to the license server.
Choose either the 30-day free trial, which allows you to add license files later, or use
an existing license. You can also download licenses or add a license file.
22
Create a Site
6. (Appears only when creating a full deployment Site.) On the Host Connection page:
Choose the type of Host you are using, its address, and the credentials to access it.
If you are not using a Host, or if you will use Studio to manage user desktops
hosted on dedicated blade PCs, select the Host type None.
Specify whether you will use Machine Creation Services (MCS) or other tools to
create VMs.
7. (Appears only when creating a full deployment Site, and using a Host and MCS.) On the
Network page, enter a name for the resources and select a network for the VMs to use.
8. (Appears only when creating a full deployment Site, and using a Host and MCS.) On the
Storage Page:
Choose the storage type: Shared or Local. Shared storage (the default) is available
through the network. If you use shared storage, you can enable the use of
IntelliCache to reduce load on the storage device. Local storage is on the Host. For
more information about using IntelliCache with XenDesktop, see Use IntelliCache
with XenDesktop.
If you plan to use Personal vDisks to store user-installed applications and user
profiles, specify whether they will use the same storage as VMs (default), or
different storage.
9. (Appears only when creating a full deployment Site.) On the App-V Publishing page,
indicate whether you want to specify App-V management and App-V publishing server
information now. If you choose Yes, enter the server addresses.
10. (Appears only when creating a Remote PC Access Site.) On the Users page, click Add
Users. Select the users and user groups that will be allowed to access their office PCs
remotely. Then click Add users.
Note: You must add entries on this page; there is no default action that
automatically adds all users.
11. (Appears only when creating a Remote PC Access Site.) On the Machine Accounts page,
add the machines associated with the users and user groups. Use one of the following
methods:
23
Click Add machine accounts. Select the machine accounts, and then click Add
machine accounts.
Create a Site
Click Add OUs. Select the domain and Organizational Units. By default, only items
in the folders are included; to also include items in subfolders, enable the Include
subfolders checkbox. Click Add OUs.
12. On the Summary page, review the information you specified. After confirming the
settings, click Finish.
After creating the Site, follow the Studio guidance to create Machine Catalogs and Delivery
Groups.
24
You cannot install XenDesktop 7 core components (for example, Controller, Studio,
Director, StoreFront, Citrix License Server) on a Windows XP or Windows Vista system.
Note: When installing the earlier version of a VDA on a 32-bit XP machine, either use the
XenDesktop 7 media locally or copy the media to the local drive. Do not attempt to
install the earlier VDA version from a network share or a mapped drive.
25
26
Remove components
To remove XenDesktop 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 firewall 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; see To remove a Controller. Before
removing Studio or Director, Citrix recommends closing them.
If you upgraded a Controller from an earlier XenDesktop deployment that included Web
Interface, you must remove the Web Interface component separately; you cannot use the
XenDesktop installer to remove Web Interface.
To remove a VDA, select Citrix Virtual Delivery Agent <version>, then right-click and
select Uninstall. The installer launches and you can select the components to be
removed.
To remove the Universal Print Server, select Citrix Universal Print Server, then
right-click and select Uninstall.
To remove one or more core components, use the /remove and /components options.
For command and parameter details, see Install using the command line.
27
Remove components
For example, the following command removes Studio.
\x64\XenDesktop Setup\XenDesktopServerSetup.exe /remove /components studio
To remove one or more core components, use the /remove and /components options.
For command and parameter details, see Install using the command line.
For example, the following command removes the VDA and Receiver.
\x64\XenDesktop Setup\XenDesktopVdaSetup.exe /removeall
You can also remove VDAs using a script in Active Directory; see Install or remove Virtual
Delivery Agents using scripts in Active Directory.
28