| uid | name | order |
|---|---|---|
royalts_reference_connections_terminal-putty |
Terminal (PuTTY) |
9950 |
The Terminal connection based on PuTTY can be used to connect to remote computers using Telnet, Secure Shell (SSH) (incl. Tunneling support), RAW or rlogin. It can also be used to connect to devices using the Serial Port.
The Terminal Dashboard is shown in the Dashboard panel when you select a Terminal connection based on the PuTTY plugin in the Navigation panel. The dashboard will show files with the extension .log. Logging and recording configuration can be found in Logging.
- Click the Open in Explorer button to open the folder containing the selected file in Windows Explorer.
- Copy path to clipboard context menu.
- Grid search and customization, including sort, filter and group.
- Delete File allows you to directly delete a log file from the Dashboard.
- The Export drop down menu allows you to export a recording to a different file format.
- Click Refresh to refresh the file list.
To configure the application default settings for the included dashboard, open the Plugins Management and click on Dashboard for the Terminal plugin based on PuTTY.
To configure individual dashboard settings for a connection, use the Dashboard property page.
To configure the plugin settings, open the Plugins Management and click on Settings for the Terminal plugin based on PuTTY:
Specify your own PuTTY executable. If no executable is specified or if the configured executable cannot be found, the PuTTY.exe included in Royal TS will be used.
Enter the registry base path without the hive.
For KiTTY use: Software\9bis.com\KiTTY
Leave empty for the default PuTTY base path: Software\SimonTatham\PuTTY
Enter the window title Royal TS should look for to identify the session window.
For KiTTY use: - KiTTY
Leave empty for the default PuTTY window title match: - PuTTY
The Terminal (PuTTY) Properties dialog is shown:
- for a new Terminal connection by clicking the Terminal menu item in the Add drop down menu in the Edit group on the Home ribbon tab when the PuTTY based plugin is set as the default plugin.
- for a new Terminal connection by clicking the More... menu item in the Add drop down menu in the Edit group on the Home ribbon tab and selecting the Terminal (based on PuTTY) entry from the list of available objects.
- for an existing Terminal connection by selecting a Terminal connection which is configured to use the PuTTY based plugin and clicking on the Properties command in the Edit group on the Home ribbon tab.
- as a bulk-edit dialog when multiple Terminal connections which are configured to use the PuTTY based plugin were selected in the Folder / Document Dashboard and the Properties command in the Edit group on the Home ribbon tab is clicked. See also: Bulk Operations
The The Terminal Connection page allows you to configure basic connection settings, such as host name and the connection type (Telnet, SSH or Serial Port). page allows you to configure basic connection settings, such as host name and the connection type (Telnet, SSH, RAW, rlogin or Serial Port). You can also configure the connection to use an existing PuTTY connection or import an existing PuTTY connection.
[!includedisplayname.md]
Select one of the supported connection types: Existing PuTTY Session, SSH Connection, Telnet Connection, Serial Port Connection, Raw or Rlogin.
Note
Depending on the selected connection type, availability of some property pages may change.
The drop down list will show all available PuTTY sessions.
Important
If you specify an existing PuTTY session, it will only use the Computer Name, Port and configured credentials of your connection. All other settings will actually be used from the saved PuTTY session.
[!includecomputername.md]
Specify the TCP port for the connection.
[!includedescription.md] [!includemacaddress.md]
The Display Options page allows you to configure font settings and appearance settings.
Select the font used for the terminal control.
Select the font size used for the terminal control.
If checked, the terminal will print all characters bold.
Specify the font quality (anti-aliasing mode).
Configure the appearance of the cursor.
If checked, the mouse pointer is hidden while you type.
Enable or disable cursor blinking.
Enable or disable blinking text.
Enter the number of columns for the terminal. This setting will only be applied on specific window resize actions.
Enter the number of rows for the terminal. This setting will only be applied on specific window resize actions.
Configure how PuTTY should behave when the window is resized.
Shows or hides the scrollbar in the terminal.
Show or hide a sunken-edge border.
Configure the gap between text and border.
By default the window title will contain the host name followed by ‘PuTTY’, for example server1.example.com - PuTTY. If you want a different window title, this is where to set it. The title string set here is therefore only the initial window title. Replacement tokens are supported.
If you want to see window and icon titles, enable this option.
When checked, a warning is shown before the window is closed.
Control whether Alt-F4 will close the window or not.
If checked, Alt-Space will bring up the system menu.
If checked, pressing Alt will bring up the system menu.
If checked, the PuTTY window will be always on top.
If checked, Alt-Enter will change the PuTTY window into Full Screen mode.
The Colors page allows you to modify the terminal palette and colors for different text styles.
Not all terminals agree on what color to turn the screen when the server sends a ‘clear screen’ sequence. Background-color erase can be turned on and off by control sequences sent by the server. This configuration option controls the default state.
If it is disabled, PuTTY will ignore any control sequences sent by the server to request colored text.
If disabled, PuTTY will ignore any control sequences sent by the server which use the extended 256-color mode supported by recent versions of xterm.
If disabled, bold and non-bold text will be displayed in the same color, and instead the font will change to indicate the difference.
If you are not getting the colors you ask for on an 8-bit display, you can try enabling this option.
Enabling this option will cause PuTTY to ignore the configured colors for ‘Default Background/Foreground’ and ‘Cursor Color/Text’, instead going with the system-wide defaults.
Adjust the ANSI color palette for individual colors.
[!includeterminalpalette.md]
[!includecredentials.md]
- Path to Private Key Fie
- Embed Private Key File
Specify the full path to the private key file or click on browse button to browse for the file.
Enter a passphrase.
[!includetasks.md] [!includewindowmode.md] [!includedashboard.md] [!includesecuregateway.md] [!includeactiveplugin.md]
The Advanced page allows you to configure advanced Terminal settings.
Select one of the supported encoding settings.
Configure how PuTTY should answer back to the ^E sequence.
Specify the local echo discipline.
Specify the line editing discipline.
Specify whether or not to turn on auto wrap mode for the connection.
Specify whether or not to turn on DEC origin mode for the connection.
If checked, the PuTTY connection implies a carriage return in every received linefeed.
If checked, the PuTTY connection implies a linefeed in every received carriage return.
If checked, PuTTY will treat incoming destructive backspace characters (7F) as non-destructive backspace characters (08).
Set the speeds for the data connection.
Select a printer to select ANSI printer output for remote-controlled printing.
Action to happen when a bell occurs.
Specify a custom sound file (.wav file) to play as a bell.
Taskbar caption indicator on bell.
Temporarily disable bell when over-used.
Specify the number of bells threshold used to determine bell over-use.
Specify the number of seconds for the over-use threshold.
Specify the number of seconds silence is needed to re-enable the bell after it was temporarily disabled.
PuTTY can optionally provide the xterm service of allowing server applications to find out the local window title. This feature is disabled by default, but you can turn it on if you really want it.
If checked, PuTTY will not respond to server commands which may cause terminal resizing.
If checked, PuTTY will ignore server commands which would update the window title.
PuTTY has the ability to change its character set configuration in response to commands from the server. If checked, PuTTY will ignore those server commands.
Many terminals, including PuTTY, support an ‘alternate screen’. If checked, the alternate screen is disabled.
If checked, Arabic text shaping is disabled.
If checked, bidirectional text display is disabled.
Enter the logical name for the remote host for SSH key lookup or similar.
Choose which IP version PuTTY should use.
Interval between sending of null packets to keep the session active. Set to 0 to turn keepalive off.
The Nagle algorithm is disabled by default for interactive connections.
TCP keepalives may be more useful for ensuring that half-open connections are terminated than for keeping a connection alive. TCP keepalives are disabled by default.
Configure how PuTTY should handle line drawing.
If checked, PUTTY will treat CJIK ambiguous characters as wide.
If checked, PuTTY will treat the Caps Lock key to switch to and back from Cyrillic.
If checked, PuTTY will use lqqqk characters in clipboard operations.
If checked, VT100 line drawing is enabled even in UTF-8 mode.
The Environment tab can be used to set specific variables and values for the connection.
The SSH Settings page allows you to configure settings specific for SSH connections.
If checked, PuTTY's hostkey command line option will be set with the value specified in the Fingerprint property.
Specify an MD5-based host key fingerprint of the form displayed in PuTTY's Event Log and host key dialog box or a base64-encoded blob describing an SSH-2 public key in OpenSSH's one-line public key format. Pre-populating the fingerprint can be helpful when connecting through SSH tunnels, proxy servers or secure gateways.
In SSH, you don't have to run a general shell session on the server. Instead, you can choose to run a single specific command (such as a mail user agent, for example). Replacement tokens are supported.
PuTTY will attempt to use protocol 1 if the server you connect to does not offer protocol 2, and vice versa.
If you select ‘1 only’ or ‘2 only’ here, PuTTY will only connect if the server you connect to offers the SSH protocol version you have specified.
If checked, a session is started but without a pseudo-terminal.
This enables data compression in the SSH connection. This can help make the most of a low-bandwidth connection.
When you make an SSH connection, PuTTY will search down the list from the top until it finds an algorithm supported by the server, and then use that. If the algorithm PuTTY finds is below the ‘warn below here’ line, you will see a warning box when you make the connection.
Single-DES is not recommended in the SSH 2 draft protocol standards, but one or two server implementations do support it.
PuTTY supports a variety of SSH-2 key exchange methods, and allows you to choose which one you prefer to use. If the first algorithm PuTTY finds is below the ‘warn below here’ line, you will see a warning box when you make the connection.
Configure the timespan between rekey attempts. Set to 0 to disable rekey.
Use 1M for 1 megabyte, 1G for 1 gigabyte, etc.
In SSH-2, it is possible to establish a connection without using SSH's mechanisms to identify or authenticate oneself to the server.
SSH-2 servers can provide a message for clients to display to the prospective user before the user logs in.
If this option is enabled, then PuTTY will look for Pageant (the SSH private-key storage agent) and attempt to authenticate with any suitable public keys Pageant currently holds.
TIS and CryptoCard authentication are (despite their names) generic forms of simple challenge/response authentication available in SSH protocol version 1 only.
The SSH-2 equivalent of TIS authentication is called ‘keyboard-interactive’.
Note
You may need to enable this option when your servers requires multi-factor authentication (MFA).
This option allows the SSH server to open forwarded connections back to your local copy of Pageant. If you are not running Pageant, this option will do nothing.
The SSH-2 protocol does allow changes of username, in principle, but does not make it mandatory for SSH-2 servers to accept them. If you know your server can cope with it, you can enable this option.
If it is enabled, GSSAPI authentication will be attempted, and (typically) if your client machine has valid Kerberos credentials loaded, then PuTTY should be able to authenticate automatically to servers that support Kerberos logins.
If you enable this option, then not only will PuTTY be able to log in automatically to a server that accepts your Kerberos credentials, but also you will be able to connect out from that server to other Kerberos-supporting services and use the same credentials just as automatically.
Configure the preferred order of GSSAPI libraries.
Specify a custom GSSAPI library (DLL).
Occasionally you might find you have a need to run a session not in a pseudo-terminal.
Check to enable X11 forwarding for this connection.
The ‘X display location’ box is blank by default, which means that PuTTY will try to use a sensible default such as :0, which is the usual display location where your X server will be installed.
Configure the X11 authentication protocol.
Specify a X authentication file for the local display.
The Input page allows you to configure keyboard behavior in the remote session.
Default is xterm. Allows you to set a custom terminal name.
Specify how to encode function keys such as F1-F20, INS, Del, Home, etc.
Specify the backspace key sequence 0x08 (^H) or 0x7F (^?).
Specify the behavior of the Home and End keys.
Specify the initial cursor key mode Normal or Application.
If checked, PuTTY will ignore cursor key mode changes requested by the remote server.
Specify the numeric keyboard mode.
If checked, PuTTY will ignore keypad mode changes from the application on the server.
DEC terminals have a Compose key, which provides an easy-to-remember way of typing accented characters. If checked, AltGr acts as compose key.
If checked, the key combination Ctrl + Left Alt is treated the same way as the AltGr key.
Choose Compromise for right-click paste and middle-click extend. Windows for middle-click extends and right-click brings up the context menu. xtermn for right-click extend and middle click paste.
Specify the initial selection mode.
If checked, the terminal screen reverts to the last entries when you press a key.
When checked, the mouse will always do copy and paste in the normal way.
Auto-copy selected text to system clipboard If checked, PuTTY will automatically copy the selected text to the system clipboard.
Select the mouse paste action performed by PuTTY.
Select the action performed by PuTTY when pressing Ctrl, Shift and Insert.
Select the action performed by PuTTY when pressing Ctrl, Shift and C or V key.
If checked, PuTTY allows you to paste text with control characters.
If checked, PuTTY will write formatting information to the clipboard as well as the actual text you copy.
Specify the number of lines kept in the scrollback buffer.
This setting allows you to choose whether PuTTY claims to be BSD or RFC-compliant (OLD_ENVIRON/NEW_ENVIRON).
In active mode, PuTTY starts to send negotiations as soon as the connection is opened. In passive mode, PuTTY will wait to negotiate until it sees a negotiation from the server.
If this box is checked, the Backspace key on the keyboard will send the Telnet special backspace code, and Control-C will send the Telnet special interrupt code.
If checked, PuTTY sends Control-M instead of the Telnet New Line code when you press Return.
The Tunnels page allows you to configure SSH port forwarding (tunneling).
If checked, it allows you to set up local-to-remote port forwarding in such a way that machines other than your client PC can connect to the forwarded port (this also applies to dynamic SOCKS forwarding).
If checked, machines other than the SSH server machine can connect to the forwarded port.
Set the source port.
Set the destination.
The Serial Port page allows you to configure the port settings to connect to devices using RS232.
Set the port for communications.
Important
The Port Name must begin with COM.
Set the handshaking protocol for serial port transmission of data.
Set the speed of the serial port communication.
Set the standard length of data bits per byte.
Set the standard number of stop bits per byte.
Set the parity checking protocol.
The Proxy Settings page allows you to configure a proxy server used to connect to the remote server.
- No proxy (direct connect): (No proxy server will be used to connect to the remote server)
- Socks 4
- Socks 4a
- Socks 5
- HTTP Connect
- Telnet
- Local
Specify the proxy server name (FQDN) or IP address to use.
Specify the proxy server port to use.
[!includecredentialmodes.md]
Enter a comma seperated list of hosts or IPs. You may also use wildcards like: 192.168.88.*, *.example.com
Connections to the local host (the host name localhost, and any loopback IP address) are never proxied. You can change that by enabling this option.
- No: PuTTY will do DNS resolution.
- Auto: PuTTY will resolve depending on the proxy mode.
- Yes: PuTTY will always pass host names to the proxy.
You can use a command such as: %user\n%pass\nconnect %host %port\n
The Logging page allows you to configure session logging. Log files can be viewed using the Dashboard.
Choose which type of information should be logged during a session.
If checked, the content of known password fields is not logged. Applies only to SSH packet logging.
If checked, no session data is logged. Applies only to SSH packet logging.
The log file name can contain &Y, &M, &D for date, &T for time, and &H for host name. If you leave the log file name blank, Royal TS will generate a file name based on the connection name and the time stamp. Replacement tokens are supported.
Specify a path where all the log files are saved. Each log file will be named automatically based on the connection name and the time stamp.
Click to open the specified folder in the Windows Explorer.
If checked, Royal TS will create a directory with the connection name and write the recording files into it.
Configure what to do if the log file already exists.
If checked, PuTTY will flush data as soon as it is displayed, so that if you view the log file while a session is still open, it will be up to date; and if the client system crashes, there's a greater chance that the data will be preserved. If PuTTY is running slowly with logging enabled, you could try unchecking this option.
[!includenotes.md] [!includecustomproperties.md] [!includecustomfields.md] [!includeparentfolder.md] [!includeparentfolder-connection-warning.md]