qvm-prefs.rst 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. .. program:: qvm-prefs
  2. :program:`qvm-prefs` -- List/set various per-VM properties
  3. ==========================================================
  4. Synopsis
  5. --------
  6. :command:`qvm-prefs` qvm-prefs [-h] [--xml *XMLFILE*] [--verbose] [--quiet] [--force-root] [--help-properties] *VMNAME* [*PROPERTY* [*VALUE*\|--delete]]
  7. Options
  8. -------
  9. .. option:: --help, -h
  10. Show help message and exit.
  11. .. option:: --help-properties
  12. List available properties with short descriptions and exit.
  13. .. option:: --qubesxml=XMLFILE
  14. Qubes OS store file.
  15. .. option:: --verbose, -v
  16. Increase verbosity.
  17. .. option:: --quiet, -q
  18. Decrease verbosity.
  19. .. option:: --force-root
  20. Force to run as root.
  21. .. option:: --unset, --default, --delete, -D
  22. Unset the property. If is has default value, it will be used instead.
  23. Common properties
  24. =================
  25. This list is non-exhaustive. For authoritative listing, see
  26. :option:`--help-properties` and documentation of the source code.
  27. .. warning::
  28. This list is from the core2. It is wrong in many cases, some of them obvious,
  29. some of them not.
  30. include_in_backups
  31. Accepted values: ``True``, ``False``
  32. Control whenever this VM will be included in backups by default (for now
  33. works only in qubes-manager). You can always manually select or
  34. deselect any VM for backup.
  35. pcidevs
  36. PCI devices assigned to the VM. Should be edited using qvm-pci tool.
  37. pci_strictreset
  38. Accepted values: ``True``, ``False``
  39. Control whether prevent assigning to VM a device which does not support any
  40. reset method. Generally such devices should not be assigned to any VM,
  41. because there will be no way to reset device state after VM shutdown, so
  42. the device could attack next VM to which it will be assigned. But in some
  43. cases it could make sense - for example when the VM to which it is assigned
  44. is trusted one, or is running all the time.
  45. label
  46. Accepted values: ``red``, ``orange``, ``yellow``, ``green``, ``gray``,
  47. ``blue``, ``purple``, ``black``
  48. Color of VM label (icon, appmenus, windows border). If VM is running,
  49. change will be applied at first VM restart.
  50. netvm
  51. Accepted values: netvm name, ``default``, ``none``
  52. To which NetVM connect. Setting to ``default`` will follow system-global
  53. default NetVM (managed by qubes-prefs). Setting to ``none`` will disable
  54. networking in this VM.
  55. dispvm_netvm
  56. Accepted values: netvm name, ``default``, ``none``
  57. Which NetVM should be used for Disposable VMs started by this one.
  58. ``default`` is to use the same NetVM as the VM itself.
  59. maxmem
  60. Accepted values: memory size in MB
  61. Maximum memory size available for this VM. Dynamic memory management (aka
  62. qmemman) will not be able to balloon over this limit. For VMs with
  63. qmemman disabled, this will be overridden by *memory* property (at VM
  64. startup).
  65. memory
  66. Accepted values: memory size in MB
  67. Initial memory size for VM. This should be large enough to allow VM startup
  68. - before qmemman starts managing memory for this VM. For VM with qmemman
  69. disabled, this is static memory size.
  70. kernel
  71. Accepted values: kernel version, ``default``, ``none``
  72. Kernel version to use (only for PV VMs). Available kernel versions will be
  73. listed when no value given (there are in /var/lib/qubes/vm-kernels).
  74. Setting to ``default`` will follow system-global default kernel (managed
  75. via qubes-prefs). Setting to ``none`` will use "kernels" subdir in
  76. VM directory - this allows having VM-specific kernel; also this the only
  77. case when /lib/modules is writable from within VM.
  78. template
  79. Accepted values: TemplateVM name
  80. TemplateVM on which VM base. It can be changed only when VM isn't running.
  81. vcpus
  82. Accepted values: no of CPUs
  83. Number of CPU (cores) available to VM. Some VM types (eg DispVM) will not
  84. work properly with more than one CPU.
  85. kernelopts
  86. Accepted values: string, ``default``
  87. VM kernel parameters (available only for PV VMs). This can be used to
  88. workaround some hardware specific problems (eg for NetVM). Setting to
  89. ``default`` will use some reasonable defaults (currently different for VMs
  90. with PCI devices and without). For VM without PCI devices
  91. ``default`` option means inherit this value from the VM template (if any).
  92. Some helpful options (for debugging purposes): ``earlyprintk=xen``,
  93. ``init=/bin/bash``
  94. name
  95. Accepted values: alphanumerical name
  96. Name of the VM. Can be only changed when VM isn't running.
  97. drive
  98. Accepted values: [hd:\|cdrom:][backend-vm:]path
  99. Additional drive for the VM (available only for HVMs). This can be used to
  100. attach installation image. ``path`` can be file or physical device (eg.
  101. :file:`/dev/sr0`). The same syntax can be used in
  102. :option:`qvm-start --drive` - to attach drive only temporarily.
  103. mac
  104. Accepted values: MAC address, ``auto``
  105. Can be used to force specific of virtual ethernet card in the VM. Setting
  106. to ``auto`` will use automatic-generated MAC - based on VM id. Especially
  107. useful when licensing requires a static MAC address.
  108. For template-based HVM ``auto`` mode means to clone template MAC.
  109. default_user
  110. Accepted values: username
  111. Default user used by :manpage:`qvm-run(1)`. Note that it make sense only on
  112. non-standard template, as the standard one always have "user" account.
  113. debug
  114. Accepted values: ``on``, ``off``
  115. Enables debug mode for VM. This can be used to turn on/off verbose logging
  116. in many Qubes components at once (gui virtualization, VM kernel, some other
  117. services).
  118. For template-based HVM, enabling debug mode also disables automatic reset
  119. :file:`root.img` (actually :file:`volatile.img`) before each VM startup, so
  120. changes made to root filesystem stays intact. To force reset
  121. :file:`root.img` when debug mode enabled, either change something in the
  122. template (simple start+stop will do, even touch its :file:`root.img` is
  123. enough), or remove VM's :file:`volatile.img` (check the path with
  124. :manpage:`qvm-prefs(1)`).
  125. qrexec_installed
  126. Accepted values: ``True``, ``False``
  127. This HVM have qrexec agent installed. When VM have qrexec agent installed,
  128. one can use qvm-run to start VM process, VM will benefit from Qubes RPC
  129. services (like file copy, or inter-vm clipboard). This option will be
  130. automatically turned on during Qubes Windows Tools installation, but if you
  131. install qrexec agent in some other OS, you need to turn this option on
  132. manually.
  133. guiagent_installed
  134. Accepted values: ``True``, ``False``
  135. This HVM have gui agent installed. This option disables full screen GUI
  136. virtualization and enables per-window seemless GUI mode. This option will
  137. be automatically turned on during Qubes Windows Tools installation, but if
  138. you install Qubes gui agent in some other OS, you need to turn this option
  139. on manually. You can turn this option off to troubleshoot some early HVM OS
  140. boot problems (enter safe mode etc), but the option will be automatically
  141. enabled at first VM normal startup (and will take effect from the next
  142. startup).
  143. .. note::
  144. when Windows GUI agent is installed in the VM, SVGA device (used to
  145. full screen video) is disabled, so even if you disable this option, you
  146. will not get functional full desktop access (on normal VM startup). Use
  147. some other means for that (VNC, RDP or so).
  148. autostart
  149. Accepted values: ``True``, ``False``
  150. Start the VM during system startup. The default netvm is autostarted
  151. regardless of this setting.
  152. timezone
  153. Accepted values: ``localtime``, time offset in seconds
  154. Set emulated HVM clock timezone. Use ``localtime`` (the default) to use the
  155. same time as dom0 have. Note that HVM will get only clock value, not the
  156. timezone itself, so if you use ``localtime`` setting, OS inside of HVM
  157. should also be configured to treat hardware clock as local time (and have
  158. proper timezone set).
  159. Authors
  160. -------
  161. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  162. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  163. | Marek Marczykowski <marmarek at invisiblethingslab dot com>
  164. | Wojtek Porczyk <woju at invisiblethingslab dot com>
  165. .. vim: ts=3 sw=3 et tw=80