Configuring USB Device Auto redirection on newer Citrix workspace App for Windows

Configuring USB Device Auto redirection on newer Citrix workspace App for Windows

book

Article ID: CTX692553

calendar_today

Updated On:

Description

USB Device Auto redirection configuration on newer Citrix workspace App for Windows


Instructions

Introduction

In the Citrix Workspace App for Windows 2109, a new device rules keyword “CONNECT” was introduced to provide more granular control over automatic redirection of USB devices, enhancing security and usability. This change fundamentally changes the way USB devices are automatically redirected inside the HDX session.

This document lists out the steps needed to configure USB device auto redirection using the CONNECT keyword on client machines. 

The auto-redirection behavior of USB devices may differ based on the versions of Citrix Virtual Apps and Desktops (CVAD) and Citrix Workspace App (CWA). The following table provides an overview of expected behavior and links to additional details.

Component versions

Default auto-redirection behavior

Additional links

  • Citrix Virtual Apps and Desktops: 2209 or older  

  • Citrix Workspace App for Windows: 2203 or newer

USB auto-redirection is disabled by default. It must be enabled through client-side settings as described in this doc below.

https://docs.citrix.com/en-us/citrix-virtual-apps-desktops/devices/usb-devices/legacy-usb-redirection-configuration

  • Citrix Virtual Apps and Desktops: 2212 or newer

  • Citrix Workspace App for Windows: 2212 or newer

USB auto-redirection is disabled by default. However, it can be enabled using Web Studio policy settings.

https://docs.citrix.com/en-us/citrix-virtual-apps-desktops/devices/usb-devices/configuration

 

Steps to configure USB Device auto-redirection 

1. Enable Client USB device redirection policy setting in Studio.

2. The following changes need to be made on the client side registry or GPO in order to get devices to automatically redirected -

Set appropriate GPOs on the client

  • Open Local Group Policy Editor on the client machine.

  • Navigate to Administrative Templates > Citrix Components > Citrix Workspace > Remoting client devices > Generic USB Remoting > USB Device Rules.

USB-GPO.jpg

  • Create a rule with the Connect keyword for the device that needs to be automatically redirected. Ex. CONNECT: VID=06A8 PID=0043

  • Set the Existing USB Devices and New USB Devices settings to "Always"

  • If you cannot find the template, please review documentation available here.

Using client side registry:

  • Open registry editor on the client machine and navigate to HKLM\SOFTWARE\Wow6432Node\Citrix\ICA Client\GenericUSB

  • Create a multi-string [REG_MULTI_SZ] value named "DeviceRules" (if it does not already exist). 

USB-ClientSideRegKey-1.jpg

  • Add a new rule with the following format (before the ALLOW: rule at the bottom of the list) - "CONNECT: vid=xxxx pid=yyyy #device name". (Replace `xxxx` and `yyyy` with the Vendor ID and Product ID of the USB device).

  • Navigate to `HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\USB` and set the following string values -

    • "ExistingDevices"="Always"

    • "NewDevices"="Always"

USB-ClientSideRegKey-2.jpg

 

Environment

Caution! Using Registry Editor incorrectly can cause serious problems that might require you to reinstall your operating system. Citrix cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk. Be sure to back up the registry before you edit it.

Additional Information

To find the VID/PID of a connected USB device you can use the Microsoft Utility USBview (https://learn.microsoft.com/en-us/windows-hardware/drivers/debugger/usbview) or by using device manager, right clicking the respective device and selecting properties. From the properties screen, select the details tab, then "Hardware IDs" from the dropdown list.