17.5. The USB Filter Editor
17.5.1. Installing the USB Filter Editor
The USB Filter Editor is a Windows tool used to configure the usbfilter.txt
policy file. The policy rules defined in this file allow or deny automatic pass-through of specific USB devices from client machines to virtual machines managed using the Red Hat Enterprise Virtualization Manager. The policy file resides on the Red Hat Enterprise Virtualization Manager in the following location:
/etc/ovirt-engine/usbfilter.txt
ovirt-engine
service on the Red Hat Enterprise Virtualization Manager server is restarted.
USBFilterEditor.msi
file from the Content Delivery Network: https://rhn.redhat.com/rhn/software/channel/downloads/Download.do?cid=20703. The file works with Red Hat Enterprise Virtualization 3.0 and above.
Procedure 17.3. Installing the USB Filter Editor
- On a Windows machine, launch the
USBFilterEditor.msi
installer obtained from the Content Delivery Network. - Follow the steps of the installation wizard. Unless otherwise specified, the USB Filter Editor will be installed by default in either
C:\Program Files\RedHat\USB Filter Editor
orC:\Program Files(x86)\RedHat\USB Filter Editor
depending on your version of Windows. - A USB Filter Editor shortcut icon is created on your desktop.
Important
The default USB device policy provides virtual machines with basic access to USB devices; update the policy to allow the use of additional USB devices.
17.5.2. The USB Filter Editor Interface
- Double-click the USB Filter Editor shortcut icon on your desktop.
Figure 17.1. Red Hat USB Filter Editor
Table 17.1. USB Editor Fields
Name | Description |
---|---|
Class | Type of USB device; for example, printers, mass storage controllers. |
Vendor | The manufacturer of the selected type of device. |
Product | The specific USB device model. |
Revision | The revision of the product. |
Action | Allow or block the specified device. |
17.5.3. Adding a USB Policy
Add a USB policy to the USB Filter Editor.
Procedure 17.4. Adding a USB Policy
- Click the Add button. The Edit USB Criteria window opens:
Figure 17.2. Edit USB Criteria
- Use the USB Class, Vendor ID, Product ID, and Revision check boxes and lists to specify the device.Click the Allow button to permit virtual machines use of the USB device; click the Block button to prohibit the USB device from virtual machines.Click OK to add the selected filter rule to the list and close the window.
Example 17.8. Adding a Device
The following is an example of how to add USB ClassSmartcard
, deviceEP-1427X-2 Ethernet Adapter
, from manufacturerAcer Communications & Multimedia
to the list of allowed devices. - Click File → Save to save the changes.
You have added a USB policy to the USB Filter Editor. USB filter policies need to be exported to the Red Hat Enterprise Virtualization Manager to take effect.
17.5.4. Removing a USB Policy
Remove a USB policy from the USB Filter Editor.
Procedure 17.5. Removing a USB Policy
- Select the policy to be removed.
Figure 17.3. Select USB Policy
- Click Remove. A message displays prompting you to confirm that you want to remove the policy.
Figure 17.4. Edit USB Criteria
- Click Yes to confirm that you want to remove the policy.
- Click File → Save to save the changes.
You have removed a USB policy from the USB Filter Editor. USB filter policies need to be exported to the Red Hat Enterprise Virtualization Manager to take effect.
17.5.5. Searching for USB Device Policies
Search for attached USB devices to either allow or block them in the USB Filter Editor.
Procedure 17.6. Searching for USB Device Policies
- Click Search. The Attached USB Devices window displays a list of all the attached devices.
Figure 17.5. Attached USB Devices
- Select the device and click Allow or Block as appropriate. Double-click the selected device to close the window. A policy rule for the device is added to the list.
- Use the Up and Down buttons to change the position of the new policy rule in the list.
- Click File → Save to save the changes.
You have searched the attached USB devices. USB filter policies need to be exported to the Red Hat Enterprise Virtualization Manager to take effect.
17.5.6. Exporting a USB Policy
USB device policy changes need to be exported and uploaded to the Red Hat Enterprise Virtualization Manager for the updated policy to take effect. Upload the policy and restart the ovirt-engine
service.
Procedure 17.7. Exporting a USB Policy
- Click Export; the Save As window opens.
- Save the file with a file name of
usbfilter.txt
. - Using a Secure Copy client, such as WinSCP, upload the
usbfilter.txt
file to the server running Red Hat Enterprise Virtualization Manager. The file must be placed in the following directory on the server:/etc/ovirt-engine/
- As the
root
user on the server running Red Hat Enterprise Virtualization Manager, restart theovirt-engine
service.# service ovirt-engine restart
The USB device policy will now be implemented on virtual machines running in the Red Hat Enterprise Virtualization environment.
17.5.7. Importing a USB Policy
An existing USB device policy must be downloaded and imported into the USB Filter Editor before you can edit it.
Procedure 17.8. Importing a USB Policy
- Using a Secure Copy client, such as WinSCP, upload the
usbfilter.txt
file to the server running Red Hat Enterprise Virtualization Manager. The file must be placed in the following directory on the server:/etc/ovirt-engine/
- Double-click the USB Filter Editor shortcut icon on your desktop to open the editor.
- Click Import to open the Open window.
- Open the
usbfilter.txt
file that was downloaded from the server.
You are able to edit the USB device policy in the USB Filter Editor.