stratumctl backup
Managed backup: plans, vaults, recovery points, restore
stratumctl backup [flags]Subcommands
Section titled “Subcommands”stratumctl backup plan: Manage scheduled backup plansstratumctl backup recovery-point: List, inspect and delete recovery pointsstratumctl backup restore: Restore a recovery point (no identity needed — the service key decrypts)stratumctl backup vault: Manage backup vaults (logical recovery-point containers)
stratumctl backup plan
Section titled “stratumctl backup plan”Manage scheduled backup plans
stratumctl backup plan [flags]Aliases: plans
Subcommands
Section titled “Subcommands”stratumctl backup plan create: Create a backup plan (one cron rule + keep-N retention + selection)stratumctl backup plan delete: Delete a backup plan (its recovery points are kept)stratumctl backup plan get: Describe a backup planstratumctl backup plan list: List the project’s backup plansstratumctl backup plan run: Run a backup plan now (the scheduler picks it up within one tick)stratumctl backup plan update: Update a backup plan (sparse: only supplied flags change)
stratumctl backup plan create
Section titled “stratumctl backup plan create”Create a backup plan (one cron rule + keep-N retention + selection)
stratumctl backup plan create [flags]Examples
Section titled “Examples”stratumctl backup plan create --name nightly --schedule '0 3 * * *' --retention 7 --volume vol-3k8m2x7q9astratumctl backup plan create --name by-tag --schedule '0 2 * * 0' --retention 4 --tag-selector backup=weekly| Flag | Type | Default | Description |
|---|---|---|---|
--disabled |
bool | false |
Create the plan disabled |
--display-name |
string | Human-readable name (defaults to –name) | |
--name |
string | Plan name (unique within the project) | |
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) | |
--retention |
int | 0 |
Keep the newest N successful points per volume |
--schedule |
string | Standard 5-field cron, e.g. ‘0 3 * * *’ | |
--tag |
stringToString | Plan tag key=value (repeatable) | |
--tag-selector |
stringToString | AND tag match key=value (repeatable) | |
--vault |
string | Target vault bv-… (empty = the project’s default vault) | |
--volume |
stringArray | Volume ID to back up (repeatable) |
stratumctl backup plan delete
Section titled “stratumctl backup plan delete”Delete a backup plan (its recovery points are kept)
stratumctl backup plan delete <bp-id> [flags]Examples
Section titled “Examples”stratumctl backup plan delete bp-4m8x2k7q9a| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) |
stratumctl backup plan get
Section titled “stratumctl backup plan get”Describe a backup plan
stratumctl backup plan get <bp-id> [flags]Examples
Section titled “Examples”stratumctl backup plan get bp-4m8x2k7q9astratumctl backup plan get bp-4m8x2k7q9a --output json| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) |
stratumctl backup plan list
Section titled “stratumctl backup plan list”List the project’s backup plans
stratumctl backup plan list [flags]Examples
Section titled “Examples”stratumctl backup plan liststratumctl backup plan list --output json| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) |
stratumctl backup plan run
Section titled “stratumctl backup plan run”Run a backup plan now (the scheduler picks it up within one tick)
stratumctl backup plan run <bp-id> [flags]Examples
Section titled “Examples”stratumctl backup plan run bp-4m8x2k7q9a| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) |
stratumctl backup plan update
Section titled “stratumctl backup plan update”Update a backup plan (sparse: only supplied flags change)
stratumctl backup plan update <bp-id> [flags]Examples
Section titled “Examples”stratumctl backup plan update bp-4m8x2k7q9a --retention 14stratumctl backup plan update bp-4m8x2k7q9a --disable| Flag | Type | Default | Description |
|---|---|---|---|
--disable |
bool | false |
Disable the plan |
--display-name |
string | Human-readable name | |
--enable |
bool | false |
Enable the plan |
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) | |
--retention |
int | 0 |
Keep the newest N successful points per volume |
--schedule |
string | Standard 5-field cron | |
--tag-selector |
stringToString | Replace the tag selector key=value (repeatable) | |
--volume |
stringArray | Replace the volume selection (repeatable) |
stratumctl backup recovery-point
Section titled “stratumctl backup recovery-point”List, inspect and delete recovery points
stratumctl backup recovery-point [flags]Aliases: rp, recovery-points
Subcommands
Section titled “Subcommands”stratumctl backup recovery-point delete: Delete a recovery point (chain-aware: 409 while later increments depend on it)stratumctl backup recovery-point get: Describe a recovery pointstratumctl backup recovery-point list: List the project’s recovery points (newest first)
stratumctl backup recovery-point delete
Section titled “stratumctl backup recovery-point delete”Delete a recovery point (chain-aware: 409 while later increments depend on it)
stratumctl backup recovery-point delete <rp-id> [flags]Examples
Section titled “Examples”stratumctl backup recovery-point delete rp-7k2m9x4q8a| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) |
stratumctl backup recovery-point get
Section titled “stratumctl backup recovery-point get”Describe a recovery point
stratumctl backup recovery-point get <rp-id> [flags]Examples
Section titled “Examples”stratumctl backup recovery-point get rp-7k2m9x4q8astratumctl backup recovery-point get rp-7k2m9x4q8a --output json| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) |
stratumctl backup recovery-point list
Section titled “stratumctl backup recovery-point list”List the project’s recovery points (newest first)
stratumctl backup recovery-point list [flags]Examples
Section titled “Examples”stratumctl backup recovery-point liststratumctl backup recovery-point list --plan bp-4m8x2k7q9astratumctl backup recovery-point list --volume vol-3k8m2x7q9a --output json| Flag | Type | Default | Description |
|---|---|---|---|
--plan |
string | Filter by producing plan (bp-…) | |
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) | |
--vault |
string | Filter by vault (bv-…) | |
--volume |
string | Filter by source volume (vol-…) |
stratumctl backup restore
Section titled “stratumctl backup restore”Restore a recovery point (no identity needed — the service key decrypts)
stratumctl backup restore <rp-id> [flags]Starts a tenant self-service restore: mode ‘newVolume’ mints a fresh volume from the point (–name overrides the volume name), mode ‘inPlace’ re-imports into the existing volume whose backing image was lost (–volume overrides the target). Poll the returned operation for progress.
Examples
Section titled “Examples”stratumctl backup restore rp-7k2m9x4q8a --name restored-datastratumctl backup restore rp-7k2m9x4q8a --mode inPlace --volume vol-3k8m2x7q9a| Flag | Type | Default | Description |
|---|---|---|---|
--mode |
string | newVolume |
Restore mode: newVolume | inPlace |
--name |
string | newVolume only: the new volume’s name | |
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) | |
--volume |
string | inPlace only: target volume (defaults to the point’s source) |
stratumctl backup vault
Section titled “stratumctl backup vault”Manage backup vaults (logical recovery-point containers)
stratumctl backup vault [flags]Aliases: vaults
Subcommands
Section titled “Subcommands”stratumctl backup vault create: Create a backup vaultstratumctl backup vault delete: Delete a backup vault (refused while plans or points reference it)stratumctl backup vault list: List the project’s backup vaults (includes the auto-created default)
stratumctl backup vault create
Section titled “stratumctl backup vault create”Create a backup vault
stratumctl backup vault create [flags]Examples
Section titled “Examples”stratumctl backup vault create --name offsite --display-name "Offsite vault"| Flag | Type | Default | Description |
|---|---|---|---|
--display-name |
string | Human-readable name (defaults to –name) | |
--name |
string | Vault name (unique within the project; ‘default’ is reserved) | |
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) |
stratumctl backup vault delete
Section titled “stratumctl backup vault delete”Delete a backup vault (refused while plans or points reference it)
stratumctl backup vault delete <bv-id> [flags]Examples
Section titled “Examples”stratumctl backup vault delete bv-2k8m4x7q9a| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) |
stratumctl backup vault list
Section titled “stratumctl backup vault list”List the project’s backup vaults (includes the auto-created default)
stratumctl backup vault list [flags]Examples
Section titled “Examples”stratumctl backup vault liststratumctl backup vault list --output json| Flag | Type | Default | Description |
|---|---|---|---|
--project |
string | Project ID (defaults to env STRATUM_PROJECT or profile) |