ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

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

Scylla Manager CLI sctool Global flags and variables

Global flags and variables¶

The flags and variables presented in this section can be used with any sctool command.

Global flags¶

  • --api-cert-file <path> - specifies the path to HTTPS client certificate used to access the Scylla Manager server

  • --api-key-file <path> - specifies the path to HTTPS client key used to access the Scylla Manager server

  • --api-url URL - URL of Scylla Manager server (default “http://127.0.0.1:5080/api/v1”)

  • -c, --cluster <cluster_name> - Specifies the target cluster name or ID

  • -h, --help - Displays help for commands. Use sctool [command] --help for help about a specific command.

Environment variables¶

sctool uses the following environment variables:

  • SCYLLA_MANAGER_CLUSTER - if set, specifies the default value for the -c, --cluster flag, in commands that support it.

  • SCYLLA_MANAGER_API_URL - if set, specifies the default value for the --api-url flag; it can be useful when using sctool with a remote Scylla Manager server.

The environment variables may be saved in your ~/.bashrc file so that the variables are set after login.

PREVIOUS
CLI sctool
NEXT
Cluster
  • 2.5
    • master
    • 3.0
    • 2.6
    • 2.5
    • 2.4
    • 2.3
    • 2.2
  • Docker
  • Install Scylla Manager
  • Install Scylla Manager Agent
  • Add a Cluster
  • Backup
    • Setup AWS S3
    • Setup S3 compatible storage
    • Setup Google Cloud Storage
    • Setup Azure Blob Storage
    • Examples
    • Specification
  • Restore
    • Download files command
  • Repair
    • Repair faster
    • Repair slower
    • Examples
  • Health Check
  • CLI sctool
    • Global flags and variables
    • Cluster
    • Backup
    • Repair
    • Status
    • Suspend & Resume
    • Task
    • Version
  • Configuration Files
    • Scylla Manager Config
    • Scylla Manager Agent Config
  • Swagger File
  • Scylla Monitoring
  • Troubleshooting
  • Older Versions
  • Slack
  • Create an issue
  • Edit this page

On this page

  • Global flags and variables
    • Global flags
    • Environment variables
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 15 February 2023.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.3.4