> For the complete documentation index, see [llms.txt](https://docs.weka.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.weka.io/weka-filesystems-and-object-stores/snapshots/snapshots-1.md). # Manage snapshots using the CLI Create, restore, update, remove, and inspect filesystem snapshots from the CLI. ## Add a snapshot Creates a point-in-time snapshot of a filesystem. A snapshot is read-only unless you pass `--writable`, and `--source-snapshot` bases it on an existing snapshot rather than the live filesystem. **Command:** `weka fs snapshot add` ```sh weka fs snapshot add [--access-point ] [--source-snapshot ] [--writable] ``` **Parameters**
ParameterDescription
filesystem*Filesystem name.
name*Target snapshot name.
--access-point <string>

Snapshot access point name.

Default: Controlled by weka fs snapshot access-point-naming-convention update <date/name>. By default, it is <date> format: @GMT_%Y.%m.%d-%H.%M.%S, which is compatible with Windows' previous versions' format for SMB.

--source-snapshot <string>

Use this snapshot as the source.

Default: The latest snapshot of the specified filesystem

--writable

Create the snapshot as writable.

Default: false

{% hint style="info" %} The newly created snapshot is saved in the `.snapshots` directory.\ See [#access-the-.snapshots-directory](#access-the-.snapshots-directory "mention"). {% endhint %} ## Remove a snapshot Deletes a snapshot. The filesystem and any other snapshots are unaffected. **Command:** `weka fs snapshot remove` ```sh weka fs snapshot remove [--force] ``` **Parameters** | Parameter | Description | | --------------- | --------------------------------------------------------------- | | `filesystem`\* | Filesystem name. | | `name`\* | Snapshot name. | | `-f`, `--force` | Force action. Perform this action without further confirmation. | {% hint style="warning" %} 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). {% endhint %} ## 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 [--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 [--preserved-overwritten-snapshot-name=preserved-overwritten-snapshot-name] [--preserved-overwritten-snapshot-access-point=preserved-overwritten-snapshot-access-point]` **Parameters** | Name | Value | | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `file-system`\* | Filesystem that contains the source snapshot, or the filesystem to restore. | | `source-name`\* | Name of the snapshot to restore from or copy from. | | `destination-name`\* | Name of the destination snapshot when using `weka fs snapshot copy`. | | `preserved-overwritten-snapshot-name` | Name to assign to the overwritten snapshot or live filesystem so it is preserved during the restore.If not specified, the system overwrites the target directly, and active IO to an existing filesystem can fail. | | `preserved-overwritten-snapshot-access-point` | Directory name that serves as the access point for the preserved overwritten snapshot.Default: If `preserved-overwritten-snapshot-name` is specified and `preserved-overwritten-snapshot-access-point` is not, the system creates it automatically based on the snapshot name. | {% hint style="warning" %} 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. {% endhint %} ## Update a snapshot Renames a snapshot or changes its access point. **Command:** `weka fs snapshot update` ```sh weka fs snapshot update [--access-point ] [--new-name ] ``` **Parameters** | Parameter | Description | | -------------------------- | ---------------------------------- | | `filesystem`\* | Filesystem name. | | `name`\* | Snapshot name. | | `--access-point` \ | New access point for the snapshot. | | `--new-name` \ | Rename the snapshot. | ## Access the `.snapshots` directory The `.snapshots` directory is available from the root directory of each mounted filesystem. It is not displayed with the `ls -la` command. Access it with the `cd .snapshots` command. The `.snapshots` directory is also available from a filesystem subdirectory, where it lists only the snapshots taken after that subdirectory was created. As in the root directory, it is not displayed with the `ls -la` command. Users scoped to a subdirectory can browse its snapshots and copy missing content without access to the root `.snapshots` 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: ```bash [root@ip-172-31-23-177 weka]# pwd /mnt/weka [root@ip-172-31-23-177 weka]# ls -la total 0 drwxrwxr-x 1 root root 0 Sep 19 04:56 . drwxr-xr-x 4 root root 33 Sep 20 06:48 .. drwx------ 1 user1 user1 0 Sep 20 09:26 user1 [root@ip-172-31-23-177 weka]# cd .snapshots [root@ip-172-31-23-177 .snapshots]# ls -l total 0 drwxrwxr-x 1 root root 0 Sep 19 05:00 @GMT-2023.09.19-05.00.12 drwxrwxr-x 1 root root 0 Sep 21 02:44 @GMT-2023.09.21-02.44.38 [root@ip-172-31-23-177 .snapshots]# ``` **Example: access the `.snapshots` directory from a subdirectory** The `user1` subdirectory was created on Sep 20. Its `.snapshots` directory lists only the snapshot taken after that date: ```bash [root@ip-172-31-23-177 weka]# cd /mnt/weka/user1 [root@ip-172-31-23-177 user1]# ls -la total 0 drwx------ 1 user1 user1 0 Sep 20 09:26 . drwxrwxr-x 1 root root 0 Sep 19 04:56 .. -rw-r--r-- 1 user1 user1 0 Sep 20 09:30 report.txt [root@ip-172-31-23-177 user1]# cd .snapshots [root@ip-172-31-23-177 .snapshots]# ls @GMT-2023.09.21-02.44.38 [root@ip-172-31-23-177 .snapshots]# ls @GMT-2023.09.21-02.44.38 report.txt [root@ip-172-31-23-177 .snapshots]# ``` ## Retrieve snapshot details Lists the snapshots on the cluster. Use `--output` to add columns such as the snapshot UID, its local and remote object locators, and the estimated reclaimable space. **Command:** `weka fs snapshot` ```sh weka fs snapshot [--filesystem ] [--name ] ``` **Parameters** | Parameter | Description | | ---------------------------- | ------------------------------------------- | | `--filesystem` \ | Filter results to a specific filesystem. | | `--name` \ | Filter results to a specific snapshot name. |
ParameterDescription
--file-systemFilter the output by filesystem name.
--nameFilter the output by snapshot name.
-o, --output...Select the columns to display. Supported values are uid, id, filesystem, name, access, writeable, created, local_upload_size, remote_upload_size, local_object_status, local_object_progress, local_object_locator, remote_object_status, remote_object_progress, remote_object_locator, removing, prefetched, est_reclaimable_size, and metadata_size.Repeat the option or use a comma-separated list.
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.weka.io/weka-filesystems-and-object-stores/snapshots/snapshots-1.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.