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! Snapshot Namespace The snapshot namespace has 10 commands, and is based on snapshot creation and management functions found in the SCALE API and web UI. It provides access to storage snapshot methods through the snapshot commands.
Snapshot Commands The following snapshot commands allow you to create new snapshots and manage existing snapshots.
Periodic snapshot tasks allow you to schedule creating read-only versions of pools and datasets at a given point in time. You can also access VMWare snapshot integration and TrueNAS SCALE storage snapshots from the Periodic Snapshot Tasks widget.
How should I use snapshots? Snapshots do not make not copies of the data so creating one is quick and if little data changed, they take very little space. It is common to take frequent snapshots as soon as every 15 minutes, even for large and active pools.
A periodic snapshot task allows scheduling the creation of read-only versions of pools and datasets at a given point in time.
How should I use snapshots? Snapshots do not make copies of the data, so creating one is quick. It is common to take frequent snapshots every 15 minutes, even for large and active pools. A snapshot with no file changes takes no storage space, but as file changes happen, the snapshot size changes to reflect the size of the changes.
Dataset
Name Description Dataset Select a pool, dataset, or zvol. Recursive Select to take separate snapshots of the dataset and each of its child datasets. Clear to take a single snapshot only of the specified dataset without child datasets. Exclude Exclude specific child datasets from the snapshot. Use with recursive snapshots. List paths to any child datasets to exclude. Example: pool1/dataset1/child1. A recursive snapshot of pool1/dataset1 will include all child datasets except child1.
The Data Protection screen Periodic Snapshot Task widget displays periodic snapshot tasks created on the system. A periodic snapshot task allows scheduling the creation of read only versions of pools and datasets at a given point in time.
Periodic Snapshot Task Widget The Periodic Snapshot Task widget displays a list of tasks configured on the system.
If a periodic snapshot task is not yet configured No Periodic Snapshot Task configured displays in the widget.
TrueCommand replication management feature allows administrators to create ZFS snapshot replication tasks for TrueNAS systems managed by TrueCommand.
Replication Screen If the TrueNAS system has a replication task created and scheduled it displays on the TrueCommand Replication screen. Click Replication to the right of Reports on the top toolbar to open the screen.
TrueNAS system completed replication tasks show with the FINISHED status, while those not yet run show PENDING status.
Use this procedure to create ZFS snapshots when using TrueNAS SCALE as a VMWare datastore.
You must have a paid edition of VMWare ESXi to use the TrueNAS SCALE VMWare Snapshots feature. ESXi free has a locked (read-only) API that prevents using TrueNAS SCALE VMWare Snapshots.
This tutorial uses ESXi version 8.
When creating a ZFS snapshot of the connected dataset, VMWare automatically takes a snapshot of any running virtual machines on the associated datastore.
Use the VMware Snapshot Integration option on the Data Protection > Periodic Snapshot Tasks widget to create snapshots when you are using TrueNAS SCALE as a VMWare datastore. See Creating VMWare Snapshots for a detailed tutorial.
VMware Snapshot Integration opens the VMWare Snapshots screen.
Figure 1: VMware Snapshot Integration Add opens the Add VMware Snapshot screen.
Figure 2: Add VMware Snapshot Screen Setting Description Hostname Enter the IP address or host name of the VMWare host.
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! Snapshot Namespace The snapshot namespace has 11 commands and is based on snapshot creation and management functions found in the SCALE API and web UI. It provides access to periodic snapshot task methods through the snapshot commands.
Snapshot Commands The following snapshot commands allow you to create new and manage existing periodic snapshot tasks.
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