Have an account?

  •   Personalized content
  •   Your products and support

Need an account?

Create an account

Deployment Guide for Cisco Webex for Virtual Desktop Infrastructure (VDI)

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Deployment Guide for Cisco Webex for Virtual Desktop Infrastructure (VDI)

Chapter Title

Deploy Webex for VDI

Results

Updated:
February 4, 2021

Chapter: Deploy Webex for VDI

Deploy Webex for VDI

Configure Hosted Virtual Desktop for Webex

To prepare for your users wanting to access Webex remotely, set up Webex on the centralized hosted virtual desktop (HVD) environment.

Before you begin

  • Follow all the prerequisites in Prepare Your Environment for Webex for VDI.


    Important

    If you want your Webex VDI users to have access to calling features in your organization, you must deploy a call service (Unified CM or Webex Calling) before you deploy VDI.

  • This section only covers how to install Webex in an existing HVD environment. See the Citrix or Vmware documentation for HVD deployment best practices.

Procedure

Step 1

Sign in to Microsoft Windows HVD as a new user with domain administration rights.

Step 2

Join the HVD to the corporate domain.
Step 3

Set up Citrix or VMware access to the HVDs.
Step 4

Go to https://www.webex.com/downloads/teams-vdi.html, and under Download Host Installer, download the Webex build for your HVD:

  • For 64-bit, download the x64 installer.
  • For 32-bit, download the x86 installer.
Step 5

Using administrative permissions, install the app on the HVD using this command and arguments:

  • VDI client in a persistent VDI setting—msiexec /i c:\Webex.msi ALLUSERS=1 ENABLEVDI=1 AUTOUPGRADEENABLED=0
  • VDI client in a non-persistent VDI setting—msiexec /i c:\Webex.msi ALLUSERS=1 ENABLEVDI=1 AUTOUPGRADEENABLED=0 ROAMINGENABLED=1

See the following table for explanations of the arguments that you can use when installing Webex in a VDI environment.

Step 6

Clone the HVD image.

For more information about the best practices for cloning Microsoft Windows HVD images, see the documentation for your Citrix or VMware product.


Note

All user preferences are in the roaming database (spark_roaming_store.db). This database is much smaller than the main db (spark_persistent_store.db). If you are a non-persistent VDI customer (a VDI environment that is deleted everytime the user logs out), you can quickly back up and restore spark_roaming_store.db so that VDI users won't lose preferences between sessions.

The roaming database contains all user credentials and preferences, encrypted using AES256. As a VDI customer, you should always back up the roaming database, so that user credentials and preferences are maintained across VDI sessions.

Installation Arguments, Explanations, and Required Privileges

See the following table for explanations of the arguments that you can use when installing Webex in a VDI environment.

Argument Notes Requires admin install privileges
ALLUSERS=1

Installs Webex in c:\program files. This is useful in a shared environment (typically non-persistent VDI).

If this argument is not specified, Webex is installed in %LocalAppData%\Programs\Cisco Spark

✓
AUTOUPGRADEENABLED=0

Prevents Webex from downloading updates in a VDI environment. The argument does not affect a non-VDI environment.

For VDI, this is necessary because you must use the versions that are provided on the Webex VDI download page at https://www.webex.com/downloads/teams-vdi.html.

This argument must be accompanied by ALLUSERS=1, otherwise the AUTOUPGRADEENABLED argument is ignored.

✓

ENABLEVDI=1

Enables the optimized VDI solution. (Officially supported.)

 ✓
ROAMINGENABLED=1

If this argument is specified, then the roaming database (spark_roaming_store.db) is stored in the user's roaming directory (AppData\Roaming). Otherwise the roaming database is stored in AppData\Local.

This argument must be accompanied by ALLUSERS=1, otherwise the ROAMINGENABLED argument is ignored.

✓

Installation Comparison

Users may be in a Citrix environment and not have the thin client installed or the virtual channel is disconnected. We support this scenario with fallback to a non-virtual Webex installation. In this mode, the app shows a warning that the quality of video may be affected. Once the virtual channel is connected, the app can change to VDI mode.

Use this table to understand the different installation combinations and how they affect media optimization for Unified CM, Webex Calling, and calls on Webex.

