Command Line - Format

General command-line format is:

USBOE.EXE <action> [-silent]

 

<action> parameter defines the action you'd like to perform. Only one action can be specified in one application call. Possible values for this parameter are:

Action

Description

-share <device>

Share a specified device. When there are several devices that match specified identifiers, then the first unshared device will be shared.

-unshare <device>

Unshare a specified device. When there are several devices that match specified identifiers, then the first shared device will be unshared.

-connect <server> <device> [-autoconnect]

Connect a specified device from a specified server. When there are several devices that match specified identifiers, then the first available non-connected device will be connected. An optional -autoconnect flag enables automatic connection of this USB device.

-disconnect <server> <device>

Disconnect a specified device from a specified server. When there are several devices that match specified identifiers, then the first available non-connected device will be connected.

-forceconnect <device> <client>

Connect a specified local device to a specified remote client. The client must be already connected to the server either directly or via callback. When there are several devices that match specified identifiers, then the first shared and non-connected (or inactive) device will be connected to a client.

-forcedisconnect <device>

Disconnect client from a specified local device. When there are several devices that match specified identifiers, then the first shared and connected (including inactive) device will be disconnected.

-addserver <server> [-autoconnect]

Add remote USB server. An optional -autoconnect flag enables automatic connection of USB devices from this server.

-removeserver <server>

Remove remote USB server

-addcallback <client> [-autoconnect] [-noclientcontrol]

Create callback connection to remote USB client. An optional -autoconnect flag enables automatic connection of USB devices to this client; specify -noclientcontrol parameter if you don't want to allow the client to control this connection (e.g. delete or change auto-connection options).

-removecallback <client>

Remove callback connection

<device> specifies the device on which you'd like to perform an action. Device can be identified by its vendor ID, product ID, revision, serial number, USB port or name. It is possible to use these identifiers in any combination.

Identifier

Description

-vid <vendor id>

USB device Vendor ID

-pid <product id>

USB device Product ID

-rev <revision>

USB device Revision

-usbport <port number>

USB port number, as displayed in USB Device List.

-serial <serial number>

USB device serial number

-name "<device name>"

USB device name. Note that the name must be specified in double-quotes.

 

<server> specifies the server where the device is located. The server should be already added via configuration utility. This parameter is not required for sharing and unsharing of local devices. Parameter format:

-server <address>[:<tcp port>]

 

<client> specifies the client address. Parameter format:

-client <address>[:<tcp port>]

 

-silent specify this parameter to enable silent mode. In this mode, USB over Ethernet won't display any error messages. You can check process exit code to determine if the operation was successful.