Product Documentation

Installer à l'aide de la ligne de commande

Jan 24, 2018
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.

  • 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 details, see Remove components.
  • Upgrade components; for details, see Upgrade a deployment.

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.

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

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.

/removeall

Removes all installed core 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:\Windows\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

Install a VDA using the command line

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 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%CitrixXenDesktop 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 FilesCitrix.

/tempdir directory

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

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

Note: Add the /masterimage option if you are installing the VDA on an image, and will use MCS to create server VMs from that image.

/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 advanced use of this option, see CTX140972.

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.
XenDesktop SetupXenDesktopVdaSetup.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.
XenDesktop SetupXenDesktopVdaSetup.exe /quiet /components vda,plugins /controllers "Contr-East.mydomain.local" /enable_hdx_ports /enable_real_time_transport /noreboot

As an alternative to using the full-product ISO to install VDAs, you can use a standalone VDA installation package. For details, see Install VDAs using the standalone package.

By default, when a machine restart is needed during an installation, the installer resumes automatically after the restart completes. To override the default, specify /noresume with the installation command. This can be helpful if you must re-mount the media or want to capture information during an automated installation.

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

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.

In XenApp and XenDesktop 7.6 FP3, the UPS package contains updated versions of the standalone UPS client and server components. For installation instructions, see Provision printers.

In XenApp and XenDesktop 7.6 FP3, if you install the Universal Print Server using the command line, we recommend that you add the command option, ENABLE_CEIP set to 1, to opt in to the Citrix Customer Experience Improvement Program (CEIP).

For example:

Code Copier

msiexec /i UpsServer.msi ENABLE_CEIP=1

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

7.6 FP3 deploying UpsServer_x86.msi on the Windows 2008 32-bit platform

To deploy UpsServer_x86.msi on Windows 2008 32-bit platform, the Minimum Version for Windows Installer for the cdf_x86.msi and UpsServer_x86.msi needs to be adjusted first, either by using VB scripts or by using a tool such as Orca. To do this:

  1. Copy the 7.6 FP3 32-bit versions of the CDF and UPS msi's (cdf_x86.msi and UpsServer_x86.msi) to a temp folder.
  2. Install the WiSumInf.vbs script or Orca tool, both available in the Windows SDK Components for Windows Installer Developers package. For more information on the script, see the MSDN article Manage Summary Information.
  3. You can modify the Minimum Version for the Windows Installer using one of the two methods below:
    • Using WiSumInf.vbs script:
      1. Copy WiSumInf.vbs to the same temp folder with the two Citrix msi's.
      2. Run the script for each package with these parameters:
        • WiSumInf.vbs cdf_x86.msi Pages=405
        • 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.