Product Documentation

Install using the command line

Sep 16, 2016

Introduction

Important: Before beginning any installation, review the Prepare to install article, which describes the installers and things you should be familiar with before installation. It also guides you through options you can include with a command. This article describes how to launch the command line interface in a product installer.

You can use a 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 and then use them to install and remove VDAs 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.
  • Upgrade components; see the Upgrade a deployment article.

You can also remove components from this version that you previously installed by using the /remove or /removeall options. For details, see the Remove components article.

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.

Both the full-product installer and the standalone VDA installer have a command line interface.

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 install core components and VDAs with the full-product installer.

  • Download the product package from Citrix. Citrix account credentials are required to access the download site.
  • Unzip the file. Optionally, burn a DVD of the ISO file.
  • Log on to the server where you are installing the components, using a local administrator account.
  • Insert the DVD in the drive or mount the ISO file.
  • From the \x64\XenDesktop Setup directory on the media:

To install core components, run the XenDesktopServerSetup.exe command. Use options listed in the Command line options for installing core components section below.

To install a VDA, run the XenDesktopVDASetup.exe command. Use options listed in the Command line options for installing a VDA section below.

Examples installing core components with the full product installer

Example 1: 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

Example 2: 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

Example 1: 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

Example 2: 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 the standalone VDA installer

Important: The Prepare to install article provides guidance about information you see and specify during installation, especially about handling restarts and extraction space when using the 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

Note

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

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 lists the valid options for the XenDesktopServerSetup.exe command.

Option

Description

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

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

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

/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 lists the valid options for the XenDesktopVDASetup.exe command.

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.

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

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

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

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

/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 of more comma-separated optional components, enclosed in quotation marks. For example, installing or upgrading a VDA on an image that is not managed by Machine Creation Services 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 VDA installation will affect monitoring and troubleshooting 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.

/h or /help

Displays command help.

/installdir directory

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

/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.  (This option is not available in the graphical interface.)

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

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

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.

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

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

/remove

Removes the components specified with the /components option.

/removeall

Removes all installed VDA components.

/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 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, read this first.

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.

Citrix recommends that you include the command option ENABLE_CEIP set to 1 to opt in to the Citrix Customer Experience Improvement Program (CEIP). For example:

msiexec /i UpsServer.msi ENABLE_CEIP=1

When you opt in, anonymous statistics and usage information are sent to Citrix to help improve the quality and performance of Citrix products.

After you install the Universal Print Server comonent 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.