qvm-pool.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. .. program:: qvm-pool
  2. :program:`qvm-pool` -- manage pools
  3. ===================================
  4. Synopsis
  5. --------
  6. :command:`qvm-pool` [-h] [--verbose] [--quiet] [--help-drivers] [-o options] [-l | -i *NAME* | -a *NAME* *DRIVER* | -r *NAME*]
  7. Options
  8. -------
  9. .. option:: --help, -h
  10. Show this help message and exit
  11. .. option:: --quiet, -q
  12. Be quiet
  13. .. option:: --verbose, -v
  14. Increase verbosity
  15. .. option:: --help-drivers
  16. List all known drivers with their options. The listed driver options can be
  17. used with the ``-o options`` switch.
  18. .. option:: -o options
  19. Comma separated list of driver options. See ``--help-drivers`` for a list of
  20. driver options.
  21. .. option:: --list, -l
  22. List all pools.
  23. .. option:: --info NAME, -i NAME
  24. Show information about a pool
  25. .. option:: --add NAME DRIVER, -a NAME DRIVER
  26. Add a pool. For supported drivers and their options see ``--help-drivers``.
  27. Most of the drivers expect some kind of options.
  28. .. option:: --remove NAME, -r NAME
  29. Remove a pool. This removes only the information about the pool in
  30. qubes.xml, but does not delete any content (FIXME: is it really true for
  31. all pool drivers?).
  32. .. option:: --set NAME, -s NAME
  33. Modify a pool. This set options of a pool. Use ``--o`` to specify actual modifications.
  34. Examples
  35. --------
  36. Create a pool backed by the `file` driver.
  37. ::
  38. qvm-pool -o dir_path=/mnt/foo -a foo file
  39. Authors
  40. -------
  41. | Bahtiar \`kalkin-\` Gadimov <bahtiar at gadimov dot de>