HVD VDI Argument Thin Client Plugin Unified CM or Webex Calling-Enabled User Calls on Webex
ENABLEVDI=0 Not installed Media is not optimized Media is not optimized
ENABLEVDI=0 Installed Media is not optimized Media is not optimized
ENABLEVDI=1 Installed Supported deployment; media is optimized Supported deployment; media is optimized
ENABLEVDI=1 Not installed Fallback to non-optimized media Fallback to non-optimized media

Configure Windows Virtual Desktop for Webex

Use these high-level steps to deploy a new Windows environment on Windows Virtual Desktop (WVD). WVD is a cloud-managed VDI solution. Users access Webex through a virtualized Windows environment.

Before you begin

This solution requires a Microsoft Azure subscription.

You must have a user account with the TenantCreator role.

User accounts must be synchronized into Azure Active Directory.

Procedure

Step 1

Walk through the deployment steps in the Azure admin portal to create the host pool, virtual machines, and related settings.

A host pool is a collection of VMs that offer a similar service. Azure indicates when the virtual environment is ready.
Step 2

Use the Windows client to test if a user can access the host pool.

For specific deployment steps, see the Microsoft documentation on getting started with Windows Virtual Desktop.

Configure VDI Optimization for Webex in Webex Control Hub

In Control Hub, you can use an organization-level setting to either enable or disable VDI optimization and detection for your Webex users. By default, the setting is enabled.


Note

This setting applies across your organization, unlike the installation parameters which affect your deployment at the server level.

Procedure

Step 1

From the customer view in https://admin.webex.com, go to Management > Organization Settings and then scroll to VDI for Cisco Webex.

Step 2

Choose a setting:

  • Toggled on (default)—Use this setting to enable the optimized VDI solution. Media paths are optimized for VDI architecture.
  • Toggled off—Use this setting if you want to use the non-optimized VDI solution. Media paths are not optimized for VDI architecture.

Install the Webex VDI Client on Windows Thin Client Systems

After Webex is installed on your HVD, you next install a Webex thin client build. Thin clients are typically lightweight or repurposed computers that users use to establish a remote connection with a centralized HVD server where Webex is hosted.

Before you begin

If you're running a 32-bit or 64-bit environment with VMware, make sure you download and install the VDI client that matches the VMware environment.

Procedure

Step 1

Go to https://www.webex.com/downloads/teams-vdi.html, and under Download Thin-client Installer, download the Webex build for your thin client systems:

  • For 64-bit, download the x64 installer.
  • For 32-bit, download the x86 installer.
Step 2

Double-click the msi file that you downloaded.

Step 3

To open the executable file, click OK.

Step 4

Read the EULA and, if you agree, click Accept and Install.

https://www.cisco.com/go/eula
Step 5

To complete the installation, click Finish.

Note 

For Webex to function properly for your users, you must use the thin client build. To confirm, the Health Check shows a connected status for the Virtual Channel.

Install the Webex VDI Client on Linux Thin Client Systems

After Webex is installed on your HVD, you next install a Webex thin client build. Thin clients are typically lightweight or repurposed computers that users use to establish a remote connection with a centralized HVD server where Webex is hosted. They are available at https://www.webex.com/downloads/teams-vdi.html.

Procedure

  • HP Thin Pro

    1. On the thin client, install the Webex VDI files in the following order, either manually from a USB stick, or use HP Device Manager for mass deployments.

      Order of installation:

      1. Prerequisites

      2. Webex for VDI .deb package.

      For more information about mass deployment, see the documentation for HP Device Manager 4.7, available from HP.

    2. Create an image for the thin clients. See the documentation for HP Device Manager 4.7, available from HP.

  • Ubuntu

    1. On the thin client, install the Webex VDI Client; enter your password at the authentication prompt.

      When you double-click the Webex for VDI deb package, the Ubuntu Software Center opens. After you click Install, the Ubuntu Software Center locates and installs the dependency libraries, and then installs the Webex Client.

    2. Create an image for the thin clients.

  • Unicon eLux

    1. On the thin client, install the Webex VDI Client and if required, deploy Cisco AnyConnect at the same time.

    2. Use the Elias tool to create an image that contains Webex VDI Client. Deploy the image to the thin clients. For more information about how to create an image or how to update the thin client, see the Elias documentation available from the Unicon website.

  • IGEL OS

    1. Ensure that a supported version of IGEL OS is installed on the thin client device, by creating a USB stick with the OS and booting from that stick on the device.)

      Download IGEL OS from https://www.igel.com/software-downloads/workspace-edition/.

    2. Use the Universal Management Suite (UMS) to update the system firmware as needed.

    3. For features, check Cisco Teams.

    4. Under the registry, enable the vdciscoteams parameter.

    5. Under Registry > vmware > view, check Cisco Teams.

    6. On the thin client, install the Webex VDI Client; enter your password at the authentication prompt.

    7. Create an image for the thin clients.


