Drivers Citrix USB Devices

by



  • 3Configuring Automatic Device Forwarding
  • 4Troubleshooting

Requirements

  • Citrix XenApp 7.6+ / XenDesktop 5.6+
  • Citrix Receiver 4.2+
  • VDA Running Windows Server 2012 R2 or Higher

Citrix Receiver is an easy-to-install software client that lets you access your desktops, applications and data easily and securely from any device, including smartphones, tablets, PCs and Macs. The USB redirection for Citrix XenDesktop is managed by Citrix Desktop Studio. In order to accept USB redirection for “all” devices please perform the following steps: 1. Open CTX Desktop Studio 2. Go to HDX/Users in the policy folder 3. Edit the filter or policy that applies to the user, which is not working 4. Go to the settings tab 5.

2) I need to know how to configure my Wyse OS to be able to also use audio over generic USB redirection (mapping the Jabra USB headset directly to the Citrix session so the headset is viewable within Windows device manager of the Citrix session) within my Citrix session. The USB device is a specialized device, such as test and measurement equipment or an industrial controller. An application requires direct access to the device as a USB device. The USB device only has a Windows driver available. For example, a smart card reader may not have a driver available for Citrix Receiver for Android.

Configuring Citrix XenApp/XenDesktop Policy

  • Start Citrix Studio
  • Go to 'Policies' on the left-hand side.
  • Either edit an existing policy, or create a new policy.
  • Edit 'Client USB device redirection', set it to 'Allowed'.
  • Edit 'Client USB device redirection rules', click 'New' and type: 'Allow: VID=18FB' (space and capitalization is important, no quotes).
    • If you wish to also include the PID in your redirection rule, please view our list of USB IDs.
  • Click 'Finish' and close Citrix Studio.

Configuring Automatic Device Forwarding

Using Group Policy

  • Open the group policy editor for the policy controlling your Citrix Receiver client's.
  • Go to Administrative Templates -> Citrix Components -> Citrix Receiver -> Remoting client devices -> Generic USB Remoting (if this is missing you need the Citrix Group Policy Extensions, see here).
  • Open 'New USB Devices', select 'Enabled', click 'OK'.
  • Open 'Existing USB Devices', select 'Enabled', click 'OK'.
  • If you need to restrict which devices get automatically forwarded, open 'USB Device Rules', add the required rules and hit 'OK'.
  • Run 'gpupdate /force' as an administrator on the client computer you're testing on to make sure you have the newest version of the policy.

