Command-line utility server.cli.exe may be used as a simple API to manage shared USB devices. Command-line utility returns 0 if the requested operation is completed successfully, or non-zero error code (HRESULT). It also prints error description to STDOUT unless the --silent parameter is specified.
The utility supports the following command-line parameters:
| Parameter | Value | Description |
|---|---|---|
-?, --help | Displays the list of supported parameters with short description. | |
--silent | Do not display any error or success messages. | |
| Main Commands | ||
-list, --list | List local USB devices. | |
-list-shared, --list-shared | List shared USB devices. | |
-share, --share | Share USB device(s) matching criteria. | |
-unshare, --unshare | Stop sharing of USB device(s) matching criteria. | |
| Device Matching | ||
--vid --pid --serial-number --name --manufacturer --location --instance-id | 16-bit hexadecimal number 16-bit hexadecimal number string string string string string | Device Vendor ID. Device Product ID. Device serial number. Device name. Device manufacturer. Device connection location. | --instance-id Device instance ID. |
| Share Options | ||
--auth-key | string | Authentication key. |
| Unshare Options | ||
--instance-id | string | Instance ID of a device to stop sharing. |
The command-line utility must be launched from an elevated command-prompt, PowerShell or Windows Terminal window. Use one (or more) of the options under “Device Matching” group to specify which devices you want to share.