qvm-backup.rst 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. .. program:: qvm-backup
  2. :program:`qvm-backup` -- None
  3. =============================
  4. Synopsis
  5. --------
  6. :command:`qvm-backup` skel-manpage.py [-h] [--verbose] [--quiet] [--force-root] [--exclude EXCLUDE_LIST] [--dest-vm *APPVM*] [--encrypt] [--no-encrypt] [--passphrase-file PASS_FILE] [--enc-algo CRYPTO_ALGORITHM] [--hmac-algo HMAC_ALGORITHM] [--compress] [--compress-filter COMPRESS_FILTER] [--tmpdir *TMPDIR*] backup_location [vms [vms ...]]
  7. Options
  8. -------
  9. .. option:: --help, -h
  10. show this help message and exit
  11. .. option:: --verbose, -v
  12. increase verbosity
  13. .. option:: --quiet, -q
  14. decrease verbosity
  15. .. option:: --force-root
  16. force to run as root
  17. .. option:: --exclude, -x
  18. Exclude the specified VM from the backup (may be repeated)
  19. .. option:: --dest-vm, -d
  20. Specify the destination VM to which the backup will be sent (implies -e)
  21. .. option:: --encrypt, -e
  22. Encrypt the backup
  23. .. option:: --no-encrypt
  24. Skip encryption even if sending the backup to a VM
  25. .. option:: --passphrase-file, -p
  26. Read passphrase from a file, or use '-' to read from stdin
  27. .. option:: --enc-algo, -E
  28. Specify a non-default encryption algorithm. For a list of supported algorithms, execute 'openssl list-cipher-algorithms' (implies -e)
  29. .. option:: --hmac-algo, -H
  30. Specify a non-default HMAC algorithm. For a list of supported algorithms, execute 'openssl list-message-digest-algorithms'
  31. .. option:: --compress, -z
  32. Compress the backup
  33. .. option:: --compress-filter, -Z
  34. Specify a non-default compression filter program (default: gzip)
  35. .. option:: --tmpdir
  36. Specify a temporary directory (if you have at least 1GB free RAM in dom0, use of /tmp is advised) (default: /var/tmp)
  37. Arguments
  38. ---------
  39. The first positional parameter is the backup location (directory path, or
  40. command to pipe backup to). After that you may specify the qubes you'd like to
  41. backup. If not specified, all qubes with `include_in_backups` property set are
  42. included.
  43. Authors
  44. -------
  45. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  46. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  47. | Marek Marczykowski <marmarek at invisiblethingslab dot com>
  48. | Wojtek Porczyk <woju at invisiblethingslab dot com>
  49. .. vim: ts=3 sw=3 et tw=80