TrueNAS SCALE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

System_Dataset

3 minute read.

Last Modified 2024-03-15 13:07 EDT

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!

System_dataset Namespace

The system_dataset namespace has 3 commands, and is based on system dataset storage functions found in the SCALE API and web UI. It provides access to storage configuration methods through the system_dataset namespace commands.

System_dataset Commands

The following system_dataset namespace commands allow you to review and update the configured system dataset. The system dataset stores core files for debugging and keys for encrypted pools. It also stores Samba4 metadata, such as the user and group cache and share-level permissions.

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

Config Command

The config command returns the current system dataset configuration.

Using the Config Command

Description

config does not require entering properties or arguments. Enter the command and then press Enter.

config returns a table showing information about the current system dataset pool as well as the path for system log storage.

Usage

From the CLI prompt, enter:

system system_dataset config

Press Enter.

Command Example

system system_dataset config
+----------+----------------------------------+
|       id | 1                                |
|     pool | tank                             |
|     uuid | ae32c386e13840b2bf9c0083275e7941 |
|   uuid_b | <null>                           |
| pool_set | true                             |
| basename | tank/.system                     |
|   uuid_a | ae32c386e13840b2bf9c0083275e7941 |
|     path | /var/db/system                   |
+----------+----------------------------------+

Pool_choices Command

The pool_choices command allows you to view all available pools that can host the system dataset.

Using the Pool_choices Command

Description

pool_choices has one optional property, include_current_pool (default true). If false the query excludes the current system dataset pool.

pool_choices returns a table containing all available pools.

Usage

From the CLI prompt, enter:

system dataset pool_choices include_current_pool=true

Where true is a boolean value.

Press Enter.

Command Example

system system_dataset pool_choices include_current_pool=true
+-----------+-----------+
| boot-pool | boot-pool |
|      tank | tank      |
|     tank2 | tank2     |
+-----------+-----------+

Update Command

The update command allows you to select a pool for the system dataset. You can also use it to exclude a pool from being automatically selected, if a pool is not defined.

Using the Update Command

Description

update has one required property, pool, and one optional property, pool_exclude. Use pool_choices to view the available pool options for either property.

update returns the percent complete status of the update.

Usage

From the CLI prompt, enter:

system system_dataset update pool="Tank" pool_exclude="Tank2"

Where Tank is the name of a valid pool to host the system dataset and Tank2 is the name of a pool to remove from the options for automatic system dataset selection, if pool is not provided.

Press Enter.

Command Example

system system_dataset update pool="Tank" pool_exclude="Tank2"
[0%] ...
[100%] ...

System_Dataset

System_dataset Namespace

System_dataset Commands

Config Command

Description

Usage

Pool_choices Command

Description

Usage

Update Command

Description

Usage

Related Content