Adding SSH Credentials

Semi-automatic simplifies setting up an SSH connection with another FreeNAS or TrueNAS system without logging in to that system to transfer SSH keys. This requires an SSH keypair on the local system and administrator account credentials for the remote TrueNAS. You must configure the remote system to allow root access with SSH. You can generate the keypair as part of the semiautomatic configuration or a manually created one using SSH Keypairs.

Using the SSH Connections configuration screen:

1. Enter a name and select the Setup Method. If establishing an SSH connection to another TrueNAS server use the default Semi-automatic (TrueNAS only) option. If connecting to a non-TrueNAS server select Manual from the dropdown list.

   

2. Enter the authentication settings.

   

   a. Enter a valid URL scheme for the remote TrueNAS URL in TrueNAS URL. This is a required field.

   b. Enter an Admin user name, which is the username on the remote system entered to log in via the Web UI to setup the connection. Or, leave Admin Username set to the default root user and enter the user password in Admin Password.

   c. If two-factor authentication is enabled, enter the one-time password in One-Time Password (if neccessary).

   d. Enter a Username, which is the user name on the remote system to log in via SSH.

   e. Enter or import the private key from a previously created SSH keypair, or create a new one using the SSH Keypair widget.

3. (Optional) Select a security option from the Cipher dropdown list. Select Standard for the most secure option, but this has the greatest impact on connection speed. Select Fast for a less secure option than Standard but it can give reasonable transfer rates for devices with limited cryptographic speed. Select Disabled to remove all security and maximize connection speed, but only disable security when using this connection within a secure, trusted network.

   

4. (Optional) Enter the number of seconds you want to have SCALE wait for the remote TrueNAS/FreeNAS system to connect in Connect Timeout.

5. Click Save. Saving a new connection automatically opens a connection to the remote TrueNAS and exchanges SSH keys. The new SSH connection displays on the SSH Connection widget. To edit it, click on the name to open the SSH Connections configuration screen populated with the saved settings.

Using the SSH Connections configuration screen:

1. Enter a name and select Manual from the Setup Method dropdown list.

   

2. Enter the authentication settings.

   

   a. Enter a host name or host IP address for the remote non-TruNAS/FreeNAS system as a valid URL. An IP address example is https://10.231.3.76. This is a required field.

   b. Enter the port number of the remote system to use for the SSH connection.

   c. Enter a user name for logging into the remote system in Username.

   c. Select the private key from the SSH keypair that you used to transfer the public key on the remote NAS from the Private Key dropdown.

   d. Enter the remote system SSH key for this TrueNAS SCALE system in Remote Host Key to authenticate the connection.

   e. Click Discover Remote Host Key after properly configuring all other fields to connect to the remote system and attempt to copy the key string to the related SCALE field.

3. (Optional) Select a security option from the Cipher dropdown list. Select Standard for the most secure option, but this has the greatest impact on connection speed. Select Fast for a less secure option than Standard but it can give reasonable transfer rates for devices with limited cryptographic speed. Select Disabled to remove all security in favor of maximizing connection speed, but only disable security when usisg this connection within a secure, trusted network.

   

4. (Optional) Enter the number of seconds you want to have SCALE wait for the remote TrueNAS/FreeNAS system to connect in Connect Timeout.

5. Click Save. Saving a new connection automatically opens a connection to the remote TrueNAS and exchanges SSH keys. The new SSH connection displays on the SSH Connection widget. To edit it, click on the name to open the SSH Connections configuration screen populated with the saved settings.

1. Copy the SSH public key text or download it to a text file.

   Log into the TrueNAS system that generated the SSH keypair and go to Credentials > Backup Credentials.

   Click on the name of the keypair on the SSH Keypairs widget to open the keypair for the SSH connection.

   Copy the text of the public SSH key or download the public key as a text file.

2. Add the public key to the root user account on the system where you want to register the public key.

   Log into the TrueNAS system that you want to register the public key on and go to Credentials > Local Users.

   Edit the root user account. Click on the expand_more icon and then click Edit to open the Edit User screen.

   Paste the SSH public key text into the Authorized Keys field on the Edit User configuration screen in the Authentication settings.

Do not paste the SSH private key.

Click Save.

3. Add a new public SSH key to the remote system.

   Generate a new SSH keypair in Credentials > Backup Credentials. Click Add on the SSH Keypairs widget and select Generate New.

   Copy or download the value for the new public key.

   Add the public key to the remote NAS.

If the remote NAS is not a TrueNAS system, refer to the documentation for that system, and find their instructions on adding a public SSH key.