qvm-backup-restore.rst 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. .. program:: qvm-backup-restore
  2. ===============================================================
  3. :program:`qvm-backup-restore` -- Restores Qubes VMs from backup
  4. ===============================================================
  5. .. warning::
  6. This page was autogenerated from command-line parser. It shouldn't be 1:1
  7. conversion, because it would add little value. Please revise it and add
  8. more descriptive help, which normally won't fit in standard ``--help``
  9. option.
  10. After rewrite, please remove this admonition.
  11. Synopsis
  12. ========
  13. :command:`qvm-backup-restore` [*options*] <*backup-dir*>
  14. Options
  15. =======
  16. .. option:: --help, -h
  17. Show this help message and exit
  18. .. option:: --verbose, -v
  19. Increase verbosity
  20. .. option:: --quiet, -q
  21. Decrease verbosity
  22. .. option:: --verify-only
  23. Do not restore the data, only verify backup integrity
  24. .. option:: --skip-broken
  25. Do not restore VMs that have missing templates or netvms
  26. .. option:: --ignore-missing
  27. Ignore missing templates or netvms, restore VMs anyway
  28. .. option:: --skip-conflicting
  29. Do not restore VMs that are already present on the host
  30. .. option:: --rename-conflicting
  31. Restore VMs that are already present on the host under different names
  32. .. option:: --exclude=EXCLUDE, -x EXCLUDE
  33. Skip restore of specified VM (might be repeated)
  34. .. option:: --skip-dom0-home
  35. Do not restore dom0 user home dir
  36. .. option:: --ignore-username-mismatch
  37. Ignore dom0 username mismatch while restoring homedir
  38. .. option:: --ignore-size-limit
  39. Backup metadata contains expected size of each VM. By default if backup
  40. contains more data than expected, it is rejected. Use this option to ignore
  41. this limit and restore such (broken, or potentially malicious) backup
  42. anyway.
  43. .. option:: --compression-filter, -Z
  44. Force specific compression filter, instead of the one named in the backup
  45. header. The compression filter is a command that accepts ``-d`` option to
  46. decompress data on stdin and output it to stdout. This can be used to
  47. override built-in protection against uncommon compression.
  48. .. option:: --dest-vm=APPVM, -d APPVM
  49. Restore from a backup located in a specific AppVM
  50. .. option:: --passphrase-file, -p
  51. Read passphrase from file, or use '-' to read from stdin
  52. .. option:: --location-is-service
  53. Provided backup location is a qrexec service name (optionally with an
  54. argument, separated by ``+``), instead of file path or a command.
  55. .. option:: --paranoid-mode, --plan-b
  56. Isolate restore process in a DisposableVM, defend against potentially
  57. compromised backup. In this mode some parts of the backup are skipped,
  58. specifically:
  59. - dom0 home directory (desktop environment settings)
  60. - PCI devices assignments
  61. .. option:: --auto-close
  62. When running with --paranoid-mode (see above), automatically close restore
  63. progress window after the restore process is finished and display restore log
  64. on the standard output. The log will be colored red if the standard output is
  65. a terminal.
  66. Authors
  67. =======
  68. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  69. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  70. | Marek Marczykowski <marmarek at invisiblethingslab dot com>