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 Tasks

Tasks¶

tasks¶

This command shows all of the scheduled tasks for the specified cluster. If cluster is not set this would output a table for every cluster. Each row contains task type and ID, separated by a slash, task properties, next activation and last status information. For more information on a task consult history and progress.

Syntax¶

sctool tasks [flags]

Command options¶

-a, --all¶

Lists all tasks, including those which have been disabled, disabled tasks are prefixed with ‘*’.

Default value: false

-c, --cluster¶

The target cluster name or ID (envvar SCYLLA_MANAGER_CLUSTER).

-h, --help¶

help for tasks

Default value: false

--show-ids¶

Always display task UUID, do not show task names.

Default value: false

--show-properties¶

Additionally display task properties. Only displays properties set to non-default values.

Default value: false

--sort¶

Returns a list of tasks sorted according to the last run status and sort key which you provide. Accepted sort key values are: ‘next-activation’, ‘status’.

-s, --status¶

Filters tasks according to their last run status. Accepted values are: NEW, RUNNING, STOPPING, STOPPED, WAITING, DONE, ERROR, ABORTED.

-t, --type¶

Display only tasks of a given type.

--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

Was this page helpful?

PREVIOUS
Suspend & Resume
NEXT
Version
  • Create an issue
  • Edit this page

On this page

  • Tasks
    • tasks
      • Syntax
      • Command options
        • -a, --all
        • -c, --cluster
        • -h, --help
        • --show-ids
        • --show-properties
        • --sort
        • -s, --status
        • -t, --type
Scylla Manager
  • 3.5
    • master
    • 3.5
    • 3.4
    • 3.3
  • Docker
  • Install ScyllaDB Manager
  • Install ScyllaDB Manager Agent
  • ScyllaDB Manager Upgrade
  • Compatibility Matrix
  • 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
  • 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