TrueNAS SCALE Documentation Archive
This content follows the TrueNAS SCALE 22.12 (Bluefin) releases. Archival documentation is provided for reference only and not actively maintained.
Use the Product and Version selectors above to view content specific to different TrueNAS software or major versions.
System
12 minute read.
Last Modified 2024-03-19 08:47 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!
Welcome to the TrueNAS SCALE Command Line Interface (CLI) guide!
The TrueNAS CLI in TrueNAS SCALE functions like a text-based version of the web UI with many functional areas grouped into parent and child namespaces that mirror the counterparts in the SCALE UI.
The underlying structure of the CLI namespaces and commands closely follows that of the SCALE API. For more information on API commands, arguments, options, and definitions go to API Keys and click on API Docs in the SCALE UI.
The system namespace has 23 child namespaces and 19 commands, and is based on functions found in the SCALE API and web UI. It provides access to system configuration methods through the system namespace commands and the child namespaces and their commands.
You can enter commands from the main CLI prompt or from the system namespace prompt.
The system namespace has 19 commands based on functions found in the SCALE API and web UI.
You can enter commands from the main CLI prompt or from the system namespace prompt.
The boot_id
command returns a unique boot identifier consisting of lowercase aphanumeric characters and dashes.
The build_time
command returns the date and time of the software build installed and running on the system but not the release name and number.
Use the version
or version_short
commands to see the name and number assigned to the software build.
The debug
command downloads a system debug file to the home directory of the logged in admin user.
Specify the file name and extension for the debug file in the command string.
Debug files are usually .tgz files but you can use the extension of your choice.
Use a file transfer application such as WinSCP to connect to the system or a share (SMB, NFS, etc.) created on the system to access the file.
The environment
commands returns the environment in which the product is running.
Possible values are DEFAULT or EC2.
The feature_enabled
command determines if the feature specified is running.
Use to determine if the deduplication, fibre channel or virtual machine (VM) feature is enabled or disabled.
The host_id
command retrieves a hex string that is generated based on the contents of the /etc/hostid file.
This is a permanent value that persists across reboots/upgrades and can be used as a unique identifier for the machine.
The info
command returns system information. Information includes:
- SCALE version and build time
- System host name
- Hardware information including phyical memory, cores and physical cores, system product and version, manufacturer
- System serial number
- System uptime and uptime seconds, average loading, boot time, and date time
- System timezone
- System license
The is_freenas
command is deprecated. Use product_type command. Applied to TrueNAS CORE systems.
The is_stable
command returns whether the system software version is stable. This command is useful if upgrading from a nightly train of an unreleased version.
The license_update
command updates the license file.
This is the license added to the system on the System Settings > General screen on the Support widget.
The product_name
command returns the name of the product (TrueNAS) in use.
The product_type
command returns the name of the product (SCALE) in use.
The ready
command returns whether the system completed the boot process and is ready to use.
This command is similar to the state
command that provides the status of the system as READY or BOOTING.
The reboot
command reboots the system. It is the CLI equivalent to the UI power button option to restart the system.
The shutdown
command exits the UI and shuts down the system. It is the CLI equivalent to the UI power button option to shutdown the system.
The state
command returns the current system state as either booting, ready, or shutting down.
Use to determine the system state if uncertain of the current state. This command is similar to the ready
command that indicates if the system completed the boot process and is ready.
The version
command returns the system full software version name and number.
If uncertain of your SCALE release, enter this or the version_short
command to view the currently-installed version number.
The version_short
command returns the system software version number.
If uncertain of your SCALE release, enter this or the version
command to view the currently-installed version name.
The following articles provide information on system child namespaces:
- ACME: Provides information about the system acme namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Advanced: Provides information about the system advanced namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Alert: Provides information about the system alert namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Boot: Provides information about the system boot namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Bootenv: Provides information about the system bootenv namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Certificate: Provides information about the system certificate namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Config: Provides information about the system config namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Core: Provides information about the system core namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Device: Provides information about the system device namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Failover: Provides information about the system failover namespace in the TrueNAS CLI. Includes command syntax and common commands.
- General: Provides information about the system general namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Init_Shutdown_Script: Provides information about the system init_shutdown_script namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Keychain_Credential: Provides information about the system keychain_credential namespace in the TrueNAS CLI. Includes command syntax and common commands.
- KMIP: Provides information about the system kmip namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Mail: Provides information about the system mail namespace in the TrueNAS CLI. Includes command syntax and common commands.
- NTP_Server: Provides information about the system ntp_server namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Reporting: Provides information about the system reporting namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Support: Provides information about the system support namespace in the TrueNAS CLI. Includes command syntax and common commands.
- System_Dataset: Provides information about the system system_dataset namespace in the TrueNAS CLI. Includes command syntax and common commands.
- TrueCommand: Provides information about the system truecommand namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Truenas: Provides information about the system truenas namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Tunable: Provides information about the system tunable namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Update: Provides information about the system update namespace in the TrueNAS CLI. Includes command syntax and common commands.