Identifying/editing TS Agent operating settings
The TS Agent does not have a configuration interface: operating settings can be looked up in the registry base of the server on which it is installed.
To look up/edit these TS Agent settings:
- Open an administrator session on the server on which the TS Agent is installed.
- Open the server's registry base (regedit).
In the registry base, you will find the TS Agent driver settings, and the TS Agent service settings. These settings have different locations.
TS Agent driver settings
IMPORTANT
If any changes are made to registry keys on the TS Agent's driver, the server must be restarted to apply the changes.
Location in the registry base:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\StormshieldRdsDrv\Parameters
Parameter | Description/Prescribed values |
---|---|
ExhaustedPortAction |
Action that the TS Agent applies when users no longer have any available ports in their port ranges for new connections.
|
ReservedPortAction |
Action that the TS Agent applies when an application attempts to use a port from the port range that is reserved for users [TotalPortsRangeLow-TotalPortsRangeHigh].
|
PortsPerRange |
Number of ports included in each port range assigned to each user (200 by default).
If the default value is unsuitable, for example, if some applications require a large number of ports in order to function, you can change the value. This will ensure that users will not run out of available ports, but reduces the maximum number of users on the TS Agent. |
RangePerUser |
Number of port ranges assigned to a user (2 by default).
If the default value is unsuitable, for example, if some applications require a large number of ports in order to function, you can change the value. This will ensure that users will not run out of available ports, but reduces the maximum number of users on the TS Agent. |
ReservedSystemPorts |
List of ports included in the range [TotalPortsRangeLow-TotalPortsRangeHigh] that must be reserved for the operation of the system. These ports cannot be assigned to any user. Several strings can be defined, by following the "[aaaaa-bbbbb]" format. For example:
The following ports are reserved by default: [1303-1303] You can run a script that analyzes any ports that may be in conflict with the TS Agent, and which adds them to this setting. For further information, refer to the section Appendix: Using script to configure ports that are reserved for system operations NOTE
|
TcpTimedWaitDelay |
Time in seconds between the closure of a connection and when the associated port is available again (120 by default).
The value must match the one used by the Windows server under the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip (120 by default). Ensure that you use the same value for both parameters. |
TotalPortsRangeLow |
Lower limit of the port range that is reserved for users (20000 by default).
If you bring down this value, ensure that the ports in the new range are not being used by other applications. You can reserve ports for the operation of the system with the parameter ReservedSystemPorts. |
TotalPortsRangeHigh |
Higher limit of the port range that is reserved for users (49151 by default).
If you raise this value, ensure that no dynamic Windows port ranges overlap the new port range that is reserved for users. Use the following command to check whether this is the case: netsh int <ipv4|ipv6> show dynamicport <tcp|udp> NOTE
|
MaximumNumberRequests |
Number of requests that can be processed simultaneously by the driver (512 by default). Adjust this value according to the memory capacity on the server.
A value of 0 disables the limit on the number of simultaneous requests. You are strongly advised against disabling this limit, as it may cause overconsumption of memory on the RDS/Citrix server. |
TS Agent service settings
IMPORTANT
If any changes are made to registry keys on the TS Agent's service, the "Stormshield-rds-service" service has to be restarted to apply the changes.
Location in the registry base:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\stormshield-rds-service\Parameters
Parameter | Description |
---|---|
PSK |
Pre-shared key for exchanges with the firewall. This key is entered when the TS Agent is installed. NOTE
|
EphemeralPortMin |
Lower limit of the range of additional ports that can be assigned to users (49152 by default). This limit is used when users no longer have any available ports in their port ranges (ExhaustedPortAction parameter set to "pass").
If you edit this value, ensure that the port range [EphemeralPortMin- EphemeralPortMax] covers all dynamic Windows port ranges. Use the following command to check whether this is the case: netsh int <ipv4|ipv6> show dynamicport <tcp|udp> NOTE
|
EphemeralPortMax |
Higher limit of the range of additional ports that can be assigned to users (65535 by default). This limit is used when users no longer have any available ports in their port ranges (ExhaustedPortAction parameter set to "pass").
If you edit this value, ensure that the port range [EphemeralPortMin- EphemeralPortMax] covers all dynamic Windows port ranges. Use the following command to check whether this is the case: netsh int <ipv4|ipv6> show dynamicport <tcp|udp> NOTE
|
LogLevel |
Log level (verbose) for communications between the TS Agent and the firewall. These logs can be looked up in the Windows Event Viewer of the server on which the TS Agent is installed.
|
ServerPort |
Communication port with the firewall (TCP/1303 by default). The default port corresponds to the predefined network object agent_ts on the firewall. NOTE
|
SNS Timeout |
Waiting time in seconds before the TS Agent considers the firewall unreachable (2 by default). Once this duration expires, the TS Agent ends the communication with the firewall. It will then save all information regarding authenticated users and forwards it to the firewall when it manages to restore the connection with the TS Agent.
|