The 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! Boot Namespace The boot namespace has eight commands and is based on boot pool management functions found in the SCALE API and web UI. It provides access to system boot pool methods through the boot commands.
Boot Commands The following boot commands allow you to run jobs related to the boot pool and manage the boot pool.
The 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! Bootenv Namespace The bootenv namespace has 7 commands, and is based on boot environment functions found in the SCALE API and web UI. It provides access to environment management methods through the bootenv namespace commands.
Bootenv Commands The following bootenv namespace commands allow you to create or delete boot environments, manage existing environments, and activate an environment.
Name Description Actions Lets users add boot environments and check their stats/settings, as well as manage and scrub the boot pool. Name The name of the boot entry as it appears in the boot menu. Active Indicates which entry boots by default if a boot environment is not active. Created Indicates the boot environment creation date and time. Space Shows boot environment size. Keep Indicates whether or not TrueNAS deletes this boot environment when a system update does not have enough space to proceed.
TrueNAS supports a ZFS feature known as boot environments. These are snapshot clones that TrueNAS can boot into. You can only use one boot environment for booting.
How does this help me? A boot environment allows rebooting into a specific point in time and greatly simplifies recovering from system misconfigurations or other potential system failures. With multiple boot environments, the process of updating the operating system becomes a low-risk operation. The updater automatically creates a snapshot of the current boot environment and adds it to the boot menu before applying the update.
Adding a second storage device to the boot pool changes the configuration to a Mirror. This allows one of the devices to fail and the system still boots. If one of the two devices were to fail, that device is easily detached and replaced.
When adding a second device to create a mirrored boot pool, consider these caveats:
Capacity: The new device must have at least the same capacity as the existing device.
The System Settings > Boot screen contains options for monitoring and maintaining the TrueNAS install pool and disks. This includes managing OS restore points, called boot environments, for the TrueNAS system.
Figure 1: System Boot Screen System Boot Actions The System Settings > Boot screen displays four options at the top right of the screen.
Setting Description Stats/Settings Opens the Stats/Settings window with the Boot pool Condition, Size and Used, and Last Scrub Run statistics for the operating system device, and provides the option to change the default duration between the operating system device scrubs from every 7 days to a new duration in days.
System Settings > Boot contains options for monitoring and managing the ZFS pool and devices that store the TrueNAS operating system.
Changing the Scrub Interval The Stats/Settings option displays current system statistics and provides the option to change the scrub interval, or how often the system runs a data integrity check on the operating system device.
Go to System Settings > Boot screen and click Stats/Settings. The Stats/Settings window displays statistics for the operating system device: Boot pool Condition as ONLINE or OFFLINE, Size in GiB and the space in use in Used, and Last Scrub Run with the date and time of the scrub.
TrueNAS CORE
TrueNAS Enterprise
TrueNAS SCALE
Compare Editions
TrueCommand
Software Status
FreeNAS
Compare Systems
F-Series
M-Series
X-Series
R-Series
Mini Series
Download TrueNAS CORE
Download TrueNAS SCALE
Get TrueNAS Enterprise
Where to Buy