Managing snapshots
How to manage snapshots using the CLI.
Viewing snapshots using the CLI
Command
weka fs snapshot
This command is used to display all snapshots of all filesystems in a single table.
Creating a snapshot using the CLI
Command
weka fs snapshot create
Use the following command line to add a snapshot:
weka fs snapshot create <file-system> <name> [<access-point>] [--source-snap=<source>] [--is-writable]
| Name | Type | Value | Limitations | Mandatory | Default |
| file-system | String | A valid filesystem identifier | Must be a valid name | Yes | |
| name | String | Unique name for filesystem snapshot | Must be a valid name | Yes | |
| access-point | String | Name of newly-created directory for filesystem level snapshots, which will serve as the access point for the snapshots | Must be a valid name | No | 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 previous versions of Windows. |
| source | String | Must be an existing snapshot | Must be a valid name | No | The snapshot name of the specified filesystem. |
| is_writable | Boolean | Sets the created snapshot to be writable | No | False |
Deleting a snapshot using the CLI
Command
weka fs snapshot delete
Use the following command line to delete a snapshot:
weka fs snapshot delete <file-system> <name>
| Name | Type | Value | Limitations | Mandatory | Default |
| file-system | String | A valid filesystem identifier | Must be a valid name | Yes | |
| name | String | Unique name for filesystem snapshot | Must be a valid name | Yes |
Restoring a filesystem or snapshot from another snapshot using the CLI
You can restore a filesystem or snapshot from another snapshot.
Command
weka fs restore
Use the following command line to restore a snapshot:
weka fs restore <file-system> <source-name>
Command
weka fs snapshot copy
Use the following command line to restore a snapshot to another snapshot:
weka fs snapshot copy <file-system> <source-name> <destination-name>
| Name | Type | Value | Limitations | Mandatory | Default |
| file-system | String | A valid filesystem identifier | Must be a valid name | Yes | |
| source-name | String | Unique name for the source of the snapshot | Must be a valid name | Yes | |
| destination-name | String | Name of the destination to which the snapshot should be copied | Must be an existing snapshot | Yes |
CautionWhen restoring a filesystem from a snapshot (or copying over an existing snapshot), the filesystem data and metadata are changed. Make sure IOs to the filesystem are stopped during this time.
Updating a snapshot using the CLI
Commandweka 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>] [--iswritable] [--access-point=<access-point>]
Parameters
| Name | String | Value | Limitations | Mandatory | Default |
| file-system | String | A valid filesystem identifier. | Must be a valid name | Yes | |
| name | String | Unique name for the updated snapshot | Must be a valid name. | Yes | |
| new-name | String | New name for the updated snapshot | Must be a valid name. | No | |
| is- writable | Boolean | Sets the snapshot to be writable | No | ||
| access-point | String | Name of directory for snapshot, which will serve as the access point for the snapshot. | Must be a valid name. | No |
Uploading a snapshot using the CLI
Commandweka fs snapshot upload
Use the following command line to upload an existing snapshot:
weka fs snapshot upload <file-system> <snapshot>
Parameters
| Name | Type | Value | Limitations | Mandatory | Default |
| filesystem | String | Name of the filesystem | Yes | ||
| snapshot | String | Name of snapshot to upload | Must be a snapshot of the <file-system> filesystem | Yes |
Creating a filesystem from a snapshot using the CLI
Commandweka fs download
Use the following command line to create a filesystem from an existing snapshot:
weka fs download <name> <group-name> <total-capacity> <ssd-capacity> <obs> <locator>
Parameters
| Name | Type | Value | Limitations | Mandatory | Default |
| name | String | Name of the filesystem to be created | Yes | ||
| group-name | String | Name of the filesystem group in which the new filesystem will be placed | Yes | ||
| total-capacity | Capacity | Total capacity of the downloaded filesystem | Yes | ||
| ssd-capacity | Capacity | SSD capacity of the downloaded filesystem | Yes | ||
| obs | String | Object store name for tiering | Yes | ||
| locator | String | Object store locator obtained from a previously successful snapshot upload | Yes | ||
| additional-obs | String | An additional objec-store name. In case te 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 read-only mode. | The snapshot locator must reside in the primary object-store supplied in the obs parameter | No | |
| snapshot-name | String | The downloaded snapshot name. | No | The uploaded snapshot name | |
| access-point | String | The downloaded snapshot access point | No | The uploaded access point |
The locator is either a locator saved previously for disaster scenarios, or can be obtained using the weka fs snapshot command on a system with a live filesystem with snapshots.
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.
- For encrypted filesystem, when downloading the same KMS master-key should be used to decrypt the snapshot data. For more information about encryption, see KMS management in the Content Software for File User Guide.