Product Documentation

Install using the command line

Nov 04, 2016

Note: This 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 articles.

In this article: 

Introduction

Important: This article describes how to issue product installation commands. Before beginning any installation, review the Prepare to install article, which describes:

  • The available installers, things you should be familiar with, and tasks you should complete before installation.
  • Details of command and option syntax.

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 alternative to using the installers directly, if you use the sample scripts provided to install, upgrade, or remove VDAs machines in Active Directory, you can specify VDA configuration options listed below in the Command line options for installing a VDA section. For information about the sample scripts, see the Install VDAs using scripts article.

Use the full-product installer

You can use the full-product installer to:

  • Install or upgrade core components: Delivery Controller, Citrix Studio, Citrix Director, License Server, and StoreFront. (See the Upgrade article for details about upgrading, and the Remove components article for removal details.)
  • Install or upgrade a VDA, or customize a previously-installed VDA. (See the Upgrade article for details about upgrading.)
  • Install the Universal Print Server server component, which provisions network session printers. The Controller already has the Universal Print Server client functionality; you need only install the UpsServer component on the print servers in your environment. After you install the component, follow the configuration instructions in the Provision printers article.
  • Install the Federated Authentication Service. (Citrix recommends using the graphical interface to install this service.)
  • Install the Self-Service Password Reset Service; see the Password Reset Service documentation for details.

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 the Command line options for installing core components section below.

To install a VDA:

Run the XenDesktopVDASetup.exe command with the options listed in the Command line options for installing a VDA section below.

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 Password Reset Service documentation.

Examples installing core components with the full product installer

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

Examples installing a VDA with the full product installer

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 

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.

  1. Download the appropriate package from Citrix: VDAServerSetup.exe (for server OS machines) or VDAWorkstationSetup.exe (for desktop OS machines). For single user, single server OS deployments (for example, delivering Windows Server 2012 to one user for web development), use the VDAWorkstationSetup.exe package. For more information, see the Server VDI article.
  2. Either extract the files from the package first and then run the installation command, or just run the package.

To extract the files before installing them, use /extract with the absolute path; for example .\VDAWorkstationSetup.exe /extract %temp%\CitrixVDAInstallMedia. Then in a separate command, run the XenDesktopVdaSetup.exe command from the directory containing the extracted content (in the example above, CitrixVDAInstallMedia). Use the options listed in the Command line options for installing a VDA section below.

To just run the downloaded package, run its name: VDAServerSetup.exe or VDAWorkstationSetup.exe. Use the options listed in the Command line options for installing a VDA section below. (If you are familiar with the full product installer: you run the downloaded standalone package as if it was the XenDesktop VdaSetup.exe command in everything except its name.)

Example installing a VDA with the standalone VDA installer

The following installation command is often used for Remote PC Access. It installs a VDA on a physical office PC, without installing Citrix Receiver or Citrix Profile Manager. The machine will not automatically 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'. Ports will be opened if the Windows Firewall Service is detected.

VDAWorkstationSetup.exe /quiet /components vda /exclude "Citrix User Profile Manager" /controllers "Contr-East.domain.com" /enable_hdx_ports /noreboot

See the Command line options for installing a VDA section for the effects of excluding components and features.

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 the Command line options for installing a VDA section below.

  • /reconfigure - this option is required when customizing a VDA
  • /h or /help
  • /quiet
  • /noreboot
  • /controllers
  • /portnumber port
  • /enable_hdx_ports

Command line options for installing core components

The following table provides an alphabetical list and description of command line options when installing core components with the the XenDesktopServerSetup.exe command. See What to specify when installing a core components for additional information about the options and features you can use.

/components <component> [,<component>] ...              

Comma-separated list of components to install or remove. Valid values are:

CONTROLLER – Controller

DESKTOPSTUDIO – 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 specified).

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

/exclude "Local Host Cache Storage (LocalDB)"  

Prevents installation of the database used for a future feature.  This has no effect on whether or not SQL Server Express is installed for use as the Site database.

/help or /h

Displays command help.

/installdir <directory>

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

/logpath <path>

Log file location. The specified folder must already exist; the installer does not create it. Default = "%TEMP%\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 will be installed for use as the Site database. (This option has no effect on the installation of SQL  Server Express LocalDB, which may be used for a future feature.)

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

/remove

Removes the core components specified with the /components option.

/removeall

Removes all installed core components.

/sendexperiencemetrics

Automatically sends analytics collected during the installation, upgrade, or removal to Citrix Insight Services. If this option is omitted, the analytics are collected locally, but not sent automatically.

/tempdir <directory>

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

/xenapp

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

 

