Get a Quote     (408) 943-4100   TrueNAS Discord VendOp_Icon_15x15px Commercial Support
TrueNAS.com Software Systems Company Community Security iX Portal Download
TrueNAS CORE TrueNAS Enterprise TrueNAS SCALE Compare Editions TrueCommand Software Status FreeNAS
Compare Systems F-Series M-Series X-Series R-Series Mini Series
About iXsystems Our Clients Reviews Careers Awards iX Blog & News iX Website Contact Us
Community Forum Discord TrueNAS GitHub TrueNAS Merch Store
Application Analytics Backup and Archival Cloud Data Mobility File Sharing iX Storj Media Creation Video Surveillance Virtualization
Industry Automotive Education Gaming Government Healthcare MSP Manufacturing Research & AI Media & Entertainment
Download TrueNAS CORE Download TrueNAS SCALE Get TrueNAS Enterprise Compare TrueNAS Editions Where to Buy
  1. Documentation Hub
  2. /
  3. TrueNAS SCALE
  4. /
  5. CLI Reference Guide
  6. /
  7. System
  8. /
  9. Advanced
Edit page
TrueNAS SCALETrueNAS 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.

Advanced

  6 minute read.

Last Modified 2024-03-15 13:07 EDT

Advanced Namespace

The advanced namespace has six commands and is based on adding and managing system settings found in the SCALE API and web UI. It provides access to advanced system settings and functions through the advanced commands.

Advanced Commands

The following advanced commands allow you to add new and manage advanced system settings.

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

Interactive Argument Editor (TUI)

Enter the -- flag following any CLI command to open the interactive arguments editor text-based user interface (TUI).

Click for more information

The interactive argument editor is a text user interface (TUI) that can help enter complex commands with multiple configurable properties. It shows expected properties, defaults, input types (string, boolean, integer, or array), and can include command instructions or warnings.

Optional properties, indicated by the # symbol, are disabled by default. Required properties are enabled. Do not disable properties that are enabled by default.

To configure required properties, enter a space after the colon then add the value.

To enable optional properties, delete # from the corresponding line.

Some required properties are disabled if they are part of a pair of properties where one or the other is required. Select one property to enable and enter a value.

Press F2 or click Save to save the modified file.

Press F10, Esc, or click Quit to exit the TUI. The command automatically executes upon exit.

Config Command

The config command lists current advanced settings for the system.

Using the Config Command

Description

The config command does not require entering a property argument. Enter the command then press Enter. The command returns a table with advanced system settings (see list of Update Properties for details).

Usage

From the CLI prompt, enter:

system advanced config

Command Example 
system advanced config
+----------------------------------+--------------------+
|                               id | 1                  |
|                      consolemenu | true               |
|                    serialconsole | false              |
|                       serialport | ttyS0              |
|                      serialspeed | 9600               |
|                      powerdaemon | false              |
|                      swapondrive | 2                  |
|                    overprovision | <null>             |
|                        traceback | true               |
|                     advancedmode | false              |
|                         autotune | false              |
|                      debugkernel | false              |
|                      uploadcrash | true               |
|                        anonstats | true               |
|                  anonstats_token |                    |
|                             motd | Welcome to TrueNAS |
|                       boot_scrub | 7                  |
|                      fqdn_syslog | false              |
|                         sed_user | USER               |
|                      sysloglevel | F_INFO             |
|                     syslogserver |                    |
|                 syslog_transport | UDP                |
|                    kdump_enabled | false              |
|             isolated_gpu_pci_ids | <empty list>       |
|             kernel_extra_options |                    |
|           syslog_tls_certificate | <null>             |
| syslog_tls_certificate_authority | <null>             |
|                       consolemsg | false              |
+----------------------------------+--------------------+

Sed_Global_Password Command

The sed_global_password command provides the global password that applies for SED drives on the system.

Using the Sed_Global_Password Command

Description

The sed_global_password does not require entering a property argument. Enter the command then press Enter. The command returns the global SED password if set or an empty line if a password is not set.

Usage

From the CLI prompt, enter:

system advanced sed_global_password

Command Example 
system advanced sed_global_password

Serial_Port_Choices Command

The serial_port_choices command lists current advanced settings for the system.

Using the Serial_Port_Choices Command

Description

The serial_port_choices command does not require entering a property argument. Enter the command then press Enter. The command returns a table with the serial port options.

Usage

From the CLI prompt, enter:

system advanced serial_port_choices

Command Example 
system advanced serial_port_choices
+-------+-------+
| ttyS0 | ttyS0 |
+-------+-------+

Syslog_Certificate_Authority_Choices Command

