TrueNAS SCALE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

Using the Console Setup Menu

9 minute read.

Last Modified 2024-03-15 13:07 EDT

The Console Setup menu displays at the end of the iso installation process and after the system boots up. You can access this menu to administer the TrueNAS system if it has a keyboard and monitor.

By default, TrueNAS does not display the Console Setup menu with SSH or web shell connections. The admin user, the root user (if enabled), or another user with administrator or root-level permissions can start the Console Setup menu by entering this command:

/usr/bin/cli --menu

The menu provides several options:

Figure 1: TrueNAS SCALE Console Setup Menu

For network configuration options 1, 2, and 3, we recommend using the SCALE UI to configure network interfaces, as it has safeguards to prevent breaking network access to SCALE.

1) Configure network interfaces
Use this to configure the primary network interface with a static IP. This is for switching away from the DHCP-assigned IP address TrueNAS provides when the system boots after installing SCALE. Also, use this to set up other network interfaces or to add alias IP addresses for the primary interface.
2) Configure network settings
Use this to set up the network default gateway, host name, domain, IPv4 gateway and DNS name servers. Configured options display in the Global Configuration widget in the web UI Network screen.
3) Configure static routes
Use this to set up static IP routes, but this is not required as part of the initial configuration setup.
4) Change local administrator password
Use to change the administrator user password. If you selected option 1 on the iso installer menu, you have already configured the admin user and password. You can use this to change the admin password before you log into the SCALE UI.
This is not the password for the root user in the CLI or the root user login password for the web UI. The root user password is disabled by default as part of security hardening. Activating the root user is not recommended.
5) Reset configuration to defaults
Use to wipe all system configuration settings and return the system to a fresh install state.
6) Open TrueNAS CLI Shell
Use to start a shell for running TrueNAS commands, or use the SCALE UI System Settings > Shell. Type exit to leave the shell.
7) Open Linux Shell
Use to start a shell window for running Linux CLI commands. Configuration changes made here are not written to the database and are reset on each system boot. We do not recommend using the Linux shell unless you are an advanced user. Type exit to leave the shell.
8) Reboot
Use to restart the system by powering down and then automatically powering on the system.
9) Shut down
Use to power down the system.

During the first boot, TrueNAS attempts to connect to a DHCP server from all live interfaces. If it receives an IP address, the Console Setup menu displays it under The web user interface is at: so you can access the SCALE web UI.

You might be able to access the web UI using a hostname.domain command at the prompt (default is truenas.local) if your system:

Does not have a monitor.
Is on a network that supports Multicast DNS (mDNS).

You can either use SCALE UI or the Console Setup menu to configure your network settings for the primary network interface or other interfaces such as a link aggregate (LAGG) or virtual LAN (VLAN), or aliases for an interface, and to configure other network settings such as the default gateway, host name, domain, and the DNS name servers, or add static routes.

We recommend that only experienced administrators familiar with network configuration and the Console setup menu use it and that less experienced and knowledgeable system administrators use the SCALE UI to configure your network interfaces and other network configuration settings. The TrueNAS SCALE UI includes safety measures to prevent you from completely disrupting network connectivity for your TrueNAS SCALE if you make a mistake with network interface settings.

Enter 1 to display the Configure Network Interfaces screen and select the interface settings.

Figure 2: TrueNAS SCALE Console Setup Menu Edit Interface

Follow the instructions on the screen to configure an IP for a network interface. Type n to open the new interface screen or press Enter to edit the existing interface.

Figure 3: TrueNAS SCALE Console Setup Menu Edit Interface Settings

You can enter aliases for an interface when you create a new one or edit an existing interface.

One or More Aliases?

Static IP addresses set a fixed address for an interface that external devices or websites need to access or remember, such as for VPN access.

Use aliases to add multiple internal IP addresses, representing containers or applications hosted in a VM, to an existing network interface without having to define a separate network interface.

In the UI, you can add aliases when adding or editing an existing interface using the Add button to the right of the Aliases. To add a static IP. Click Add again to add an additional alias.

