Skip to content
SHC Docs

shc volume restore-snapshot

restore a block volume from one of its cloud snapshots

Replace a block volume’s contents with a snapshot’s.

The volume’s current contents are discarded, so -y/--yes is required. The volume must be detached: stop the deployment (or move it) first, because a restore replaces the backing cloud resource and would otherwise swap the block device out from under a mounted filesystem.

On some clouds the restore lands in a new backing volume, so the volume’s handle may change; the new handle is recorded and printed.

shc volume restore-snapshot <volume-id|name> <snapshot> [flags]
-h, --help help for restore-snapshot
-y, --yes assume yes: the volume's current contents are discarded (required)
--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)
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)
  • shc volume - manage and inspect cluster block volumes