Command Line Options for Windows

USB Network Gate lets you use command line options to automate the process of sharing USB devices on the server and connecting to them on the client. Command line is available for all license types.

Note: USB Network Gate Service commands (install, uninstall, enable, disable) are available for the OEM License owners only and are described solely in the OEM User Guide, which will become available to you after the OEM License purchase.

USB Network Gate commands are the following:

Server commands:

Client commands:

Help commands:

Note: For the 64-bit Windows version the UsbService64.exe must be used instead.

Server Commands

  • UsbService.exe share-usb-port usb-port [–tcp=param] [–desc=param] [–auth=pasw] [–crypt]

    Share a USB port (USB device).

    Parameters:

    usb-port : The number of USB port that will be shared. It can be derived with show-usb-list command.

    tcp : The parameters of TCP connection. If only the TCP port number is indicated, then the server will wait for incoming connection from the client PC.
    If the full network path is indicated, then the server will initiate the connection with the client PC.

    E.g.: 3777 – waiting for connection on port 3777; localhost:3777 – client will try to connect with the server on localhost:3777.

    desc : The additional description of the device.

    auth : Indicates the password for connection with this device.

    crypt : Indicates that all traffic will be encrypted.

    Example:

    UsbService.exe share-usb-port 1:1 --tcp=3777 --desc="My usb flash" --auth="123" --crypt

    The first USB port will be shared on the first USB hub; the connection will require authorization; the server will wait for connection on TCP port 3777; \”My usb flash\” is additional description; all traffic is encrypted.

  • UsbService.exe unshare-usb-port usb-port

    Make a port available to the local system.

    Parameters:

    usb-port : USB port number that will be unshared. Shared devices list can be derived with show-shared-usb command.

    Example:

    UsbService.exe unshare-usb-port 1:1

    USB port 1 on the first hub will become available to the local system.

  • UsbService.exe show-usb-list

    Display the USB ports list.

  • UsbService.exe show-shared-usb

    Display the list of shared USB ports (devices).

  • UsbService.exe shared-usb-disconnectInterrupt the current connection for this device.

    Parameters:

    usb-port : USB port that needs to be disconnected. Shared devices list and their connection statuses can be derived with show-shared-usb command.

    Example:

    UsbService.exe shared-usb-disconnect 1:1

    The connection of the client with the shared USB port 1 on the first hub will be interrupted.

  • UsbService.exe unshare-all-usb-portsUnshare all ports (devices) on the server and make them available on this computer again.

Client Commands:

  • UsbService.exe add-remote-device tcp

    Add the remote shared device.

    Parameters:

    tcp : The parameters of TCP connection. If the full network path is indicated, then the client PC will initiate the connection with the server. If only the port number is indicated, then the client PC will wait for incoming connection from the server.

    E.g.: 3777 – waiting for connection on port 3777; localhost:3777 – client will try to connect with the server on localhost:3777.

    Example:

     UsbService.exe add-remote-device localhost:3777

    Adds the remote shared device at the client via localhost on TCP port 3777.

  • UsbService.exe remove-remote-device tcp

    Remove the remote device on client.

    Parameters:

    tcp : Parameters of the TCP connection that were indicated during creation of the connection with the remote device.

    Example:

    UsbService.exe remove-remote-device localhost:3777

    Removes remote device from the client which connected to the server PC at localhost on TCP port 3777.

  • UsbService.exe connect-remote-device tcp [–auth=passw] [–auto-reconnect]

    Initiate the TCP connection with the remote device. The list of shared remote devices that were added on a client PC and their connection statuses can be invoked by show-remote-devices command.

    Parameters:

    tcp : Parameters of the TCP connection that were indicated during creation of the connection with the remote device.

    auth : Indicates that the connection will require authentication.

    auto-reconnect : Automatically restore the connection after it was lost.

    Example:

    UsbService.exe connect-remote-device localhost:3777 --auth="123" --auto-reconnect

    Initiates the connection with the remote server PC localhost on TCP port 3777 with authentication. If the connection was lost, tries to reestablish connection with the server.

  • UsbService.exe disconnect-remote-device tcp

    Interrupt the connection with the remote device. The list of shared remote devices that were added on a client PC and their connection statuses can be invoked by show-remote-devices command.

    Parameters:

    tcp : Parameters of the TCP connection that were indicated during creation of the connection with the remote device.

    Example:

    UsbService.exe disconnect-remote-device localhost:3777

    Interrupts the connection with the remote device on the localhost server on TCP port 3777.

  • UsbService.exe show-remote-devices

    Show all added remote devices and their parameters and connection statuses.

  • UsbService.exe find-remote-devices server

    Look for shared remote devices on the server.

    Parameters:

    server : IP address or DNS name of the server PC to look for shared remote devices at.

    Example:

    UsbService.exe find-remote-devices localhost

    Looks for all shared remote devices on the server PC localhost.


Help Commands:

  • UsbService.exe helpInvokes general help.
  • UsbService.exe help [command]Invokes help on a definite command.