Product Documentation

Prepare to install

May 03, 2015

The following tables list tasks to complete and things to consider or be aware of before installing the core components (Delivery Controller, Citrix Studio, Citrix Director, Citrix License Server, StoreFront) and Virtual Delivery Agents (VDAs).

Core component and general installation preparation

Description
First:
  • Review topics in the Plan section.
  • Check Known issues for installation issues you might encounter.
  • If you are installing components in a cloud environment, see Set up cloud environment.
Decide where you will install the components and then prepare the machines and operating systems.
  • Review System requirements for XenApp 7.5 and XenDesktop 7.5 for supported operating systems and versions for the Controller, Studio, Director, Virtualization resources, and VDAs. The Citrix StoreFront and the Citrix License Server requirements topics specify their supported platforms.
    • 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.
    • You can install both the Delivery Controller and the Virtual Delivery Agent for Windows Server OS on the same server. Launch the installer and select the Delivery Controller (plus any other core components you want on that machine); then launch the installer again and select the Virtual Delivery Agent for Windows Server OS.
  • Be sure that each operating system has the latest updates.
  • Be sure that all machines have synchronized system clocks. Synchronization is required by the Kerberos infrastructure that secures communication between the machines.
  • Components are installed in C:\Program Files\Citrix by default. You can specify a different location during installation, but it must have execute permissions for network service.
  • Most component prerequisites are installed automatically; however, the System requirements notes exceptions.
Decide where to install the SQL Server software for the Site Configuration Database.
  • By default, SQL Server 2012 Express is installed automatically on the server when you install the Controller, if another instance is not detected. Alternatively, you can separately install a supported SQL Server version on that server or on a different server. In such cases, the SQL Server software does not need to be installed before you install the core components, but it must be installed before you create the Site.
  • Review the database considerations in the Plan topics, and set up any supported redundancy infrastructure.
Important: Windows authentication is required between the Controller and the database.

Decide how you want ports opened.

By default, the following ports are opened automatically if the Windows Firewall Service is running, even if the firewall is not enabled. You can disable this default action and open the ports manually if you use a third-party firewall or no firewall, or if you just prefer to do it yourself.
  • Controller: TCP 80, 443
  • Director: TCP 80, 443
  • License Server: TCP 7279, 8082, 8083, 27000
  • StoreFront: TCP 80, 443
Tip: For complete port information, see CTX101810.
Configure your Active Directory domain.
  • In addition to being a domain user, you must be a local administrator on the machines where you are installing core components.
  • Do not attempt to install any components on a domain controller.
  • See the Active Directory topics in the Plan section for more information. See the Microsoft documentation for instructions.

When you install the License Server, that user account is automatically made a full administrator on the license server.

When you install Director, decide if you will use the shadowing feature of DIrector, which uses Windows Remote Assistance.

Good to know:
  • If a component does not install successfully, the process stops with an error message. Components that installed successfully are retained; you do not need to reinstall them.
  • Studio starts automatically after it is installed. You can disable this action during installation.
  • 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).
  • After installing components in Amazon Web Services (AWS), you will need to know the region, availability zone, VPC name, subnet addresses, domain name, security group names, and credentials when you use Studio to create a Site.

VDA installation preparation

Description

If you will be installing a VDA for Windows Desktop OS, decide if you want to install the HDX 3D Pro version.

The HDX3D Pro feature delivers desktops and applications that perform best with a GPU for hardware acceleration. For more information, see the HDX 3D Pro documentation.

Decide how you will use the VDA.

The default setting assumes that you will use a master image of the installed VDA with Machine Creation Services or Provisioning Services to create other virtual machines. You can override this default if you want to install the VDA on an existing machine.

Decide if you want to install Citrix Receiver for Windows (CitrixReceiver.exe).

You can disable this default action.

Decide how you want ports opened.

