Manage snapshots using the CLI
This page describes how to manage snapshots using the CLI.
Using the CLI, you can:
Create a snapshot
Command: weka fs snapshot create
Use the following command line to create a snapshot:
weka fs snapshot create <file-system> <name> [--access-point access-point] [--source-snap=<source-snap>] [--is-writable]
The newly created snapshot is saved in the .snapshot
directory.
See Access the .snapshots directory.
Parameters
Delete a snapshot
Command: weka fs snapshot delete
Use the following command line to delete a snapshot:
weka fs snapshot delete <file-system> <name>
Parameters
A snapshot deletion cannot happen parallel to a snapshot upload to the same filesystem. Since uploading a snapshot to a remote object store might take a while, it is advisable to delete the desired snapshots before uploading to the remote object store.
This becomes more important when uploading snapshots to local and remote object stores. While local and remote uploads can progress in parallel, consider the case of a remote upload in progress, then a snapshot is deleted, and later a snapshot is uploaded to the local object store. In this scenario, the local snapshot upload waits for the pending deletion of the snapshot (which happens only once the remote snapshot upload is done).
Restore a snapshot to a filesystem or another snapshot
Commands: weka fs restore
or weka fs snapshot copy
Use the following command line to restore a filesystem from a snapshot:
weka fs restore <file-system> <source-name> [--preserved-overwritten-snapshot-name=preserved-overwritten-snapshot-name] [--preserved-overwritten-snapshot-access-point=preserved-overwritten-snapshot-access-point]
Use the following command line to restore a snapshot to another snapshot:
weka fs snapshot copy <file-system> <source-name> <destination-name> [--preserved-overwritten-snapshot-name=preserved-overwritten-snapshot-name] [--preserved-overwritten-snapshot-access-point=preserved-overwritten-snapshot-access-point]
Parameters
When restoring a filesystem from a snapshot (or copying over an existing snapshot), the filesystem data and metadata are changed. If you do not specify the preserved-overwritten-snapshot-name
parameter, ensure IOs to the filesystem are stopped during this time.
Update a snapshot
Command: weka fs snapshot update
This command changes the snapshot attributes. Use the following command line to update an existing snapshot:
weka fs snapshot update <file-system> <name> [--new-name=<new-name>] [--access-point=<access-point>]
Parameters
Access the .snapshots
directory
.snapshots
directoryThe .snapshots
directory is located in the root directory of each mounted filesystem. It is not displayed with the ls -la
command. You can access this directory using the cd .snapshots
command from the root directory.
Example
The following example shows a filesystem named default
mounted to /mnt/weka
.
To confirm you are in the root directory of the mounted filesystem, change into the .snapshots
directory, and then display any snapshots in that directory:
Last updated