proxmox-file-restore

Synopsis

proxmox-file-restore extract <snapshot> <path> [<target>] [OPTIONS]

Restore files from a backup snapshot.

<snapshot><string>

Group/Snapshot path.

<path><string>

Path to restore. Directories will be restored as archive files if extracted to stdout.

<target><string>

Target directory path. Use '-' to write to standard output.

Optional parameters:

--base64 <boolean>   (default=false)

If set, 'path' will be interpreted as base64 encoded.

--crypt-mode none|encrypt|sign-only   (default=encrypt)

Defines whether data is encrypted (using an AEAD cipher), only signed, or neither.

--driver Qemu

--format plain|pxar|zip|tar

The desired format of the result.

--keyfd <integer> (0 - N)

Pass an encryption key via an already opened file descriptor.

--keyfile <string>

Path to encryption key. All data will be encrypted using this key.

--ns <string>

Namespace.

--repository <string>

Repository URL.

--verbose <boolean>   (default=false)

Print verbose information

--zstd <boolean>   (default=false)

If true, output will be zstd compressed.

proxmox-file-restore help [{<command>}] [OPTIONS]

Get help about specified command (or sub-command).

<command><string>

Command. This may be a list in order to spefify nested sub-commands. Can be specified more than once.

Optional parameters:

--verbose <boolean>

Verbose help.

proxmox-file-restore list <snapshot> <path> [OPTIONS]

List a directory from a backup snapshot.

<snapshot><string>

Group/Snapshot path.

<path><string>

Path to restore. Directories will be restored as .zip files.

Optional parameters:

--base64 <boolean>   (default=false)

If set, 'path' will be interpreted as base64 encoded.

--crypt-mode none|encrypt|sign-only   (default=encrypt)

Defines whether data is encrypted (using an AEAD cipher), only signed, or neither.

--driver Qemu

--json-error <boolean>   (default=false)

If set, errors are returned as json instead of writing to stderr

--keyfd <integer> (0 - N)

Pass an encryption key via an already opened file descriptor.

--keyfile <string>

Path to encryption key. All data will be encrypted using this key.

--ns <string>

Namespace.

--output-format text|json|json-pretty

Output format.

--repository <string>

Repository URL.

--timeout <integer> (1 - N)

Defines the maximum time the call can should take.

proxmox-file-restore status [OPTIONS]

Retrieve status information about currently running/mapped restore images

Optional parameters:

--driver Qemu

--output-format text|json|json-pretty

Output format.

proxmox-file-restore stop <name>

Immediately stop/unmap a given image. Not typically necessary, as VMs will stop themselves after a timer anyway.

<name><string>

The name of the VM to stop.

Description

Command line tool for restoring files and directories from PBS archives. In contrast to proxmox-backup-client, this supports both container/host and VM backups.