By default, the following ports are opened automatically if the Windows Firewall Service is running, even if the firewall is not enabled. You can disable this default action and open the ports manually if you use a third-party firewall or no firewall, or if you just prefer to do it yourself.
  • Controller: TCP 80, 1494, 2598, 8008
    • For communication between user devices and virtual desktops, configure inbound TCP on ports 1494 and 2598 as port exceptions. For security, Citrix recommends that you do not use these registered ports for anything other than the ICA protocol and the Common Gateway Protocol.
    • For communication between Controllers and virtual desktops, configure inbound port 80 as a port exception.
  • Windows Remote Assistance: TCP 3389

    Windows opens this port automatically if the feature is enabled, even if you choose to open the ports manually.

  • Real-Time Audio Transport: UDP 16500-16509

Tip: For complete port information, see CTX101810.
Decide how the locations of installed Controllers will be specified.
  • Manually, by entering the Fully Qualified Domain Name (FQDN) of the Controller. 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.
  • Using Active Directory, if the Controller is in the domain.
  • Allowing Machine Creation Services to specify the Controller.
  • Later, by rerunning the installer, using Citrix policies, setting registry values, or using Active Directory OUs.

Citrix Group Policy settings that specify Controller locations will 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. For more information about methods for specifying Controllers, see Manage your Delivery Controller environment.

Decide if you want to use the following features:
  • Optimize performance: When this feature is enabled, the optimization tool is used for VDAs running in a VM on a hypervisor. VM optimization includes disabling offline files, disabling background defragmentation, and reducing event log size. For more information, see CTX125874. Do not enable this option if you will be using Remote PC Access. Default = enabled.
  • Windows Remote Assistance: When this feature is enabled, Windows Remote Assistance is used with the user shadowing feature of Director, and Windows automatically opens TCP port 3389 in the firewall, even if you choose to open firewall ports manually. Default = enabled.
  • Real-Time Audio Transport for audio: When this feature is enabled, UDP is used for audio packets, which can improve audio performance. Default = enabled.
  • Personal vDisk: (Available only when installing a VDA for Windows Desktop OS on a VM.) When this feature is enabled, Personal vDisks can be used with a master image. For more information, see Personal vDisks. Default = disabled.
Good to know:
  • The installer automatically detects your operating system and allows you to install only the VDA type supported on that system: VDA for Windows Server OS or VDA for Windows Desktop OS.
  • Profile management is installed during VDA installation.
  • 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, Remote Desktop Services role services are automatically installed and enabled (if they are not already installed and enabled).
  • When you install a VDA for Windows Desktop OS, Touch PC Features are also installed, including the Flicks application. (If you are using Microsoft System Center Configuration Manager: the machine is categorized as a tablet after it restarts.)
  • For Remote PC Access configurations, install the VDA for Windows Desktop OS on each physical office PC that users will access remotely.
  • Do not install this version of the VDA for Windows Server OS on a server that has XenApp 6.5 or earlier installed.

Install using the graphical interface

Note: Before beginning any installation, review and complete the tasks in Prepare to install.
Launch the installer graphical interface:
  1. Download the product package and unzip it. Optionally, burn a DVD of the ISO file.
  2. Log on to the server where you are installing the components, using a local administrator account.
  3. 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.
  4. Select the component you want to install:
    • If you're just getting started, click Delivery Controller. From there, you can install the Delivery Controller and optionally, Studio, Director, License Server, and StoreFront on the same server.
    • If you've already installed some components and want to extend your deployment, click the component you want to install from the right column. This column offers core components and the Universal Print Server, which you can install on your print server.
    • To install a Virtual Delivery Agent (VDA), click the available VDA entry - the installer knows which one is right for the operating system where you're running the installer.
Later, if you want to customize a VDA that you've already installed:
  1. From the Windows feature for removing or changing programs, select Citrix Virtual Delivery Agent <version-number>, then right-click and select Change.
  2. Select Customize Virtual Delivery Agent Settings. When the installer launches, you can change the Controller addresses, TCP/IP port to register with the Controller (default = 80), or whether to automatically open Windows Firewall port exceptions.

Install using the command line

Use the command line interface to:
  • Install one or more core components: Delivery Controller, Citrix Studio, Citrix Director, License Server, and StoreFront.
  • Install a Virtual Delivery Agent (VDA) on a master image or on a virtual or physical machine.

    You can also customize scripts provided on the media, then use them to install and remove VDAs in Active Directory; see Install or remove Virtual Delivery Agents using scripts in Active Directory.

  • Customize a previously-installed VDA.
  • 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 components from this version that you previously installed, 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.

