Module model 

The pure parts: a volume’s settings, and the names isb gives snapshots, staged restores and backup objects (and reads back for retention).

Structs

Staged

A staged restore of volume made at stamp: the new volume, the disk device on the instance and where it is mounted.

VolumeRecord

A volume’s stored settings with the scheduler’s anchor.

VolumeSettings

What a user sets on a volume: its snapshot schedule and its hook.

Constants

AUTO

Scheduled snapshots: auto-<stamp>; only these are pruned.

BACKUP_SNAPSHOT

The snapshot a backup exports from, deleted after it.

DEFAULT_HOOK_TIMEOUT

How long the hook may run unless the settings say otherwise.

HOOK_PATH

Where an instance’s pre-snapshot hook lives.

KEY_RESTORE_BY

KEY_RESTORE_FROM

KEY_RESTORE_INSTANCE

KEY_RESTORE_OF

incus volume config keys on a staged restore.

KEY_RESTORE_STAMP

KEY_TEMPORARY

A volume isb made for a moment (a backup’s export) and deletes.

MANUAL

Snapshot now, unnamed: manual-<stamp>, kept until deleted.

MAX_HOOK_TIMEOUT

The longest a hook may be given.

RESTORE_ROOT

Where a staged restore is mounted inside the instance.

Functions

auto_time

The time in an auto-<stamp> snapshot’s name.

export_volume

The temporary volume a backup exports from.

parse_volume_key

A key volume_key wrote: its volume, time and compression.

select_snapshot_prune

Which scheduled snapshots retention deletes: auto- ones beyond the newest keep. Manual and other snapshots are never touched.

select_volume_prune

Which volume backup objects retention deletes: those volume_key wrote under prefix beyond the newest keep.

staged

stamp

A time as isb stamps names with: 20261003T090912Z.

validate_snapshot_name

A snapshot name a user gives.

validate_volume_name

A custom volume’s name as isb accepts it: incus’ rules, and safe as a directory name.

volume_key

A volume backup’s object key.