Command Line Utility

To use the USB over Network (Linux version) Server run the command line utility with the corresponding command:

$ /opt/ftusbnet/bin/ftusbnetctl <command>

Command-line syntax cheat sheet

Notation	Example	Description
Text without brackets	command	Items which must be typed as shown.
Text in square brackets	[optional]	Optional parameter.
Text in angle brackets	<value>	Placeholder for user-provided values.
Text in curly braces	{ required_value =0\|=1 }	Group of required choices. At least one option must be included.
Pipe	option_1\|option_2	Divider between alternative options. Only one option can be selected.

Command	Description
help	Show this help.
list	List available USB devices.
share <id>[:interface] [password]	Share the device by its ID and protect connection to device by password. If interface is specified, only that interface will be shared, not the device as a whole.
unshare <id>	Unshare the device by its ID.
callback add <address\|name>[:port] [password]	Initiate a callback connection to the client.
callback list	List callback connections.
callback del <address\|name>	Remove the callback connection.
wait	Wait for changes of device list or device state.
info <id>	Show device information by its ID.
import <file>	Import settings from configuration file. Root privileges are required.
export <file>	Export settings to configuration file.

Examples

List available devices:

$ /opt/ftusbnet/bin/ftusbnetctl list 
ID         VID: PID: REV           Location  Device name and status 
107        07d1:3c03:0001               1-2  802.11 bg WLAN /Shared/ 
202        046d:c045:2730               2-1  USB Optical Mouse /Unshared/

Here the columns are:

ID: Unique device identifier.
VID:PID:REV: Device hardware identifier (vendor ID, product ID, revision).
Location: USB device topology (can be "unknown" if your system cannot report the device topology).
Device name and status: Displays the name of the device and its current status (shared/unshared/connected).

Share the device by its unique ID (an example below shows how to share USB Optical Mouse from the list above):

$ /opt/ftusbnet/bin/ftusbnetctl share 202

NOTE: Sharing by the device ID allows you to share separately one of the devices that have identical VID:PID:REV.

To unshare the device use unshare command with the same syntax as share:

$ /opt/ftusbnet/bin/ftusbnetctl unshare 202