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 Stop

Caution

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

Stop¶

stop¶

This command stops a specified task, stopping an already stopped task has no effect. If you want to stop all tasks see sctool suspend. If there is one task of the given type the ‘<id|name>’ argument is not needed.

Syntax¶

sctool stop --cluster <id|name> [flags] <type>[/<id|name>]

Command options¶

-c, --cluster¶

The target cluster name or ID (envvar SCYLLA_MANAGER_CLUSTER).

--delete¶

Permanently remove the task.

Default value: false

--disable¶

Prevents the task from running until it has been re-enabled with the ‘sctool <task_type> update –enabled’ command.

Default value: false

-h, --help¶

help for stop

Default value: false

--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
Status
NEXT
Suspend & Resume
  • Create an issue
  • Edit this page

On this page

  • Stop
    • stop
      • Syntax
      • Command options
        • -c, --cluster
        • --delete
        • --disable
        • -h, --help
Scylla Manager
  • master
    • 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 09 June 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6