Command Line Interface
Use USBSRVCmd.exe console program to configure the program via command line interface.
Command line USBSRVCmd.exe file is created during the program installation. You can find it in USB over Network Server program folder.
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 =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. |
USB over Network Server console utility
Copyright © 2000-2024 FabulaTech
Usage: usbsrvcmd.exe command [option]
Syntax:
list List all available USB devices and shared ports.
list [-v|-o] [-i] [-s|<devID>]
List USB devices and shared ports:
-v - verbose output;
-o - alternative style output;
-i - show interfaces of composite devices;
-s - short view, only devID;
devID - detailed info about the USB device
identified by devID.
tcpport <port>|-d Set TCP port or use default (33000).
share <devID> Share the USB device identified by devID.
share -a [<VID[:PID[:REV]]>] [-s <Serial>] [-p <Port>]
Share all USB devices identified by VID:PID:REV
and/or Serial number and/or USB Port.
unshare <devID> Unshare the USB device identified by devID.
unshare -a [<VID[:PID[:REV]]>] [-s <Serial>] [-p <Port>]
Unshare the USB device identified by VID:PID:REV
and/or Serial number and/or USB Port.
shareport <devID>|-p <port>
Share the USB port identified by devID of a
device plugged in or by USB port.
unshareport <devID>|-p <port>
Unshare the USB port identified by devID of a
device plugged in or by USB port.
callback list List callback connections.
callback add <host> [<port>] [-m <message>] [-p <password>]
Initiate a callback connection to the Client:
-m message - text message that will be shown in
the request window on the Client side;
-p password - Client's password, if required.
callback del <callbackID>|all
Remove the callback connection identified by
callback ID or remove all callbacks.
disconnect <devID> Disconnect the USB device identified by devID
from the Client.
listrules [-v] List sharing rules in short or verbose format.
addrule [-rn <name>] [-id <VID[:PID[:REV]]>] [-cls <CLS[:SCLS[:PROTO]]>]
[-s <serial>] [-p <port>] [-share|-prevent] [-dd <DeviceDescription>]
[-ds <serial>] [-ap permanent|unplug|restart] [-lu] [-co] [-pass <password>]
[-rp =1|=0] [-rs] [-approx <1-10>]
Add sharing rule with the next parameters:
-rn <name> - sharing rule name;
-id <VID:PID:REV> - Vendor ID, Product ID,
Revision parameters of USB devices;
-cls <CLS:SCLS:PROTO> - Class, Subclass,
Protocol parameters of USB devices;
-s <serial> - device serial number;
-p <port> - USB port;
-share|-prevent - action that will be performed
to matched devices;
-dd <DeviceDescription> -custom device nickname;
-ds <serial> - replace device serial number;
-ap permanent|unplug|restart - action
persistence;
-lu - allow local use until Client connects;
-co - allow the USB device connecting even if
it is occupied by another user;
-pass - protect the device with password;
-rp - reset power;
-rs - reset device on share;
-approx <1-10> - approximation for pointing
devices.
editrule <ruleID> [-enable|-disable] [-rn <name>] [-id <VID[:PID[:REV]]>]
[-cls <CLS[:SCLS[:PROTO]]>] [-s <serial>] [-p <port>] [-share|-prevent]
[-dd <DeviceDescription>] [-ds <serial>] [-ap permanent|unplug|restart] [-lu]
[-co] [-pass <password>] [-rp =1|=0] [-rs] [-approx <1-10>]
Edit the sharing rule identified by ruleID:
-enable|-disable - enable or disable the rule;
other parameters are described above.
removerule <ruleID>|-rn <name>|all
Remove the sharing rule identified by
ruleID | rule name | remove all rules.
password -g | [-s <password>]
Display|Set password, required for Client
authentication.
ssl [=1|=0] Display status, enable or disable SSL.
ssl cert [<path>] Display or set path to the PEM-encoded
Certificate file for the Server.
ssl key [<path>] Display or set path to the PEM-encoded Private
Key file for the Server; Private Key must be
unencrypted.
ssl use_chain [=1|=0] Display status, enable or disable certification
authorities chain file usage.
ssl chain [<path>] Display or set path to the PEM-encoded
certification authorities chain file.
ssl use_auth [=1|=0] Display status, enable or disable Clients
authentication.
ssl auth [<path>] Display or set path to the PEM-encoded client
authentication certificate list file.
ssl use_revoc [=1|=0] Display status, enable or disable certificate
revocation list usage.
ssl revoc [<path>] Display or set path to the certificate
revocation list.
ssl chkname [=1|=0] Display status, enable or disable common name
checking.
lickey [[-f] <key file path>]
Display or apply the license key from a
specified file:
-f - force applying (even if the license key is
outdated).
licsrv [list] Display usage status of the License Server or
display list of available License Servers.
licsrv set <host> [<port>]
Use the License Server instead of local license:
host - License Server hostname or IP;
port - TCP port.
alias my -g | -s [<name>] Display or set alias name of this computer.
alias other -g | { -s =1|=0 } Display status, enable or disable displaying
alias names of another computers.
ping -t <value> -p <value> Set ping options:
-t <value> - ping packet interval, seconds;
-p <value> - break connection interval, seconds.
export <path> Export the program configuration to a file.
import <path> Import the program configuration from a file.
log show Display the program log.
log level error|debug Set the logging level to error or debug.
help|/? Show this help.
Command line usage examples:
Get the list of available USB devices:
C:\Program Files\FabulaTech\USB over Network (Server)>usbsrvcmd list devID:0 - USB Mouse (unshared) devID:3 - TTDC TTDC PPG Receiver (unshared) devID:4 - PANTECH USB MMC Storage (unshared)
To share a device use the "share" command and specify its devId:
C:\Program Files\USB over Network (Server)>usbsrvcmd share 4 Device shared successfully.
To unshare a USB device use the "unshare" command and specify its devId:
C:\Program Files\FabulaTech\USB over Network (Server)>usbsrvcmd unshare 4 Device unshared successfully.
To view licensing information use the "lickey" command. It will show various details about currently used license, including its state (e.g., Valid or Expired). Additionally, in the case of an expired license, the %ERRORLEVEL% environment variable will be set to 1.
C:\Program Files\FabulaTech\USB over Network (Server)>usbsrvcmd.exe lickey License type: user Key generation date: Fri Jul 11 03:00:00 2024 License name: Alice Cooper Number of licenses: 1 Allowed number of devices: 3 Update period: 365 days Expiration date: Wed Jul 11 03:00:00 2025 State: Expired. C:\Program Files\FabulaTech\USB over Network (Server)>echo %ERRORLEVEL% 1