General

checkin does not require entering properties or arguments. After UI settings are saved with rollback_timeout, see update properties, this method needs to be called within that timeout limit to prevent reverting the pending changes.

Enter the command string and then press Enter.

The command returns an empty line.

From the CLI prompt, enter:

system general checkin

Press Enter.

system general checkin

checkin_waiting does not require entering properties or arguments.

Enter the command string and then press Enter.

If UI settings are saved with rollback_timeout, see update properties, checkin_waiting returns the remaining time (in seconds) before the automatic rollback. Returns null if there are no changes pending.

From the CLI prompt, enter:

system general checkin_waiting

Press Enter.

system general checkin_waiting
44

config does not require entering properties or arguments.

Enter the command string and then press Enter.

Returns a table containing current UI and localization settings. If UI settings are saved with rollback_timeout enabled, see update properties, the table includes any pending changes. An automatic rollback reverts pending changes if checkin is not called before the timeout limit.

From the CLI prompt, enter:

system general config

Press Enter.

system general config
+-------------------------+---------------------------+
|                      id | 1                         |
|                language | en                        |
|                  kbdmap | us                        |
|                birthday | 1970-01-01T00:00:00+00:00 |
|                timezone | America/Los_Angeles       |
|             wizardshown | false                     |
|        usage_collection | true                      |
|                 ds_auth | false                     |
|              ui_address | 0.0.0.0                   |
|            ui_v6address | ::                        |
|            ui_allowlist | <empty list>              |
|                 ui_port | 80                        |
|            ui_httpsport | 443                       |
|        ui_httpsredirect | false                     |
|       ui_httpsprotocols | TLSv1.2                   |
|                         | TLSv1.3                   |
|      ui_x_frame_options | SAMEORIGIN                |
|           ui_consolemsg | false                     |
|          ui_certificate | <dict>                    |
| usage_collection_is_set | false                     |
+-------------------------+---------------------------+

country_choices does not require entering properties or arguments.

Enter the command string and then press Enter.

Returns a table containing the available country codes for use in certificates.

From the CLI prompt, enter:

system general country_choices

Press Enter.

system general country_choices
+----+------------------------------------------------------------------+
| AF | Afghanistan                                                      |
| AL | Albania                                                          |
| DZ | Algeria                                                          |
| AD | Andorra                                                          |
| AO | Angola                                                           |
| AG | Antigua and Barbuda                                              |
| AR | Argentina                                                        |
| AM | Armenia                                                          |
...
| SJ | Svalbard                                                         |
| AC | Ascension                                                        |
| TA | Tristan da Cunha                                                 |
| AQ | Australian Antarctic Territory + Ross Dependency + Peter I Is... |
+----+------------------------------------------------------------------+

kbdmap_choices does not require entering properties or arguments.

Enter the command string and then press Enter.

Returns a table containing the available keyboard maps.

From the CLI prompt, enter:

system general kbdmap_choices

Press Enter.

system general kbdmap_choices
+-------------------------------+------------------------------------------------------+
|                        custom | A user-defined custom Layout                         |
|                       gh.akan | Akan                                                 |
|                            al | Albanian                                             |
|                      al.plisi | Albanian (Plisi)                                     |
|                al.veqilharxhi | Albanian (Veqilharxhi)                               |
|                            et | Amharic                                              |
|                           ara | Arabic                                               |
...
|                         vn.us | Vietnamese (US)                                      |
|                            sn | Wolof                                                |
|                        ru.sah | Yakut                                                |
|                     ng.yoruba | Yoruba                                               |
+-------------------------------+------------------------------------------------------+

English is the default language in TrueNAS SCALE. However, users can contribute text string translations for the TrueNAS web interface to help make TrueNAS available in other languages. For all language options, the web UI defaults to English text if a translated string is not available. See Web Interface Translations for more information.

language_choices does not require entering properties or arguments.

Enter the command string and then press Enter.

Returns a table containing the available languages.

From the CLI prompt, enter:

system general language_choices

Press Enter.

system general language_choices
+---------+----------------------+
|      af | Afrikaans            |
|      ar | Arabic               |
|     ast | Asturian             |
...
|      ur | Urdu                 |
|      vi | Vietnamese           |
| zh-hans | Simplified Chinese   |
| zh-hant | Traditional Chinese  |
+---------+----------------------+

local_url does not require entering properties or arguments.