Note

For Webex to function properly for your users and be optimized for VDI, you must use the thin client build. To confirm, the Health Check in Webex shows a connected status for the Virtual Channel.

Enable or Disable Advanced Video Features in Fallback Mode

You can disable specific Webex features such as high definition (HD), screen sharing, or the blurred and virtual background features. Doing so can save resources on the server in the data center. You can also decide whether users can do full or HVD window only screen share. If your users are on systems that are capable of more advanced video features, you can enable the features as needed.

Before you begin


Note

Changes to the Windows registry should be done with extreme caution. We recommend that you make a backup of your registry before using these steps.

Virtual backgrounds are disabled by default. To enable them, follow the steps in Configure Virtual Backgrounds for Webex Users.

Procedure

Step 1

In Windows search or the Run window, type regedit and then press Enter
Step 2

Go to HKEY_LOCAL_MACHINE\Software\Cisco Spark Native\.

Step 3

Change values for the following registry keys as needed:
Step 4

Choose a DWORD value for VDIFallBackConf:

  • 0—Advanced video features are disabled. (Default)
  • 1—Advanced video features are enabled. Users will be in full mode, which is the same as Webex for Windows (audio, video, screen share and advanced video features).
  • 2—Video and screen sharing are disabled. Users are able to do audio only calls.
  • 3—Video is disabled. Users are able to do audio calls with sharing capability.
  • 4—Screen or application share only is enabled. Users cannot make audio or video calls and are in messaging only mode.
  • 5—A dialogue prompt shows an error message: “Due to your company policy, you are not allowed to start Webex Calling  without VDI-Optimized on Hosted Virtual desktop. Please ask your site admin for help.”
Note 

This registry key only works when enablevdi=1 during installation and the VDI plugin is not installed. because In fallback mode, datacenter load increases, so media is not used to prevent overload.

Step 5

Choose a DWORD value for VDIBackgroundEnabled:

  • 0—Disables virtual backgrounds when Webex is in optimized VDI mode. (Default)
  • 1—Disables virtual backgrounds when Webex is in optimized VDI mode.
Step 6

Choose a DWORD value for VDIScreenShareEnabled:

  • 0—Disables full screen sharing when Webex is in optimized VDI mode. With this setting, users can only share the HVD window view.
  • 1—Enables full screen sharing when Webex is in optimized VDI mode. (Default)

Known Issues and Limitations With Webex for VDI

Webex and VDI Client

  • For VDI mode, we only support the provided Webex for Windows and Webex VDI client versions that are posted on https://www.webex.com/downloads/teams-vdi.html.

  • You must disable auto upgrade for Webex and use the versions that are available on the download link above.

  • We only support IPv4 for the HVD and thin client environments.

  • When users either don't use the VDI optimized solution or are in fall back mode, HD video is disabled and Webex shows a notification that you may see a media quality issue.


    Note

    We do not recommend that users use VDI in unoptimized or fallback mode. Their camera or headset may not work and they may experience poor media quality.

Calling

  • For on-premises calling only with Expressways that are release X12.6 or earlier: if there is is no NAT between the HVD and Expressway-E in a traversal pair used for MRA, Expressway treats the SIP and media signaling as internal and does not transmit the media to the thin client. As a workaround, deploy a NAT between the HVD and the Expressways. That way, when HVD sends a SIP INVITE to the Expressway-E, it goes to the NAT first. Then, Expressway-E can transmit to the thin client. You can also upgrade your Expressway-E to release X12.7 or later to fix this issue.

