Skip to content
SHC Docs

shc backup schedule run

fire a scheduled backup for a scope now

Fire the scheduled backup path for a scope immediately. This is the same executor the cron uses (Scheduled: true, a restic-only destination, orchestrated capture), not shc backup create. Use it after a failed nightly, or to prove a newly-set schedule can actually run, without waiting for the next tick.

The fire runs on the cluster leader as an operation and this command follows it to its end. Leaving early does not stop the fire. A fire of the scope that is already running is followed instead of starting a second one.

shc backup schedule run [flags]
shc backup schedule run --scope stack -s myblog
shc backup schedule run --scope tenant -t default
shc backup schedule run --scope stack -s myblog --all-connected
--all-connected also back up each matched deployment's integration-graph peers
-h, --help help for run
--scope string scope level (global|tenant|environment|stack|deployment) (default "stack")
-s, --stack string stack name (for stack/deployment scopes)
--with-dependants also back up the deployments that depend on each matched deployment
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)