ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs Scylla Manager CLI sctool Progress

Caution

You're viewing documentation for a previous version of Scylla Manager. Switch to the latest stable version.

Progress¶

progress¶

This command shows details of the latest run (or still running) task. If there is one task of the given type the ‘<id|name>’ argument is not needed. ‘Progress: X%’ means that X% of the task has been completed without any failures. ‘Progress: X%/Y%’ means that X% of the task has succeeded and Y% of the task has failed.

Syntax¶

sctool progress --cluster <id|name> [--details] [--run UUID] [flags] <type>[/<id|name>]

Command options¶

-c, --cluster¶

The target cluster name or ID (envvar SCYLLA_MANAGER_CLUSTER).

--details¶

More detailed progress data, depending on task type.

Default value: false

-h, --help¶

help for progress

Default value: false

--host¶

A list of host glob patterns, e.g. ‘1.1.1.*,!1.2.*.4.’. 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: []

-K, --keyspace¶

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: []

--run¶

Show progress of a particular run, see sctool info to get the IDs.

Default value: latest

--api-cert-file

File path to HTTPS client certificate used to access the Scylla Manager server when client certificate validation is enabled (envvar SCYLLA_MANAGER_API_CERT_FILE).

--api-key-file

File path to HTTPS client key associated with –api-cert-file flag (envvar SCYLLA_MANAGER_API_KEY_FILE).

--api-url

Base URL of Scylla Manager server (envvar SCYLLA_MANAGER_API_URL).

If running sctool on the same machine as server, it’s generated based on ‘/etc/scylla-manager/scylla-manager.yaml’ file.

Default value: http://127.0.0.1:5080/api/v1

Example¶

Get progress of latest repair task of cluster 'prod'.
sctool progress -c prod repair

Was this page helpful?

PREVIOUS
Info
NEXT
Repair
  • Create an issue
  • Edit this page

On this page

  • Progress
    • progress
      • Syntax
      • Command options
        • -c, --cluster
        • --details
        • -h, --help
        • --host
        • -K, --keyspace
        • --run
      • Example
Scylla Manager
  • 3.3
    • master
    • 3.5
    • 3.4
    • 3.3
  • Docker
  • Install ScyllaDB Manager
  • Install ScyllaDB Manager Agent
  • ScyllaDB Manager Upgrade
  • Add a Cluster
  • Backup
    • Setup Amazon S3
    • Setup S3 compatible storage
    • Setup Google Cloud Storage
    • Setup Azure Blob Storage
    • Examples
    • Specification
  • Restore
    • Restore tables
    • Restore schema for ScyllaDB 6.0/2024.2 or newer
    • Restore schema for ScyllaDB 5.4/2024.1 or older
    • Examples
    • Compatibility Matrix
  • Repair
    • Repair faster
    • Repair slower
    • Examples
  • Health Check
  • CLI sctool
    • Environment variables
    • Completion
    • Download files
    • Backup
    • Restore
    • Cluster
    • Info
    • Progress
    • Repair
    • Start
    • Status
    • Stop
    • Suspend & Resume
    • Tasks
    • Version
  • Configuration Files
    • Scylla Manager Config
    • Scylla Manager Agent Config
  • Swagger File
  • ScyllaDB Monitoring
  • Troubleshooting
  • Slack
Docs Tutorials University Contact Us About Us
© 2025, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 07 May 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6