Important: Before beginning an installation, read and complete the tasks in Prepare to install.

To install core components using the command line

From the \x64\XenDesktop Setup directory on the media, run the XenDesktopServerSetup.exe command. The following table describes command options.
Note: To install XenApp, include the /xenapp option on the command line. To install XenDesktop, do not include the /xenapp option.
Option Description

/help or /h

Displays command help.

/quiet or /passive

No user interface appears during the installation. The only evidence of the installation process is in Windows Task Manager. If this option is omitted, the graphical interface launches.

/logpath path

Log file location. The specified folder must already exist; the installer does not create it. Default = "%TEMP%\Citrix\XenDesktop Installer"

/noreboot

Prevents a restart after installation. (For most core components, a restart is not enabled by default.)

/remove

Removes the core components specified with the /components option. For more information about removing components, see Remove components.

/removeall

Removes all installed core components. For more information about removing components, see Remove components.

/xenapp

Installs XenApp. If this option is omitted, XenDesktop is installed.

/configure_firewall

Opens all ports in the Windows firewall needed by components being installed, if the Windows Firewall Service is running, even if the firewall is not enabled. If you are using a third-party firewall or no firewall, you must manually open the ports.

/components component [,component] ...

(Required.) Comma-separated list of components to install or remove. Valid values are:
  • CONTROLLER - Controller
  • DESKTOPSTUDIO - Studio
  • DESKTOPDIRECTOR - Director
  • LICENSESERVER - Citrix Licensing
  • STOREFRONT - StoreFront

If this option is omitted, all components are installed (or removed, if the /remove option is also specified).

/installdir directory

Existing empty directory where components will be installed. Default = c:\Program Files\Citrix.

/tempdir directory

Directory that holds temporary files during installation. Default = c:\Wndows\Temp.

/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 will be installed.

/no_remote_assistance

(Valid only when installing Director.) Prevents the installation and enabling of the Windows Remote Assistance feature.

For example, the following command installs a XenDesktop Controller, Studio, Citrix Licensing, and SQL Server Express on the server. Ports required for component communications will be opened automatically.
\x64\XenDesktop Setup\XenDesktopServerSetup.exe /components  
controller,desktopstudio,licenseserver /configure_firewall
The following command installs a XenApp Controller, Studio, and SQL Server Express on the server. Ports required for component communication will be opened automatically.
\x64\XenDesktop Setup\XenDesktopServerSetup.exe /xenapp /components  
controller,desktopstudio /configure_firewall

To install a VDA using the command line

Note: For information about installing an earlier Virtual Desktop Agent version on Windows XP or Windows Vista systems, see Install an earlier Virtual Desktop Agent on Windows XP or Windows Vista.

When installing a VDA for use with Remote PC Access, specify only options that are valid on physical machines (not VMs or master images) and for VDAs for Windows Desktop OS.

From the \x64\XenDesktop Setup directory on the product media, run the XenDesktopVdaSetup.exe command. The following table describes command options. Unless otherwise noted, options apply to physical and virtual machines, and to VDAs for Windows Desktop OS and VDAs for Windows Server OS.
Option Description

/h or /help

Displays command help.

/quiet or /passive

No user interface appears during the installation. The only evidence of the installation and configuration process is in Windows Task Manager. If this option is omitted, the graphical interface launches.

/logpath path

Log file location. The specified folder must already exist; the installer does not create it. Default = "%TEMP%\Citrix\XenDesktop Installer"

/noreboot

Prevents a restart after installation. The VDA will not be fully available for use until after a restart.

/remove

Removes the components specified with the /components option.

/removeall

Removes all installed VDA components.

/reconfig

Customizes previously-configured 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.

/portnumber port

(Valid only if the /reconfig option is specified.) Port number to enable for communications between the VDA and the Controller. The previously-configured port is disabled, unless it is port 80.

/components component[,component]

Comma-separated list of components to install or remove. Valid values are:
  • VDA - installs the VDA
  • PLUGINS - installs the Citrix Receiver for Windows (CitrixReceiver.exe)

