- Notifications
You must be signed in to change notification settings - Fork250
Windows software for sharing locally connected USB devices to other machines, including Hyper-V guests and WSL 2.
License
dorssel/usbipd-win
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Windows software for sharing locally connected USB devices to other machines, including Hyper-V guests and WSL 2.
This software requires Microsoft Windows 10 (x64 only) / Microsoft Windows Server 2019, version 1809 or newer;it does not depend on any other software.
Run the installer (.msi) from thelatest releaseon the Windows machine where your USB device is connected.
Alternatively, use the Windows Package Manager:
winget install usbipd
This will install:
- A service called
usbipd(display name: USBIP Device Host).
You can check the status of this service using the Services app from Windows. - A command line tool
usbipd.
The location of this tool will be added to thePATHenvironment variable. - A firewall rule called
usbipdto allow all local subnets to connect to the service.
You can modify this firewall rule to fine tune access control.
Note
If you are using a third-party firewall, you may have to reconfigure it to allowincoming connections on TCP port 3240.
By default devices are not shared with USBIP clients.To lookup and share devices, run the following commands with administrator privileges:
usbipd--helpusbipd listusbipd bind--busid=<BUSID>
Sharing a device is persistent; it survives reboots.
Tip
See thewiki for a list of tested devices.
Attaching devices to a client is non-persistent. You will have to re-attach after a reboot,or when the device resets or is physically unplugged/replugged.
From another (possibly virtual) machine running Linux, use theusbip client-side tool:
usbip list --remote=<HOST>sudo usbip attach --remote=<HOST> --busid=<BUSID>
Note
Client-side tooling exists for other operating systems such as Microsoft Windows, but not as part of this project.
Tip
In case you have usedusbipd with WSL 2 before, the following has changed since version 4.0.0:
- You have to share the device using
usbipd bindfirst. - You no longer have to install any client-side tooling.
- You no longer have to specify a specific distribution.
- The syntax for the command to attach has changed slightly.
You can attach the device from within Windows with the following command, which does not require administrator privileges:
usbipd attach--wsl--busid=<BUSID>
Tip
See thewiki on how to add driversfor USB devices that are not supported by the default WSL 2 kernel.
For those who prefer a GUI over a CLI, the following is available:
- Andrew Leech has created aWindows Desktop Application.
- Dushan Balisson has created aVisual Studio Code Extension.
Uninstall via Add/Remove Programs or via Settings/Apps.
Alternatively, use the Windows Package Manager:
winget uninstall usbipd
About
Windows software for sharing locally connected USB devices to other machines, including Hyper-V guests and WSL 2.