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

-unshare <device>

Unshare a specified device

-connect <server> <device>

Connect a specified device from a specified server

-disconnect <server> <device>

Disconnect a specified device from a specified server

-forceconnect <device> <client>

Connect a specified local device to a specified client

-forcedisconnect <device>

Disconnect client from a specified local device

<device> specifies the device on which you'd like to perform an action. Device can be identified by hardware id (vendor id, product id and revision), serial number and/or a USB port. It is possible to combine these identifiers, as well as leave some of them.

Identifier

Description

-vid <vendorid>

USB device Vendor ID

-pid <productid>

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

If there are several devices that match the specified identifiers, the behavior depends on the <action> parameter as follows:

 

Action

Behavior

-share

First unshared device that matches specified identifiers will be selected.

-unshare

First shared device that matches specified identifiers will be selected.

-connect

First available non-connected device that matches specified identifiers will be selected.

-disconnect

First connected device that matches specified identifiers will be selected.

-forceconnect

First shared non-connected or inactive device that matches specified identifiers will be selected.

-forcedisconnect

First shared connected or inactive device that matches specified identifiers will be selected.

<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. The client must be already connected to the server. This parameter is required for forced device connection only. Parameter format:

-client <address>

-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.