Enter the command string and then press Enter.

Returns the configured URL in the format of protocol://host:port.

From the CLI prompt, enter:

system general local_url

Press Enter.

system general local_url
https://8.8.8.8:443

timezone_choices does not require entering properties or arguments.

Enter the command string and then press Enter.

Returns a table containing all available timezones.

From the CLI prompt, enter:

system general timezone_choices

Press Enter.

system general timezone_choices
+----------------------------------+----------------------------------+
|                   Africa/Abidjan | Africa/Abidjan                   |
|                     Africa/Accra | Africa/Accra                     |
|               Africa/Addis_Ababa | Africa/Addis_Ababa               |
|                   Africa/Algiers | Africa/Algiers                   |
|                    Africa/Asmara | Africa/Asmara                    |
...
|                              UTC | UTC                              |
|                        Universal | Universal                        |
|                             W-SU | W-SU                             |
|                              WET | WET                              |
|                             Zulu | Zulu                             |
+----------------------------------+----------------------------------+

ui_address_choices does not require entering properties or arguments.

Enter the command string and then press Enter.

Returns a table containing the available addresses.

From the CLI prompt, enter:

system general ui_address_choices

Press Enter.

system general ui_address_choices
+---------+---------+
| 0.0.0.0 | 0.0.0.0 |
+---------+---------+

ui_certificate_choices does not require entering properties or arguments.

Enter the command string and then press Enter.

The command returns a table containing available certificate options.

From the CLI prompt, enter:

system general ui_certificate_choices

Press Enter.

system general ui_certificate_choices
+---+-----------------+
| 1 | truenas_default |
+---+-----------------+

ui_httpsprotocols_choices does not require entering properties or arguments.

Enter the command string and press Enter.

The command returns a table containing available protocols.

From the CLI prompt, enter:

system general ui_httpsprotocols_choices

Press Enter.

system general ui_httpsprotocols_choices
+---------+---------+
|   TLSv1 | TLSv1   |
| TLSv1.1 | TLSv1.1 |
| TLSv1.2 | TLSv1.2 |
| TLSv1.3 | TLSv1.3 |
+---------+---------+

New UI settings, configured via update, are not applied automatically. Use ui_restart to apply settings, include the optional delay property to apply settings after an amount of time (in seconds), for example the amount of time you need to receive the response for your settings update request, or use the update property ui_restart_delay.

ui_restart has one available property, delay.

Enter the command string and press Enter.

The command returns a blank line. After any specified delay is exceeded, the web server restarts. The screen briefly displays a “Connecting to TrueNAS…” dialogue, then the UI returns.

From the CLI prompt, enter:

system general ui_restart delay=30

Where 30 is the amount of time (in seconds) to wait before the web server restarts. Press Enter.

system general ui_restart delay=30

ui_v6address_choices does not require properties or arguments.

Enter the command string and then press Enter.

The command returns a table containing available addresses.

From the CLI prompt, enter:

system general ui_v6address_choices

Press Enter.

system general ui_v6address_choices
+----+----+
| :: | :: |
+----+----+

update has 18 available properties, see the table below.

Connect properties and value pairs using an = sign, for example property=value. Enclose values using special characters in double quotes, for example ui_address="0.0.0.0". Separate multiple property and value pairs using a space.

List properties can accept a single value, for example ui_httpsprotocols="TLSv1.3", multiple values enclosed in square brackets [] and separated by a comma and space, for example ui_httpsprotocols=["TLSv1.2", “TLSv1.3”], or an empty list [] to clear current configuration, for example ui_httpsprotocols=[].

Enter the command string with all properties you want to update and press Enter.

update returns an empty line. Use config to confirm pending changes.

UI settings are not applied automatically. Use ui_restart to apply new settings or set the ui_restart_delay property to automatically apply settings after a set time (in seconds).

Incorrect UI configuration can result in lost web UI or even API connectivity! To avoid problems, specify a rollback_timeout in seconds. If a checkin is not called before the rollback_timeout expires, the UI server automatically restarts and pending updates are reverted to previous settings.

Note: The automatic rollback only reverts UI settings. It does not affect localization properties, such as language or timezone.

From the CLI prompt, enter:

system general update property=value

Where property is the property to update and value is its configured value. Press Enter.

system general update language=en timezone="US/Eastern" rollback_timeout=60 ui_restart_delay=5