qvm-device.rst 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  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.
  37. .. option:: --persistent, -p
  38. Attach device persistently, which means have it attached also after qube restart.
  39. aliases: a, at
  40. detach
  41. ^^^^^^
  42. | :command:`qvm-device` *DEVICE_CLASS* detach [-h] [--verbose] [--quiet] *VMNAME* *BACKEND_DOMAIN:DEVICE_ID*
  43. Detach the device with *BACKEND_DOMAIN:DEVICE_ID* from domain *VMNAME*
  44. aliases: d, dt
  45. Device classes
  46. ==============
  47. * block - block devices
  48. * usb - USB devices
  49. * pci - PCI devices
  50. Authors
  51. =======
  52. | Joanna Rutkowska <joanna at invisiblethingslab dot com>
  53. | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
  54. | Marek Marczykowski <marmarek at invisiblethingslab dot com>