The syslog_certificate_authority_choices command lists current certificate authority choices on the system.

Using the Syslog_Certificate_Authority_Choices Command

Description

The syslog_certificate_authority_choices command does not require entering a property argument. Enter the command then press Enter. The command returns a table with the certificate authority options.

Usage

From the CLI prompt, enter:

system advanced syslog_certificate_authority_choices

Command Example 
system advanced syslog_certificate_authority_choices
+---+-------+
| 1 | minio |
+---+-------+

Syslog_Certificate_Choices Command

The syslog_certificate_choices command lists current certificate choices on the system.

Using the Syslog_Certificate_Choices Command

Description

The syslog_certificate_choices command does not require entering a property argument. Enter the command then press Enter. The command returns a table with the certificate options.

Usage

From the CLI prompt, enter:

system advanced syslog_certificate_choices

Command Example 
system advanced syslog_certificate_choices
+---+-----------------+
| 1 | truenas_default |
| 2 | minio           |
+---+-----------------+

Update Command

Use the update command to update advanced system settings.

The TrueNAS CLI guide for SCALE is a work in progress! This command has not been fully tested and validated. Full documentation is still being developed. Check back for updated information.
Using the Update Command

Description

The Update command has 16 optional properties to use to add or change advanced system settings. Enter the property argument using the = delimiter to separate property and value. Double-quote property argument values using special characters.

Enter the command string then press Enter. The command returns an empty line.

Update Properties
PropertyDescriptionSyntax Example
boot_scrubRepresents the number of days between boot pool scrubs. Enter a numeric value.boot_scrub=8
consolemenuSet consolemenu to false to default to standard login or to true to show the console menu.consolemenu=true
consolemsgDeprecated. Removal of consolemsg is planned in a future release. Use system general update ui_consolemsg property to display console messages in real time at the bottom of the UI browser.N/A
debugkernelSet to true to include the kernel debug when generating a debug file. After the next system reboot, the debug file includes kernel debug information.debugkernel=true
fqdn_syslogSet to true to include the Fully-Qualified Domain Name (FQDN) in logs to precisely identify systems with similar hostnames.fqdn_syslog=true
motdEnter the message to display when a user logs in with SSH.motd="Display this text"
serialconsoleSet to true to enable the serial console but do not enable if the serial port is disabled.serialconsole=true
serialportEnter the serial port address.serialport="serialPort"
serialspeedEnter the serial port speed as one of these options: 9600, 19200, 138400, 57600, or 115200.serialspeed=9600
sed_userEnter the user passed to camcontrol security -u to unlock SEDs. User options are USER or MASTER.sed_user="USER"
sysloglevelEnter the log level to send when syslogserver is defined. Only logs at or above this level are sent. Options are: F_EMERG, F_ALERT, F_CRIT, F_ERR, F_WARNING, F_NOTICE, F_INFO, F_DEBUG.sysloglevel="F_DEBUG"
syslogserverWhen defined, logs of sysloglevel or above are sent. Enter the remote syslog server DNS hostname or IP address. Use nonstandard port numbers by adding a colon and the port number to the hostname, like mysyslogserver:1928. Log entries are written to local logs and sent to the remote syslog server.syslogserver=​"remoteIP:portNumber"
syslog_transportTransport protocol for the remote system log server connection. Choosing Transport Layer Security (TLS) also requires setting a preconfigured system certificate. Options are: UDP, TCP, TLS.syslog_transport=TCP
syslog_tls_certificateEnter the TLS certificate key hex string.syslog_tls_certificate=​tlsCertficate
systlog_tls_​certificate_authorityEnter the TLS certificate authority for the certificate.syslog_tls_certificate_authority=​tls_CA
sed_passwordEnter the global password to use to unlock SEDs.sed_password="sedPassword"

Usage

From the CLI prompt, enter:

system advanced update debugkernel=true

Where true turns on the kernel debug option.

Command Example 
system advanced update debugkernel=true

Isolated_Gpu_Pci_Ids command

Use isolated_gpu_pci_ids command to add the ID for a GPU PCI device.

Use the UI System > Advanced > Isolated GPU configuration screen to find and add the PCI ID detected by the system.

The TrueNAS CLI guide for SCALE is a work in progress! This command has not been fully tested and validated. Full documentation is still being developed. Check back for updated information.

Related Content

SCALE CLI Reference
SCALE Tutorials
SCALE UI Reference

Have more questions?

For further discussion or assistance, see these resources:

Found content that needs an update?  You can suggest content changes directly! To request changes to this content, click the Feedback button located on the middle-right side of the page (might require disabling ad blocking plugins).