TrueNAS SCALE Version Documentation
This 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.

SMART

3 minute read.

Last Modified 2024-03-19 08:38 EDT

SMART Namespace

The smart namespace has two commands and is based on S.M.A.R.T. service functions found in the SCALE API and web UI. It provides access to S.M.A.R.T. service management methods through the smart commands.

SMART Commands

The following smart commands allow you to view and edit smart properties.

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

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!

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

Config Command

The config command returns a table with current UPS settings.

Using the Config Command

Description

The config command has no required properties. Enter the command then press Enter. The command returns a table of current S.M.A.R.T. service settings when successful.

Usage

From the CLI prompt, enter:

service smart config

Command Example

service smart config
+---------------+-------+
|            id | 1     |
|      interval | 30    |
|     powermode | NEVER |
|    difference | 0     |
| informational | 0     |
|      critical | 0     |
+---------------+-------+

Update Command

The update command allows you to update S.M.A.R.T. service settings.

Using the Update Command

Description

The update command has five optional properties; interval, powermode, difference, informational, and critical. See Update Command Properties below for details. After entering update, you must include at least one property to update. Separate additional properties with a space. Enter the command string then press Enter. The command returns a blank line when successful.

Update Command Properties

Property	Description	Syntax Example
`interval`	Defines the value in minutes for smartd to wake up and check if any tests are configured to run.	`interval=number`
`powermode`	S.M.A.R.T. power mode to apply. `NEVER` where the device is fully powered up and ready to send/receive data. The disk only undergoes S.M.A.R.T. tests when powermode is set to `NEVER`. Default value is `NEVER`. `IDLE` where the disk completes commands slower than when set to `NEVER` but uses less power. `STANDBY` where the disk completes commands slower than when set to `IDLE` but uses less power. `SLEEP` where the disk does not complete commands until reset. Uses the least amount of power.	powermode=:MODE
`difference`	Enter the threshold temperature in Celsius. Report if the temperature of a drive has changed by this many degrees Celsius since the last report. 0 disables the report. Enter the property argument using the `=` to separate the property and double-quoted value.	`difference=number`
`informational`	Enter the threshold temperature in Celsius. Report if the drive temperature is at or above this temperature in Celsius. 0 disables the report. Enter the property argument using the `=` to separate the property and double-quoted value.	`informational=number`
`critical`	Enter the threshold temperature in Celsius. If the drive temperature is higher than this value, a LOG_CRIT level log entry is created and an email is sent. 0 disables this check. Enter the property argument using the `=` to separate the property and double-quoted value.	`critical=number`

Usage

From the CLI prompt, enter:

service smart update property=value

Where:

property is the property you want to update.
value is the value you want to specify for the property.

Command Example

service smart update interval=30 powermode=NEVER difference=0 informational=0 critical=0

SMART

SMART Namespace

SMART Commands

Interactive Argument Editor (TUI)

Config Command

Description

Usage

Update Command

Description

Usage

Related CLI Service Articles

Related S.M.A.R.T. Articles