qvm-device.rst 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. .. program:: qvm-device
  2. =============================================
  3. :program:`qvm-device` -- List/set VM devices
  4. =============================================
  5. Synopsis
  6. ========
  7. | :command:`qvm-device` [*options*] *DEVICE_CLASS* {list,ls,l} <*vm-name*>
  8. | :command:`qvm-device` [*options*] *DEVICE_CLASS* {attach,at,a} <*vm-name*> <*device*>
  9. | :command:`qvm-device` [*options*] *DEVICE_CLASS* {detach,dt,d} <*vm-name*> <*device*>
  10. Options
  11. =======
  12. .. option:: --help, -h
  13. Show this help message and exit
  14. .. option:: --verbose, -v
  15. increase verbosity
  16. .. option:: --quiet, -q
  17. decrease verbosity
  18. Commands
  19. ========
  20. list
  21. ^^^^
  22. | :command:`qvm-device` *DEVICE_CLASS* list [-h] [--verbose] [--quiet] [*VMNAME* [*VMNAME* ...]]
  23. List devices.
  24. .. option:: --all
  25. List devices from all qubes. You can use :option:`--exclude` to limit the
  26. qubes set.
  27. .. option:: --exclude
  28. Exclude the qube from :option:`--all`.
  29. aliases: ls, l
  30. attach
  31. ^^^^^^
  32. | :command:`qvm-device` *DEVICE_CLASS* attach [-h] [--verbose] [--quiet] [--ro] *VMNAME* *BACKEND_DOMAIN:DEVICE_ID*
  33. Attach the device with *DEVICE_ID* from *BACKEND_DOMAIN* to the domain *VMNAME*
  34. .. option:: --option, -o
  35. Specify device-class specific option, use `name=value` format. You can
  36. specify this option multiple times. See below for options specific to
  37. different device classes.
  38. .. option:: --persistent, -p
  39. Attach device persistently, which means have it attached also after qube restart.
  40. aliases: a, at
  41. detach
  42. ^^^^^^
  43. | :command:`qvm-device` *DEVICE_CLASS* detach [-h] [--verbose] [--quiet] *VMNAME* *BACKEND_DOMAIN:DEVICE_ID*
  44. Detach the device with *BACKEND_DOMAIN:DEVICE_ID* from domain *VMNAME*
  45. aliases: d, dt
  46. Device classes
  47. ==============
  48. block
  49. ^^^^^
  50. Block device. Available options:
  51. * `frontend-dev` - device node in target domain, by default first available, starting from `xvdi`
  52. * `read-only` - attach device in read-only mode; default depends on device, if possible - attach read-write; if device itself is read-only, only read-only attach is allowed
  53. * `devtype` - type of device - either `disk` or `cdrom`; default: `disk`
  54. usb
  55. ^^^
  56. USB device. This type of device does not support options.
  57. pci
  58. ^^^
  59. PCI device. Only dom0 expose such devices. One should be very careful when attaching this type of devices, because some of them are strictly required to stay in dom0 (for example host bridge). Available options:
  60. * `no-strict-reset` - allow to attach device even if it does not support any reliable reset operation; switching such device to another domain (without full host restart) can be a security risk; default: `False`, accepted values: `True`, `False` (option absent)
  61. Authors
  62. =======
  63. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  64. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  65. | Marek Marczykowski <marmarek at invisiblethingslab dot com>