BackupCopy

-c, --clusterCopy

The target cluster name or ID (envvar SCYLLA_MANAGER_CLUSTER).

--cronCopy

Task schedule as a cron expression. It supports the extended syntax including @monthly, @weekly, @daily, @midnight, @hourly, @every X[h|m|s].

--dcCopy

A list of datacenter glob patterns separated by a comma, e.g. ‘dc1,!otherdc*’ used to specify the datacenters to include or exclude. The following syntax for glob patterns is supported:

• ‘*’ - matches any number of any characters including none

• ‘?’ - matches any single character

• ‘[abc]’ - matches one character given in the bracket

• ‘[a-z]’ - matches one character from the range given in the bracket

Patterns are evaluated from left to right. If a pattern starts with ‘!’ it unselects items that were selected by previous patterns i.e. ‘a?,!aa’ selects ab but not aa.

Default value: []

--dry-runCopy

Validates and prints backup information without actually scheduling a backup.

Default value: false

--enabledCopy

Not enabled tasks are not executed and are hidden from the task list.

Default value: true

-h, --helpCopy

help for backup

Default value: false

-i, --intervalCopy

–interval is deprecated, please use –cron instead

Time after which a successfully completed task would be run again. The supported units are:

• ‘d’ - days

• ‘h’ - hours

• ‘m’ - minutes

• ‘s’ - seconds

• ‘ms’ - milliseconds

The task run date is aligned with ‘–start date’ value. For example, if you select ‘–interval 7d’ task would run weekly at the ‘–start-date’ time.

-K, --keyspaceCopy

A list of glob patterns separated by a comma used to include or exclude tables. The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. ‘keyspace,!keyspace.table_prefix_*’. The following syntax for glob patterns is supported:

• ‘*’ - matches any number of any characters including none

• ‘?’ - matches any single character

• ‘[abc]’ - matches one character given in the bracket

• ‘[a-z]’ - matches one character from the range given in the bracket

Patterns are evaluated from left to right. If a pattern starts with ‘!’ it unselects items that were selected by previous patterns i.e. ‘a?,!aa’ selects ab but not aa.

Default value: []

--labelCopy

A comma-separated list of label modifications. Labels are represented as a key-value store. Character ‘=’ has a special meaning and cannot be a part of label’s key nor value. A single modification takes form of: * ‘<key>=<value>’ - sets the label <key> to <value> * ‘<key>-’ - removes the label

For example, ‘–label k1=v1,k2-’ will set the label ‘k1’ to ‘v1’ and will also remove label ‘k2’.

-L, --locationCopy

A list of backup locations separated by a comma, specifies where to place the backup, the format is [<dc>:]<provider>:<bucket>. The ‘<dc>’ parameter is optional it allows to specify location for a datacenter in a multi-dc setting, it must match Scylla nodes datacenter. The supported storage ‘<provider>’s are ‘azure’, ‘gcs’, ‘s3’. The ‘bucket’ parameter is a bucket name, it must be an alphanumeric string and may contain a dash and or a dot, but other characters are forbidden.

Default value: []

--nameCopy

Task name that can be used instead of ID.

-r, --num-retriesCopy

Number of times a task reruns following a failure.

Default value: 3

--purge-onlyCopy

Run the backup cleanup only.

Default value: false

--rate-limitCopy

Limits the upload rate (as expressed in megabytes (MiB) per second) at which snapshotfiles can be uploaded from a Scylla node to its backup destination. You can set limits for more than one DC using a comma-separated list expressed in the format [<dc>:]<limit>. The <dc>: part is optional and is only needed when different datacenters require different upload limits. Set to 0 for no limit (default 100).

Default value: []

--retentionCopy

The number of backups to store, once this number is reached, the next backup which comes in from this destination will initiate a purge of the oldest backup. Can be used simultaneously with ‘–retention-days’ flag.

Default value: 7

--retention-daysCopy

The number of days for which backup is stored, the next backup will initiate a purge of all expired backups. Can be used simultaneously with ‘–retention’ flag.

Default value: 0

--retry-waitCopy

Initial exponential backoff duration X[h|m|s]. With –retry-wait 10m task will wait 10 minutes, 20 minutes and 40 minutes after first, second and third consecutire failure.

Default value: 10m

--show-tablesCopy

Prints table names together with keyspace, used in combination with –dry-run.

Default value: false

--skip-schemaCopy

