Snapshot Commands

sbctl snapshot --help

Snapshot Commands

Creates a new snapshot.

Creates a new snapshot.

sbctl snapshot add
    <VOLUME_ID>
    <NAME>
    --backup

Argument	Description	Data Type	Required
VOLUME_ID	The logical volume id.	string	True
NAME	The new snapshot name.	string	True

Parameter	Description	Data Type	Required	Default
--backup	Also create an S3 backup of this snapshot.	marker	False	-

Lists all snapshots.

Lists all snapshots.

sbctl snapshot list
    --all
    --cluster-id=<CLUSTER_ID>
    --with-details

Parameter	Description	Data Type	Required	Default
--all	List soft deleted snapshots.	marker	False	-
--cluster-id	Filter snapshots by cluster UUID	string	False	-
--with-details	List snapshots with replicate and chaining details	marker	False	-

Deletes a snapshot.

Deletes a snapshot.

sbctl snapshot delete
    <SNAPSHOT_ID>
    --force

Argument	Description	Data Type	Required
SNAPSHOT_ID	The snapshot id.	string	True

Parameter	Description	Data Type	Required	Default
--force	Force remove.	marker	False	-

Check a snapshot health

Check a snapshot health

sbctl snapshot check
    <SNAPSHOT_ID>

Argument	Description	Data Type	Required
SNAPSHOT_ID	Snapshot id	string	True

Provisions a new logical volume from an existing snapshot.

Provisions a new logical volume from an existing snapshot.

sbctl snapshot clone
    <SNAPSHOT_ID>
    <LVOL_NAME>
    --resize=<RESIZE>

Argument	Description	Data Type	Required
SNAPSHOT_ID	The snapshot id.	string	True
LVOL_NAME	The logical volume name.	string	True

Parameter	Description	Data Type	Required	Default
--resize	New logical volume size: 10M, 10G, 10(bytes). Can only increase. Default: 0.	size	False	0

Lists snapshots replication status

Lists snapshots replication status

sbctl snapshot replication-status
    <CLUSTER_ID>

Argument	Description	Data Type	Required
CLUSTER_ID	Cluster UUID	string	True

Delete replicated version of a snapshot

Delete replicated version of a snapshot

sbctl snapshot delete-replication-only
    <SNAPSHOT_ID>

Argument	Description	Data Type	Required
SNAPSHOT_ID	Snapshot UUID	string	True

Gets a snapshot information

Gets a snapshot information

sbctl snapshot get
    <SNAPSHOT_ID>

Argument	Description	Data Type	Required
SNAPSHOT_ID	Snapshot UUID	string	True

Create an S3 backup of an existing snapshot.

Create an S3 backup of an existing snapshot.

sbctl snapshot backup
    <SNAPSHOT_ID>

Argument	Description	Data Type	Required
SNAPSHOT_ID	The snapshot id.	string	True