Caution

You are not reading the most current version of the documentation. If you want up-to-date information, please have a look at 2.5 .

Download files command

Scylla Manger Agent comes with a download-files subcommand that given a backup location can be used to:

  1. List clusters, datacenters and nodes.

  2. Search for snapshot tags.

  3. Download files without a need for third-party tools.

Download-files

Syntax:

scylla-manager-agent download-files --location <backup location> [OPTION]...

parameters

--clear-tables

Remove sstables before downloading


-c, --config-file path

Configuration file path, you can specify the flag multiple times to overwrite configuration options.

Default: /etc/scylla-manager-agent/scylla-manager-agent.yaml


-d, --data-dir path

Path to Scylla data directory (typically /var/lib/scylla/data) or other directory to use for downloading the files.

Default: current directory


--debug

Enable debug logs.

Default: current directory


--dry-run

Validate and print a plan without downloading (or clearing) any files.


--dump-manifest

Print Scylla Manager backup manifest as JSON.


--dump-tokens

Print list of tokens from the manifest.


-K, --keyspace list

A comma-separated list of keyspace/tables glob patterns, e.g. ‘keyspace,!keyspace.table_prefix_*’.


--list-nodes

Print list of nodes including cluster name and node IP, this command would help you find nodes you can restore data from.


--list-snapshots

Print list of snapshots of the specified node, this also takes into account keyspace filter and returns only snapshots containing any of requested keyspaces or tables, newest snapshots are printed first.


-L, --location string

Backup location in the format <provider>:<name> e.g. s3:my-bucket, the supported providers are: s3, gcs, azure.


--mode upload, sstableloader

Mode changes resulting directory structure, supported values are: upload, sstableloader, set ‘upload’ to use table upload directories, set ‘sstableloader’ for <keyspace>/<table> directories layout.


-n, --node ID

‘Host ID’ value from nodetool status command output of a node you want to restore.

Default: local node


-p, --parallel int

How many files to download in parallel.

Default: 8


--rate-limit int

Rate limit in megabytes (MiB) per second.

Default: no limit


-T, --snapshot-tag tag

Scylla Manager snapshot tag as read from backup listing e.g. sm_20060102150405UTC, use –list-snapshots to get a list of snapshots of the node.