Citrix

  • In non-optimization mode or fall back mode, Citrix device mapping supports a maximum of 4 devices.

  • On Citrix for Linux, we only support voicemail playback by using the default device on the thin client. So when you want to play back voicemail using your preferred audio device, you need to open the sound settings on the thin client to set the device that you want to use by default.

  • You must install Citrix Receiver/Workspace before you install the Webex VDI client, including when you update the Receiver/Workspace environment. If either a Citrix or VMWare client are not installed, the Webex VDI client shows an error and the installation ends.

  • For Windows, if you're running a version of Citrix Workspace that is earlier than 2002, you must reinstall (uninstall and then install again or repair) the Webex VDI client after you uninstall and reinstall the Citrix Receiver/Workspace. If you run version 2002 or later, you don't have to uninstall and reinstall.

    For all supported versions of Citrix Workspace for Linux, you must reinstall (uninstall and then install again or repair) the Webex VDI client after you uninstall and reinstall the Citrix Receiver/Workspace.

  • Citrix Receiver/Workspace uses 32 bit architecture. Both Webex VDI 32 bit and 64bit work with this environment.

Windows Virtual Desktop

  • On Windows Virtual Desktop for on-premises Unified CM calling, we currently only support the thin client working under MRA. Webex in a WVD desktop (a cloud based remote desktop) works on MRA. If the thin client is on-premises, Unified CM calling may be blocked by some firewall settings. Webex Calling and Webex built-in calling are not affected.

  • Windows Virtual Desktop doesn't support "Fit session to Window" in the WVD client setup.

  • For Windows Virtual Desktop deployments, you must enable the UDP connections between the internal network and the Expressway-E—port ranges from 16384–32767.

VMWare

  • You must install VMWare Horizon client before you install the Webex VDI client. If either a Citrix or VMWare client are not installed, the Webex VDI client shows an error and the installation ends.

  • The VMWare Horizon client only has one installer and the default installation is 64 bit, The Webex VDI client must have the same architecture with VMWare Horizon client: the 64 bit VMWare Horizon client only works with the 64 bit Webex VDI client. If vdpService.dll exist under the folder C:\Program Files (x86)\VMware\VMware Horizon View Client\x64, you have the 64 bit VMWare Horizon client. If vdpService.dll is under C:\Program Files (x86)\VMware\VMware Horizon View Client\, you have the 32 bit VMWare Horizon client.

  • On VMWare for Linux and Windows, we only support voicemail playback by using the default device on the thin client. So when you want to play back voicemail using your preferred audio device, you need to open the sound settings on the thin client to set the device that you want to use by default.

  • On VMware Cloud desktop for on-premises Unified CM calling, we currently only support the thin client working under MRA. Webex in a VMware Cloud desktop (a cloud based remote desktop) works on MRA. If the thin client is on-premises, Unified CM calling may be blocked by some firewall settings. Webex Calling and Webex built-in calling are not affected.

  • For VMware Cloud desktop deployments, you must enable the UDP connections between the internal network and the Expressway-E—port ranges from 16384–32767.

Miscellaneous

  • In Citrix and Windows Virtual Desktop vGPU environments, Webex is not detected as working in a VDI environment.

    These Windows registry entries on the HVDs is used to detect Webex in a VDI environment:

    • [HKEY_CURRENT_USER\Software\Cisco Systems, Inc.\CiscoVDI] "isVDIEnv" = "true", datatype:REG_EXPAND_SZ

    • [HKEY_LOCAL_MACHINE\SOFTWARE\Cisco Spark Native] "isVDIEnv" = "true", datatype:REG_EXPAND_SZ

  • We support one Webex VDI client working together with one instance of Webex. Users can start multiple Citrix or VMWare sessions, but only one connection instance works and the other instances fall back to non-VDI mode.

  • Webex VDI detects Citrix at first and then VMWare in the HVD environment. If you want to use VMWare, make sure no Citrix Agent is installed.

Was this Document Helpful?

FeedbackFeedback

Contact Cisco

Related Cisco Community Discussions

About Us
Contact Us
Work with Us