``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:

``--auth-id`` ``<string>``
  Authentication ID
``--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.
``--datastore`` ``<string>``
  Datastore name.
``--driver`` ``Qemu``
  The block driver type to use.
``--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.
``--port`` ``<integer> (1 - 65535)   (default=8007)``
  Backup server port. Default: 8007
``--repository`` ``<string>``
  Repository URL: [[auth-id@]server[:port]:]datastore
``--server`` ``<string>``
  Backup server address (hostname or IP). Default: localhost
``--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 specify 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>``
  (Sub-)Path to list.

Optional parameters:

``--auth-id`` ``<string>``
  Authentication ID
``--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.
``--datastore`` ``<string>``
  Datastore name.
``--driver`` ``Qemu``
  The block driver type to use.
``--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.
``--port`` ``<integer> (1 - 65535)   (default=8007)``
  Backup server port. Default: 8007
``--repository`` ``<string>``
  Repository URL: [[auth-id@]server[:port]:]datastore
``--server`` ``<string>``
  Backup server address (hostname or IP). Default: localhost
``--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``
  The block driver type to use.
``--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.
