Registry Settings and Group Policy Object (GPO) template
The registry and GPO settings described below assist in configuring and troubleshooting the product.
Serial Port for Remote Desktop Server includes *.admx and *.adml administrative template files. These template files allow to configure the product via Local GPO and/or Domain-Based GPO. Please refer to Microsoft MSDN article on managing ADMX files.
GPO template
The archive file containing administrative template can be found in the installation directory:
%ProgramFiles%\FabulaTech\Serial Port for Remote Desktop (Server)\policies.zip
Additionally, the administrative template files are deployed to a local GPO during product installation and can be found here:
%WINDIR%\PolicyDefinitions\Fabulatech.admx %WINDIR%\PolicyDefinitions\ftsprrdp.admx %WINDIR%\PolicyDefinitions\en-US\Fabulatech.adml %WINDIR%\PolicyDefinitions\en-US\ftsprrdp.adml
The GPO template can be used to configure the following settings:
| Setting | Description |
|---|---|
| Allow/Deny port filters | Exclude specific COM ports from redirection. |
| Bandwidth limit | Control data transfer speed. |
| Disable functionality | Disable serial port redirection. |
| Disable Update Subscription expiration notification | Control update subscription notification behavior. |
| Licensing | Licensing management. |
| Local settings priority | Prioritization of settings (Local over Group Policy). |
| Lock configuration | Prevent users from changing the settings via the UI. |
| COM Port Isolation Mode | Visibility and accessibility of virtual serial ports in multi-user environment. |
| Connect all ports automatically | Configure client COM ports auto-connection behavior. |
| PortSettings | Configuring certain port parameters ("Source port number", "Source port device", "Destination virtual port number", etc.). |
it's recommended to use the GPO template files provided with the latest version of Serial Port for Remote Desktop Server.
Registry Settings
It is strictly recommended for non-administrative users to change all settings via Serial Port for Remote Desktop user interface.
Local Settings can be overwritten by the program GUI and vice versa. To prevent this, it's possible to configure the LockConfig registry key. This ensures that users cannot change the settings using the tray context menu. However, they will still be able to modify the program settings directly in the HKCU section of the Registry.
|
HKLM\Software(\WOW6432Node)\FabulaTech\Serial Port for Remote Desktop (Server)\ HKCU\Software\FabulaTech\Serial Port for Remote Desktop (Server)\ |
|||||
|---|---|---|---|---|---|
| Value name | Type | Range | Default | If none * | Description |
| LogLevel | REG_DWORD | 0-4 | 3 | 3 | Serial Port for Remote Desktop Server logging level: 0 - Errors 1 - Warnings 2 - Information 3 - Debug 4 – Dump. |
| RotationLogFileNumber | REG_DWORD | 0-99 | Not exists | 10 | When a particular log file reaches a size limit, the program initiates log file rotation, i.e. it renames the existing log file and creates the new one. If 0, no rotation will take place, unlimited number of log files. If N, delete oldest log file when N log files already exists. |
| OverrideLogMaxFiles | REG_DWORD | 0-4294967295 | Not exists | 150 | There can be several log files for every user, depending on Session ID, PID, etc. This setting specifies the maximum number of log files of specific component for every user. The number of users is not limited. So all of them will log the activity, but every user is limited in the total number of log files. If 0, older log files will not be removed. If N, older log files will be removed once specified limitation is reached. |
| HKLM\Software(\WOW6432Node)\FabulaTech\Serial Port for Remote Desktop (Server)\Settings\ | |||||
|---|---|---|---|---|---|
| Value name | Type | Range | Default | If none * | Description |
| Disabled | REG_DWORD | 0,1 | 0 | 0 | 1 - the connection with the workstation side is not established, the ports are not redirected and the tray menu icon is not present. 0 - the Serial COM works in usual mode. Not configured - the disabling functionality is determined by local program settings. |
| BandwidthLimit | REG_DWORD | 0-2*1024*1024 | Not exists | 0 | If this policy setting is enabled, the data transfer speed between the server and all workstations is limited by the specified kilobytes per second. The value "0" disables speed limitation. 0 - the speed limitation is disabled. Not configured - the speed limitation is determined by local program settings. |
| ConnectAll | REG_DWORD | 0,1 | Not exists | 0 | Connect all ports automatically. If this policy setting is enabled, all client COM ports will be automatically connected (even if no individual GPO is configured). If there are individual GPO settings configured for some of the ports, the individual port GPO settings are used. If this policy setting is disabled or not configured, the auto-connect functionality is determined by individual port GPO or local program settings. |
| IsolatePorts | REG_DWORD | 0-2 | 0 | 0 | 0 - Isolation Disabled 1 - Full Isolation 2 - Strict Isolation If "Full Isolation" mode is chosen, virtual serial ports are visible and accessible within user sessions only. In this mode COM port names can have the same names in different user sessions. Important: system services (like spoolsv.exe) are not able to access isolated serial ports in such case. If "Strict Isolation" mode is chosen, virtual serial ports are visible and accessible within user sessions and only withing the processes run under the owner of the session. This means that the processes started using "Run as Administrator", or the processes started using PsExec utility will not be able to see and access the redirected serial ports. If "Isolation Disabled" mode is chosen, virtual serial ports are visible globally. Any port can be accessed from any session. Limitation: port names must be unique for every user (so the ports cannot have the same names in different user sessions). Important: system services (like spoolsv.exe) can access any serial ports. If this policy setting is not configured, Serial Redirection operates in the default mode: - If Terminal Services is installed, "Full Isolation" mode is applied. - If Terminal Services is not installed, "Isolation Disabled" mode is applied. |
|
HKLM\Software(\WOW6432Node)\FabulaTech\Serial Port for Remote Desktop (Server)\Settings\PortSettings\<NAME>\ HKCU\Software\FabulaTech\Serial Port for Remote Desktop (Server)\Settings\PortSettings\<NAME>\ |
|||||
|---|---|---|---|---|---|
| Value name | Type | Range | Default | If none * | Description |
| CreateOverlappedIfRequired | REG_DWORD | 0,1 | Not exists | 1 | 1 - create overlapped virtual port if existing CorrespondingVirtualPort exists on machine. |
| SrcPortNum | REG_DWORD | "1-256" | Not exists | required | "Source port number" - Number of the COM port redirected from the workstation side (e.g. 2 means COM2). |
| SrcPortDevice | REG_SZ | Not exists | "Source Port Device" - Name of Serial port device redirected from the workstation side (e.g. "COM5" for Windows, or "/dev/ttySerial0" for Linux. This parameter has higher priority than Source port number.). | ||
| DstVirtPortNum | REG_DWORD | "1-256" | Not exists | required or -1 for "port automapping mode" | "Destination virtual port number" - virtual COM port number, created on the server side and corresponding to the COM port on the workstation side. |
| Autoconnect | REG_DWORD | 0,1 | Not exists | 0 | "Autoconnect" - If this flag is set, the port is automatically redirected to the server side when it plugged on the workstation side. |
| IgnoreDsr | REG_DWORD | 0,1 | Not exists | 0 | "IgnoreDsr" - If this flag is set, the DSR signal is ignored. |
| PauseBeforeClosePort | REG_DWORD | 0-3000 | Not exists | 0 | "Pause before close port" - Troubleshooting setting. Time (in ms) to wait after virtual COM port was closed by user. Required for some USB-COM adapters. |
| UsePauseBeforeSendData | REG_DWORD | 0,1 | Not exists | 0 | "Use pause before send data" - If this flag is set, pause before send data after port opening will use. See value "Pause before send data". |
| PauseBeforeSendData | REG_DWORD | 0-5000 | Not exists | 0 | "Pause before send data" - Troubleshooting setting. Time (in ms) to wait before virtual COM port will transfer data to physical side. Required for some specific serial devices (Olivetti card reader). |
| Serial2USBModeChangeEnabled | REG_DWORD | 0,1 | Not exists | 0 | Troubleshooting setting. Disables Overlapped Mode when communicating with hardware COM ports. This allows to overcome specific issues of GlobalSat BU353 GPS adapter (and some other Prolific USB-COM adapters). |
| DisableErrorsInWaitMask | REG_DWORD | 0,1 | Not exists | 0 | "Disable errors in wait mask" - Troubleshooting setting. Disables "error" value in serial COM mask. See this article for details. Required for some software. |
| HandleBtDisappear | REG_DWORD | 0,1 | Not exists | 0 | Troubleshooting setting. It handles the situations when Bluetooth COM ports disappear suddenly on the Client side (because the Bluetooth device gets out of range) and then appear again. |
| UsbToComTroubleShooting | REG_DWORD | 0,1 | Not exists | 0 | Troubleshooting setting. Fixes some specific issues of USB-COM adapters. |
| UseTimeoutsMultiplicator | REG_DWORD | 0,1 | Not exists | 0 | "Use network latency compensation" - Troubleshooting setting. Use compensation capability to avoid influence of network delays. |
| TimeoutsMultiplicator | REG_DWORD | "1-10" | Not exists | 0 | "Compensation level" - Troubleshooting setting. Using spinedit, select network latency compensation level. Find out the minimal level at which your communications application works stable with a remote serial device. |
| UseFixedBaudRate | REG_DWORD | 0,1 | Not exists | 0 | "Use fixed baud rate" - If this flag is set, the value specified in "Bits per second" is used instead of the baudrate set by serial communications application. |
| FixedBaudRate | REG_DWORD | 110-115200 | Not exists | 0 | "Bits per second" - Fixed baudrate value in bits per second (applied, if "Use fixed baud rate" is set). |
| UseFixedLineControl | REG_DWORD | 0,1 | Not exists | 0 | "Use fixed line control" - If this flag is set, the values specified in "Data bits", "Parity" and "Stop bits" are used instead of the values set by serial communications application. |
| FixedLineControlDataBits | REG_DWORD | "5-8" | Not exists | 0 | "Data bits" - Fixed Databits value (applied, if "Use fixed line control" is set) [values from 5 to 8]. |
| FixedLineControlParity | REG_DWORD | 0-4 | Not exists | 0 | "Parity" - Fixed Parity value (applied, if "Use fixed line control" is set). 0 - No parity check occurs. 1 - Sets the parity bit so that the count of bits set is an odd number. 2 - Sets the parity bit so that the count of bits set is an even number. 3 - Leaves the parity bit set to 1. 4 - Leaves the parity bit set to 0. |
| FixedLineControlStopBits | REG_DWORD | 0-2 | Not exists | 0 | "Stop bits" - Fixed Stop bits value (applied, if "Use fixed line control" is set). 0 - One stop bit is used. 1 - 1.5 stop bits are used. 2 - Two stop bits are used. |
| UseFixedFlowControl | REG_DWORD | 0,1 | Not exists | 0 | "Use fixed flow control" - If this flag is set, the value specified in "Flow control" is used instead of the value set by serial communications application. |
| FixedFlowControl | REG_DWORD | 0-2 | Not exists | 0 | "Flow control" - Fixed Stop bits value (applied, if "Use fixed flow control" is set). 0 - Hardware flow control is used for the handshake. 1 - The XON/XOFF software flow control is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. 2 - No control is used for the handshake. |
| HKCU\Software\FabulaTech\Serial Port for Remote Desktop (Server)\PortSvcSettings\<NAME>\ | |||||
|---|---|---|---|---|---|
| Value name | Type | Range | Default | If none * | Description |
| LastMappedDstVirtPortNum | REG_DWORD | "1-256" | Not exists | -1 | Virtual port number which was last used for mapping physical port <NAME>. Used for stable mapping. |
| RealSpeedEnabled | REG_DWORD | 0,1 | Not exists | 1 | Enable bitrate emulation. |
|
Should be set both: HKLM\Software\FabulaTech\Netlink 3 HKLM\Software\Wow6432Node\FabulaTech\Netlink 3 |
|||||
|---|---|---|---|---|---|
| Value name | Type | Range | Default | If none * | Description |
| LogLevel | REG_DWORD | 0-3 | 1 | 1 | NetLink logging level: 0 - Error. 1 - Warning. 2 - Info. 3 – Debug. |