Don’t backup schema. For ScyllaDB versions starting at 6.0 and 2024.2, SM requires CQL credentials to back up the schema. CQL Credentials can be added with ‘sctool cluster update –username –password’ command. This flag can be used to skip this step and allow for backing up user data without providing SM with CQL credentials. Note that it’s impossible to restore schema from such backups.

Default value: false

--snapshot-parallelCopy

A comma-separated list of snapshot parallelism limits in the format [<dc>:]<limit>. The ‘dc’ part is optional and allows for specifying different limits in selected datacenters. If the ‘dc’ part is not set, the limit is global and the runs are parallel in ‘n’ nodes. If for example, you were to set ‘dc1:2,5’, then ‘dc1’ would have two parallel nodes and there would be five parallel nodes in the other DCs.

Default value: []

-s, --start-dateCopy

The date can be expressed relatively to now or as a RFC3339 formatted string. To run the task in 2 hours use ‘now+2h’. The supported units are:

• ‘d’ - days

• ‘h’ - hours

• ‘m’ - minutes

• ‘s’ - seconds

• ‘ms’ - milliseconds

If you want the task to start at a specified date use RFC3339 formatted string i.e. ‘2018-01-02T15:04:05-07:00’. If you want the repair to start immediately, use the value ‘now’ or skip this flag.

--timezoneCopy

Timezone of –cron and –window flag values. The default value is taken from this system, namely ‘TZ’ envvar or ‘/etc/localtime’ file.

Default value: UTC

--transfersCopy

Sets the amount of file transfers to run in parallel when uploading files from a Scylla node to its backup location. Set to -1 for using the transfers value defined in node’s ‘scylla-manager-agent.yaml’ config file.

Default value: -1

--upload-parallelCopy

A comma-separated list of upload parallelism limits in the format [<dc>:]<limit>. The ‘dc’ part is optional and allows for specifying different limits in selected datacenters. If the ‘dc’ part is not set, the limit is global (e.g. ‘dc1:2,5’) the runs are parallel in ‘n’ nodes. If for example, you were to set ‘dc1:2,5’, then ‘dc1’ would have two parallel nodes and there would be five parallel nodes in the other DCs.

Default value: []

--windowCopy

A comma-separated list of time markers in a form [WEEKDAY-]HH:MM. WEEKDAY can be written as the whole word or only using the first 3 characters, HH:MM is an hour from 00:00 to 23:59.

• ‘MON-00:00,FRI-15:00’ - can be executed from Monday to Friday 3PM

• ‘23:00,06:00’ - can be executed every night from 11PM to 6AM

• ‘23:00,06:00,SAT-00:00,SUN-23:59’ - can be executed every night from 11PM to 6AM and all day during the weekend

Default value: []

-c, --clusterCopy

The target cluster name or ID (envvar SCYLLA_MANAGER_CLUSTER).

--cronCopy

Task schedule as a cron expression. It supports the extended syntax including @monthly, @weekly, @daily, @midnight, @hourly, @every X[h|m|s].

--delete-orphaned-filesCopy

If set data files not belonging to any snapshot will be deleted after the validation.

Default value: false

--enabledCopy

Not enabled tasks are not executed and are hidden from the task list.

Default value: true

-h, --helpCopy

help for validate

Default value: false

-i, --intervalCopy

–interval is deprecated, please use –cron instead

Time after which a successfully completed task would be run again. The supported units are:

• ‘d’ - days

• ‘h’ - hours

• ‘m’ - minutes

• ‘s’ - seconds

• ‘ms’ - milliseconds

The task run date is aligned with ‘–start date’ value. For example, if you select ‘–interval 7d’ task would run weekly at the ‘–start-date’ time.

--labelCopy

A comma-separated list of label modifications. Labels are represented as a key-value store. Character ‘=’ has a special meaning and cannot be a part of label’s key nor value. A single modification takes form of: * ‘<key>=<value>’ - sets the label <key> to <value> * ‘<key>-’ - removes the label

For example, ‘–label k1=v1,k2-’ will set the label ‘k1’ to ‘v1’ and will also remove label ‘k2’.

-L, --locationCopy

A list of backup locations separated by a comma, specifies where to place the backup, the format is [<dc>:]<provider>:<bucket>. The ‘<dc>’ parameter is optional it allows to specify location for a datacenter in a multi-dc setting, it must match Scylla nodes datacenter. The supported storage ‘<provider>’s are ‘azure’, ‘gcs’, ‘s3’. The ‘bucket’ parameter is a bucket name, it must be an alphanumeric string and may contain a dash and or a dot, but other characters are forbidden.

