Backup Commands

sbctl backup --help

Backup Commands

List all backups.

List all backups.

sbctl backup list
    --cluster-id=<CLUSTER_ID>

Parameter	Description	Data Type	Required	Default
--cluster-id	The cluster id.	string	False	-

Delete all backups for a logical volume.

Delete all backups for a logical volume.

sbctl backup delete
    <LVOL_ID>

Argument	Description	Data Type	Required
LVOL_ID	The logical volume id.	string	True

Restore a backup to a new logical volume.

Restore a backup to a new logical volume.

sbctl backup restore
    <BACKUP_ID>
    --lvol=<LVOL>
    --pool=<POOL>
    --node=<NODE>
    --cluster-id=<CLUSTER_ID>

Argument	Description	Data Type	Required
BACKUP_ID	The volume backup id.	string	True

Parameter	Description	Data Type	Required	Default
--lvol	The new logical volume name.	string	True	-
--pool	The target pool name or id.	string	True	-
--node	The target storage node id.	string	False	-
--cluster-id	The cluster id.	string	False	-

Export backup metadata to a JSON file for cross-cluster restore.

Export backup metadata to a JSON file for cross-cluster restore.

sbctl backup export
    --cluster-id=<CLUSTER_ID>
    --lvol=<LVOL>
    -o=<O>

Parameter	Description	Data Type	Required	Default
--cluster-id	The cluster id.	string	False	-
--lvol	Filter exports to a specific logical volume name.	string	False	-
-o, --output	The output file path.	string	False	-

Import backup metadata from a JSON file.

Import backup metadata from a JSON file.

sbctl backup import
    <METADATA_FILE>
    --cluster-id=<CLUSTER_ID>

Argument	Description	Data Type	Required
METADATA_FILE	The path to JSON metadata file.	string	True

Parameter	Description	Data Type	Required	Default
--cluster-id	The target cluster to import into (required for cross-cluster restore).	string	False	-

Create a new backup policy.

Create a new backup policy.

sbctl backup policy-add
    <CLUSTER_ID>
    <NAME>
    --versions=<VERSIONS>
    --age=<AGE>
    --schedule=<SCHEDULE>

Argument	Description	Data Type	Required
CLUSTER_ID	The cluster id.	string	True
NAME	The policy name.	string	True

Parameter	Description	Data Type	Required	Default
--versions	The maximum number of backup versions.	integer	False	-
--age	Maximum backup age (e.g. 2d, 12h, 1w).	string	False	-
--schedule	Auto-backup schedule as space-separated tiers: "15m,4 60m,11 24h,7" (interval,keep_count per tier).	string	False	-

Remove a backup policy.

Remove a backup policy.

sbctl backup policy-remove
    <POLICY_ID>

Argument	Description	Data Type	Required
POLICY_ID	The backup policy id.	string	True

List all backup policies.

List all backup policies.

sbctl backup policy-list
    --cluster-id=<CLUSTER_ID>

Parameter	Description	Data Type	Required	Default
--cluster-id	The cluster id.	string	False	-

Attach a backup policy to a storage pool or logical volume.

Attach a backup policy to a storage pool or logical volume.

sbctl backup policy-attach
    <POLICY_ID>
    <TARGET_TYPE>
    <TARGET_ID>

Argument	Description	Data Type	Required
POLICY_ID	The backup policy id.	string	True
TARGET_TYPE	The target type.	string	True
TARGET_ID	The target id (storage pool or logical volume id).	string	True

Detach a backup policy from a storage pool or logical volume.

Detach a backup policy from a storage pool or logical volume.

sbctl backup policy-detach
    <POLICY_ID>
    <TARGET_TYPE>
    <TARGET_ID>

Argument	Description	Data Type	Required
POLICY_ID	The backup policy id.	string	True
TARGET_TYPE	The target type.	string	True
TARGET_ID	The target id (storage pool or logical volume id).	string	True

List backup sources (local and imported clusters).

List backup sources (local and imported clusters).

sbctl backup source-list
    --cluster-id=<CLUSTER_ID>

Parameter	Description	Data Type	Required	Default
--cluster-id	The cluster id.	string	False	-

Switch the active S3 backup source to a different cluster. Use 'local' or the local cluster id to switch back.

Switch the active S3 backup source to a different cluster. Use 'local' or the local cluster id to switch back.

sbctl backup source-switch
    <SOURCE_CLUSTER_ID>
    --cluster-id=<CLUSTER_ID>

Argument	Description	Data Type	Required
SOURCE_CLUSTER_ID	The source cluster id or 'local'.	string	True

Parameter	Description	Data Type	Required	Default
--cluster-id	The cluster id.	string	False	-