TrueNAS SCALETrueNAS SCALE Version Documentation
This content follows the TrueNAS SCALE 23.10 (Cobia) releases. Use the Product and Version selectors above to view content specific to different TrueNAS software or major version.

Configuration

  2 minute read.

Last Modified 2024-03-19 08:38 EDT

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!

Configuration Commands

The configuration namespace has three commands that are based on functions found in the SCALE API and web UI. These commands return allowed network activity choices, configuration information, and allow you to change global network configuration settings. Options can vary by the type of system and license applied (i.e., an HA system).

You can enter commands from the main CLI prompt or from a network namespace prompt.

Activity_choices Command

The activity_choices command returns a list of system activities.

Press Enter after entering the command to display the list.

From the CLI prompt, enter:

network configuration activity_choices

From the network prompt, enter:

configuration activity_choices

Config Command

The config command displays the current system configuration network settings.

Press Enter after entering the command to display the list.

From the CLI prompt, enter:

network configuration config

From the network prompt, enter:

configuration config

Update Command

This section covers configuring the default gateway.

Enter configuration (or network configuration if you just opened the TrueNAS CLI Shell).

Enter update ipv4gateway="ipaddress"

If entered properly, your system networking is now configured.

Related CLI Network Articles