Using TTYredirector

General Options


The general options affect all TTYredirector tty devices.

Please note:

  • When using general options, do not specify TTYredirector tty devices.
  • Single-letter forms of option names appear on a line following the long form.
  • Option names can be shortened as long as they are not ambiguous.
  • Unless otherwise noted, these options can be combined in any order in a single command.
  • For the status values returned by trconfig, see the Technical Notes.

The client/server network connection

trconfig -nagle Y|N
trconfig -g Y|N

Controls use of the Nagle algorithm, which coalesces data into fewer network packets. In some applications, latency needs to be improved (at the expense of somewhat higher network loading) by disabling the Nagle algorithm to use more frequent packets that each hold less data. For more information, see the Technical Notes.

Default setting: Y

trconfig -keepalive n
trconfig -k n

n — The number of milliseconds between keep-alive transmissions. A value of at least 1000 is recommended.

Default setting: 60000 (60 seconds).

If the device server supports Telnet protocol with RFC 2217 extensions, TTYredirector can use a keep-alive message method to detect a failed connection to the server. This option controls the interval at which TTYredirector will issue the keep-alive message, if no activity has occurred on the connection. For more information, see the Technical Notes.

trconfig -timeout n

n — The number of milliseconds the daemon will wait for an answer to a keep-alive message before the connection to the server is considered a failed connection. A value of at least 1000 is recommended.

Default setting: 30000 (30 seconds).

See the description of the keepalive option above for additional information.

trconfig -maxreconnect m
trconfig -m m

n — The number of milliseconds between reconnect attempts. A value of at least 1000 is recommended.

Controls the maximum time between attempts by TTYredirector to reconnect to the server if -restore is enabled for a tty.

Default setting: 30000 (30 seconds).

trconfig -delayclose c
trconfig -C c

c — The number of milliseconds to delay closing the connection to the server after the tty device has been closed.

Default setting: 8000 (8 seconds).

For a related option that applies to specific tty devices, see -ptydelayclose in Managing TTY Devices.

trconfig -sync Y|N
trconfig -Y Y|N

If set to Y, the tty device does not transmit data to the server until the Telnet protocol (if used) is fully negotiated and server login (if enabled) is complete (if enabled). If the server uses raw TCP and does not require login, this option has no effect.

Default setting: N

trconfig -limitrate Y|N
trconfig -R Y|N

If set to Y, the outbound data rate to the device server is throttled to match the baud rate in effect for the tty device.

If the server supports Telnet with RFC 2217 extensions, this feature is enabled regardless of the setting of this option.

Default setting: N

Server login

trconfig -authterm term
trconfig -M term

term — The character(s) that TTYredirector will append to the username and password when responding to prompts from a device server.

Settings can include:

\n — linefeed

\r — carriage return

\t — tab

Remember to quote the \ character in shell commands:

trconfig -authterm '\r'

Default setting: \n

trconfig -login lp -pwd pp

Specifies additional login and password prompt strings that TTYredirector looks for if automatic login is enabled (see the -auth option).

Either or both options can be used.

lp — One or more strings (separated by vertical bar) specifying additional login prompt strings.

pp — One or more strings (separated by vertical bar) specifying additional password prompt strings.

The built-in login prompt strings are:

login: |username: |Username:|login :|Login:|user:|

The built-in password prompt strings are:

password:|Password:|Enter PASSCODE|

License key

trconfig -licensekey lk

Replaces the license key being used by TTYredirector.

lk — A TTYredirector license key xxxx-xxxx-xxxx-xxxx-xxxx

The license key is not case-sensitive and dashes are optional.

The new license key is effective immediately.

No other options can be used with this command.

Reset

trconfig -reset

Changes all global options to default settings.

This action differs from using -reset with a list of devices.

No other options can be used with this command.