Default value: []

--nameCopy

Task name that can be used instead of ID.

-r, --num-retriesCopy

Number of times a task reruns following a failure.

Default value: 3

--parallelCopy

Number of hosts to analyze in parallel.

Default value: 0

--retry-waitCopy

Initial exponential backoff duration X[h|m|s]. With –retry-wait 10m task will wait 10 minutes, 20 minutes and 40 minutes after first, second and third consecutire failure.

Default value: 10m

-s, --start-dateCopy

The date can be expressed relatively to now or as a RFC3339 formatted string. To run the task in 2 hours use ‘now+2h’. The supported units are:

• ‘d’ - days

• ‘h’ - hours

• ‘m’ - minutes

• ‘s’ - seconds

• ‘ms’ - milliseconds

If you want the task to start at a specified date use RFC3339 formatted string i.e. ‘2018-01-02T15:04:05-07:00’. If you want the repair to start immediately, use the value ‘now’ or skip this flag.

--timezoneCopy

Timezone of –cron and –window flag values. The default value is taken from this system, namely ‘TZ’ envvar or ‘/etc/localtime’ file.

Default value: UTC

--windowCopy

A comma-separated list of time markers in a form [WEEKDAY-]HH:MM. WEEKDAY can be written as the whole word or only using the first 3 characters, HH:MM is an hour from 00:00 to 23:59.

• ‘MON-00:00,FRI-15:00’ - can be executed from Monday to Friday 3PM

• ‘23:00,06:00’ - can be executed every night from 11PM to 6AM

• ‘23:00,06:00,SAT-00:00,SUN-23:59’ - can be executed every night from 11PM to 6AM and all day during the weekend

Default value: []

-c, --clusterCopy

The target cluster name or ID (envvar SCYLLA_MANAGER_CLUSTER).

--cronCopy

Task schedule as a cron expression. It supports the extended syntax including @monthly, @weekly, @daily, @midnight, @hourly, @every X[h|m|s].

--dcCopy

A list of datacenter glob patterns separated by a comma, e.g. ‘dc1,!otherdc*’ used to specify the datacenters to include or exclude. The following syntax for glob patterns is supported:

• ‘*’ - matches any number of any characters including none

• ‘?’ - matches any single character

• ‘[abc]’ - matches one character given in the bracket

• ‘[a-z]’ - matches one character from the range given in the bracket

Patterns are evaluated from left to right. If a pattern starts with ‘!’ it unselects items that were selected by previous patterns i.e. ‘a?,!aa’ selects ab but not aa.

Default value: []

--dry-runCopy

Validates and prints backup information without actually scheduling a backup.

Default value: false

--enabledCopy

Not enabled tasks are not executed and are hidden from the task list.

Default value: true

-h, --helpCopy

help for update

Default value: false

-i, --intervalCopy

–interval is deprecated, please use –cron instead

Time after which a successfully completed task would be run again. The supported units are:

• ‘d’ - days

• ‘h’ - hours

• ‘m’ - minutes

• ‘s’ - seconds

• ‘ms’ - milliseconds

The task run date is aligned with ‘–start date’ value. For example, if you select ‘–interval 7d’ task would run weekly at the ‘–start-date’ time.

-K, --keyspaceCopy

A list of glob patterns separated by a comma used to include or exclude tables. The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. ‘keyspace,!keyspace.table_prefix_*’. The following syntax for glob patterns is supported:

• ‘*’ - matches any number of any characters including none

• ‘?’ - matches any single character

• ‘[abc]’ - matches one character given in the bracket

• ‘[a-z]’ - matches one character from the range given in the bracket

Patterns are evaluated from left to right. If a pattern starts with ‘!’ it unselects items that were selected by previous patterns i.e. ‘a?,!aa’ selects ab but not aa.

Default value: []

--labelCopy

A comma-separated list of label modifications. Labels are represented as a key-value store. Character ‘=’ has a special meaning and cannot be a part of label’s key nor value. A single modification takes form of: * ‘<key>=<value>’ - sets the label <key> to <value> * ‘<key>-’ - removes the label

For example, ‘–label k1=v1,k2-’ will set the label ‘k1’ to ‘v1’ and will also remove label ‘k2’.

-L, --locationCopy