If this option is omitted, all components are installed.

/installdir directory

Existing empty directory where components will be installed. Default = c:\Program Files\Citrix.

/tempdir directory

Directory to hold temporary files during installation. (This option is not available in the graphical interface.) Default = c:\Wndows\Temp.

/site_guid guid

Globally Unique Identifier of the site Active Directory Organizational Unit (OU). This associates a virtual desktop with a Site when you are using Active Directory for discovery (auto-update is the recommended and default discovery method). The site GUID is a site property displayed in Studio. Do not specify both the /site_guid and /controllers options.

/controllers "controller [controller] [...]"

Space-separated Fully Qualified Domain Names (FQDNs) of Controllers with which the VDA can communicate, enclosed in quotation marks. Do not specify both the /site_guid and /controllers options.

/xa_server_location url

URL of the server for Windows server applications.

/enable_remote_assistance

Enables Windows Remote Assistance for use with Director. If you specify this option, Windows opens TCP port 3389 in the firewall, even if you omit the /enable_hdx_ports option.

/enable_hdx_ports

Opens ports in the Windows firewall required by the Controller and features you specified (Windows Remote Assistance, real-time transport, and optimize), if the Windows Firewall Service is detected, even if the firewall is not enabled. If you are using a different firewall or no firewall, you must configure the firewall manually.

/optimize

Enables optimization for VDAs running in a VM on a hypervisor. VM optimization includes disabling offline files, disabling background defragmentation, and reducing event log size. Do not specify this option for Remote PC Access. For more information about the optimization tool, see CTX125874.

/baseimage

(Valid only when installing a VDA for Windows Desktop OS on a VM.) Enables the use of Personal vDisks with a master image. For more information, see Manage Personal vDisks.

/enable_hdx_3d_pro

Installs the VDA for HDX 3D Pro. For more information, see the HDX 3D Pro documentation.

/enable_real_time_transport

Enables or disables use of UDP for audio packets (Real-Time 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 if the Windows Firewall Service is detected.

/masterimage

(Valid only when installing a VDA on a VM.) Sets up the VDA as a master image.

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

/nodesktopexperience

(Valid only when installing a VDA for Windows Server OS.) Prevents enabling of the Enhanced Desktop Experience feature. This feature is also controlled with the Enhanced Desktop Experience Citrix policy setting.

/nocitrixwddm

(Valid only on Windows 7 machines that do not include a WDDM driver.) Disables installation of the Citrix WDDM driver.

/servervdi

Installs a VDA for Windows Desktop OS on a supported Windows Server. Omit this option when installing a VDA for Windows Server OS on a Windows Server. Before using this option, see Server VDI.

/installwithsecurebootenabled

Allows VDA installation when Secure Boot is enabled. If this option is omitted, a warning displays that Secure Boot must be disabled to successfully install a VDA.

/exclude "Personal vDisk","Machine Identity Service"

(Valid only when upgrading from an earlier 7.x VDA version on a physical machine.) Excludes Personal vDisk and Machine Identity Service from the upgrade.

For example, the following command installs a VDA for Windows Desktop OS and Citrix Receiver to the default location on a VM. This VDA will be used as a master image. The VDA will register initially with the Controller on the server named 'Contr-Main' in the domain 'mydomain,' and 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
The following command installs a VDA for Windows Desktop OS and Citrix Receiver to the default location on an office PC that will be used with Remote PC Access. The machine will not be restarted after the VDA is installed; however, a restart is required before the VDA can be used. The VDA will register initially with the Controller on the server named 'Contr-East' in the domain 'mydomain,' and will use UDP for audio packets. HDX ports will be opened if the Windows Firewall service is detected.
\x64\XenDesktop Setup\XenDesktopVdaSetup.exe /quiet  
/components vda,plugins /controllers "Contr-East.mydomain.local" /enable_hdx_ports  
/enable_real_time_transport /noreboot 

To 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 above.
  • /reconfigure - this option is required when customizing a VDA
  • /h or /help
  • /quiet
  • /noreboot
  • /controllers
  • /portnumber port
  • /enable_hdx_ports

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