qvm-pool.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. .. program:: qvm-pool
  2. :program:`qvm-pool` -- Manage pools
  3. ===================================
  4. Synopsis
  5. --------
  6. | :command:`qvm-pool` {add,a} [*options*] <*pool_name*> <*driver*>
  7. | :command:`qvm-pool` {drivers,d} [*options*]
  8. | :command:`qvm-pool` {info,i} [*options*] <*pool_name*>
  9. | :command:`qvm-pool` {list,ls,l} [*options*]
  10. | :command:`qvm-pool` {remove,rm,i} [*options*] <*pool_name*> ...
  11. | :command:`qvm-pool` {set,s} [*options*] <*pool_name*>
  12. Options
  13. -------
  14. .. option:: --help, -h
  15. Show this help message and exit
  16. .. option:: --quiet, -q
  17. Be quiet
  18. .. option:: --verbose, -v
  19. Increase verbosity
  20. Commands
  21. --------
  22. add
  23. ^^^
  24. | :command:`qvm-pool add` [-h] [--verbose] [--quiet] *POOL_NAME* *DRIVER*
  25. Add a new pool.
  26. .. option:: --option, -o
  27. Set option for the driver in `name=value` format. You can specify this
  28. option multiple times. For supported drivers and their options,
  29. see ``drivers``.
  30. aliases: a
  31. drivers
  32. ^^^^^^^
  33. | :command:`qvm-pool drivers` [-h] [--verbose] [--quiet]
  34. List all known drivers with their options.
  35. The listed driver options can be used with the ``-o options`` switch.
  36. aliases: d
  37. info
  38. ^^^^
  39. | :command:`qvm-pool info` [-h] [--verbose] [--quiet] *POOL_NAME*
  40. Print info about a specified pool
  41. aliases: i
  42. list
  43. ^^^^
  44. | :command:`qvm-pool list` [-h] [--verbose] [--quiet]
  45. List all available pools.
  46. aliases: l, ls
  47. remove
  48. ^^^^^^
  49. | :command:`qvm-pool remove` [-h] [--verbose] [--quiet] *POOL_NAME* [*POOL_NAME* ...]
  50. Remove the specified pools. This removes only the information about the pool
  51. from qubes.xml, but does not delete any content (FIXME: is it really true for
  52. all pool drivers?).
  53. aliases: r, rm
  54. set
  55. ^^^
  56. | :command:`qvm-pool set` [-h] [--verbose] [--quiet] *POOL_NAME*
  57. Modify driver options for a pool.
  58. .. option:: --option, -o
  59. Set option for the driver in `name=value` format. You can specify this
  60. option multiple times. For supported drivers and their options,
  61. see ``drivers``.
  62. aliases: s
  63. Examples
  64. --------
  65. Create a pool backed by the `file` driver.
  66. ::
  67. qvm-pool add foo file -o dir_path=/mnt/foo
  68. Authors
  69. -------
  70. | Bahtiar \`kalkin-\` Gadimov <bahtiar at gadimov dot de>
  71. | Saswat Padhi <padhi at cs dot ucla dot edu>