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.
Truenas
5 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!
TrueNAS EnterpriseOn licensed systems, use the truenas namespace for viewing or modifying Enterprise customer service details. Systems without an Enterprise license do not use this namespace.
The truenas namespace has five commands and is based on TrueNAS Enterprise functions found in the SCALE API and web UI. It provides access to Enterprise customer management methods through the truenas namespace commands.
The following truenas namespace commands allow you to accept the TrueNAS EULA, modify Enterprise customer information, and control system production status.
You can enter commands from the main CLI prompt or from the system namespace prompt.
Enter the
--
flag following any CLI command to open the interactive arguments editor text-based user interface (TUI).
The accept_eula
command records agreement with the TrueNAS SCALE End User License Agreement (EULA).
Review the EULA before accepting it.
The get_customer_information
command returns a table of stored customer information.
The is_production
command returns if the system is marked as a production system.
The set_production
command adds or removes in-production status from the system and creates a ticket to notify iXsystems Support that the system is ready for use in production.
The update_customer_information
command modifies stored customer information.
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.