From the Console Setup menu, select option 1 to configure network settings and add alias IP addresses.

Type q to return to the main Console Setup menu screen.

Enter 2 to display the Network Settings screen to set up the host name, domain, default gateway and name servers. You can also add these settings using the web UI.

Figure 4: TrueNAS SCALE Console Setup Menu Edit Network Settings

Enter 3 to display the Static Route Settings screen to set up static routes. You can also add static routes in the web UI.

Figure 5: TrueNAS SCALE Console Setup Menu Static Routes

One or More Aliases?

Static IP addresses set a fixed address for an interface that external devices or websites need to access or remember, such as for VPN access.

Use aliases to add multiple internal IP addresses, representing containers or applications hosted in a VM, to an existing network interface without having to define a separate network interface.

From the Console Setup menu, select option 1 to configure network settings and add alias IP addresses.

Configuring Required Network Settings

TrueNAS uses DHCP to assign the IP address required to access the SCALE UI and displays it on the Console Setup Menu screen, and it sets the host name to truenas.

If you do not plan to use the DHCP-assigned network addresses provided by SCALE, identify your host and domain names, the static or fixed IP addresses you plan to assign to your network interface card(s), the default gateway, subnet mask(s), and the DNS name servers in your network.

TrueNAS Enterprise
For Enterprise systems, have your network information ready to provide iXsystems Support when they guide you through your configuration.

All other users should have their network information ready before starting to configure network settings. This makes the process go faster and reduces the risk of issues when you configure SCALE.

To use the Console Setup menu to change the network interface IP address:

Type 1 and then press Enter to open the Configure Network Interfaces screen.
Use either Tab or the arrow keys to select the interface to use as your primary network interface if you have more than one interface installed and wired to your network.
Enter in the IP address, then use either Tab or the arrow keys to move through the menu and down to select Save, and then press Enter. After saving, enter q to return to the main Console Setup menu.

To configure the default gateway, host name, domain and DNS name severs using the Console Setup menu type 2 and then press Enter to open the Network Settings screen.

To configure network settings in the SCALE UI, enter the IP address displayed on the Console Setup menu screen in a browser URL field and press Enter. Log in with the admin user name and password set for the administration user during the iso installation process, and then go to Network to edit an interface or global network configuration settings.

Configuring Home User Network Settings

Home users have a few options to allow Internet access using TrueNAS SCALE:

Use 8.8.8.8 as the DNS nameserver address
Use your ISP provider DNS servers (contact them for assistance with these addresses)
Use 1.1.1.1 for Cloudflare
Use 9.9.9.9 for Quad9

Changing the Administrator Password

SCALE has implemented administrator account logins as replacements for the root user. The Local Administrator user account is the default account, and the root password is now disabled by default. If you migrate from CORE to SCALE and need to upload the CORE system configuration file, the root user password is not disabled but you must recreate the admin user account and disable the root password.

You can change the admin user password in the UI or from the Console Setup menu. You can set and enable the root user password in the UI, but for security hardening, we recommend leaving it disabled.

Changing the admin user (or root if you have not created the admin user) password disables 2FA (Two-Factor Authentication).

Disabling a password in the UI prevents the user from logging in with it. If both the root and local admin user passwords are disabled and the web interface session times out with these passwords disabled, SCALE provides a temporary sign-in screen to allow logging into the UI. Immediately go to the Credentials > Local User screen, select the admin user, click Edit and re-enable the password.

Resetting the System Configuration

Caution! Resetting the configuration deletes all settings and reverts TrueNAS to default settings. Before resetting the system, back up all data and encryption keys/passphrases! After the system resets and reboots, you can go to Storage and click Import Pool to re-import pools.

Enter 5 in the Console Setup menu, then enter y to reset the system configuration. The system reboots and reverts to default settings.

Completing your System Setup

After setting up network requirements, log into the web UI to complete your system setup by:

[Completing network configuration] (/scale/scaletutorials/network/) if not already set up using the Console Setup menu.
Setting up storage
Setting up sharing
Backing Up your configuration