tebib snapshot

Generated from the CLI's own command tree. Run tebib snapshot --help for the same text in your terminal.

Point-in-time snapshots of a VM's volumes.

Commands

tebib snapshot create

Snapshot a VM's volumes (application-consistent when the guest agent runs).

tebib snapshot create [OPTIONS] NAME

Argument	Description
NAME required	Snapshot name, unique in the project.

Option	Value	Description
--vm required	str	VM to snapshot.
--description	str	Description.
--tag	KEY=VALUE (repeatable)	Tag as KEY=VALUE; repeat for more tags.
--project, -p	str	Project ID (default: from the profile).
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 1800.
--output, -o	table | json | yaml	Output format.

tebib snapshot delete

Delete a snapshot.

tebib snapshot delete [OPTIONS] ID

Argument	Description
ID required	Snapshot ID (snap-...).

Option	Value	Description
--yes, -y	flag	Don't ask for confirmation.
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 600.
--project, -p	str	Project ID (default: from the profile).

tebib snapshot list

List the project's snapshots.

tebib snapshot list [OPTIONS]

Option	Value	Description
--project, -p	str	Project ID (default: from the profile).
--limit	int range	Show at most this many items.
--output, -o	table | json | yaml	Output format.

tebib snapshot show

Show one snapshot.

tebib snapshot show [OPTIONS] ID

Argument	Description
ID required	Snapshot ID (snap-...).

Option	Value	Description
--project, -p	str	Project ID (default: from the profile).
--output, -o	table | json | yaml	Output format.

tebib snapshot update

Change a snapshot's description or tags.

tebib snapshot update [OPTIONS] ID

Argument	Description
ID required	Snapshot ID (snap-...).

Option	Value	Description
--description	str	New description.
--tag	KEY=VALUE (repeatable)	Replace ALL tags (KEY=VALUE, repeatable).
--clear-tags	flag	Remove all tags.
--project, -p	str	Project ID (default: from the profile).
--output, -o	table | json | yaml	Output format.

tebib snapshot schedule

Scheduled backups: snapshot a VM on a schedule and delete old snapshots.

tebib snapshot schedule create

Snapshot a VM on a schedule, e.g. --every daily --at 02:30 --keep 7.

Snapshots it takes are named <schedule>-<YYYYMMDD-HHMM> and bill like any snapshot.

tebib snapshot schedule create [OPTIONS] NAME

Argument	Description
NAME required	Schedule name, unique in the project.

Option	Value	Description
--vm required	str	VM to snapshot.
--every	hourly|daily|weekly	hourly, daily or weekly (or give --cron).
--cron	str	Custom schedule: 'minute hour day-of-month month day-of-week', e.g. '30 2 * * 1-5'. At most once an hour.
--at	HH:MM	Time of day HH:MM (daily, weekly), or :MM for hourly.
--on	DAY	Day of the week for weekly: sun, mon, ... sat.
--timezone	str	IANA time zone of --at/--cron, e.g. Africa/Nairobi.
--keep	int range	Keep the newest N snapshots it took.
--keep-days	int range	Delete the snapshots it took once N days old.
--disabled	flag	Create it turned off.
--description	str	Description.
--tag	KEY=VALUE (repeatable)	Tag as KEY=VALUE; repeat for more tags.
--project, -p	str	Project ID (default: from the profile).
--output, -o	table | json | yaml	Output format.

tebib snapshot schedule delete

Delete a snapshot schedule. The snapshots it took stay until you delete them.

tebib snapshot schedule delete [OPTIONS] ID

Argument	Description
ID required	Snapshot schedule ID (ssch-...).

Option	Value	Description
--yes, -y	flag	Don't ask for confirmation.
--wait	flag	Wait until the resource is ready (or gone, for deletes).
--timeout	float range	Seconds to wait with --wait. Default: 600.
--project, -p	str	Project ID (default: from the profile).

tebib snapshot schedule list

List the project's snapshot schedules.

tebib snapshot schedule list [OPTIONS]

Option	Value	Description
--vm	str	Only this VM's schedules.
--project, -p	str	Project ID (default: from the profile).
--output, -o	table | json | yaml	Output format.

tebib snapshot schedule show

Show one snapshot schedule: next run, last run and why it didn't succeed.

tebib snapshot schedule show [OPTIONS] ID

Argument	Description
ID required	Snapshot schedule ID (ssch-...).

Option	Value	Description
--project, -p	str	Project ID (default: from the profile).
--output, -o	table | json | yaml	Output format.

tebib snapshot schedule update

Change the schedule or retention, or turn it off and on. A changed schedule starts from now: runs already past are not taken.

tebib snapshot schedule update [OPTIONS] ID

Argument	Description
ID required	Snapshot schedule ID (ssch-...).

Option	Value	Description
--every	hourly|daily|weekly	hourly, daily or weekly (or give --cron).
--cron	str	Custom schedule: 'minute hour day-of-month month day-of-week', e.g. '30 2 * * 1-5'. At most once an hour.
--at	HH:MM	Time of day HH:MM (daily, weekly), or :MM for hourly.
--on	DAY	Day of the week for weekly: sun, mon, ... sat.
--timezone	str	IANA time zone of --at/--cron, e.g. Africa/Nairobi.
--keep	int range	Keep the newest N snapshots it took.
--keep-days	int range	Delete the snapshots it took once N days old.
--no-keep	flag	Stop keeping by count (needs --keep-days).
--no-keep-days	flag	Stop keeping by age (needs --keep).
--enable, --disable	flag	Turn it on (from now on) or off.
--description	str	New description.
--tag	KEY=VALUE (repeatable)	Replace ALL tags (KEY=VALUE, repeatable).
--project, -p	str	Project ID (default: from the profile).
--output, -o	table | json | yaml	Output format.