Command line options for installing a VDA

The following table provides an alphabetical list and description of command line options when installing VDAs with the XenDesktopVDASetup.exe command (or the VDAWorkstationSetup.exe command when using the standalone VDA installation package). See What to specify when installing a VDA for additional information about the options and features you can use.

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.

/baseimage

Valid only when isntalling a VDA for Desktop OS on a VM. Enables the use of Personal vDisks with a master image. For more information, see the Personal vDisks articles.

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

For example, to install the VDA but not Citrix Receiver, specify /components vda.

If this option is omitted, all components are installed.

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

/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 firewall required by the Controller and enabled features (such as Windows Remote Assistance, Real-Time Transport, and optimization), 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.

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

/enable_remote_assistance

Enables the shadowing feature in 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.

/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 will not be managed by MCS does not require the Personal vDisk or Machine Identity Service components. Valid values are:

Personal vDisk

Machine Identity Service

Citrix User Profile Manager

Excluding Citrix Profile management from the installation (Using the /exclude "Citrix User Profile Manager" option) will affect monitoring and troubleshooting of VDAs with Citrix Director.  On the User details and EndPoint pages, the Personalization panel and the Logon Duration panel will fail. On the Dashboard and Trends pages, the Average Logon Duration panel will display data only for machines that have Profile management installed. 

Even if you are using a third party user profile management solution, it is recommended that you install and run the Citrix Profile management Service to avoid loss of monitoring and troubleshooting in Citrix Director (enabling the Citrix Profile management Service is not required).

/h or /help

Displays command help.

/installdir <directory>

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

/logpath <path>

Log file location. The specified folder must already exist; the installer does not create it.  (This option is not available in the graphical interface.) Default = "%TEMP%\Citrix\XenDesktop Installer"

/masterimage

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

/no_appv

Prevents installation of the Citrix App-V components. For more information, see the App-V article. 

/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. This feature is also controlled with the Enhanced Desktop Experience Citrix policy setting.

/noreboot

Prevents a restart after installation. The VDA will not be fully available for use 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 offline files, disabling background defragmentation, and reducing event log size. Do not specify this option for Remote PC Access deployments. For more information, see CTX125874.

/portnumber <port>

Valid only when 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.

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

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

/remotepc

Valid only for Remote PC Access deployments.  Excludes installation of the following components on a desktop OS:

App V Component - Citrix Personalization for App-V

UpmComponent - Citrix User Profile Manager

UpmVdaPlugin Component - Citrix User Profile Manager WMI Plugin

Mps Component - Machine Identity Service

VDisk Component - Personal vDisk

During an upgrade, if any of these components are installed, the installer detects and upgrades them.

/remove

Removes the components specified with the /components option.

/removeall

Removes all installed VDA components.

/sendexperiencemetrics

Automatically sends analytics collected during the installation, upgrade, or removal to Citrix Insight Services. If this option is omitted, 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 the Server VDI article. (This option is not available in the graphical interface.)

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

/tempdir <directory>

Directory to hold temporary files during installation. (This option is not available in the graphical interface.) 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.

/xa_server_location <url>

URL of the server for Windows server applications.

 

Install the Universal Print Server using the command line

Note: If you are installing the UpsServer component on a 32-bit Windows 2008 server, follow the steps in Before installing the Universal print Server on a 32-bit Windows 2008.

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, configure it using the guidance in the Provision printers article.

Before installing the Universal Print Server on a 32-bit Windows 2008 server

Before deploying UpsServer_x86.msi on a 32-bit Windows 2008 machine, you must adjust the Minimum Version for Windows Installer for the cdf_x86.msi and UpsServer_x86.msi, using either Visual Basic scripts or a tool such as Orca.

  1. Copy the 32-bit versions of the CDF and UPS MSI files (cdf_x86.msi and UpsServer_x86.msi) to a temp folder.
  2. Install the WiSumInf.vbs script or the Orca tool, both available in the Windows SDK Components for Windows Installer Developers package. For information about the script, see the MSDN article Manage Summary Information.
  3. Modify the Minimum Version for the Windows Installer using one of the following methods:

Using the WiSumInf.vbs script: Copy WiSumInf.vbs to the same temp folder with the two Citrix msi's. Then, run the script for each package with the parameters WiSumInf.vbs cdf_x86.msi Pages=405 and WiSumInf.vbs UpsServer_x86.msi Pages=405.

Using Orca: Open each of the cdf_x86.msi and UpsServer_x86.msi packages,  go to the View menu > Summary Information, and change the value of the Schema textbox to 405.

After completing the above procedure, install the Universal Print Server on the print server.