A list of backup locations separated by a comma, specifies where to place the backup, the format is [<dc>:]<provider>:<bucket>. The ‘<dc>’ parameter is optional it allows to specify location for a datacenter in a multi-dc setting, it must match Scylla nodes datacenter. The supported storage ‘<provider>’s are ‘azure’, ‘gcs’, ‘s3’. The ‘bucket’ parameter is a bucket name, it must be an alphanumeric string and may contain a dash and or a dot, but other characters are forbidden.

Default value: []

--nameCopy

Task name that can be used instead of ID.

-r, --num-retriesCopy

Number of times a task reruns following a failure.

Default value: 3

--purge-onlyCopy

Run the backup cleanup only.

Default value: false

--rate-limitCopy

Limits the upload rate (as expressed in megabytes (MiB) per second) at which snapshotfiles can be uploaded from a Scylla node to its backup destination. You can set limits for more than one DC using a comma-separated list expressed in the format [<dc>:]<limit>. The <dc>: part is optional and is only needed when different datacenters require different upload limits. Set to 0 for no limit (default 100).

Default value: []

--retentionCopy

The number of backups to store, once this number is reached, the next backup which comes in from this destination will initiate a purge of the oldest backup. Can be used simultaneously with ‘–retention-days’ flag.

Default value: 7

--retention-daysCopy

The number of days for which backup is stored, the next backup will initiate a purge of all expired backups. Can be used simultaneously with ‘–retention’ flag.

Default value: 0

--retry-waitCopy

Initial exponential backoff duration X[h|m|s]. With –retry-wait 10m task will wait 10 minutes, 20 minutes and 40 minutes after first, second and third consecutire failure.

Default value: 10m

--show-tablesCopy

Prints table names together with keyspace, used in combination with –dry-run.

Default value: false

--skip-schemaCopy

Don’t backup schema. For ScyllaDB versions starting at 6.0 and 2024.2, SM requires CQL credentials to back up the schema. CQL Credentials can be added with ‘sctool cluster update –username –password’ command. This flag can be used to skip this step and allow for backing up user data without providing SM with CQL credentials. Note that it’s impossible to restore schema from such backups.

Default value: false

--snapshot-parallelCopy

A comma-separated list of snapshot parallelism limits in the format [<dc>:]<limit>. The ‘dc’ part is optional and allows for specifying different limits in selected datacenters. If the ‘dc’ part is not set, the limit is global and the runs are parallel in ‘n’ nodes. If for example, you were to set ‘dc1:2,5’, then ‘dc1’ would have two parallel nodes and there would be five parallel nodes in the other DCs.

Default value: []

-s, --start-dateCopy

The date can be expressed relatively to now or as a RFC3339 formatted string. To run the task in 2 hours use ‘now+2h’. The supported units are:

• ‘d’ - days

• ‘h’ - hours

• ‘m’ - minutes

• ‘s’ - seconds

• ‘ms’ - milliseconds

If you want the task to start at a specified date use RFC3339 formatted string i.e. ‘2018-01-02T15:04:05-07:00’. If you want the repair to start immediately, use the value ‘now’ or skip this flag.

--timezoneCopy

Timezone of –cron and –window flag values. The default value is taken from this system, namely ‘TZ’ envvar or ‘/etc/localtime’ file.

Default value: UTC

--transfersCopy

Sets the amount of file transfers to run in parallel when uploading files from a Scylla node to its backup location. Set to -1 for using the transfers value defined in node’s ‘scylla-manager-agent.yaml’ config file.

Default value: -1

--upload-parallelCopy

A comma-separated list of upload parallelism limits in the format [<dc>:]<limit>. The ‘dc’ part is optional and allows for specifying different limits in selected datacenters. If the ‘dc’ part is not set, the limit is global (e.g. ‘dc1:2,5’) the runs are parallel in ‘n’ nodes. If for example, you were to set ‘dc1:2,5’, then ‘dc1’ would have two parallel nodes and there would be five parallel nodes in the other DCs.

Default value: []

--windowCopy

A comma-separated list of time markers in a form [WEEKDAY-]HH:MM. WEEKDAY can be written as the whole word or only using the first 3 characters, HH:MM is an hour from 00:00 to 23:59.

• ‘MON-00:00,FRI-15:00’ - can be executed from Monday to Friday 3PM

• ‘23:00,06:00’ - can be executed every night from 11PM to 6AM

• ‘23:00,06:00,SAT-00:00,SUN-23:59’ - can be executed every night from 11PM to 6AM and all day during the weekend

Default value: []

--all-clustersCopy

