17.6. USB Device Redirection

17.6.1. Device Access
17.6.2. Supported Configurations
17.6.3. Tested USB Devices
17.6.4. Additional Notes
17.6.5. How to Add USB Drivers to a Virtual Machine
17.6.6. USB Redirection Troubleshooting

The USB redirection feature enables users to access USB devices connected to a Sun Ray Client from their Windows sessions, provided that the appropriate device drivers are installed on the Windows system.

Once you install the USB redirection component and add USB Drivers to the Virtual Machines (when needed), users can simply plug in and access the USB devices from their Sun Ray Client.

Note

Human Interface Devices (HID) such as keyboards and mice do not use the USB redirection component.

The USB device service is enabled by default on the Sun Ray server, which enables the USB redirection functionality to work on the clients. You can use the utdevadm command or the Advanced > Security page on the Admin GUI to check if the USB device service is enabled.

17.6.1. Device Access

The accessibility of USB devices through USB redirection is determined by what Windows operating system you are using for the remote desktop connection.

When using the single-user Windows XP, Windows 7, and Windows 8 platforms, the USB devices connected to a client are accessible only to the user logged into the client's Windows session.

When using the Windows Server 2003 R2, Windows Server 2008 R2, and Windows Server 2012 platforms, the USB devices connected to a client are accessible and visible to all desktops running on the Windows system. Sharing USB devices between multiple clients does not require any additional setup. Users are always prompted to verify if it is acceptable to share their USB device with others.

17.6.2. Supported Configurations

For the list of supported Windows operating systems, see Section 3.1.3, “Windows Remote Desktop Support”.

USB redirection is available through the following configurations:

  • Windows connector in kiosk mode

  • VMware View connector in kiosk mode

17.6.3. Tested USB Devices

For the list of USB devices tested to work with the USB redirection feature, see the Sun Ray Client and Oracle Virtual Desktop Client Peripherals document on the Oracle Technology Network.

Note

USB headsets do not require or use USB redirection. See Section 15.6, “USB Headsets” for details.

17.6.4. Additional Notes

  • Devices should be connected to a user's session only after a Windows session is established. When users exit their session, the device should be disconnected.

  • If a device is connected before a Windows session is established and the device is not available in the Windows session, hotplugging the device will make it available to the Windows session.

  • Before disconnecting a USB device being used through USB redirection during a live Windows session, users must follow the same steps to safely remove the USB device as if the device were directly connected to Windows.

  • There is no limit to the number of USB devices that USB redirection can support on a client. A USB hub can be used to expand the number of physical USB ports if needed.

  • CCID-compliant USB smart card readers do not use USB redirection. Instead, they use the RDP smart card channel if the -r scard:on option of the uttsc command is specified. USB smart card readers that are not CCID-compliant use USB redirection, but they cannot be used for Windows session authentication.

  • The following scenarios might lead to data corruption on the device:

    • Hotplugging a device during data transfer

    • Hotdesking during data transfer

    • If the session is disconnected for any reason

  • Some unpowered USB devices may draw more current than what is supported by the Sun Ray Client. If you see the icon shown in Figure 17.7, “USB Redirection Overcurrent Icon”, then the device may not work properly.

    Figure 17.7. USB Redirection Overcurrent Icon

    ALT TEXT

  • Writing files to USB flash drives with Oracle Linux may take longer than expected. This reduced performance is because of the 1 Kbyte block size and the file synchronization mechanism of Oracle Linux.

  • Writing files to USB secure flash drives may require administrator permissions on the Windows system.

17.6.5. How to Add USB Drivers to a Virtual Machine

If your Virtual Machine (VM) does not have the USB driver installed by default, you must install the driver for USB device redirection to work properly. Examples of VMs that require this step include VMWare ESX and Hyper-V Server.

This procedure should be done before the USB redirection feature is installed. For details on installing the USB redirection feature, see Section 3.2.7, “How to Install the Windows Connector Components on a Windows System”.

  1. Make sure the Windows system has access to the Windows XP ISO used to create the VM.

  2. Copy the usbd.sy_ file from the Windows XP ISO to the VM.

    For 32-bit:

    cp ISO-image\i386\usbd.sy_ \windows\system32\drivers
    

    For 64-bit:

    cp ISO-image\amd64\usbd.sy_ \windows\system32\drivers
    
  3. Change to the drivers directory.

    cd \windows\system32\drivers
  4. Install the USB drivers.

    expand usbd.sy_ usbd.sys
  5. Reboot the VM.

17.6.6. USB Redirection Troubleshooting

Here is a list of questions if USB redirection is not working.

  • Is the USB redirection taskbar icon displayed in the Window's System Tray.

  • Are you using a tested USB device? Check the Sun Ray Client and Oracle Virtual Desktop Client Peripherals document for the list of tested USB devices.

  • Are you using USB redirection in a supported configuration. See Section 17.6.2, “Supported Configurations” for details.

  • Is the USB device service enabled on the Sun Ray server? Use the utdevadm command or the Advanced > Security page on the Admin GUI to check if the USB device service is enabled.

  • Are you using a USB device that draws more current than what is supported by the Sun Ray Client. If there is a power problem with the device, the overcurrent icon is displayed, as shown in Figure 17.7, “USB Redirection Overcurrent Icon”.

  • Was the USB device was plugged in after the Windows session was established? If not, disconnect the USB device and plug it in again.

  • Are you using a USB external smart card reader for session authentication. If so, this will produce unpredictable behaviors.

  • Is the device driver for the USB device configured properly in the Windows Device Manager?

    If the device driver is not configured properly, a yellow question mark is displayed next to the USB device's entry in the Device Manager. You must install the device driver for the USB device on the Windows system.

  • Are the USB redirection device drivers (utSrServerBus and utSrDtuBus) configured properly in the Windows Device Manager?

    Figure 17.8, “Verifying USB Redirection in Windows Device Manager” shows that the USB redirection component is configured properly (utSrServerBus under Device Manager/System devices and utSrDtuBus under Device Manager/Universal Serial Bus controllers). If they are missing, you must reinstall the USB redirection component. See Section 3.2.7, “How to Install the Windows Connector Components on a Windows System” for details.

    Figure 17.8. Verifying USB Redirection in Windows Device Manager

    Screenshot of the Windows Device Manager showing that the USB redirection device drivers are configured properly.

17.6.6.1. How to Verify that USB Redirection is Active

When USB redirection is active and running in a session, a USB redirection taskbar icon is displayed in the Windows desktop taskbar, as shown in Figure 17.9, “Verifying USB Redirection is Active”.

Figure 17.9. Verifying USB Redirection is Active

Screenshot showing a USB redirection taskbar icon indicating that USB redirection is active.

When you see this icon, you can connect USB devices to the Sun Ray Client.

If you don't see this icon but you know the component is installed, run the following command on the Windows system to restart the USB redirection component:

C:\Program Files\Oracle\Sun Ray\utUsbRedirector\utUsbRedirector.exe

17.6.6.2. USB Redirection Log File

By default, the /var/opt/SUNWut/log/uttscpd.log log file provides some USB redirection error messages. To enable full debug information for USB redirection, perform the following steps:

  1. Become superuser on the Sun Ray server.

  2. Uncomment the USB_DEBUG_ON variable in the /etc/init.d/uttscp file and make sure it is set to something like "-D 20"

    USB_DEBUG_ON="-D 20"
  3. Restart the Windows connector proxy daemon.

    # /opt/SUNWuttsc/sbin/uttscrestart