dump

Section profile.dump

This section configures restic command dump . Information on command and flags is copied from the restic manual pages.

The “dump” command extracts files from a snapshot from the repository. If a single file is selected, it prints its contents to stdout. Folders are output as a tar (default) or zip file containing the contents of the specified folder. Pass “/” as file name to dump the whole snapshot as an archive file.

The special snapshotID “latest” can be used to use the latest snapshot in the repository.

To include the folder content at the root of the archive, you can use the “snapshotID:subfolder” syntax, where “subfolder” is a path within the snapshot.

Flags used by resticprofile only:
NameTypeDefaultNotes
run-afterone or more stringsRun shell command(s) after a successful restic command
run-after-failone or more stringsRun shell command(s) after failed restic or shell commands
run-beforeone or more stringsRun shell command(s) before a restic command
run-finallyone or more stringsRun shell command(s) always, after all other commands
Flags passed to the restic command line:
NameTypeDefaultNotes
archivestring"tar"set archive format as “tar” or “zip”. restic >= 0.12.0
hosttrue / false OR one or more hostnamesonly consider snapshots for this host, when snapshot ID “latest” is given (can be specified multiple times) (default: $RESTIC_HOST). Boolean true is replaced with the hostname of the system. Examples: true, false, "host"
pathtrue / false OR one or more stringsonly consider snapshots including this (absolute) path, when snapshot ID “latest” is given (can be specified multiple times, snapshots must include all specified paths). Boolean true is replaced with the paths from section “backup”. Examples: true, false, "path"
tagtrue / false OR one or more stringsonly consider snapshots including tag[,tag,…], when snapshot ID “latest” is given. Boolean true is replaced with the tags from section “backup”. Examples: true, false, "tag"
targetstring""write the output to target path. restic >= 0.17.0
Tip

Flags declared for the restic command line in section profile can be overridden in this section.