Online Help > Entry Types > Sessions > Remote Connections

SSH Shell

Description

 

This entry is used to define and configure an SSH Shell session.

 

The SSH Shell entry type offers secure connections over an encrypted internet protocol via a Command Line Interface (CLI).

 

Settings

 

General

SSH Shell - General

SSH Shell - General

 

OPTION

DESCRIPTION

Host

Enter the host name or IP address of the remote device.

Port selector

Click on the link to edit the port number.

Port generator

Click on the icon to display the Port Generator.

Username

Enter the account's username.

Password

Enter the account's password.

View / Hide password

Click on the view icon to view the password.

Click on the hide icon to hide the password.

Password generator

Click on the icon to display the Password Generator.

Password history

Click on the icon to display the password history for this session.

Password analyzer

Indicates the strength of the password.

Always ask for password

Check this option to be prompted for the password upon every usage of this entry. It also has the effect of preventing the password from being specified.



 

Private Key

On the Windows platform, our native SSH Shell client supports the PuTTY Private Key (.ppk) format only.

For more information on private keys, please consult our Private Key topic.

 

Proxy

SSH Shell – Proxy

SSH Shell – Proxy

 

OPTION

DESCRIPTION

Proxy mode

Select the proxy mode. Select between:

None: do not use any proxy.

Link: select an existing proxy.

Custom: provide the proxy information in the session's properties.

Proxy

Select a existing proxy configuration. Only when the Proxy mode is set to Custom.

Proxy type

Select a proxy type. Select between:

Socks4

Socks5

HTTP

Host

Enter the host name or IP address of the remote device.

Port selector

Click on the link to edit the port number.

Port generator

Click on the icon to display the Port Generator.

Username

Enter the account's username.

Password

Enter the account's password.

View / Hide password

Click on the view icon to view the password.

Click on the hide icon to hide the password.

Password generator

Click on the icon to display the Password Generator.

Password history

Click on the icon to display the password history for this session.

Excluded hosts

Enter host names or IP addresses to exclude.

Consider proxying local host connections

TBD

DNS name lookup at proxy end

TBD

Telnet / local proxy command

TBD

 

SSH Gateway (jump host)

It is possible to tunnel the connection through another another host for enhanced security.

 

SSH Shell – SSH Gateway (jump host)

SSH Shell – SSH Gateway (jump host)

 

OPTION

DESCRIPTION

Connect through SSG Gateway

Allow the connection to try connecting through the host configured below.

Host

Enter the hostname or IP address of the intermediate host.

Port

Enter the port of the intermediate host.

Port generator

Click on the icon to display the Port Generator.

Credentials

Select where the credentials are retrieved from. Select between:

Custom credentials

Credential repository

My personnal credentials

Username

Enter the username used to connect to the intermediate host.

Password

Enter the password used to connect to the intermediate host.

Prompt for credentials

Promt the user for credentials before connecting the the intermediate host.

 

After Login And Before Disconnect Commands

These two tabs are the same with one exception. The commands in the After Login Commands tab are executed at the session opening. In the Before Disconnect Commands tab they are executed just before the session is closed.

 

SSH Shell - After Login and Before disconnect commands

SSH Shell - After Login and Before disconnect commands

 

OPTION

DESCRIPTION

Automatic {ENTER} after command

Click the box to execute commands automatically.

Command 1 to 5

Enter the command you want to be executed.

More commands

Enter additional commands you want to be executed. One command per line.

Help button

Click to open the help for Auto Typing Macro commands in your web browser.

Delay

Add a delay before executing the command.

 

Terminal – General

SSH Shell - Terminal - General

SSH Shell - Terminal - General

 

OPTION

DESCRIPTION

Override terminal type

Specify your preferred terminal type.

Encoding

Select the encoding that you want to use.

Auto wrap

Break the output text into multiple lines when it reaches the right-hand edge of the window. Select between:

Default

On

Off

Local echo

Print everything that is typed in the terminal. Select between

Default

