Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rafftechnologies.com/llms.txt

Use this file to discover all available pages before exploring further.

Updated May 10, 2026 The raff snapshot command group covers point-in-time snapshots of VM disks and volumes. Snapshots are stored separately from the source and can be restored back over the source disk. Every subcommand supports --output json for scripting. Aliases: raff snapshots, raff snap.

​
Subcommand index

SubcommandWhat it does
listList snapshots, optionally filtered
getShow details for one snapshot
createCapture a snapshot of a VM or volume
renameRename a snapshot
restoreRestore the source from a snapshot
deleteDelete a snapshot

​
list

raff snapshot list [--vm-id <vm-uuid>] [--volume-id <id>] [--type vm|volume] [--output table|json]
List snapshots in the current project. Filter by source VM, source volume, or snapshot type. Output columns: ID, NAME, SIZE, TYPE, SOURCE, STATUS, CREATED. 
# Every snapshot in the project
raff snapshot list

# Only VM snapshots
raff snapshot list --type vm

# Snapshots of a specific VM
raff snapshot list --vm-id <vm-uuid>

​
get

raff snapshot get <snapshot-id> [--output table|json]
Show full details for one snapshot.

​
create

raff snapshot create \
  --name <name> \
  --resource-type vm|volume \
  [--resource-id <vm-uuid>] \
  [--volume-id <volume-id>]
Capture a snapshot. Required: --name, --resource-type. Pass --resource-id <vm-uuid> for VM snapshots, --volume-id <id> for volume snapshots. 
# Snapshot a VM disk
raff snapshot create --name "pre-upgrade" \
  --resource-type vm --resource-id <vm-uuid>

# Snapshot a volume
raff snapshot create --name "data-01-2026-05-10" \
  --resource-type volume --volume-id 42

​
rename

raff snapshot rename <snapshot-id> --name <new-name>

​
restore

raff snapshot restore <snapshot-id> [--force]
Restore the source VM or volume from this snapshot. The current disk state is overwritten. Pass --force to skip the confirmation prompt. While the source is reverted to a snapshot, that snapshot’s status reads active and it cannot be deleted. Saved-but-not-in-use snapshots have an empty status.

​
delete

raff snapshot delete <snapshot-id> [--force]
Delete a snapshot. Pass --force to skip the confirmation prompt. Cannot delete a snapshot whose status is active — the source is currently reverted to it.

Backup commands

Managed backups with retention.

raff_snapshot (Terraform)

Declarative snapshot management.

API Reference

The HTTP API behind the CLI.
Last modified on May 11, 2026