TrueNAS Documentation Archive
This content follows the TrueNAS 23.10 (Cobia) releases. Archival documentation is provided for reference only and not actively maintained. Use the Product and Version selectors above to view content specific to different TrueNAS software or major version.

SSH

4 minute read.

Last Modified 2024-03-19 08:38 EDT

SSH Namespace

The ssh namespace has three commands and is based on SSH service functions found in the SCALE API and web UI. It provides access to SSH service management methods through the ssh commands.

SSH Commands

The following ssh commands allow you to view and edit ssh properties.

The SCALE CLI guide is a work in progress! New namespace and command documentation is continually added and maintained, so check back here often to see what is new!

Interactive Argument Editor (TUI)

Enter the -- flag following any CLI command to open the interactive arguments editor text-based user interface (TUI).
Click for more information

Bindiface_Choices Command

The bindiface_choices command returns a table of available interface for SSH to listen on.

Using the Bindiface_Choices Command

Description

The bindiface_choices command has no required properties. Enter the command then press Enter. The command returns a table of available interfaces when successful.

Usage

From the CLI prompt, enter:

service ssh bindiface_choices

Command Example

service ssh bindiface_choices
+------------+------------+
|       eno1 | eno1       |
|       eno2 | eno2       |
| enp179s0f0 | enp179s0f0 |
| enp179s0f1 | enp179s0f1 |
| enp179s0f2 | enp179s0f2 |
| enp179s0f3 | enp179s0f3 |
+------------+------------+

Config Command

The config command returns a table with current SSH settings.

Using the Config Command

Description

The config command has no required properties. Enter the command then press Enter. The command returns a table of current SSH service settings when successful.

Usage

From the CLI prompt, enter:

service smart config

Command Example

ssh config
+---------------------------+------------------------------------------------------------------+
|                        id | 1                                                                |
|                 bindiface | <empty list>                                                     |
|                   tcpport | 22                                                               |
|                 rootlogin | false                                                            |
|                adminlogin | true                                                             |
|              passwordauth | true                                                             |
|              kerberosauth | false                                                            |
|                    tcpfwd | false                                                            |
|               compression | false                                                            |
|                privatekey |                                                                  |
|            sftp_log_level |                                                                  |
|         sftp_log_facility |                                                                  |
|              host_dsa_key | LS0tLS1CRUdJTiBPUEVOU1NIIFBSSVZBVEUgS0VZLS0tLS0KYjNCbGJuTnphQ... |
|          host_dsa_key_pub | c3NoLWRzcyBBQUFBQjNOemFDMWtjM01BQUFDQkFQL3dkaXM5NUdWeHUySXVtb... |
|     host_dsa_key_cert_pub | <null>                                                           |
|            host_ecdsa_key | LS0tLS1CRUdJTiBPUEVOU1NIIFBSSVZBVEUgS0VZLS0tLS0KYjNCbGJuTnphQ... |
|        host_ecdsa_key_pub | ZWNkc2Etc2hhMi1uaXN0cDI1NiBBQUFBRTJWalpITmhMWE5vWVRJdGJtbHpkS... |
|   host_ecdsa_key_cert_pub | <null>                                                           |
|          host_ed25519_key | LS0tLS1CRUdJTiBPUEVOU1NIIFBSSVZBVEUgS0VZLS0tLS0KYjNCbGJuTnphQ... |
|      host_ed25519_key_pub | c3NoLWVkMjU1MTkgQUFBQUMzTnphQzFsWkRJMU5URTVBQUFBSUdFa1hFdUloa... |
| host_ed25519_key_cert_pub | <null>                                                           |
|                  host_key | <null>                                                           |
|              host_key_pub | <null>                                                           |
|              host_rsa_key | LS0tLS1CRUdJTiBPUEVOU1NIIFBSSVZBVEUgS0VZLS0tLS0KYjNCbGJuTnphQ... |
|          host_rsa_key_pub | c3NoLXJzYSBBQUFBQjNOemFDMXljMkVBQUFBREFRQUJBQUFCZ1FDcDBmb09LY... |
|     host_rsa_key_cert_pub | <null>                                                           |
|              weak_ciphers | AES128-CBC                                                       |
|                           | NONE                                                             |
|                   options |                                                                  |
+---------------------------+------------------------------------------------------------------+

Update Command

The update command allows you to update SSH service settings.

Using the Update Command

Description

The update command has 12 optional properties; bindiface, tcpport, rootlogin, adminlogin, passwordauth, kerberosauth, tcpfwd, compression, sftp_log_level, sftp_log_facility, weak_ciphers, and options. See Update Command Properties below for details. After entering update, you must include at least one property to update. Separate additional properties with a space. Enter the command string then press Enter. The command returns a blank line when successful.

Update Command Properties

Property	Description	Syntax Example
`bindiface`	The interfaces for SSH to listen on. Leave empty for SSH to listen on all interfaces.	`bindiface=[interface, interface]`
`tcpport`	The port you want to use for SSH connection requests.	`tcpport=number`
`rootlogin`	Allows root logins.	`rootlogin=true/false`
`adminlogin`	Allows admin logins.	`adminlogin=true/false`
`passwordauth`	Allows using a password to authenticate the SSH login.	`passwordauth=true/false`
`kerberosauth`	Allows Kerberos authentication using valid directory services entries.	`kerberosauth=true/false`
`tcpfwd`	Allows users to bypass firewall restrictions using the SSH port forwarding feature.	`tcpfwd=true/false`
`compression`	When enabled, the system attempts to reduce latency over slow networks.	`compression=true/false`
`sftp_log_level`	Select the syslog(3) level of the SFTP server.	`sftp_log_level=LEVEL`
`sftp_log_facility`	Select the syslog(3) facility of the SFTP server.	`sftp_log_facility=FACILITY`
`weak_ciphers`	Allow more ciphers for sshd(8) in addition to the defaults in sshd_config(5).	`weak_ciphers=[“CIPHER”, “CIPHER”]`
`options`	Additional sshd_config(5) options	`options=options`

Usage

From the CLI prompt, enter:

service ssh update property=value

Where:

property is the property you want to update.
value is the value you want to specify for the property.

Command Example

service ssh update bindiface=[] tcpport=22 adminlogin=true weak_ciphers=["NONE", "AES128-CBC"]

Use Cases

Industry

Support

Resources

SSH

SSH Namespace

SSH Commands

Interactive Argument Editor (TUI)

Bindiface_Choices Command

Description

Usage

Config Command

Description

Usage

Update Command

Description

Usage

Related CLI SSH Articles