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 .zip 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

--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.
--repository <string>
Repository URL.
--verbose <boolean>   (default=false)
Print verbose information

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

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

<command> : <array>
Command. This may be a list in order to spefify nested sub-commands.

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

--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.
--output-format text|json|json-pretty
Output format.
--repository <string>
Repository URL.

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.