Install Citrix XenApp /XenDesktop 7.13 VDA with the command line2017-03-06T21:33:21+00:00

Command line options for installing a Citrix XenApp / XenDesktop 7.13 VDA

The following options are valid with one or more of the following commands: XenDesktopVDASetup.exe, VDAServerSetup.exe, VDAWorkstationSetup.exe, or VDAWorkstationCoreSetup.exe.

/baseimage

Valid only when installing a VDA for Desktop OS on a VM. Enables the use of Personal vDisks with a master image.

This option is not valid when using the VDAWorkstationCoreSetup.exe installer.

/components <component>[,<component>]

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

VDA: Virtual Delivery Agent

PLUGINS: 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.

This option is not valid when using the VDAWorkstationCoreSetup.exe installer. That installer cannot install a Citrix Receiver.

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

Tip: To open the UDP ports that HDX adaptive transport uses to communicate with the Controller, specify the /enable_hdx_udp_ports option, in addition to this option.

/enable_hdx_udp_ports

Opens UDP ports in the Windows firewall that are required by HDX adaptive transport, if the Windows Firewall Service is detected, even if the firewall is not enabled.

Tip: To open additional ports that the VDA uses to communicate with the Controller and enabled features, specify the /enable_hdx_ports option, in addition to this option.

/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
  • Citrix User Profile Manager WMI Plugin
  • Citrix Universal Print Client
  • Citrix Telemetry Service
  • Citrix Personalization for App-V – VDA

This option is not valid when using the VDAWorkstationCoreSetup.exe installer. That installer automatically excludes many of these items./h or /help

Displays command help.

/hdxflashv2only

Prevents installation of Flash redirection legacy binaries, for enhanced security.

This option is not available in the graphical interface.

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

This option is not available in the graphical interface.

/masterimage

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

This option is not valid when using the VDAWorkstationCoreSetup.exe installer.

/nocitrixwddm

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

This option is not available in the graphical interface.

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

  • Citrix Personalization for App-V
  • Citrix User Profile Manager
  • Citrix User Profile Manager WMI Plugin
  • Machine Identity Service
  • Personal vDisk

This option is not valid when using the VDAWorkstationCoreSetup.exe installer. That installer automatically excludes installation of these components.

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

This option should be used only with the full-product VDA installer. 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. Default = c:\Windows\Temp.

This option is not available in the graphical interface.

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

This option is not available in the graphical interface.

/xa_server_location <url>

URL of the server for Windows server applications.