Virtual Serial Ports - Software Virtual COM Port Null Modem Cable Emulator for Windows
Docs

Command-line Parameters

Command-line utility vysercli.exe may be used as a simple API to create and manage virtual serial ports and bridges. Command-line utility returns 0 if the requested operation 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, --create(port|bridge|remote-bridge)Create port, bridge or remote bridge. See the details below on supported parameters for each type.
-delete, --delete(N1,[N2,[N3...]])Delete one or more serial ports.
Local Bridge Creation
--comsN1,N2Specify COM port numbers for created devices. Optional parameter. If omitted, port numbers are assigned automatically. If the specified COM port number is already being used, an error is returned.
--permanentMake the created bridge permanent, that is, it is automatically recreated after the system restarts.
Remote Bridge Creation
--remote-hosthostnameRemote host name or IP-address.
--remote-portNCOM port number of the port on remote computer.
--comNLocal port number. Optional parameter. If omitted, the port number is automatically assigned. If the specified port number is already being used, an error is returned.
--permanentMake the created bridge permanent, that is, it is automatically recreated after the system restarts.
--loginusernameLogin of the user for authentication on remote computer. Optional for non-permanent bridges.
--passwordpasswordPassword of the user for authentication on remote computer. Optional for non-permanent bridges.
--domainhostnameDomain of the user for authentication on remote computer. Optional parameter.
Ports Creation
--comNLocal port number. Optional parameter. If omitted, the port number is automatically assigned. If the specified port number is already being used, an error is returned.
--mode(listening|pipe|files)Created port mode
Listening port
--securitySDString security identifier for listening port access control.
Pipe port
--create-pipepipenameSpecify pipe name to create and connect to. Required unless --connect-pipe parameter is specified.
--connect-pipepipenameSpecify pipe name to connect to. Required unless --create-pipe parameter is specified.
Input/Output files port
--input-filefilenameSpecify the input file name.
--output-filefilenameSpecify the output file name.