Product documentation
Citrix Virtual Apps and Desktops
Service Current Release 2402 LTSR 2311 2308 2305 2303 2212 2209 2206 2203 LTSR 1912 LTSR
View PDF

Install VDAs using SCCM

April 21, 2023
Contributed by: 
C L

Note:

Citrix is not responsible for issues that arise caused by the deployment of a Virtual Delivery Agent (VDA) using software distribution tools such as Microsoft System Center Configuration Manager (SCCM) adapted to match customer production environments. For any install related Citrix issues, open a technical support case with the relevant install logs using the Citrix Support portal.

Overview

VDA installation has two phases:

  • Install prerequisites
  • Install the VDA

To successfully deploy the VDA using Microsoft System Center Configuration Manager (SCCM) or similar software distribution tools, Citrix recommends addressing the phases separately. In other words, instead of using the VDA installer to install both the prerequisites and the VDA, we recommend that you first install the prerequisites using the prerequisites’ installers, and then install the VDA using a VDA installer.

Identify requirements and task sequence

Prerequisites must be installed on the machine before the VDA is installed. VDA prerequisites vary, depending on the VDA version. For guidance, see the system requirements for the VDA version you’re installing:

Similarly, the need to install these prerequisites can vary between environments (for example, based on the target machines’ operating system, and what the machines already have installed). Before creating scripts or task sequences, it is important to understand your environment’s specific requirements (such as which prerequisites need to be installed). Then, you can properly define the task sequence.

Tip: A good way to collect this information is by manually installing the VDA in one of the machines in the environment. This process reveals which prerequisites are identified as needed and installed throughout the VDA installation process.

The installation files for the VDA’s prerequisites are included in the installation media for the Citrix Virtual Apps and Desktops (or XenApp and XenDesktop) release under the Support folder. Use those files to ensure that you’re installing the correct prerequisite versions.

Restarts

The required number of restarts during the installation of prerequisites and the VDA depends on the environment. For example, a restart might be required for pending updates or restarts from earlier software installations. Also, files previously locked by other processes might need updates.

  • During the manual installation, identify which prerequisites trigger a restart.
  • Some optional components in the VDA installer (such as Citrix Profile Management, Citrix Files) might require a restart. During the manual installation, identify which component installations trigger a restart.

Define the task sequence

After identifying all prerequisites and restarts, use the SCCM Task Sequencer to complete the following:

  1. Create separate SCCM jobs for installing each prerequisite. This helps isolate any issues or failures that occur during the deployment, which facilitates troubleshooting.

  2. Create the VDA installation job. Do not execute this job until all prerequisites are successfully installed. This can be accomplished one of two ways:

    • Have the SCCM client monitor the prerequisites’ GUIDs to determine whether they are present.
    • Make the VDA installation job dependent on the prerequisites’ jobs.

SCCM installation sequence example

The following is an example SCCM installation sequence. Remember: Your prerequisite versions may differ, depending on which VDA version you’re installing.

  1. SCCM JOB1: Microsoft .NET Framework 4.8
  2. SCCM JOB2: Microsoft Visual C++ 2017 Runtime (32-bit and 64-bit)
  3. SCCM JOB3: VDA installation
    1. Use the appropriate VDA installer command, based on requirements. Add the /quiet, /noreboot, and /noresume options. (The /noresume option removes the dependency on the interactive login to continue the install, thus allowing SCCM to drive the installation process.)
    2. Watch for return codes.
      • 0: success, installation complete, restart required.
      • 3: success, installation is not complete, restart required.
      • 8: success, installation complete, restart required.
    3. Restart the machine.
    4. If the return code was 3, repeat step 3a. (When upgrading a VDA, additional restarts are necessary.)

For more information about return codes see Citrix installation return codes.

VDA installation command examples

The available installation options vary, depending on which installer is used. See the following articles for command line option details. (Links are provided to Citrix Virtual Apps and Desktops Current Release locations. If you’re using an LTSR product version, see the equivalent LTSR articles.)

Installation commands for Remote PC Access

  • The following command uses the single-session core VDA installer (standalone VDAWorkstationCoreSetup.exe):

    VDAWorkstationCoreSetup.exe /quiet /controllers “control.domain.com” /enable_hdx_ports /noresume /noreboot

  • The following command uses the single-session full VDA installer (standalone VDAWorkstationSetup.exe):

    VDAWorkstationSetup.exe /quiet /remotepc /controllers “control.domain.com” /enable_hdx_ports /noresume /noreboot

Installation command for dedicated VDI

  • The following command uses the single-session full VDA installer (standalone VDAWorkstationSetup.exe):

    VDAWorkstationSetup.exe /quiet /components vda /controllers “control.domain.com” /enable_hdx_ports /enable_remote_assistance /noresume /noreboot

Install VDAs using SCCM
April 21, 2023
Contributed by: 
C L
April 21, 2023
Contributed by: 
C L

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.