TrueNAS SCALETrueNAS 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.


The Snapshots screen, accessed from the Datasets screen by clicking Manage Snapshots on the Data Protection widget, provides a list of existing snapshots filtered for the snapshot you selected, allows you to add new or manage existing snapshots.

The Snapshots screen also opens when you click Snapshots on the Periodic Snapshot Tasks widget found on the Data Protection screen.

Snapshots Screen

If the selected snapshot does not have snapshots the screen displays No Snapshots are Available.

No Snapshots Available
Figure 1: No Snapshots Available

To check for snapshots for other datasets, clear the search filter of the dataset path.

All Snapshots
Figure 2: All Snapshots
My Snapshot screen is blank If your Snapshots screen does not display a list of snapshots and you know you added snapshots, clear the dataset path in the search field to show all dataset and zvol snapshots on the system.

Add opens the Add Snapshot screen.

Show Extra Columns

Click the Show Extra Columns toggle to add extra information columns to the list of snapshots. This opens the Show Extra Columns dialog.

Show Extra Columns
Figure 3: Show Extra Columns

Show adds the extra columns to the list of snapshots. These columns add the space used (Used), the snapshot creation date, and the amount of data the dataset can access (Referenced).

Click the toggle again to open the Hide Extra Columns dialog. Hide to return to the default view with only the Dataset and Snapshot columns.

Snapshot Details Screen

Click anywhere on a snapshot to expand it and view more information and options for that snapshot.

Expanded Snapshot
Figure 4: Expanded Snapshot

Select the checkbox to the left of each snapshot to select multiple snapshots and display the Batch Operations option to Delete the selected snapshots.

DeleteOpens a Delete confirmation dialog for the selected snapshot(s). Select Confirm to activate the Delete button.
Clone to New DatasetOpens the Clone to New Dataset) window where you enter a new name or clone with the default value in the Dataset Name field.
RollbackOpens the Dataset Rollback From Snapshot window with three radio button options. Confirm activates the Rollback button.
HoldSelect to prevent the snapshot from being deleted. If selected and you batch-operation delete datasets, this opens an error displays with the name of the dataset and prevents the delete operation from continuing.

Dataset Rollback from Snapshot Window

The snapshot Rollback option replaces the data in the selected dataset with the information saved in the snapshot.

WARNING: Rolling the dataset back destroys data on the dataset and can destroy additional snapshots that are related to the dataset. This can result in permanent data loss! Do not roll back until all desired data and snapshots are backed up.
Click Here for More Information

There are three Stop Rollback if Snapshot Exists radio button options that impose safety levels on the rollback operation. When the safety check finds additional snapshots that are directly related to the dataset you are rolling back it cancels the rollback.

Newer Intermediate, Child, and cloneSelect to stop rollback when the safety check finds any related intermediate, child dataset, or clone snapshots that are newer than the rollback snapshots.
Newer CloneSelect to stop rollback when the safety check finds any related clone snapshots that are newer than the rollback snapshot.
No Safety Check (CAUTION)Select to stop rollback if snapshot exists. The rollback destroys any related intermediate, child dataset, and cloned snapshots that are newer than the rollback snapshot.
ConfirmSelect to confirm the selection and activate the Rollback button.

Clone Snapshot and Promote Dataset

Snapshot Listing
Figure 6: Snapshot Listing

Cloning to New Dataset

The Clone to New Dataset button creates a clone of the snapshot. The clone appears directly beneath the parent dataset in the dataset tree table on the Datasets screen. Clicking the Clone to New Dataset button opens a clone confirmation dialog.

Click Clone to confirm.

The Go to Datasets button opens the Datasets screen.

Promoting a Dataset

Clicking on the clone name in the dataset listing populates the Dataset Details widget. The Promote button is visible.

After clicking the Promote button, the dataset clone is promoted and this button no longer appears.

Promote now displays on the Dataset Details widget when you select the demoted parent dataset.

See zfs-promote.8 for more information.

Delete Snapshot

The snapshot Delete option opens a window that lists the snapshot(s) you select.

Delete Snapshot
Figure 13: Delete Snapshot

Confirm activates the Delete button.

Batch Operations - Delete

To delete more than one snapshot in one operation, select the checkbox beside the datasets you want to delete and to display the Batch Operations Delete option.

Click Here for More Information

Batch Operations Delete opens a window listing all selected snapshots.

Confirm activates the Delete button. If a snaphot has the Hold option selected, an error displays to prevent you from deleting that snapshot.

Add Snapshot Screen

The Add Snapshots screen allows you to create a snapshot while on the Snapshots screen. It also opens when you click Create Snapshot on the Dataset Protection widget on the Datasets screen.

Click Here for More Information

Create Snapshot on the Dataset Protection widget opens the Add Snapshot screen. The Dataset field is prepopulated with the name of the dataset you selected on the Datasets screen. If you open it using Add on the Snapshots screen you select the value in the Dataset field.

DatasetSelect the dataset or zvol from the dropdown list. The snapshot created is from this dataset or zvol.
NameTrueNAS populates this with a name but you can override the name with any string of your choice. You cannot use Name and Naming Schema for the same snapshot.
Naming SchemaSelect an option from the dropdown list or leave this blank to use the system-populated name in the Name field. This generates a name for the snapshot using the naming schema from a previously-entered periodic snapshot. This allows replication of the snapshot. You cannot use Naming Schema with Name. Selecting a schema option overwrites the value in Name.
RecursiveSelect to include child datasets or zvols in the snapshot.

Save retains the settings and returns to the Snapshots screen.