# Manage Snap-To-Object using the CLI

Using the CLI, you can:

* [Upload a  snapshot](#upload-a-snapshot)
* [Create a filesystem from an uploaded snapshot](#create-a-filesystem-from-an-uploaded-snapshot)
* [Manage incremental snapshots](#manage-incremental-snapshots)
* [Recover from a remote snapshot](#recover-from-a-remote-snapshot)

## Upload a  snapshot

**Command:** `weka fs snapshot upload`

Use the following command line to upload an existing snapshot:

`weka fs snapshot upload <file-system> <snapshot> [--site site]`

**Parameters**

| **Name**      | **Type** | **Value**                         | **Limitations**                                      | **Mandatory**                                          | **Default**                                             |
| ------------- | -------- | --------------------------------- | ---------------------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
| `file-system` | String   | Name of the filesystem            |                                                      | Yes                                                    |                                                         |
| `snapshot`    | String   | Name of the snapshot to upload    | Must be a snapshot of the `<file-system>` filesystem | Yes                                                    |                                                         |
| `site`        | String   | Location for the snapshot  upload | `local` or `remote`                                  | Only if both `local` and `remote` buckets are attached | Auto selected if only one bucket for upload is attached |

## Create a filesystem from an uploaded snapshot

**Command:** `weka fs download`

Use the following command line to create (or recreate) a filesystem from an existing snapshot:

`weka fs download <name> <group-name> <total-capacity> <ssd-capacity> <obs-bucket> <locator> [--additional-obs additional-obs] [--snapshot-name snapshot-name] [--access-point access-point]`

**Parameters**

<table data-header-hidden><thead><tr><th width="203">Name</th><th>Type</th><th>Value</th><th>Limitations</th><th>Mandatory</th><th>Default</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td><strong>Type</strong></td><td><strong>Value</strong></td><td><strong>Limitations</strong></td><td><strong>Mandatory</strong></td><td><strong>Default</strong></td></tr><tr><td><code>name</code></td><td>String</td><td>Name of the filesystem to be created</td><td></td><td>Yes</td><td></td></tr><tr><td><code>group-name</code></td><td>String</td><td>Name of the filesystem group in which the new filesystem will be placed</td><td></td><td>Yes</td><td></td></tr><tr><td><code>total-capacity</code></td><td>Capacity</td><td>The total capacity of the downloaded filesystem</td><td></td><td>Yes</td><td></td></tr><tr><td><code>ssd-capacity</code></td><td>Capacity</td><td>SSD capacity of the downloaded filesystem</td><td></td><td>Yes</td><td></td></tr><tr><td><code>obs-bucket</code></td><td>String</td><td>Object store name for tiering</td><td></td><td>Yes</td><td></td></tr><tr><td><code>locator</code></td><td>String</td><td>Object store locator obtained from a previously successful snapshot upload</td><td></td><td>Yes</td><td></td></tr><tr><td><code>additional-obs</code></td><td>String</td><td>An additional object-store name. In case the data to recover resides in two object stores (a second object-store attached to the filesystem, and the filesystem has not undergone full migration). This object-store will be attached in a <code>read-only</code> mode.</td><td>The snapshot locator must reside in the primary object-store supplied in the <code>obs</code> parameter</td><td>No</td><td></td></tr><tr><td><code>snapshot-name</code></td><td>String</td><td>The downloaded snapshot name.</td><td></td><td>No</td><td>The uploaded snapshot name</td></tr><tr><td><code>access-point</code></td><td>String</td><td>The downloaded snapshot access point. </td><td></td><td>No</td><td>The uploaded access point.</td></tr></tbody></table>

The `locator` can be a locator saved previously for disaster scenarios, or you can obtain the `locator` using the `weka fs snapshot` command on a system with a live filesystem with snapshots.

{% hint style="info" %}
**Note:** Due to the bandwidth characteristics and potential costs when interacting with remote object stores it is not allowed to download a filesystem from a remote object-store bucket. If a snapshot on a local object-store bucket exists, it is advisable to use that one. Otherwise, follow the procedure in [Recover from a remote snapshot](/4.1/fs/snap-to-obj.md#recover-from-a-remote-snapshot).&#x20;
{% endhint %}

{% hint style="info" %}
**Note:** For encrypted filesystem, when downloading, you must use the same KMS master key to decrypt the snapshot data. For more information, see the [KMS Management](/4.1/usage/security/kms-management.md#overview) section.
{% endhint %}

## Manage incremental snapshots

The workflow to manage the incremental snapshots includes:

1. Upload snapshots using, for example, the snapshots scheduler. See [Snapshot management](/4.1/appendix/snapshot-management.md).
2. Download the incremental snapshot (described below).
3. Restore a specific snapshot to a filesystem. See [Restore a snapshot to a filesystem or another snapshot](/4.1/fs/snapshots/snapshots-1.md#restore-a-snapshot-to-a-filesystem-or-another-snapshot).

### Download an incremental snapshot

**Command:** `weka fs snapshot download`

Use the following command line to download an incremental snapshot. This command is only relevant for snapshots uploaded from a system of version 4.0 and higher:

&#x20;`weka fs snapshot download <file-system> <locator>`

{% hint style="warning" %}
Make sure to download incremental snapshots in chronological order. Non-chronological snapshots are inefficient and are not incremental.&#x20;

If you need to download a snapshot that is earlier than the latest downloaded one, for example, when you need one of the daily incremental snapshots after the weekly incremental snapshot was downloaded, add the `--allow-non-chronological` flag to download it anyway.
{% endhint %}

**Parameters**

| **Name**      | **Type** | **Value**                                                                  | **Limitations** | **Mandatory** | **Default** |
| ------------- | -------- | -------------------------------------------------------------------------- | --------------- | ------------- | ----------- |
| `file-system` | String   | Name of the filesystem                                                     |                 | Yes           |             |
| `locator`     | String   | Object store locator obtained from a previously successful snapshot upload |                 | Yes           |             |

**Related topics**

[Snap-To-Object](/4.1/fs/snap-to-obj.md#incremental-snapshots)

## Recover from a remote snapshot

When recovering a snapshot residing on a remote object store, it is required to define the object store bucket containing the snapshot as a local bucket.

A remote object store has restrictions over the download, and we want to use a different local object store due to the QoS reasons explained in [Manage object stores](/4.1/fs/managing-object-stores.md#overview).

To recover a snapshot residing on a remote object store, create a new filesystem from this snapshot as follows:

1. Add a new local object-store, using `weka fs tier obs add` CLI command.
2. Add a local object-store bucket, referring to the bucket containing the snapshot to recover, using `weka fs tier s3 add.`
3. Download the filesystem, using `weka fs download.`
4. If the recovered filesystem should also be tiered, add a local object store bucket for tiering using `weka fs tier s3 add.`
5. Detach the initial object store bucket from the filesystem.
6. Assuming you want a remote backup to this filesystem, attach a remote bucket to the filesystem.
7. Remove the local object store bucket and local object store created for this procedure.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.weka.io/4.1/fs/snap-to-obj/snap-to-obj-1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.