Auto

On

Off

Initial keypad mode

Select the initial keypad mode. Select between:

Default

Application

Normal

Disable application keypad mode

Disable the application keypad mode. Select between:

Default

True

False

Cursor type

Select the type of text cursor to display. Select between:

Default

Block

Underline

Vertical line

Cursor blink

Select either if the text cursor blinks or not.

Force Non-destructive backspace

Prevent the user from erasing the output text.

Implicit carriage return in Linefeed

Force a carriage return in every linefeed.

Implicit linefeed in carriage return

Force a linefeed in every carriage return.

Max scrollback lines

Select the number of lines kept in history.

Double-click delimiters

Input characters to be used as double-click selection delimiters.

 

Terminal - Font

SSH Shell - Terminal - Font

SSH Shell - Terminal - Font

 

OPTION

DESCRIPTION

Override

Enable the terminal font override. Select between the following:

Default

Override

Font

Select the font.

Size

Select the font size.

Is bold

Makes the output font bold.

Font quality

Adjust the output font quality. Select between:

Default

Anti-aliased

Non anti-aliased

ClearType

 

Terminal - Bell

SSH Shell - Terminal - Bell

SSH Shell - Terminal - Bell

 

OPTION

DESCRIPTION

Bell behavior

Change the bell behavior. Select between:

Default

None

Sound

Visual (flash window)

 

Keyboard

SSH Shell - Keyboard

SSH Shell - Keyboard

 

OPTION

DESCRIPTION

Cursor key mode

Change the behavior of the cursor key. Select between:

Default

Normal

Application

Backspace key mode

Change the behavior of the backspace key. Select between:

Default

Control-H

Control-? (ASCII code 127)

Home / End key mode

Change the behavior of the Home / End keys. Select between:

Default

Standard

RXVT

Functions keys mode

Change the behavior of the Functions Keys. Select between:

Default

ESC[N~

Linux

Xterm R6

VT400

VT100+

SCO

 

X11 Forwarding

The X11 forwarding feature allows you to forward the graphical user interface (GUI) of applications from a remote device. Once the feature is enabled, type the name of the application to launch in the command line. This will launch the application on the remote system, forwarding its GUI to the local system.

 

SSH Shell - X11 Forwarding

SSH Shell - X11 Forwarding

 

OPTION

DESCRIPTION

Enable X11 forwarding

Allow X window system forwarding.

X display location

Specify the display location. By default, the display location is the local primary display (:0). Change this value if you to use an external display.

Protocol

Specify the X window system protocol. Select between:

MIT-Magic-Cookie-1 (simple password-style protocol)

XDM-Authorization-1 (cryptographically authenticated protocol: the data sent by the X client is different every time)

X authority file for local display

Specify the location of the local display's X authority file if your X server requires authorization.

 

Advanced

SSH Shell - Advanced

SSH Shell - Advanced

 

OPTION

DESCRIPTION

Internet Protocol

Select your preferred Internet Protocol. Select between:

Default

IPv4

IPv6

Enable logging

Create a log file in the location specified below.

Log path

Enter the path for the log file.

Log mode

Select a logging mode. Select between:

Event

Printable output

Log overwrite mode

Available only when the Log mode is set to Printable output. Select between:

Default

Prompt

Append

Overwrite

Verbose

Provides additional details in output.

Enable GSS API authentication

Enable GSS API for encrypted authentication.

Close on disconnect or error

The session will close if the connection is lost or an error occur.

Do not display error messages

Do not display the error dialog when an error occurs.

Enable TCP keepalives

Keep the TCP connection instead of creating a new one.

Seconds

Time for TCP keepalive.

Always accept fingerprint

Accept any fingerprint without prompting for permission.

Mouse click mode

Change the mouse click behavior. Select between:

Default

Windows

Compromise

XTerm

Use SSH authentication agent

Use the Key Agent Manager for private keys.

Allow SSH authentication agent forwarding

Enable the Key Agent Manager forwarding.