Update

The update namespace allows users to locate pending updates or available trains and to update the TrueNAS SCALE release using the CLI.

The update namespace has 10 commands and is based on functions found in the SCALE API and web UI.

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

Use the check_available command to see if updates are available for the release train specified. Use the get_trains command to see the current and selected train dictionary for the system.

The download command downloads the updates for the selected train.

system update download
[0%]...
[0%] Retrieving update manifest...

The file command updates the system using an uploaded file.

The get_auto_download command returns the status of the auto download function is enabled.

system update get_auto_download
true

The get_pending command returns a table with a list of packages already downloaded and ready to apply.

system update get_pending
+-----------+--------+--------+
| operation | old    | new    |
+-----------+--------+--------+
| upgrade   | <dict> | <dict> |
+-----------+--------+--------+

The get_trains command shows the available trains dictionary, the currently configured train and the train of the current boot environment on the system.

Use before entering the check_available and set_train commands.

system update get_trains 
+----------|--------------------------|
|   trains | <dict>                   |
|  current | TrueNAS-SCALE-Cobia-BETA |
| selected | TrueNAS-SCALE-Cobia-BETA |
+----------|--------------------------|

The manual command updates the system using a manual update file downloaded from the SCALE release train and uploaded to the system using a file transfer program.

To perform a manual update via the TrueNAS CLI, you must first upload a manual update file onto the system.

Connect to your system with your choice of FTP program (such as WinSCP) and place the manual update file in /var/tmp/firmware.

After it finishes uploading, go to System Settings > Shell and enter cli at the prompt if the system shell is set to a shell other than TrueNAS CLI for the admin user. From the SCALE CLI, enter:

system update manual path=/var/tmp/firmware/updatefilename

Where updatefilename is the name of the update file.

The set_auto_download command sets the update to auto-download update files.

system update set_auto_download autocheck=true

The set_train command sets an update train to use by default for updates. Use to change the current train to another available train.

The update command downloads an update, if not already in the cache, and then applies it.

system update update
[0%]
[0%] Retrieving update manifest...