Using the Registry

  • Create a new key located at: HKLMSOFTWARECitrixICA ClientGenericUSBDevicesVID18FB PID0200 (replace PID0200 with the product id for the product you're looking to forward).
  • Create a new DWORD value named 'AutoRedirect' and set it to '1'.
  • Navigate to the key: HKEY_LOCAL_MACHINESOFTWAREPoliciesCitrixICA ClientUSB
  • To automatically redirect devices when the session starts create a new String Value named 'ExistingDevices' and set it to 'always'
  • To automatically redirect devices when they are plugged in create a new String Value named 'NewDevices' and set it to 'always'

Troubleshooting

Receiver Drivers

  • Citrix Receiver installs two drivers to support USB forwarding functionality
  • In a command prompt run: driverquery
  • A list of installed drivers should display and look like this:
  • Verify that both ctxusbm and Ctxusbr are in the list
  • If a driver is missing, attempt a reinstall of Citrix or contact support to attempt to resolve the missing driver issue
Retrieved from 'https://wiki.scriptel.com/index.php?title=Using_Citrix_XenApp_USB_Forwarding&oldid=1826'
  • 1Overview
  • 2Details
    • 2.3Host USB in xm/xend
  • 3More info

There are two general methods for passing through individual host devices to a guest. The first is via an emulated USB device controller; the second is PVUSB.

Additionally, there are two ways to add USB devices to a guest: via the config file at domain creation time, and via hot-plug while the VM is running.

Another popular method for passing through USB devices, particular for gaming rigs, is to use PCI pass-through to pass through the entire host USB controller. This will result in the lowest overhead and best feature support. It does mean however that you cannot choose individual USB devices on a controller to the guest: it's all or nothing. This is suitable for both PV and HVM guests.

There are also non-Xen solutions like USB IP, in which USB devices are shared over the network.

Emulated USB

In emulated USB, the device model (qemu) presents an emulated USB controller to the guest. The device model process then grabs control of the device from domain 0 and and passes the USB commands between the guest OS and the host USB device.

This method is only available to HVM domains, and is not available for domains running with device model stub domains.

PVUSB

PVUSB uses a paravirtialized front-end/back-end interface, similar to the traditional Xen PV network and disk protocols. In order to use PVUSB, you need usbfront in your guest OS, and usbback in dom0 or usb backend in qemu (or your USB driver domain).

Unfortunately, kernel support for the PVUSB protocol isn't very good currently. See the section below for links to more information about PVUSB driver support.

Additionally, for easy use of PVUSB, you need support in the toolstack to get the two sides to talk to each other. (Alternately, you can write a script to talk over xenstore to the front and backends manually; see the section below for more information.)

Mbed

Currently PVUSB supports USB 1.1 and USB 2.0. PVUSB supports both PV and HVM guests.

As of Xen 4.4 PVUSB is only supported with xm/xend toolstack.

Since Xen 4.7, PVUSB support to XL/libxl toolstack is introduced. For PVUSB in xl, usb backend can be usbback in dom0 or usb backend in qemu, so called 'qusb'. Later one is still in process.

Specifying a host USB device

USB devices are primarily specified either by their bus address (in the form bus.device) or their device tag (in the form vendorid:deviceid).

Download citrix usb devices driver windows 10. Each way of specifying has its advantages:

  • Specifying by device tag will always get the same device, regardless of where the device ends up in the USB bus topology. However, if there are two identical devices, it will not allow you to specify which one.
  • Specifying by bus address will always allow you to choose a specific device, even if you have duplicates. However, the bus address may change depending on which port you plugged the device into, and possibly also after a reboot.

You can use lsusb to list the USB devices on the system:

To pass through the Logitec mouse, for instance, you could specify either 046d:c016 or 1.6.

Note: lsusb lists the bus and device number with leading zeroes, but you should remove these when specifying the device to xl. (Leading zeroes will result in xl interpreting the number as an octal.)

Host USB in xl

As of Xen 4.6, xl only has support for emulated USB, from the config file.

Enable the emulated USB hub with usb=1. Then specify devices among the list of devices in the config file along with other emulated devices by using host:USBID. For example:

The default USB controller created by qemu is USB 1.1. For some devices, this isn't sufficient. For this reason, as of 4.6, you can specify that the USB controller version as well, with usbversion. However, at the moment this is incompatible with usbdevice, and so is only useful in conjunction with spice USB redirection. This option is not available for qemu-traditional.

As of Xen 4.7, xl PVUSB support and hot-plug support is introduced.

From the config file, specify USB controllers and USB host devices with usbctrl and usbdev. For example:

To hot-plug PVUSB device, use commands usbctrl-attach, usbctrl-detach, usb-list, usbdev-attach and usb-detach. For example:

Host USB in xm/xend

Note: xend/xm has been deprecated since 4.2, and is removed from Xen 4.5.

xend has support for both emulated USB and PVUSB.

Usb

Please note however, that emulated USB and PVUSB use different sets of commands, both for hotplug, and in the config file, and the naming scheme isn't very obvious.

Emulated USB in xm/xend

In order to use emulated USB, you must enable it in the config file with usb=1.

You can specify a device in the config file; but unfortunately the xend syntax for usbdevice only allows you to specify a single USB device of any kind:

Fortunately, you can also hot-plug and un-plug devices after boot:

  • xm usb-add domain host:xx.yy
  • xm usb-del domain host:xx.yy

xend only supports USB 1.1, because xm/xend only supports qemu-dm-traditional. USB 2.0 and USB 3.0 are only supported with qemu-upstream and XL.

PVUSB in xm/xend

PVUSB uses the following hotplug commands: usb-hc-create, usb-hc-destroy, usb-attach, usb-destroy

PVUSB can also be specified in the config file via the vusb directive.

Please see the xm and xm.cfg man pages for more information. Rainbow china usb devices driver download for windows 10.

Citrix

PVUSB in xl/libxl

The support for PVUSB in xl/libxl is introduced since Xen 4.7, including both PVUSB device from config file and PVUSB device hot-plug and un-plug. Currently it supports USB 1.1 and USB 2.0.

From the config file, specify USB controllers and USB host devices with usbctrl and usbdev. For example:

For type you can specify auto (the default: xl tries to select the most appropriate type), qusb (paravirtualized qemu based backend, should be specified for pvUSB used by HVM domains), pv (paravirtualized kernel based backend, not supported by current standard linux), or devicemodel (qemu emulated USB controller, not yet supported).

You can also specify usbdev only, for example:

Drivers Citrix USB Devices

Then it will automatically create a USB controller of version 2.0 and 8 ports, and attach the USB device to the first port of this new controller.

To hot-plug and un-plug PVUSB device, use commands usbctrl-attach, usbctrl-detach, usb-list, usbdev-attach and usbdev-detach. For example:

This will create a USB controller which is version USB 1.1 and has 8 ports.

Drivers Citrix Usb Devices Pc Camera

This will show all USB controllers and USB devices in the domain.

This will find the first available controller:port in the domain, and attach USB device whose busnum:devnum is 1:2 to it.One can also specify controller and port.

This will detach USB device under controller 0 port 1.

This will remove USB controller with the indicated dev_id, and all USB devices under it.

PVUSB support in Xen 4.0 and newer versions

PVUSB is a new high performance method of doing USB passthru from dom0 to the guests, supporting both USB 2.0 and USB 1.1 devices. PVUSB does not use Qemu-dm. PVUSB can be used with both HVM and PV domUs, but it requires special pvusb drivers in dom0 kernel (xen-usbback) and the frontend driver (xen-usbfront) in the VM.

Presentation slides about PVUSB from XenSummits (contains usage examples and syntax):

  • February 2009 PVUSB: http://www.xen.org/files/xensummit_oracle09/PVUSB.pdf
  • November 2009 PVUSB update: http://www.xen.org/files/xensummit_intel09/PVUSBStatusUpdate.pdf

Links related to PVUSB:

  • A script to use PVUSB in an easier way with Xen: http://www.neobiker.de/wiki/index.php?title=XEN-PVUSB
  • Submission of PVUSB drivers to Xen, usage help etc: http://lists.xensource.com/archives/html/xen-devel/2009-03/msg01084.html
  • PVUSB updates from 10/2009: http://lists.xensource.com/archives/html/xen-devel/2009-10/msg00257.html
  • PVUSB xm/xend support: http://lists.xensource.com/archives/html/xen-devel/2009-12/msg00478.html and http://xenbits.xen.org/xen-unstable.hg?rev/2e5032921b07
  • Mailinglist discussions about PVUSB: http://article.gmane.org/gmane.comp.emulators.xen.devel/70980, http://old.nabble.com/anyone-using-pvusb--td25273516.html

Xen Linux kernels that have PVUSB support included:

  • linux-2.6.18-xen has both the PVUSB backend and frontend drivers included. http://xenbits.xen.org/linux-2.6.18-xen.hg
  • PVUSB drivers are currently being ported to the pvops kernel (2.6.32). RFC patch available from: http://lists.xensource.com/archives/html/xen-devel/2011-01/msg00354.html (http://members.iinet.net.au/~nathanael/pvusb.diff).
  • Novell/SuSe SLES11 SP1 kernel-xen (2.6.32) has PVUSB backend and frontend drivers.
  • SuSe SLES12 kernel-xen (3.x) has PVUSB backend and frontend drivers.
  • OpenSuSe also has PVUSB drivers.
  • Linux 3.x pvops PVUSB patches: http://lists.xen.org/archives/html/xen-devel/2012-02/msg00576.html and http://lists.xen.org/archives/html/xen-devel/2012-02/msg00571.html .
Drivers citrix usb devices pc camera

More information about different kernel versions and drivers in them:

Drivers Citrix USB Devices
  • List of various Xen dom0 capable kernel trees for Linux: XenDom0Kernels:
  • List of Xen features in different Linux kernel trees: XenKernelFeatures:

Drivers Citrix Usb Devices Wireless Adapter

Windows Xen PVUSB drivers (frontends):

  • Xen Windows GPLPV drivers by James Harper have an early version of PVUSB frontend driver included.
  • Discussion about initial GPLPV usbfront implementation: http://lists.xensource.com/archives/html/xen-devel/2009-09/msg00491.html
Retrieved from 'https://wiki.xenproject.org/index.php?title=Xen_USB_Passthrough&oldid=17231'