Virtual Serial Ports - Build advanced serial port configurations for any usage scenario
Docs

Command-Line Utility

Command-line utility rspcli.exe may be used as a simple API to create and manage alias, shared and remote serial ports. Command-line utility returns 0 if the requested operation is completed successfully, or non-zero error code (HRESULT). It also prints error description to STDOUT unless the --silent parameter is specified.

Command-line Parameters

The utility supports the following command-line parameters:

ParameterValueDescription
-?, --helpDisplays the list of supported parameters with short description.
--silentDo not display any error or success messages.
-create(alias | shared | remote)Create new virtual serial device.
-deleteNDelete an existing port.
-list(alias | shared | remote)List all remote serial ports on the current computer.
-list-remotehostnameList all shared serial ports on the specified host.
Port Creation Parameters
--local-portNOptional local port number. If omitted, the next available port is used.
Alias Port Parameters
--alias-portNOriginal serial port number.
Shared Port Parameters
--shared-portNOriginal serial port number.
Common Port Parameters
--baud-rateNSpecify port baud rate to override.
--data-bitsNSpecify port data bits to override.
--parity(no | odd | even | mark | space)Specify port parity to override.
--stop-bits(1 | 1.5 | 2)Specify port stop bits to override.
--flow-control(none | software | hardware)Specify port flow control to override.
Remote Port Parameters
--remote-hosthostnameName or address of remote host that shares COM port.
--remote-portNCOM port number of the port on remote computer.
--loginusernameName of the user to use for authentication on a remote host. May include domain in the form DOMAIN\USERNAME.
--passwordpasswordPassword of the user for authentication on remote computer. If omitted, the user is asked to enter password in terminal.
--connection-timeoutNAn optional connection timeout (in milliseconds).
--connection-attemptsNAn optional number of connection attempts to try before giving up.