Shows backups for all clusters. Useful for listing clusters that are no longer available locally but are backed up in the past to remote location.

Default value: false

-c, --clusterCopy

The target cluster name or ID (envvar SCYLLA_MANAGER_CLUSTER).

-h, --helpCopy

help for list

Default value: false

-K, --keyspaceCopy

A list of glob patterns separated by a comma used to include or exclude tables. The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. ‘keyspace,!keyspace.table_prefix_*’. The following syntax for glob patterns is supported:

• ‘*’ - matches any number of any characters including none

• ‘?’ - matches any single character

• ‘[abc]’ - matches one character given in the bracket

• ‘[a-z]’ - matches one character from the range given in the bracket

Patterns are evaluated from left to right. If a pattern starts with ‘!’ it unselects items that were selected by previous patterns i.e. ‘a?,!aa’ selects ab but not aa.

Default value: []

-L, --locationCopy

A list of backup locations separated by a comma, specifies where to place the backup, the format is [<dc>:]<provider>:<bucket>. The ‘<dc>’ parameter is optional it allows to specify location for a datacenter in a multi-dc setting, it must match Scylla nodes datacenter. The supported storage ‘<provider>’s are ‘azure’, ‘gcs’, ‘s3’. The ‘bucket’ parameter is a bucket name, it must be an alphanumeric string and may contain a dash and or a dot, but other characters are forbidden.

Default value: []

--max-dateCopy

Specifies maximal snapshot date expressed in RFC3339 form or ‘now[+duration]’, ex. ‘now+3d2h10m’. Valid units are:

• ‘d’ - days

• ‘h’ - hours

• ‘m’ - minutes

• ‘s’ - seconds

• ‘now’ - happens immediately

--min-dateCopy

Specifies minimal snapshot date expressed in RFC3339 form or ‘now[+duration]’, ex. ‘now+3d2h10m’. Valid units are:

• ‘d’ - days

• ‘h’ - hours

• ‘m’ - minutes

• ‘s’ - seconds

• ‘now’ - happens immediately

--show-tablesCopy

Prints table names together with keyspace.

Default value: false

-c, --clusterCopy

The target cluster name or ID (envvar SCYLLA_MANAGER_CLUSTER).

-h, --helpCopy

help for delete

Default value: false

-L, --locationCopy

A list of backup locations separated by a comma, specifies where to place the backup, the format is [<dc>:]<provider>:<bucket>. The ‘<dc>’ parameter is optional it allows to specify location for a datacenter in a multi-dc setting, it must match Scylla nodes datacenter. The supported storage ‘<provider>’s are ‘azure’, ‘gcs’, ‘s3’. The ‘bucket’ parameter is a bucket name, it must be an alphanumeric string and may contain a dash and or a dot, but other characters are forbidden.

Default value: []

-T, --snapshot-tagCopy

A list of snapshot tags separated by a comma.

Default value: []

--all-clustersCopy

Shows backups for all clusters.

Default value: false

-c, --clusterCopy

The target cluster name or ID (envvar SCYLLA_MANAGER_CLUSTER).

-d, --delimiterCopy

Dictates which character will be used as a whitespace between remote file path and information about keyspace and table.

Default value: `` ``

-h, --helpCopy

help for files

Default value: false

-K, --keyspaceCopy

A list of glob patterns separated by a comma used to include or exclude tables. The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. ‘keyspace,!keyspace.table_prefix_*’. The following syntax for glob patterns is supported:

• ‘*’ - matches any number of any characters including none

• ‘?’ - matches any single character

• ‘[abc]’ - matches one character given in the bracket

• ‘[a-z]’ - matches one character from the range given in the bracket

Patterns are evaluated from left to right. If a pattern starts with ‘!’ it unselects items that were selected by previous patterns i.e. ‘a?,!aa’ selects ab but not aa.

Default value: []

-L, --locationCopy

A list of backup locations separated by a comma, specifies where to place the backup, the format is [<dc>:]<provider>:<bucket>. The ‘<dc>’ parameter is optional it allows to specify location for a datacenter in a multi-dc setting, it must match Scylla nodes datacenter. The supported storage ‘<provider>’s are ‘azure’, ‘gcs’, ‘s3’. The ‘bucket’ parameter is a bucket name, it must be an alphanumeric string and may contain a dash and or a dot, but other characters are forbidden.

Default value: []

-T, --snapshot-tagCopy

Snapshot tag as read from the backup listing.

--with-versionCopy

Renders table names with version UUID.

Default value: false