TrueNAS SCALE Version DocumentationThis 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.
General
12 minute read.
Last Modified 2024-03-19 08:38 EDTThe 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!
The general namespace has 14 commands, and is based on general settings functions found in the SCALE API and web UI. It provides access to GUI and localization configuration settings through the general namespace commands.
The following general namespace commands allow you to configure time zone, language, HTTP protocol, UI address, and system certificate options. You can also restart the system through this namespace.
You can enter commands from the main CLI prompt or from the system namespace prompt.
The checkin
command accepts pending settings.
The checkin_waiting
command determines whether the system is waiting for a checkin
to confirm pending changes.
The config
command returns current UI configuration.
The country_choices
command returns a list of available country options for use in creating certificates. See system certificate
for more information.
The kbdmap_choices
command returns a list of available keyboard map options.
The language_choices
command returns a list of available language translation options for the TrueNAS SCALE web UI.
The local_url
command returns the current local URL configuration for the TrueNAS SCALE web UI.
The timezone_choices
command returns a list of available timezone options for system localization.
The ui_address_choices
command returns IPv4 address options for the TrueNAS SCALE UI.
The ui_certificate_choices
command returns a list of certificates which can be used for configuring ui_certificate
(see update
properties).
The ui_httpsprotocols_choices
command returns a table of available HTTPS protocols for the TrueNAS SCALE web UI.
The ui_restart
command restarts the HTTP Server for the TrueNAS SCALE web UI.
This does not shut down and reboot the full system.
The ui_v6address_choices
command returns IPv6 address choices for the TrueNAS SCALE web UI.
The update
command allows users to configure UI and localization settings for the TrueNAS SCALE web UI.