You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

qemu-options.hx 191KB

  1. HXCOMM Use DEFHEADING() to define headings in both help text and texi
  2. HXCOMM Text between STEXI and ETEXI are copied to texi version and
  3. HXCOMM discarded from C version
  4. HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to
  5. HXCOMM construct option structures, enums and help message for specified
  6. HXCOMM architectures.
  7. HXCOMM HXCOMM can be used for comments, discarded from both texi and C
  8. DEFHEADING(Standard options:)
  9. STEXI
  10. @table @option
  11. ETEXI
  12. DEF("help", 0, QEMU_OPTION_h,
  13. "-h or -help display this help and exit\n", QEMU_ARCH_ALL)
  14. STEXI
  15. @item -h
  16. @findex -h
  17. Display help and exit
  18. ETEXI
  19. DEF("version", 0, QEMU_OPTION_version,
  20. "-version display version information and exit\n", QEMU_ARCH_ALL)
  21. STEXI
  22. @item -version
  23. @findex -version
  24. Display version information and exit
  25. ETEXI
  26. DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
  27. "-machine [type=]name[,prop[=value][,...]]\n"
  28. " selects emulated machine ('-machine help' for list)\n"
  29. " property accel=accel1[:accel2[:...]] selects accelerator\n"
  30. " supported accelerators are kvm, xen, hax, hvf, whpx or tcg (default: tcg)\n"
  31. " kernel_irqchip=on|off|split controls accelerated irqchip support (default=off)\n"
  32. " vmport=on|off|auto controls emulation of vmport (default: auto)\n"
  33. " kvm_shadow_mem=size of KVM shadow MMU in bytes\n"
  34. " dump-guest-core=on|off include guest memory in a core dump (default=on)\n"
  35. " mem-merge=on|off controls memory merge support (default: on)\n"
  36. " igd-passthru=on|off controls IGD GFX passthrough support (default=off)\n"
  37. " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n"
  38. " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n"
  39. " suppress-vmdesc=on|off disables self-describing migration (default=off)\n"
  40. " nvdimm=on|off controls NVDIMM support (default=off)\n"
  41. " enforce-config-section=on|off enforce configuration section migration (default=off)\n"
  42. " memory-encryption=@var{} memory encryption object to use (default=none)\n",
  44. STEXI
  45. @item -machine [type=]@var{name}[,prop=@var{value}[,...]]
  46. @findex -machine
  47. Select the emulated machine by @var{name}. Use @code{-machine help} to list
  48. available machines.
  49. For architectures which aim to support live migration compatibility
  50. across releases, each release will introduce a new versioned machine
  51. type. For example, the 2.8.0 release introduced machine types
  52. ``pc-i440fx-2.8'' and ``pc-q35-2.8'' for the x86_64/i686 architectures.
  53. To allow live migration of guests from QEMU version 2.8.0, to QEMU
  54. version 2.9.0, the 2.9.0 version must support the ``pc-i440fx-2.8''
  55. and ``pc-q35-2.8'' machines too. To allow users live migrating VMs
  56. to skip multiple intermediate releases when upgrading, new releases
  57. of QEMU will support machine types from many previous versions.
  58. Supported machine properties are:
  59. @table @option
  60. @item accel=@var{accels1}[:@var{accels2}[:...]]
  61. This is used to enable an accelerator. Depending on the target architecture,
  62. kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used. If there is
  63. more than one accelerator specified, the next one is used if the previous one
  64. fails to initialize.
  65. @item kernel_irqchip=on|off
  66. Controls in-kernel irqchip support for the chosen accelerator when available.
  67. @item gfx_passthru=on|off
  68. Enables IGD GFX passthrough support for the chosen machine when available.
  69. @item vmport=on|off|auto
  70. Enables emulation of VMWare IO port, for vmmouse etc. auto says to select the
  71. value based on accel. For accel=xen the default is off otherwise the default
  72. is on.
  73. @item kvm_shadow_mem=size
  74. Defines the size of the KVM shadow MMU.
  75. @item dump-guest-core=on|off
  76. Include guest memory in a core dump. The default is on.
  77. @item mem-merge=on|off
  78. Enables or disables memory merge support. This feature, when supported by
  79. the host, de-duplicates identical memory pages among VMs instances
  80. (enabled by default).
  81. @item aes-key-wrap=on|off
  82. Enables or disables AES key wrapping support on s390-ccw hosts. This feature
  83. controls whether AES wrapping keys will be created to allow
  84. execution of AES cryptographic functions. The default is on.
  85. @item dea-key-wrap=on|off
  86. Enables or disables DEA key wrapping support on s390-ccw hosts. This feature
  87. controls whether DEA wrapping keys will be created to allow
  88. execution of DEA cryptographic functions. The default is on.
  89. @item nvdimm=on|off
  90. Enables or disables NVDIMM support. The default is off.
  91. @item enforce-config-section=on|off
  92. If @option{enforce-config-section} is set to @var{on}, force migration
  93. code to send configuration section even if the machine-type sets the
  94. @option{migration.send-configuration} property to @var{off}.
  95. NOTE: this parameter is deprecated. Please use @option{-global}
  96. @option{migration.send-configuration}=@var{on|off} instead.
  97. @item memory-encryption=@var{}
  98. Memory encryption object to use. The default is none.
  99. @end table
  100. ETEXI
  101. HXCOMM Deprecated by -machine
  103. DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
  104. "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL)
  105. STEXI
  106. @item -cpu @var{model}
  107. @findex -cpu
  108. Select CPU model (@code{-cpu help} for list and additional feature selection)
  109. ETEXI
  110. DEF("accel", HAS_ARG, QEMU_OPTION_accel,
  111. "-accel [accel=]accelerator[,thread=single|multi]\n"
  112. " select accelerator (kvm, xen, hax, hvf, whpx or tcg; use 'help' for a list)\n"
  113. " thread=single|multi (enable multi-threaded TCG)\n", QEMU_ARCH_ALL)
  114. STEXI
  115. @item -accel @var{name}[,prop=@var{value}[,...]]
  116. @findex -accel
  117. This is used to enable an accelerator. Depending on the target architecture,
  118. kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used. If there is
  119. more than one accelerator specified, the next one is used if the previous one
  120. fails to initialize.
  121. @table @option
  122. @item thread=single|multi
  123. Controls number of TCG threads. When the TCG is multi-threaded there will be one
  124. thread per vCPU therefor taking advantage of additional host cores. The default
  125. is to enable multi-threading where both the back-end and front-ends support it and
  126. no incompatible TCG features have been enabled (e.g. icount/replay).
  127. @end table
  128. ETEXI
  129. DEF("smp", HAS_ARG, QEMU_OPTION_smp,
  130. "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,dies=dies][,sockets=sockets]\n"
  131. " set the number of CPUs to 'n' [default=1]\n"
  132. " maxcpus= maximum number of total cpus, including\n"
  133. " offline CPUs for hotplug, etc\n"
  134. " cores= number of CPU cores on one socket (for PC, it's on one die)\n"
  135. " threads= number of threads on one CPU core\n"
  136. " dies= number of CPU dies on one socket (for PC only)\n"
  137. " sockets= number of discrete sockets in the system\n",
  139. STEXI
  140. @item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,dies=dies][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
  141. @findex -smp
  142. Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
  143. CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
  144. to 4.
  145. For the PC target, the number of @var{cores} per die, the number of @var{threads}
  146. per cores, the number of @var{dies} per packages and the total number of
  147. @var{sockets} can be specified. Missing values will be computed.
  148. If any on the three values is given, the total number of CPUs @var{n} can be omitted.
  149. @var{maxcpus} specifies the maximum number of hotpluggable CPUs.
  150. ETEXI
  151. DEF("numa", HAS_ARG, QEMU_OPTION_numa,
  152. "-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node]\n"
  153. "-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node]\n"
  154. "-numa dist,src=source,dst=destination,val=distance\n"
  155. "-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]\n",
  157. STEXI
  158. @item -numa node[,mem=@var{size}][,cpus=@var{firstcpu}[-@var{lastcpu}]][,nodeid=@var{node}]
  159. @itemx -numa node[,memdev=@var{id}][,cpus=@var{firstcpu}[-@var{lastcpu}]][,nodeid=@var{node}]
  160. @itemx -numa dist,src=@var{source},dst=@var{destination},val=@var{distance}
  161. @itemx -numa cpu,node-id=@var{node}[,socket-id=@var{x}][,core-id=@var{y}][,thread-id=@var{z}]
  162. @findex -numa
  163. Define a NUMA node and assign RAM and VCPUs to it.
  164. Set the NUMA distance from a source node to a destination node.
  165. Legacy VCPU assignment uses @samp{cpus} option where
  166. @var{firstcpu} and @var{lastcpu} are CPU indexes. Each
  167. @samp{cpus} option represent a contiguous range of CPU indexes
  168. (or a single VCPU if @var{lastcpu} is omitted). A non-contiguous
  169. set of VCPUs can be represented by providing multiple @samp{cpus}
  170. options. If @samp{cpus} is omitted on all nodes, VCPUs are automatically
  171. split between them.
  172. For example, the following option assigns VCPUs 0, 1, 2 and 5 to
  173. a NUMA node:
  174. @example
  175. -numa node,cpus=0-2,cpus=5
  176. @end example
  177. @samp{cpu} option is a new alternative to @samp{cpus} option
  178. which uses @samp{socket-id|core-id|thread-id} properties to assign
  179. CPU objects to a @var{node} using topology layout properties of CPU.
  180. The set of properties is machine specific, and depends on used
  181. machine type/@samp{smp} options. It could be queried with
  182. @samp{hotpluggable-cpus} monitor command.
  183. @samp{node-id} property specifies @var{node} to which CPU object
  184. will be assigned, it's required for @var{node} to be declared
  185. with @samp{node} option before it's used with @samp{cpu} option.
  186. For example:
  187. @example
  188. -M pc \
  189. -smp 1,sockets=2,maxcpus=2 \
  190. -numa node,nodeid=0 -numa node,nodeid=1 \
  191. -numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1
  192. @end example
  193. @samp{mem} assigns a given RAM amount to a node. @samp{memdev}
  194. assigns RAM from a given memory backend device to a node. If
  195. @samp{mem} and @samp{memdev} are omitted in all nodes, RAM is
  196. split equally between them.
  197. @samp{mem} and @samp{memdev} are mutually exclusive. Furthermore,
  198. if one node uses @samp{memdev}, all of them have to use it.
  199. @var{source} and @var{destination} are NUMA node IDs.
  200. @var{distance} is the NUMA distance from @var{source} to @var{destination}.
  201. The distance from a node to itself is always 10. If any pair of nodes is
  202. given a distance, then all pairs must be given distances. Although, when
  203. distances are only given in one direction for each pair of nodes, then
  204. the distances in the opposite directions are assumed to be the same. If,
  205. however, an asymmetrical pair of distances is given for even one node
  206. pair, then all node pairs must be provided distance values for both
  207. directions, even when they are symmetrical. When a node is unreachable
  208. from another node, set the pair's distance to 255.
  209. Note that the -@option{numa} option doesn't allocate any of the
  210. specified resources, it just assigns existing resources to NUMA
  211. nodes. This means that one still has to use the @option{-m},
  212. @option{-smp} options to allocate RAM and VCPUs respectively.
  213. ETEXI
  214. DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
  215. "-add-fd fd=fd,set=set[,opaque=opaque]\n"
  216. " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL)
  217. STEXI
  218. @item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
  219. @findex -add-fd
  220. Add a file descriptor to an fd set. Valid options are:
  221. @table @option
  222. @item fd=@var{fd}
  223. This option defines the file descriptor of which a duplicate is added to fd set.
  224. The file descriptor cannot be stdin, stdout, or stderr.
  225. @item set=@var{set}
  226. This option defines the ID of the fd set to add the file descriptor to.
  227. @item opaque=@var{opaque}
  228. This option defines a free-form string that can be used to describe @var{fd}.
  229. @end table
  230. You can open an image using pre-opened file descriptors from an fd set:
  231. @example
  232. qemu-system-i386
  233. -add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
  234. -add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
  235. -drive file=/dev/fdset/2,index=0,media=disk
  236. @end example
  237. ETEXI
  238. DEF("set", HAS_ARG, QEMU_OPTION_set,
  239. "-set\n"
  240. " set <arg> parameter for item <id> of type <group>\n"
  241. " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
  242. STEXI
  243. @item -set @var{group}.@var{id}.@var{arg}=@var{value}
  244. @findex -set
  245. Set parameter @var{arg} for item @var{id} of type @var{group}
  246. ETEXI
  247. DEF("global", HAS_ARG, QEMU_OPTION_global,
  248. "-global\n"
  249. "-global driver=driver,property=property,value=value\n"
  250. " set a global default for a driver property\n",
  252. STEXI
  253. @item -global @var{driver}.@var{prop}=@var{value}
  254. @itemx -global driver=@var{driver},property=@var{property},value=@var{value}
  255. @findex -global
  256. Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
  257. @example
  258. qemu-system-i386 -global ide-hd.physical_block_size=4096 disk-image.img
  259. @end example
  260. In particular, you can use this to set driver properties for devices which are
  261. created automatically by the machine model. To create a device which is not
  262. created automatically and set properties on it, use -@option{device}.
  263. -global @var{driver}.@var{prop}=@var{value} is shorthand for -global
  264. driver=@var{driver},property=@var{prop},value=@var{value}. The
  265. longhand syntax works even when @var{driver} contains a dot.
  266. ETEXI
  267. DEF("boot", HAS_ARG, QEMU_OPTION_boot,
  268. "-boot [order=drives][,once=drives][,menu=on|off]\n"
  269. " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n"
  270. " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
  271. " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
  272. " 'sp_time': the period that splash picture last if menu=on, unit is ms\n"
  273. " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n",
  275. STEXI
  276. @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}][,strict=on|off]
  277. @findex -boot
  278. Specify boot order @var{drives} as a string of drive letters. Valid
  279. drive letters depend on the target architecture. The x86 PC uses: a, b
  280. (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
  281. from network adapter 1-4), hard disk boot is the default. To apply a
  282. particular boot order only on the first startup, specify it via
  283. @option{once}. Note that the @option{order} or @option{once} parameter
  284. should not be used together with the @option{bootindex} property of
  285. devices, since the firmware implementations normally do not support both
  286. at the same time.
  287. Interactive boot menus/prompts can be enabled via @option{menu=on} as far
  288. as firmware/BIOS supports them. The default is non-interactive boot.
  289. A splash picture could be passed to bios, enabling user to show it as logo,
  290. when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
  291. supports them. Currently Seabios for X86 system support it.
  292. limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
  293. format(true color). The resolution should be supported by the SVGA mode, so
  294. the recommended is 320x240, 640x480, 800x640.
  295. A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
  296. when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
  297. reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
  298. system support it.
  299. Do strict boot via @option{strict=on} as far as firmware/BIOS
  300. supports it. This only effects when boot priority is changed by
  301. bootindex options. The default is non-strict boot.
  302. @example
  303. # try to boot from network first, then from hard disk
  304. qemu-system-i386 -boot order=nc
  305. # boot from CD-ROM first, switch back to default order after reboot
  306. qemu-system-i386 -boot once=d
  307. # boot with a splash picture for 5 seconds.
  308. qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
  309. @end example
  310. Note: The legacy format '-boot @var{drives}' is still supported but its
  311. use is discouraged as it may be removed from future versions.
  312. ETEXI
  313. DEF("m", HAS_ARG, QEMU_OPTION_m,
  314. "-m [size=]megs[,slots=n,maxmem=size]\n"
  315. " configure guest RAM\n"
  316. " size: initial amount of guest memory\n"
  317. " slots: number of hotplug slots (default: none)\n"
  318. " maxmem: maximum amount of guest memory (default: none)\n"
  319. "NOTE: Some architectures might enforce a specific granularity\n",
  321. STEXI
  322. @item -m [size=]@var{megs}[,slots=n,maxmem=size]
  323. @findex -m
  324. Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB.
  325. Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in
  326. megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem}
  327. could be used to set amount of hotpluggable memory slots and maximum amount of
  328. memory. Note that @var{maxmem} must be aligned to the page size.
  329. For example, the following command-line sets the guest startup RAM size to
  330. 1GB, creates 3 slots to hotplug additional memory and sets the maximum
  331. memory the guest can reach to 4GB:
  332. @example
  333. qemu-system-x86_64 -m 1G,slots=3,maxmem=4G
  334. @end example
  335. If @var{slots} and @var{maxmem} are not specified, memory hotplug won't
  336. be enabled and the guest startup RAM will never increase.
  337. ETEXI
  338. DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
  339. "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
  340. STEXI
  341. @item -mem-path @var{path}
  342. @findex -mem-path
  343. Allocate guest RAM from a temporarily created file in @var{path}.
  344. ETEXI
  345. DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
  346. "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
  348. STEXI
  349. @item -mem-prealloc
  350. @findex -mem-prealloc
  351. Preallocate memory when using -mem-path.
  352. ETEXI
  353. DEF("k", HAS_ARG, QEMU_OPTION_k,
  354. "-k language use keyboard layout (for example 'fr' for French)\n",
  356. STEXI
  357. @item -k @var{language}
  358. @findex -k
  359. Use keyboard layout @var{language} (for example @code{fr} for
  360. French). This option is only needed where it is not easy to get raw PC
  361. keycodes (e.g. on Macs, with some X11 servers or with a VNC or curses
  362. display). You don't normally need to use it on PC/Linux or PC/Windows
  363. hosts.
  364. The available layouts are:
  365. @example
  366. ar de-ch es fo fr-ca hu ja mk no pt-br sv
  367. da en-gb et fr fr-ch is lt nl pl ru th
  368. de en-us fi fr-be hr it lv nl-be pt sl tr
  369. @end example
  370. The default is @code{en-us}.
  371. ETEXI
  372. HXCOMM Deprecated by -audiodev
  373. DEF("audio-help", 0, QEMU_OPTION_audio_help,
  374. "-audio-help show -audiodev equivalent of the currently specified audio settings\n",
  376. STEXI
  377. @item -audio-help
  378. @findex -audio-help
  379. Will show the -audiodev equivalent of the currently specified
  380. (deprecated) environment variables.
  381. ETEXI
  382. DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
  383. "-audiodev [driver=]driver,id=id[,prop[=value][,...]]\n"
  384. " specifies the audio backend to use\n"
  385. " id= identifier of the backend\n"
  386. " timer-period= timer period in microseconds\n"
  387. " in|out.fixed-settings= use fixed settings for host audio\n"
  388. " in|out.frequency= frequency to use with fixed settings\n"
  389. " in|out.channels= number of channels to use with fixed settings\n"
  390. " in|out.format= sample format to use with fixed settings\n"
  391. " valid values: s8, s16, s32, u8, u16, u32\n"
  392. " in|out.voices= number of voices to use\n"
  393. " in|out.buffer-len= length of buffer in microseconds\n"
  394. "-audiodev none,id=id,[,prop[=value][,...]]\n"
  395. " dummy driver that discards all output\n"
  396. #ifdef CONFIG_AUDIO_ALSA
  397. "-audiodev alsa,id=id[,prop[=value][,...]]\n"
  398. " in| name of the audio device to use\n"
  399. " in|out.period-len= length of period in microseconds\n"
  400. " in|out.try-poll= attempt to use poll mode\n"
  401. " threshold= threshold (in microseconds) when playback starts\n"
  402. #endif
  404. "-audiodev coreaudio,id=id[,prop[=value][,...]]\n"
  405. " in|out.buffer-count= number of buffers\n"
  406. #endif
  408. "-audiodev dsound,id=id[,prop[=value][,...]]\n"
  409. " latency= add extra latency to playback in microseconds\n"
  410. #endif
  411. #ifdef CONFIG_AUDIO_OSS
  412. "-audiodev oss,id=id[,prop[=value][,...]]\n"
  413. " in| path of the audio device to use\n"
  414. " in|out.buffer-count= number of buffers\n"
  415. " in|out.try-poll= attempt to use poll mode\n"
  416. " try-mmap= try using memory mapped access\n"
  417. " exclusive= open device in exclusive mode\n"
  418. " dsp-policy= set timing policy (0..10), -1 to use fragment mode\n"
  419. #endif
  420. #ifdef CONFIG_AUDIO_PA
  421. "-audiodev pa,id=id[,prop[=value][,...]]\n"
  422. " server= PulseAudio server address\n"
  423. " in| source/sink device name\n"
  424. #endif
  425. #ifdef CONFIG_AUDIO_SDL
  426. "-audiodev sdl,id=id[,prop[=value][,...]]\n"
  427. #endif
  428. #ifdef CONFIG_SPICE
  429. "-audiodev spice,id=id[,prop[=value][,...]]\n"
  430. #endif
  431. "-audiodev wav,id=id[,prop[=value][,...]]\n"
  432. " path= path of wav file to record\n",
  434. STEXI
  435. @item -audiodev [driver=]@var{driver},id=@var{id}[,@var{prop}[=@var{value}][,...]]
  436. @findex -audiodev
  437. Adds a new audio backend @var{driver} identified by @var{id}. There are
  438. global and driver specific properties. Some values can be set
  439. differently for input and output, they're marked with @code{in|out.}.
  440. You can set the input's property with @code{in.@var{prop}} and the
  441. output's property with @code{out.@var{prop}}. For example:
  442. @example
  443. -audiodev alsa,id=example,in.frequency=44110,out.frequency=8000
  444. -audiodev alsa,id=example,out.channels=1 # leaves in.channels unspecified
  445. @end example
  446. Valid global options are:
  447. @table @option
  448. @item id=@var{identifier}
  449. Identifies the audio backend.
  450. @item timer-period=@var{period}
  451. Sets the timer @var{period} used by the audio subsystem in microseconds.
  452. Default is 10000 (10 ms).
  453. @item in|out.fixed-settings=on|off
  454. Use fixed settings for host audio. When off, it will change based on
  455. how the guest opens the sound card. In this case you must not specify
  456. @var{frequency}, @var{channels} or @var{format}. Default is on.
  457. @item in|out.frequency=@var{frequency}
  458. Specify the @var{frequency} to use when using @var{fixed-settings}.
  459. Default is 44100Hz.
  460. @item in|out.channels=@var{channels}
  461. Specify the number of @var{channels} to use when using
  462. @var{fixed-settings}. Default is 2 (stereo).
  463. @item in|out.format=@var{format}
  464. Specify the sample @var{format} to use when using @var{fixed-settings}.
  465. Valid values are: @code{s8}, @code{s16}, @code{s32}, @code{u8},
  466. @code{u16}, @code{u32}. Default is @code{s16}.
  467. @item in|out.voices=@var{voices}
  468. Specify the number of @var{voices} to use. Default is 1.
  469. @item in|out.buffer=@var{usecs}
  470. Sets the size of the buffer in microseconds.
  471. @end table
  472. @item -audiodev none,id=@var{id}[,@var{prop}[=@var{value}][,...]]
  473. Creates a dummy backend that discards all outputs. This backend has no
  474. backend specific properties.
  475. @item -audiodev alsa,id=@var{id}[,@var{prop}[=@var{value}][,...]]
  476. Creates backend using the ALSA. This backend is only available on
  477. Linux.
  478. ALSA specific options are:
  479. @table @option
  480. @item in|{device}
  481. Specify the ALSA @var{device} to use for input and/or output. Default
  482. is @code{default}.
  483. @item in|out.period-len=@var{usecs}
  484. Sets the period length in microseconds.
  485. @item in|out.try-poll=on|off
  486. Attempt to use poll mode with the device. Default is on.
  487. @item threshold=@var{threshold}
  488. Threshold (in microseconds) when playback starts. Default is 0.
  489. @end table
  490. @item -audiodev coreaudio,id=@var{id}[,@var{prop}[=@var{value}][,...]]
  491. Creates a backend using Apple's Core Audio. This backend is only
  492. available on Mac OS and only supports playback.
  493. Core Audio specific options are:
  494. @table @option
  495. @item in|out.buffer-count=@var{count}
  496. Sets the @var{count} of the buffers.
  497. @end table
  498. @item -audiodev dsound,id=@var{id}[,@var{prop}[=@var{value}][,...]]
  499. Creates a backend using Microsoft's DirectSound. This backend is only
  500. available on Windows and only supports playback.
  501. DirectSound specific options are:
  502. @table @option
  503. @item latency=@var{usecs}
  504. Add extra @var{usecs} microseconds latency to playback. Default is
  505. 10000 (10 ms).
  506. @end table
  507. @item -audiodev oss,id=@var{id}[,@var{prop}[=@var{value}][,...]]
  508. Creates a backend using OSS. This backend is available on most
  509. Unix-like systems.
  510. OSS specific options are:
  511. @table @option
  512. @item in|{device}
  513. Specify the file name of the OSS @var{device} to use. Default is
  514. @code{/dev/dsp}.
  515. @item in|out.buffer-count=@var{count}
  516. Sets the @var{count} of the buffers.
  517. @item in|out.try-poll=on|of
  518. Attempt to use poll mode with the device. Default is on.
  519. @item try-mmap=on|off
  520. Try using memory mapped device access. Default is off.
  521. @item exclusive=on|off
  522. Open the device in exclusive mode (vmix won't work in this case).
  523. Default is off.
  524. @item dsp-policy=@var{policy}
  525. Sets the timing policy (between 0 and 10, where smaller number means
  526. smaller latency but higher CPU usage). Use -1 to use buffer sizes
  527. specified by @code{buffer} and @code{buffer-count}. This option is
  528. ignored if you do not have OSS 4. Default is 5.
  529. @end table
  530. @item -audiodev pa,id=@var{id}[,@var{prop}[=@var{value}][,...]]
  531. Creates a backend using PulseAudio. This backend is available on most
  532. systems.
  533. PulseAudio specific options are:
  534. @table @option
  535. @item server=@var{server}
  536. Sets the PulseAudio @var{server} to connect to.
  537. @item in|{sink}
  538. Use the specified source/sink for recording/playback.
  539. @end table
  540. @item -audiodev sdl,id=@var{id}[,@var{prop}[=@var{value}][,...]]
  541. Creates a backend using SDL. This backend is available on most systems,
  542. but you should use your platform's native backend if possible. This
  543. backend has no backend specific properties.
  544. @item -audiodev spice,id=@var{id}[,@var{prop}[=@var{value}][,...]]
  545. Creates a backend that sends audio through SPICE. This backend requires
  546. @code{-spice} and automatically selected in that case, so usually you
  547. can ignore this option. This backend has no backend specific
  548. properties.
  549. @item -audiodev wav,id=@var{id}[,@var{prop}[=@var{value}][,...]]
  550. Creates a backend that writes audio to a WAV file.
  551. Backend specific options are:
  552. @table @option
  553. @item path=@var{path}
  554. Write recorded audio into the specified file. Default is
  555. @code{qemu.wav}.
  556. @end table
  557. ETEXI
  558. DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
  559. "-soundhw c1,... enable audio support\n"
  560. " and only specified sound cards (comma separated list)\n"
  561. " use '-soundhw help' to get the list of supported cards\n"
  562. " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL)
  563. STEXI
  564. @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
  565. @findex -soundhw
  566. Enable audio and selected sound hardware. Use 'help' to print all
  567. available sound hardware.
  568. @example
  569. qemu-system-i386 -soundhw sb16,adlib disk.img
  570. qemu-system-i386 -soundhw es1370 disk.img
  571. qemu-system-i386 -soundhw ac97 disk.img
  572. qemu-system-i386 -soundhw hda disk.img
  573. qemu-system-i386 -soundhw all disk.img
  574. qemu-system-i386 -soundhw help
  575. @end example
  576. Note that Linux's i810_audio OSS kernel (for AC97) module might
  577. require manually specifying clocking.
  578. @example
  579. modprobe i810_audio clocking=48000
  580. @end example
  581. ETEXI
  582. DEF("device", HAS_ARG, QEMU_OPTION_device,
  583. "-device driver[,prop[=value][,...]]\n"
  584. " add device (based on driver)\n"
  585. " prop=value,... sets driver properties\n"
  586. " use '-device help' to print all possible drivers\n"
  587. " use '-device driver,help' to print all possible properties\n",
  589. STEXI
  590. @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
  591. @findex -device
  592. Add device @var{driver}. @var{prop}=@var{value} sets driver
  593. properties. Valid properties depend on the driver. To get help on
  594. possible drivers and properties, use @code{-device help} and
  595. @code{-device @var{driver},help}.
  596. Some drivers are:
  597. @item -device ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}][,sdrfile=@var{file}][,furareasize=@var{val}][,furdatafile=@var{file}]
  598. Add an IPMI BMC. This is a simulation of a hardware management
  599. interface processor that normally sits on a system. It provides
  600. a watchdog and the ability to reset and power control the system.
  601. You need to connect this to an IPMI interface to make it useful
  602. The IPMI slave address to use for the BMC. The default is 0x20.
  603. This address is the BMC's address on the I2C network of management
  604. controllers. If you don't know what this means, it is safe to ignore
  605. it.
  606. @table @option
  607. @item bmc=@var{id}
  608. The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above.
  609. @item slave_addr=@var{val}
  610. Define slave address to use for the BMC. The default is 0x20.
  611. @item sdrfile=@var{file}
  612. file containing raw Sensor Data Records (SDR) data. The default is none.
  613. @item fruareasize=@var{val}
  614. size of a Field Replaceable Unit (FRU) area. The default is 1024.
  615. @item frudatafile=@var{file}
  616. file containing raw Field Replaceable Unit (FRU) inventory data. The default is none.
  617. @end table
  618. @item -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}]
  619. Add a connection to an external IPMI BMC simulator. Instead of
  620. locally emulating the BMC like the above item, instead connect
  621. to an external entity that provides the IPMI services.
  622. A connection is made to an external BMC simulator. If you do this, it
  623. is strongly recommended that you use the "reconnect=" chardev option
  624. to reconnect to the simulator if the connection is lost. Note that if
  625. this is not used carefully, it can be a security issue, as the
  626. interface has the ability to send resets, NMIs, and power off the VM.
  627. It's best if QEMU makes a connection to an external simulator running
  628. on a secure port on localhost, so neither the simulator nor QEMU is
  629. exposed to any outside network.
  630. See the "lanserv/README.vm" file in the OpenIPMI library for more
  631. details on the external interface.
  632. @item -device isa-ipmi-kcs,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}]
  633. Add a KCS IPMI interafce on the ISA bus. This also adds a
  634. corresponding ACPI and SMBIOS entries, if appropriate.
  635. @table @option
  636. @item bmc=@var{id}
  637. The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above.
  638. @item ioport=@var{val}
  639. Define the I/O address of the interface. The default is 0xca0 for KCS.
  640. @item irq=@var{val}
  641. Define the interrupt to use. The default is 5. To disable interrupts,
  642. set this to 0.
  643. @end table
  644. @item -device isa-ipmi-bt,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}]
  645. Like the KCS interface, but defines a BT interface. The default port is
  646. 0xe4 and the default interrupt is 5.
  647. ETEXI
  648. DEF("name", HAS_ARG, QEMU_OPTION_name,
  649. "-name string1[,process=string2][,debug-threads=on|off]\n"
  650. " set the name of the guest\n"
  651. " string1 sets the window title and string2 the process name\n"
  652. " When debug-threads is enabled, individual threads are given a separate name\n"
  653. " NOTE: The thread names are for debugging and not a stable API.\n",
  655. STEXI
  656. @item -name @var{name}
  657. @findex -name
  658. Sets the @var{name} of the guest.
  659. This name will be displayed in the SDL window caption.
  660. The @var{name} will also be used for the VNC server.
  661. Also optionally set the top visible process name in Linux.
  662. Naming of individual threads can also be enabled on Linux to aid debugging.
  663. ETEXI
  664. DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
  665. "-uuid %08x-%04x-%04x-%04x-%012x\n"
  666. " specify machine UUID\n", QEMU_ARCH_ALL)
  667. STEXI
  668. @item -uuid @var{uuid}
  669. @findex -uuid
  670. Set system UUID.
  671. ETEXI
  672. STEXI
  673. @end table
  674. ETEXI
  676. DEFHEADING(Block device options:)
  677. STEXI
  678. @table @option
  679. ETEXI
  680. DEF("fda", HAS_ARG, QEMU_OPTION_fda,
  681. "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
  682. DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
  683. STEXI
  684. @item -fda @var{file}
  685. @itemx -fdb @var{file}
  686. @findex -fda
  687. @findex -fdb
  688. Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}).
  689. ETEXI
  690. DEF("hda", HAS_ARG, QEMU_OPTION_hda,
  691. "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
  692. DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
  693. DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
  694. "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
  695. DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
  696. STEXI
  697. @item -hda @var{file}
  698. @itemx -hdb @var{file}
  699. @itemx -hdc @var{file}
  700. @itemx -hdd @var{file}
  701. @findex -hda
  702. @findex -hdb
  703. @findex -hdc
  704. @findex -hdd
  705. Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
  706. ETEXI
  707. DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
  708. "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
  710. STEXI
  711. @item -cdrom @var{file}
  712. @findex -cdrom
  713. Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
  714. @option{-cdrom} at the same time). You can use the host CD-ROM by
  715. using @file{/dev/cdrom} as filename (@pxref{host_drives}).
  716. ETEXI
  717. DEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev,
  718. "-blockdev [driver=]driver[,node-name=N][,discard=ignore|unmap]\n"
  719. " [,|off][,|off]\n"
  720. " [,read-only=on|off][,detect-zeroes=on|off|unmap]\n"
  721. " [,driver specific parameters...]\n"
  722. " configure a block backend\n", QEMU_ARCH_ALL)
  723. STEXI
  724. @item -blockdev @var{option}[,@var{option}[,@var{option}[,...]]]
  725. @findex -blockdev
  726. Define a new block driver node. Some of the options apply to all block drivers,
  727. other options are only accepted for a specific block driver. See below for a
  728. list of generic options and options for the most common block drivers.
  729. Options that expect a reference to another node (e.g. @code{file}) can be
  730. given in two ways. Either you specify the node name of an already existing node
  731. (file=@var{node-name}), or you define a new node inline, adding options
  732. for the referenced node after a dot (file.filename=@var{path},file.aio=native).
  733. A block driver node created with @option{-blockdev} can be used for a guest
  734. device by specifying its node name for the @code{drive} property in a
  735. @option{-device} argument that defines a block device.
  736. @table @option
  737. @item Valid options for any block driver node:
  738. @table @code
  739. @item driver
  740. Specifies the block driver to use for the given node.
  741. @item node-name
  742. This defines the name of the block driver node by which it will be referenced
  743. later. The name must be unique, i.e. it must not match the name of a different
  744. block driver node, or (if you use @option{-drive} as well) the ID of a drive.
  745. If no node name is specified, it is automatically generated. The generated node
  746. name is not intended to be predictable and changes between QEMU invocations.
  747. For the top level, an explicit node name must be specified.
  748. @item read-only
  749. Open the node read-only. Guest write attempts will fail.
  750. @item
  751. The host page cache can be avoided with @option{}. This will
  752. attempt to do disk IO directly to the guest's memory. QEMU may still perform an
  753. internal copy of the data.
  754. @item
  755. In case you don't care about data integrity over host failures, you can use
  756. @option{}. This option tells QEMU that it never needs to write
  757. any data to the disk but can instead keep things in cache. If anything goes
  758. wrong, like your host losing power, the disk storage getting disconnected
  759. accidentally, etc. your image will most probably be rendered unusable.
  760. @item discard=@var{discard}
  761. @var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls
  762. whether @code{discard} (also known as @code{trim} or @code{unmap}) requests are
  763. ignored or passed to the filesystem. Some machine types may not support
  764. discard requests.
  765. @item detect-zeroes=@var{detect-zeroes}
  766. @var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic
  767. conversion of plain zero writes by the OS to driver specific optimized
  768. zero write commands. You may even choose "unmap" if @var{discard} is set
  769. to "unmap" to allow a zero write to be converted to an @code{unmap} operation.
  770. @end table
  771. @item Driver-specific options for @code{file}
  772. This is the protocol-level block driver for accessing regular files.
  773. @table @code
  774. @item filename
  775. The path to the image file in the local filesystem
  776. @item aio
  777. Specifies the AIO backend (threads/native, default: threads)
  778. @item locking
  779. Specifies whether the image file is protected with Linux OFD / POSIX locks. The
  780. default is to use the Linux Open File Descriptor API if available, otherwise no
  781. lock is applied. (auto/on/off, default: auto)
  782. @end table
  783. Example:
  784. @example
  785. -blockdev driver=file,node-name=disk,filename=disk.img
  786. @end example
  787. @item Driver-specific options for @code{raw}
  788. This is the image format block driver for raw images. It is usually
  789. stacked on top of a protocol level block driver such as @code{file}.
  790. @table @code
  791. @item file
  792. Reference to or definition of the data source block driver node
  793. (e.g. a @code{file} driver node)
  794. @end table
  795. Example 1:
  796. @example
  797. -blockdev driver=file,node-name=disk_file,filename=disk.img
  798. -blockdev driver=raw,node-name=disk,file=disk_file
  799. @end example
  800. Example 2:
  801. @example
  802. -blockdev driver=raw,node-name=disk,file.driver=file,file.filename=disk.img
  803. @end example
  804. @item Driver-specific options for @code{qcow2}
  805. This is the image format block driver for qcow2 images. It is usually
  806. stacked on top of a protocol level block driver such as @code{file}.
  807. @table @code
  808. @item file
  809. Reference to or definition of the data source block driver node
  810. (e.g. a @code{file} driver node)
  811. @item backing
  812. Reference to or definition of the backing file block device (default is taken
  813. from the image file). It is allowed to pass @code{null} here in order to disable
  814. the default backing file.
  815. @item lazy-refcounts
  816. Whether to enable the lazy refcounts feature (on/off; default is taken from the
  817. image file)
  818. @item cache-size
  819. The maximum total size of the L2 table and refcount block caches in bytes
  820. (default: the sum of l2-cache-size and refcount-cache-size)
  821. @item l2-cache-size
  822. The maximum size of the L2 table cache in bytes
  823. (default: if cache-size is not specified - 32M on Linux platforms, and 8M on
  824. non-Linux platforms; otherwise, as large as possible within the cache-size,
  825. while permitting the requested or the minimal refcount cache size)
  826. @item refcount-cache-size
  827. The maximum size of the refcount block cache in bytes
  828. (default: 4 times the cluster size; or if cache-size is specified, the part of
  829. it which is not used for the L2 cache)
  830. @item cache-clean-interval
  831. Clean unused entries in the L2 and refcount caches. The interval is in seconds.
  832. The default value is 600 on supporting platforms, and 0 on other platforms.
  833. Setting it to 0 disables this feature.
  834. @item pass-discard-request
  835. Whether discard requests to the qcow2 device should be forwarded to the data
  836. source (on/off; default: on if discard=unmap is specified, off otherwise)
  837. @item pass-discard-snapshot
  838. Whether discard requests for the data source should be issued when a snapshot
  839. operation (e.g. deleting a snapshot) frees clusters in the qcow2 file (on/off;
  840. default: on)
  841. @item pass-discard-other
  842. Whether discard requests for the data source should be issued on other
  843. occasions where a cluster gets freed (on/off; default: off)
  844. @item overlap-check
  845. Which overlap checks to perform for writes to the image
  846. (none/constant/cached/all; default: cached). For details or finer
  847. granularity control refer to the QAPI documentation of @code{blockdev-add}.
  848. @end table
  849. Example 1:
  850. @example
  851. -blockdev driver=file,node-name=my_file,filename=/tmp/disk.qcow2
  852. -blockdev driver=qcow2,node-name=hda,file=my_file,overlap-check=none,cache-size=16777216
  853. @end example
  854. Example 2:
  855. @example
  856. -blockdev driver=qcow2,node-name=disk,file.driver=http,file.filename=
  857. @end example
  858. @item Driver-specific options for other drivers
  859. Please refer to the QAPI documentation of the @code{blockdev-add} QMP command.
  860. @end table
  861. ETEXI
  862. DEF("drive", HAS_ARG, QEMU_OPTION_drive,
  863. "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
  864. " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
  865. " [,snapshot=on|off][,rerror=ignore|stop|report]\n"
  866. " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n"
  867. " [,readonly=on|off][,copy-on-read=on|off]\n"
  868. " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n"
  869. " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n"
  870. " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n"
  871. " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n"
  872. " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n"
  873. " [[,iops_size=is]]\n"
  874. " [[,group=g]]\n"
  875. " use 'file' as a drive image\n", QEMU_ARCH_ALL)
  876. STEXI
  877. @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
  878. @findex -drive
  879. Define a new drive. This includes creating a block driver node (the backend) as
  880. well as a guest device, and is mostly a shortcut for defining the corresponding
  881. @option{-blockdev} and @option{-device} options.
  882. @option{-drive} accepts all options that are accepted by @option{-blockdev}. In
  883. addition, it knows the following options:
  884. @table @option
  885. @item file=@var{file}
  886. This option defines which disk image (@pxref{disk_images}) to use with
  887. this drive. If the filename contains comma, you must double it
  888. (for instance, "file=my,,file" to use file "my,file").
  889. Special files such as iSCSI devices can be specified using protocol
  890. specific URLs. See the section for "Device URL Syntax" for more information.
  891. @item if=@var{interface}
  892. This option defines on which type on interface the drive is connected.
  893. Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio, none.
  894. @item bus=@var{bus},unit=@var{unit}
  895. These options define where is connected the drive by defining the bus number and
  896. the unit id.
  897. @item index=@var{index}
  898. This option defines where is connected the drive by using an index in the list
  899. of available connectors of a given interface type.
  900. @item media=@var{media}
  901. This option defines the type of the media: disk or cdrom.
  902. @item snapshot=@var{snapshot}
  903. @var{snapshot} is "on" or "off" and controls snapshot mode for the given drive
  904. (see @option{-snapshot}).
  905. @item cache=@var{cache}
  906. @var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough"
  907. and controls how the host cache is used to access block data. This is a
  908. shortcut that sets the @option{} and @option{}
  909. options (as in @option{-blockdev}), and additionally @option{cache.writeback},
  910. which provides a default for the @option{write-cache} option of block guest
  911. devices (as in @option{-device}). The modes correspond to the following
  912. settings:
  913. @c Our script doesn't support @multitable, so fall back to using
  914. @c plain ASCII art (well, UTF-8 art really). This looks okay both in the manpage
  915. @c and the HTML output.
  916. @example
  917. @ │ cache.writeback
  918. ─────────────┼─────────────────────────────────────────────────
  919. writeback │ on off off
  920. none │ on on off
  921. writethrough │ off off off
  922. directsync │ off on off
  923. unsafe │ on off on
  924. @end example
  925. The default mode is @option{cache=writeback}.
  926. @item aio=@var{aio}
  927. @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
  928. @item format=@var{format}
  929. Specify which disk @var{format} will be used rather than detecting
  930. the format. Can be used to specify format=raw to avoid interpreting
  931. an untrusted format header.
  932. @item werror=@var{action},rerror=@var{action}
  933. Specify which @var{action} to take on write and read errors. Valid actions are:
  934. "ignore" (ignore the error and try to continue), "stop" (pause QEMU),
  935. "report" (report the error to the guest), "enospc" (pause QEMU only if the
  936. host disk is full; report the error to the guest otherwise).
  937. The default setting is @option{werror=enospc} and @option{rerror=report}.
  938. @item copy-on-read=@var{copy-on-read}
  939. @var{copy-on-read} is "on" or "off" and enables whether to copy read backing
  940. file sectors into the image file.
  941. @item bps=@var{b},bps_rd=@var{r},bps_wr=@var{w}
  942. Specify bandwidth throttling limits in bytes per second, either for all request
  943. types or for reads or writes only. Small values can lead to timeouts or hangs
  944. inside the guest. A safe minimum for disks is 2 MB/s.
  945. @item bps_max=@var{bm},bps_rd_max=@var{rm},bps_wr_max=@var{wm}
  946. Specify bursts in bytes per second, either for all request types or for reads
  947. or writes only. Bursts allow the guest I/O to spike above the limit
  948. temporarily.
  949. @item iops=@var{i},iops_rd=@var{r},iops_wr=@var{w}
  950. Specify request rate limits in requests per second, either for all request
  951. types or for reads or writes only.
  952. @item iops_max=@var{bm},iops_rd_max=@var{rm},iops_wr_max=@var{wm}
  953. Specify bursts in requests per second, either for all request types or for reads
  954. or writes only. Bursts allow the guest I/O to spike above the limit
  955. temporarily.
  956. @item iops_size=@var{is}
  957. Let every @var{is} bytes of a request count as a new request for iops
  958. throttling purposes. Use this option to prevent guests from circumventing iops
  959. limits by sending fewer but larger requests.
  960. @item group=@var{g}
  961. Join a throttling quota group with given name @var{g}. All drives that are
  962. members of the same group are accounted for together. Use this option to
  963. prevent guests from circumventing throttling limits by using many small disks
  964. instead of a single larger disk.
  965. @end table
  966. By default, the @option{cache.writeback=on} mode is used. It will report data
  967. writes as completed as soon as the data is present in the host page cache.
  968. This is safe as long as your guest OS makes sure to correctly flush disk caches
  969. where needed. If your guest OS does not handle volatile disk write caches
  970. correctly and your host crashes or loses power, then the guest may experience
  971. data corruption.
  972. For such guests, you should consider using @option{cache.writeback=off}. This
  973. means that the host page cache will be used to read and write data, but write
  974. notification will be sent to the guest only after QEMU has made sure to flush
  975. each write to the disk. Be aware that this has a major impact on performance.
  976. When using the @option{-snapshot} option, unsafe caching is always used.
  977. Copy-on-read avoids accessing the same backing file sectors repeatedly and is
  978. useful when the backing file is over a slow network. By default copy-on-read
  979. is off.
  980. Instead of @option{-cdrom} you can use:
  981. @example
  982. qemu-system-i386 -drive file=file,index=2,media=cdrom
  983. @end example
  984. Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
  985. use:
  986. @example
  987. qemu-system-i386 -drive file=file,index=0,media=disk
  988. qemu-system-i386 -drive file=file,index=1,media=disk
  989. qemu-system-i386 -drive file=file,index=2,media=disk
  990. qemu-system-i386 -drive file=file,index=3,media=disk
  991. @end example
  992. You can open an image using pre-opened file descriptors from an fd set:
  993. @example
  994. qemu-system-i386
  995. -add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
  996. -add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
  997. -drive file=/dev/fdset/2,index=0,media=disk
  998. @end example
  999. You can connect a CDROM to the slave of ide0:
  1000. @example
  1001. qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom
  1002. @end example
  1003. If you don't specify the "file=" argument, you define an empty drive:
  1004. @example
  1005. qemu-system-i386 -drive if=ide,index=1,media=cdrom
  1006. @end example
  1007. Instead of @option{-fda}, @option{-fdb}, you can use:
  1008. @example
  1009. qemu-system-i386 -drive file=file,index=0,if=floppy
  1010. qemu-system-i386 -drive file=file,index=1,if=floppy
  1011. @end example
  1012. By default, @var{interface} is "ide" and @var{index} is automatically
  1013. incremented:
  1014. @example
  1015. qemu-system-i386 -drive file=a -drive file=b"
  1016. @end example
  1017. is interpreted like:
  1018. @example
  1019. qemu-system-i386 -hda a -hdb b
  1020. @end example
  1021. ETEXI
  1022. DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
  1023. "-mtdblock file use 'file' as on-board Flash memory image\n",
  1024. QEMU_ARCH_ALL)
  1025. STEXI
  1026. @item -mtdblock @var{file}
  1027. @findex -mtdblock
  1028. Use @var{file} as on-board Flash memory image.
  1029. ETEXI
  1030. DEF("sd", HAS_ARG, QEMU_OPTION_sd,
  1031. "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
  1032. STEXI
  1033. @item -sd @var{file}
  1034. @findex -sd
  1035. Use @var{file} as SecureDigital card image.
  1036. ETEXI
  1037. DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
  1038. "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
  1039. STEXI
  1040. @item -pflash @var{file}
  1041. @findex -pflash
  1042. Use @var{file} as a parallel flash image.
  1043. ETEXI
  1044. DEF("snapshot", 0, QEMU_OPTION_snapshot,
  1045. "-snapshot write to temporary files instead of disk image files\n",
  1046. QEMU_ARCH_ALL)
  1047. STEXI
  1048. @item -snapshot
  1049. @findex -snapshot
  1050. Write to temporary files instead of disk image files. In this case,
  1051. the raw disk image you use is not written back. You can however force
  1052. the write back by pressing @key{C-a s} (@pxref{disk_images}).
  1053. ETEXI
  1054. DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
  1055. "-fsdev local,id=id,path=path,security_model=mapped-xattr|mapped-file|passthrough|none\n"
  1056. " [,writeout=immediate][,readonly][,fmode=fmode][,dmode=dmode]\n"
  1057. " [[,throttling.bps-total=b]|[[,throttling.bps-read=r][,throttling.bps-write=w]]]\n"
  1058. " [[,throttling.iops-total=i]|[[,throttling.iops-read=r][,throttling.iops-write=w]]]\n"
  1059. " [[,throttling.bps-total-max=bm]|[[,throttling.bps-read-max=rm][,throttling.bps-write-max=wm]]]\n"
  1060. " [[,throttling.iops-total-max=im]|[[,throttling.iops-read-max=irm][,throttling.iops-write-max=iwm]]]\n"
  1061. " [[,throttling.iops-size=is]]\n"
  1062. "-fsdev proxy,id=id,socket=socket[,writeout=immediate][,readonly]\n"
  1063. "-fsdev proxy,id=id,sock_fd=sock_fd[,writeout=immediate][,readonly]\n"
  1064. "-fsdev synth,id=id\n",
  1065. QEMU_ARCH_ALL)
  1066. STEXI
  1067. @item -fsdev local,id=@var{id},path=@var{path},security_model=@var{security_model} [,writeout=@var{writeout}][,readonly][,fmode=@var{fmode}][,dmode=@var{dmode}] [,throttling.@var{option}=@var{value}[,throttling.@var{option}=@var{value}[,...]]]
  1068. @itemx -fsdev proxy,id=@var{id},socket=@var{socket}[,writeout=@var{writeout}][,readonly]
  1069. @itemx -fsdev proxy,id=@var{id},sock_fd=@var{sock_fd}[,writeout=@var{writeout}][,readonly]
  1070. @itemx -fsdev synth,id=@var{id}[,readonly]
  1071. @findex -fsdev
  1072. Define a new file system device. Valid options are:
  1073. @table @option
  1074. @item local
  1075. Accesses to the filesystem are done by QEMU.
  1076. @item proxy
  1077. Accesses to the filesystem are done by virtfs-proxy-helper(1).
  1078. @item synth
  1079. Synthetic filesystem, only used by QTests.
  1080. @item id=@var{id}
  1081. Specifies identifier for this device.
  1082. @item path=@var{path}
  1083. Specifies the export path for the file system device. Files under
  1084. this path will be available to the 9p client on the guest.
  1085. @item security_model=@var{security_model}
  1086. Specifies the security model to be used for this export path.
  1087. Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
  1088. In "passthrough" security model, files are stored using the same
  1089. credentials as they are created on the guest. This requires QEMU
  1090. to run as root. In "mapped-xattr" security model, some of the file
  1091. attributes like uid, gid, mode bits and link target are stored as
  1092. file attributes. For "mapped-file" these attributes are stored in the
  1093. hidden .virtfs_metadata directory. Directories exported by this security model cannot
  1094. interact with other unix tools. "none" security model is same as
  1095. passthrough except the sever won't report failures if it fails to
  1096. set file attributes like ownership. Security model is mandatory
  1097. only for local fsdriver. Other fsdrivers (like proxy) don't take
  1098. security model as a parameter.
  1099. @item writeout=@var{writeout}
  1100. This is an optional argument. The only supported value is "immediate".
  1101. This means that host page cache will be used to read and write data but
  1102. write notification will be sent to the guest only when the data has been
  1103. reported as written by the storage subsystem.
  1104. @item readonly
  1105. Enables exporting 9p share as a readonly mount for guests. By default
  1106. read-write access is given.
  1107. @item socket=@var{socket}
  1108. Enables proxy filesystem driver to use passed socket file for communicating
  1109. with virtfs-proxy-helper(1).
  1110. @item sock_fd=@var{sock_fd}
  1111. Enables proxy filesystem driver to use passed socket descriptor for
  1112. communicating with virtfs-proxy-helper(1). Usually a helper like libvirt
  1113. will create socketpair and pass one of the fds as sock_fd.
  1114. @item fmode=@var{fmode}
  1115. Specifies the default mode for newly created files on the host. Works only
  1116. with security models "mapped-xattr" and "mapped-file".
  1117. @item dmode=@var{dmode}
  1118. Specifies the default mode for newly created directories on the host. Works
  1119. only with security models "mapped-xattr" and "mapped-file".
  1120. @item throttling.bps-total=@var{b},throttling.bps-read=@var{r},throttling.bps-write=@var{w}
  1121. Specify bandwidth throttling limits in bytes per second, either for all request
  1122. types or for reads or writes only.
  1123. @item throttling.bps-total-max=@var{bm},bps-read-max=@var{rm},bps-write-max=@var{wm}
  1124. Specify bursts in bytes per second, either for all request types or for reads
  1125. or writes only. Bursts allow the guest I/O to spike above the limit
  1126. temporarily.
  1127. @item throttling.iops-total=@var{i},throttling.iops-read=@var{r}, throttling.iops-write=@var{w}
  1128. Specify request rate limits in requests per second, either for all request
  1129. types or for reads or writes only.
  1130. @item throttling.iops-total-max=@var{im},throttling.iops-read-max=@var{irm}, throttling.iops-write-max=@var{iwm}
  1131. Specify bursts in requests per second, either for all request types or for reads
  1132. or writes only. Bursts allow the guest I/O to spike above the limit temporarily.
  1133. @item throttling.iops-size=@var{is}
  1134. Let every @var{is} bytes of a request count as a new request for iops
  1135. throttling purposes.
  1136. @end table
  1137. -fsdev option is used along with -device driver "virtio-9p-...".
  1138. @item -device virtio-9p-@var{type},fsdev=@var{id},mount_tag=@var{mount_tag}
  1139. Options for virtio-9p-... driver are:
  1140. @table @option
  1141. @item @var{type}
  1142. Specifies the variant to be used. Supported values are "pci", "ccw" or "device",
  1143. depending on the machine type.
  1144. @item fsdev=@var{id}
  1145. Specifies the id value specified along with -fsdev option.
  1146. @item mount_tag=@var{mount_tag}
  1147. Specifies the tag name to be used by the guest to mount this export point.
  1148. @end table
  1149. ETEXI
  1150. DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
  1151. "-virtfs local,path=path,mount_tag=tag,security_model=mapped-xattr|mapped-file|passthrough|none\n"
  1152. " [,id=id][,writeout=immediate][,readonly][,fmode=fmode][,dmode=dmode]\n"
  1153. "-virtfs proxy,mount_tag=tag,socket=socket[,id=id][,writeout=immediate][,readonly]\n"
  1154. "-virtfs proxy,mount_tag=tag,sock_fd=sock_fd[,id=id][,writeout=immediate][,readonly]\n"
  1155. "-virtfs synth,mount_tag=tag[,id=id][,readonly]\n",
  1156. QEMU_ARCH_ALL)
  1157. STEXI
  1158. @item -virtfs local,path=@var{path},mount_tag=@var{mount_tag} ,security_model=@var{security_model}[,writeout=@var{writeout}][,readonly] [,fmode=@var{fmode}][,dmode=@var{dmode}]
  1159. @itemx -virtfs proxy,socket=@var{socket},mount_tag=@var{mount_tag} [,writeout=@var{writeout}][,readonly]
  1160. @itemx -virtfs proxy,sock_fd=@var{sock_fd},mount_tag=@var{mount_tag} [,writeout=@var{writeout}][,readonly]
  1161. @itemx -virtfs synth,mount_tag=@var{mount_tag}
  1162. @findex -virtfs
  1163. Define a new filesystem device and expose it to the guest using a virtio-9p-device. The general form of a Virtual File system pass-through options are:
  1164. @table @option
  1165. @item local
  1166. Accesses to the filesystem are done by QEMU.
  1167. @item proxy
  1168. Accesses to the filesystem are done by virtfs-proxy-helper(1).
  1169. @item synth
  1170. Synthetic filesystem, only used by QTests.
  1171. @item id=@var{id}
  1172. Specifies identifier for the filesystem device
  1173. @item path=@var{path}
  1174. Specifies the export path for the file system device. Files under
  1175. this path will be available to the 9p client on the guest.
  1176. @item security_model=@var{security_model}
  1177. Specifies the security model to be used for this export path.
  1178. Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
  1179. In "passthrough" security model, files are stored using the same
  1180. credentials as they are created on the guest. This requires QEMU
  1181. to run as root. In "mapped-xattr" security model, some of the file
  1182. attributes like uid, gid, mode bits and link target are stored as
  1183. file attributes. For "mapped-file" these attributes are stored in the
  1184. hidden .virtfs_metadata directory. Directories exported by this security model cannot
  1185. interact with other unix tools. "none" security model is same as
  1186. passthrough except the sever won't report failures if it fails to
  1187. set file attributes like ownership. Security model is mandatory only
  1188. for local fsdriver. Other fsdrivers (like proxy) don't take security
  1189. model as a parameter.
  1190. @item writeout=@var{writeout}
  1191. This is an optional argument. The only supported value is "immediate".
  1192. This means that host page cache will be used to read and write data but
  1193. write notification will be sent to the guest only when the data has been
  1194. reported as written by the storage subsystem.
  1195. @item readonly
  1196. Enables exporting 9p share as a readonly mount for guests. By default
  1197. read-write access is given.
  1198. @item socket=@var{socket}
  1199. Enables proxy filesystem driver to use passed socket file for
  1200. communicating with virtfs-proxy-helper(1). Usually a helper like libvirt
  1201. will create socketpair and pass one of the fds as sock_fd.
  1202. @item sock_fd
  1203. Enables proxy filesystem driver to use passed 'sock_fd' as the socket
  1204. descriptor for interfacing with virtfs-proxy-helper(1).
  1205. @item fmode=@var{fmode}
  1206. Specifies the default mode for newly created files on the host. Works only
  1207. with security models "mapped-xattr" and "mapped-file".
  1208. @item dmode=@var{dmode}
  1209. Specifies the default mode for newly created directories on the host. Works
  1210. only with security models "mapped-xattr" and "mapped-file".
  1211. @item mount_tag=@var{mount_tag}
  1212. Specifies the tag name to be used by the guest to mount this export point.
  1213. @end table
  1214. ETEXI
  1215. DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
  1216. "-virtfs_synth Create synthetic file system image\n",
  1217. QEMU_ARCH_ALL)
  1218. STEXI
  1219. @item -virtfs_synth
  1220. @findex -virtfs_synth
  1221. Create synthetic file system image. Note that this option is now deprecated.
  1222. Please use @code{-fsdev synth} and @code{-device virtio-9p-...} instead.
  1223. ETEXI
  1224. DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
  1225. "-iscsi [user=user][,password=password]\n"
  1226. " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n"
  1227. " [,initiator-name=initiator-iqn][,id=target-iqn]\n"
  1228. " [,timeout=timeout]\n"
  1229. " iSCSI session parameters\n", QEMU_ARCH_ALL)
  1230. STEXI
  1231. @item -iscsi
  1232. @findex -iscsi
  1233. Configure iSCSI session parameters.
  1234. ETEXI
  1235. STEXI
  1236. @end table
  1237. ETEXI
  1238. DEFHEADING()
  1239. DEFHEADING(USB options:)
  1240. STEXI
  1241. @table @option
  1242. ETEXI
  1243. DEF("usb", 0, QEMU_OPTION_usb,
  1244. "-usb enable on-board USB host controller (if not enabled by default)\n",
  1245. QEMU_ARCH_ALL)
  1246. STEXI
  1247. @item -usb
  1248. @findex -usb
  1249. Enable USB emulation on machine types with an on-board USB host controller (if
  1250. not enabled by default). Note that on-board USB host controllers may not
  1251. support USB 3.0. In this case @option{-device qemu-xhci} can be used instead
  1252. on machines with PCI.
  1253. ETEXI
  1254. DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
  1255. "-usbdevice name add the host or guest USB device 'name'\n",
  1256. QEMU_ARCH_ALL)
  1257. STEXI
  1258. @item -usbdevice @var{devname}
  1259. @findex -usbdevice
  1260. Add the USB device @var{devname}. Note that this option is deprecated,
  1261. please use @code{-device usb-...} instead. @xref{usb_devices}.
  1262. @table @option
  1263. @item mouse
  1264. Virtual Mouse. This will override the PS/2 mouse emulation when activated.
  1265. @item tablet
  1266. Pointer device that uses absolute coordinates (like a touchscreen). This
  1267. means QEMU is able to report the mouse position without having to grab the
  1268. mouse. Also overrides the PS/2 mouse emulation when activated.
  1269. @item braille
  1270. Braille device. This will use BrlAPI to display the braille output on a real
  1271. or fake device.
  1272. @end table
  1273. ETEXI
  1274. STEXI
  1275. @end table
  1276. ETEXI
  1277. DEFHEADING()
  1278. DEFHEADING(Display options:)
  1279. STEXI
  1280. @table @option
  1281. ETEXI
  1282. DEF("display", HAS_ARG, QEMU_OPTION_display,
  1283. "-display spice-app[,gl=on|off]\n"
  1284. "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
  1285. " [,window_close=on|off][,gl=on|core|es|off]\n"
  1286. "-display gtk[,grab_on_hover=on|off][,gl=on|off]|\n"
  1287. "-display vnc=<display>[,<optargs>]\n"
  1288. "-display curses[,charset=<encoding>]\n"
  1289. "-display none\n"
  1290. "-display egl-headless[,rendernode=<file>]"
  1291. " select display type\n"
  1292. "The default display is equivalent to\n"
  1293. #if defined(CONFIG_GTK)
  1294. "\t\"-display gtk\"\n"
  1295. #elif defined(CONFIG_SDL)
  1296. "\t\"-display sdl\"\n"
  1297. #elif defined(CONFIG_COCOA)
  1298. "\t\"-display cocoa\"\n"
  1299. #elif defined(CONFIG_VNC)
  1300. "\t\"-vnc localhost:0,to=99,id=default\"\n"
  1301. #else
  1302. "\t\"-display none\"\n"
  1303. #endif
  1304. , QEMU_ARCH_ALL)
  1305. STEXI
  1306. @item -display @var{type}
  1307. @findex -display
  1308. Select type of display to use. This option is a replacement for the
  1309. old style -sdl/-curses/... options. Valid values for @var{type} are
  1310. @table @option
  1311. @item sdl
  1312. Display video output via SDL (usually in a separate graphics
  1313. window; see the SDL documentation for other possibilities).
  1314. @item curses
  1315. Display video output via curses. For graphics device models which
  1316. support a text mode, QEMU can display this output using a
  1317. curses/ncurses interface. Nothing is displayed when the graphics
  1318. device is in graphical mode or if the graphics device does not support
  1319. a text mode. Generally only the VGA device models support text mode.
  1320. The font charset used by the guest can be specified with the
  1321. @code{charset} option, for example @code{charset=CP850} for IBM CP850
  1322. encoding. The default is @code{CP437}.
  1323. @item none
  1324. Do not display video output. The guest will still see an emulated
  1325. graphics card, but its output will not be displayed to the QEMU
  1326. user. This option differs from the -nographic option in that it
  1327. only affects what is done with video output; -nographic also changes
  1328. the destination of the serial and parallel port data.
  1329. @item gtk
  1330. Display video output in a GTK window. This interface provides drop-down
  1331. menus and other UI elements to configure and control the VM during
  1332. runtime.
  1333. @item vnc
  1334. Start a VNC server on display <arg>
  1335. @item egl-headless
  1336. Offload all OpenGL operations to a local DRI device. For any graphical display,
  1337. this display needs to be paired with either VNC or SPICE displays.
  1338. @item spice-app
  1339. Start QEMU as a Spice server and launch the default Spice client
  1340. application. The Spice server will redirect the serial consoles and
  1341. QEMU monitors. (Since 4.0)
  1342. @end table
  1343. ETEXI
  1344. DEF("nographic", 0, QEMU_OPTION_nographic,
  1345. "-nographic disable graphical output and redirect serial I/Os to console\n",
  1346. QEMU_ARCH_ALL)
  1347. STEXI
  1348. @item -nographic
  1349. @findex -nographic
  1350. Normally, if QEMU is compiled with graphical window support, it displays
  1351. output such as guest graphics, guest console, and the QEMU monitor in a
  1352. window. With this option, you can totally disable graphical output so
  1353. that QEMU is a simple command line application. The emulated serial port
  1354. is redirected on the console and muxed with the monitor (unless
  1355. redirected elsewhere explicitly). Therefore, you can still use QEMU to
  1356. debug a Linux kernel with a serial console. Use @key{C-a h} for help on
  1357. switching between the console and monitor.
  1358. ETEXI
  1359. DEF("curses", 0, QEMU_OPTION_curses,
  1360. "-curses shorthand for -display curses\n",
  1361. QEMU_ARCH_ALL)
  1362. STEXI
  1363. @item -curses
  1364. @findex -curses
  1365. Normally, if QEMU is compiled with graphical window support, it displays
  1366. output such as guest graphics, guest console, and the QEMU monitor in a
  1367. window. With this option, QEMU can display the VGA output when in text
  1368. mode using a curses/ncurses interface. Nothing is displayed in graphical
  1369. mode.
  1370. ETEXI
  1371. DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
  1372. "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
  1373. QEMU_ARCH_ALL)
  1374. STEXI
  1375. @item -alt-grab
  1376. @findex -alt-grab
  1377. Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
  1378. affects the special keys (for fullscreen, monitor-mode switching, etc).
  1379. ETEXI
  1380. DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
  1381. "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
  1382. QEMU_ARCH_ALL)
  1383. STEXI
  1384. @item -ctrl-grab
  1385. @findex -ctrl-grab
  1386. Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
  1387. affects the special keys (for fullscreen, monitor-mode switching, etc).
  1388. ETEXI
  1389. DEF("no-quit", 0, QEMU_OPTION_no_quit,
  1390. "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
  1391. STEXI
  1392. @item -no-quit
  1393. @findex -no-quit
  1394. Disable SDL window close capability.
  1395. ETEXI
  1396. DEF("sdl", 0, QEMU_OPTION_sdl,
  1397. "-sdl shorthand for -display sdl\n", QEMU_ARCH_ALL)
  1398. STEXI
  1399. @item -sdl
  1400. @findex -sdl
  1401. Enable SDL.
  1402. ETEXI
  1403. DEF("spice", HAS_ARG, QEMU_OPTION_spice,
  1404. "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
  1405. " [,x509-key-file=<file>][,x509-key-password=<file>]\n"
  1406. " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n"
  1407. " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n"
  1408. " [,tls-ciphers=<list>]\n"
  1409. " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n"
  1410. " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n"
  1411. " [,sasl][,password=<secret>][,disable-ticketing]\n"
  1412. " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n"
  1413. " [,jpeg-wan-compression=[auto|never|always]]\n"
  1414. " [,zlib-glz-wan-compression=[auto|never|always]]\n"
  1415. " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n"
  1416. " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n"
  1417. " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n"
  1418. " [,gl=[on|off]][,rendernode=<file>]\n"
  1419. " enable spice\n"
  1420. " at least one of {port, tls-port} is mandatory\n",
  1421. QEMU_ARCH_ALL)
  1422. STEXI
  1423. @item -spice @var{option}[,@var{option}[,...]]
  1424. @findex -spice
  1425. Enable the spice remote desktop protocol. Valid options are
  1426. @table @option
  1427. @item port=<nr>
  1428. Set the TCP port spice is listening on for plaintext channels.
  1429. @item addr=<addr>
  1430. Set the IP address spice is listening on. Default is any address.
  1431. @item ipv4
  1432. @itemx ipv6
  1433. @itemx unix
  1434. Force using the specified IP version.
  1435. @item password=<secret>
  1436. Set the password you need to authenticate.
  1437. @item sasl
  1438. Require that the client use SASL to authenticate with the spice.
  1439. The exact choice of authentication method used is controlled from the
  1440. system / user's SASL configuration file for the 'qemu' service. This
  1441. is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
  1442. unprivileged user, an environment variable SASL_CONF_PATH can be used
  1443. to make it search alternate locations for the service config.
  1444. While some SASL auth methods can also provide data encryption (eg GSSAPI),
  1445. it is recommended that SASL always be combined with the 'tls' and
  1446. 'x509' settings to enable use of SSL and server certificates. This
  1447. ensures a data encryption preventing compromise of authentication
  1448. credentials.
  1449. @item disable-ticketing
  1450. Allow client connects without authentication.
  1451. @item disable-copy-paste
  1452. Disable copy paste between the client and the guest.
  1453. @item disable-agent-file-xfer
  1454. Disable spice-vdagent based file-xfer between the client and the guest.
  1455. @item tls-port=<nr>
  1456. Set the TCP port spice is listening on for encrypted channels.
  1457. @item x509-dir=<dir>
  1458. Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
  1459. @item x509-key-file=<file>
  1460. @itemx x509-key-password=<file>
  1461. @itemx x509-cert-file=<file>
  1462. @itemx x509-cacert-file=<file>
  1463. @itemx x509-dh-key-file=<file>
  1464. The x509 file names can also be configured individually.
  1465. @item tls-ciphers=<list>
  1466. Specify which ciphers to use.
  1467. @item tls-channel=[main|display|cursor|inputs|record|playback]
  1468. @itemx plaintext-channel=[main|display|cursor|inputs|record|playback]
  1469. Force specific channel to be used with or without TLS encryption. The
  1470. options can be specified multiple times to configure multiple
  1471. channels. The special name "default" can be used to set the default
  1472. mode. For channels which are not explicitly forced into one mode the
  1473. spice client is allowed to pick tls/plaintext as he pleases.
  1474. @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
  1475. Configure image compression (lossless).
  1476. Default is auto_glz.
  1477. @item jpeg-wan-compression=[auto|never|always]
  1478. @itemx zlib-glz-wan-compression=[auto|never|always]
  1479. Configure wan image compression (lossy for slow links).
  1480. Default is auto.
  1481. @item streaming-video=[off|all|filter]
  1482. Configure video stream detection. Default is off.
  1483. @item agent-mouse=[on|off]
  1484. Enable/disable passing mouse events via vdagent. Default is on.
  1485. @item playback-compression=[on|off]
  1486. Enable/disable audio stream compression (using celt 0.5.1). Default is on.
  1487. @item seamless-migration=[on|off]
  1488. Enable/disable spice seamless migration. Default is off.
  1489. @item gl=[on|off]
  1490. Enable/disable OpenGL context. Default is off.
  1491. @item rendernode=<file>
  1492. DRM render node for OpenGL rendering. If not specified, it will pick
  1493. the first available. (Since 2.9)
  1494. @end table
  1495. ETEXI
  1496. DEF("portrait", 0, QEMU_OPTION_portrait,
  1497. "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
  1498. QEMU_ARCH_ALL)
  1499. STEXI
  1500. @item -portrait
  1501. @findex -portrait
  1502. Rotate graphical output 90 deg left (only PXA LCD).
  1503. ETEXI
  1504. DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
  1505. "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
  1506. QEMU_ARCH_ALL)
  1507. STEXI
  1508. @item -rotate @var{deg}
  1509. @findex -rotate
  1510. Rotate graphical output some deg left (only PXA LCD).
  1511. ETEXI
  1512. DEF("vga", HAS_ARG, QEMU_OPTION_vga,
  1513. "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n"
  1514. " select video card type\n", QEMU_ARCH_ALL)
  1515. STEXI
  1516. @item -vga @var{type}
  1517. @findex -vga
  1518. Select type of VGA card to emulate. Valid values for @var{type} are
  1519. @table @option
  1520. @item cirrus
  1521. Cirrus Logic GD5446 Video card. All Windows versions starting from
  1522. Windows 95 should recognize and use this graphic card. For optimal
  1523. performances, use 16 bit color depth in the guest and the host OS.
  1524. (This card was the default before QEMU 2.2)
  1525. @item std
  1526. Standard VGA card with Bochs VBE extensions. If your guest OS
  1527. supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
  1528. to use high resolution modes (>= 1280x1024x16) then you should use
  1529. this option. (This card is the default since QEMU 2.2)
  1530. @item vmware
  1531. VMWare SVGA-II compatible adapter. Use it if you have sufficiently
  1532. recent XFree86/XOrg server or Windows guest with a driver for this
  1533. card.
  1534. @item qxl
  1535. QXL paravirtual graphic card. It is VGA compatible (including VESA
  1536. 2.0 VBE support). Works best with qxl guest drivers installed though.
  1537. Recommended choice when using the spice protocol.
  1538. @item tcx
  1539. (sun4m only) Sun TCX framebuffer. This is the default framebuffer for
  1540. sun4m machines and offers both 8-bit and 24-bit colour depths at a
  1541. fixed resolution of 1024x768.
  1542. @item cg3
  1543. (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer
  1544. for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP)
  1545. resolutions aimed at people wishing to run older Solaris versions.
  1546. @item virtio
  1547. Virtio VGA card.
  1548. @item none
  1549. Disable VGA card.
  1550. @end table
  1551. ETEXI
  1552. DEF("full-screen", 0, QEMU_OPTION_full_screen,
  1553. "-full-screen start in full screen\n", QEMU_ARCH_ALL)
  1554. STEXI
  1555. @item -full-screen
  1556. @findex -full-screen
  1557. Start in full screen.
  1558. ETEXI
  1559. DEF("g", 1, QEMU_OPTION_g ,
  1560. "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
  1562. STEXI
  1563. @item -g @var{width}x@var{height}[x@var{depth}]
  1564. @findex -g
  1565. Set the initial graphical resolution and depth (PPC, SPARC only).
  1566. ETEXI
  1567. DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
  1568. "-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL)
  1569. STEXI
  1570. @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
  1571. @findex -vnc
  1572. Normally, if QEMU is compiled with graphical window support, it displays
  1573. output such as guest graphics, guest console, and the QEMU monitor in a
  1574. window. With this option, you can have QEMU listen on VNC display
  1575. @var{display} and redirect the VGA display over the VNC session. It is
  1576. very useful to enable the usb tablet device when using this option
  1577. (option @option{-device usb-tablet}). When using the VNC display, you
  1578. must use the @option{-k} parameter to set the keyboard layout if you are
  1579. not using en-us. Valid syntax for the @var{display} is
  1580. @table @option
  1581. @item to=@var{L}
  1582. With this option, QEMU will try next available VNC @var{display}s, until the
  1583. number @var{L}, if the origianlly defined "-vnc @var{display}" is not
  1584. available, e.g. port 5900+@var{display} is already used by another
  1585. application. By default, to=0.
  1586. @item @var{host}:@var{d}
  1587. TCP connections will only be allowed from @var{host} on display @var{d}.
  1588. By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
  1589. be omitted in which case the server will accept connections from any host.
  1590. @item unix:@var{path}
  1591. Connections will be allowed over UNIX domain sockets where @var{path} is the
  1592. location of a unix socket to listen for connections on.
  1593. @item none
  1594. VNC is initialized but not started. The monitor @code{change} command
  1595. can be used to later start the VNC server.
  1596. @end table
  1597. Following the @var{display} value there may be one or more @var{option} flags
  1598. separated by commas. Valid options are
  1599. @table @option
  1600. @item reverse
  1601. Connect to a listening VNC client via a ``reverse'' connection. The
  1602. client is specified by the @var{display}. For reverse network
  1603. connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
  1604. is a TCP port number, not a display number.
  1605. @item websocket
  1606. Opens an additional TCP listening port dedicated to VNC Websocket connections.
  1607. If a bare @var{websocket} option is given, the Websocket port is
  1608. 5700+@var{display}. An alternative port can be specified with the
  1609. syntax @code{websocket}=@var{port}.
  1610. If @var{host} is specified connections will only be allowed from this host.
  1611. It is possible to control the websocket listen address independently, using
  1612. the syntax @code{websocket}=@var{host}:@var{port}.
  1613. If no TLS credentials are provided, the websocket connection runs in
  1614. unencrypted mode. If TLS credentials are provided, the websocket connection
  1615. requires encrypted client connections.
  1616. @item password
  1617. Require that password based authentication is used for client connections.
  1618. The password must be set separately using the @code{set_password} command in
  1619. the @ref{pcsys_monitor}. The syntax to change your password is:
  1620. @code{set_password <protocol> <password>} where <protocol> could be either
  1621. "vnc" or "spice".
  1622. If you would like to change <protocol> password expiration, you should use
  1623. @code{expire_password <protocol> <expiration-time>} where expiration time could
  1624. be one of the following options: now, never, +seconds or UNIX time of
  1625. expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800
  1626. to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this
  1627. date and time).
  1628. You can also use keywords "now" or "never" for the expiration time to
  1629. allow <protocol> password to expire immediately or never expire.
  1630. @item tls-creds=@var{ID}
  1631. Provides the ID of a set of TLS credentials to use to secure the
  1632. VNC server. They will apply to both the normal VNC server socket
  1633. and the websocket socket (if enabled). Setting TLS credentials
  1634. will cause the VNC server socket to enable the VeNCrypt auth
  1635. mechanism. The credentials should have been previously created
  1636. using the @option{-object tls-creds} argument.
  1637. @item tls-authz=@var{ID}
  1638. Provides the ID of the QAuthZ authorization object against which
  1639. the client's x509 distinguished name will validated. This object is
  1640. only resolved at time of use, so can be deleted and recreated on the
  1641. fly while the VNC server is active. If missing, it will default
  1642. to denying access.
  1643. @item sasl
  1644. Require that the client use SASL to authenticate with the VNC server.
  1645. The exact choice of authentication method used is controlled from the
  1646. system / user's SASL configuration file for the 'qemu' service. This
  1647. is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
  1648. unprivileged user, an environment variable SASL_CONF_PATH can be used
  1649. to make it search alternate locations for the service config.
  1650. While some SASL auth methods can also provide data encryption (eg GSSAPI),
  1651. it is recommended that SASL always be combined with the 'tls' and
  1652. 'x509' settings to enable use of SSL and server certificates. This
  1653. ensures a data encryption preventing compromise of authentication
  1654. credentials. See the @ref{vnc_security} section for details on using
  1655. SASL authentication.
  1656. @item sasl-authz=@var{ID}
  1657. Provides the ID of the QAuthZ authorization object against which
  1658. the client's SASL username will validated. This object is
  1659. only resolved at time of use, so can be deleted and recreated on the
  1660. fly while the VNC server is active. If missing, it will default
  1661. to denying access.
  1662. @item acl
  1663. Legacy method for enabling authorization of clients against the
  1664. x509 distinguished name and SASL username. It results in the creation
  1665. of two @code{authz-list} objects with IDs of @code{vnc.username} and
  1666. @code{vnc.x509dname}. The rules for these objects must be configured
  1667. with the HMP ACL commands.
  1668. This option is deprecated and should no longer be used. The new
  1669. @option{sasl-authz} and @option{tls-authz} options are a
  1670. replacement.
  1671. @item lossy
  1672. Enable lossy compression methods (gradient, JPEG, ...). If this
  1673. option is set, VNC client may receive lossy framebuffer updates
  1674. depending on its encoding settings. Enabling this option can save
  1675. a lot of bandwidth at the expense of quality.
  1676. @item non-adaptive
  1677. Disable adaptive encodings. Adaptive encodings are enabled by default.
  1678. An adaptive encoding will try to detect frequently updated screen regions,
  1679. and send updates in these regions using a lossy encoding (like JPEG).
  1680. This can be really helpful to save bandwidth when playing videos. Disabling
  1681. adaptive encodings restores the original static behavior of encodings
  1682. like Tight.
  1683. @item share=[allow-exclusive|force-shared|ignore]
  1684. Set display sharing policy. 'allow-exclusive' allows clients to ask
  1685. for exclusive access. As suggested by the rfb spec this is
  1686. implemented by dropping other connections. Connecting multiple
  1687. clients in parallel requires all clients asking for a shared session
  1688. (vncviewer: -shared switch). This is the default. 'force-shared'
  1689. disables exclusive client access. Useful for shared desktop sessions,
  1690. where you don't want someone forgetting specify -shared disconnect
  1691. everybody else. 'ignore' completely ignores the shared flag and
  1692. allows everybody connect unconditionally. Doesn't conform to the rfb
  1693. spec but is traditional QEMU behavior.
  1694. @item key-delay-ms
  1695. Set keyboard delay, for key down and key up events, in milliseconds.
  1696. Default is 10. Keyboards are low-bandwidth devices, so this slowdown
  1697. can help the device and guest to keep up and not lose events in case
  1698. events are arriving in bulk. Possible causes for the latter are flaky
  1699. network connections, or scripts for automated testing.
  1700. @item audiodev=@var{audiodev}
  1701. Use the specified @var{audiodev} when the VNC client requests audio
  1702. transmission. When not using an -audiodev argument, this option must
  1703. be omitted, otherwise is must be present and specify a valid audiodev.
  1704. @end table
  1705. ETEXI
  1706. STEXI
  1707. @end table
  1708. ETEXI
  1710. ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
  1711. STEXI
  1712. @table @option
  1713. ETEXI
  1714. DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
  1715. "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
  1716. QEMU_ARCH_I386)
  1717. STEXI
  1718. @item -win2k-hack
  1719. @findex -win2k-hack
  1720. Use it when installing Windows 2000 to avoid a disk full bug. After
  1721. Windows 2000 is installed, you no longer need this option (this option
  1722. slows down the IDE transfers).
  1723. ETEXI
  1724. DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
  1725. "-no-fd-bootchk disable boot signature checking for floppy disks\n",
  1726. QEMU_ARCH_I386)
  1727. STEXI
  1728. @item -no-fd-bootchk
  1729. @findex -no-fd-bootchk
  1730. Disable boot signature checking for floppy disks in BIOS. May
  1731. be needed to boot from old floppy disks.
  1732. ETEXI
  1733. DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
  1734. "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM)
  1735. STEXI
  1736. @item -no-acpi
  1737. @findex -no-acpi
  1738. Disable ACPI (Advanced Configuration and Power Interface) support. Use
  1739. it if your guest OS complains about ACPI problems (PC target machine
  1740. only).
  1741. ETEXI
  1742. DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
  1743. "-no-hpet disable HPET\n", QEMU_ARCH_I386)
  1744. STEXI
  1745. @item -no-hpet
  1746. @findex -no-hpet
  1747. Disable HPET support.
  1748. ETEXI
  1749. DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
  1750. "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n"
  1751. " ACPI table description\n", QEMU_ARCH_I386)
  1752. STEXI
  1753. @item -acpitable [sig=@var{str}][,rev=@var{n}][,oem_id=@var{str}][,oem_table_id=@var{str}][,oem_rev=@var{n}] [,asl_compiler_id=@var{str}][,asl_compiler_rev=@var{n}][,data=@var{file1}[:@var{file2}]...]
  1754. @findex -acpitable
  1755. Add ACPI table with specified header fields and context from specified files.
  1756. For file=, take whole ACPI table from the specified files, including all
  1757. ACPI headers (possible overridden by other options).
  1758. For data=, only data
  1759. portion of the table is used, all header information is specified in the
  1760. command line.
  1761. If a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id
  1762. fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order
  1763. to ensure the field matches required by the Microsoft SLIC spec and the ACPI
  1764. spec.
  1765. ETEXI
  1766. DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
  1767. "-smbios file=binary\n"
  1768. " load SMBIOS entry from binary file\n"
  1769. "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
  1770. " [,uefi=on|off]\n"
  1771. " specify SMBIOS type 0 fields\n"
  1772. "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
  1773. " [,uuid=uuid][,sku=str][,family=str]\n"
  1774. " specify SMBIOS type 1 fields\n"
  1775. "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
  1776. " [,asset=str][,location=str]\n"
  1777. " specify SMBIOS type 2 fields\n"
  1778. "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n"
  1779. " [,sku=str]\n"
  1780. " specify SMBIOS type 3 fields\n"
  1781. "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n"
  1782. " [,asset=str][,part=str]\n"
  1783. " specify SMBIOS type 4 fields\n"
  1784. "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n"
  1785. " [,asset=str][,part=str][,speed=%d]\n"
  1786. " specify SMBIOS type 17 fields\n",
  1788. STEXI
  1789. @item -smbios file=@var{binary}
  1790. @findex -smbios
  1791. Load SMBIOS entry from binary file.
  1792. @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off]
  1793. Specify SMBIOS type 0 fields
  1794. @item -smbios type=1[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,uuid=@var{uuid}][,sku=@var{str}][,family=@var{str}]
  1795. Specify SMBIOS type 1 fields
  1796. @item -smbios type=2[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,location=@var{str}]
  1797. Specify SMBIOS type 2 fields
  1798. @item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}]
  1799. Specify SMBIOS type 3 fields
  1800. @item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}]
  1801. Specify SMBIOS type 4 fields
  1802. @item -smbios type=17[,loc_pfx=@var{str}][,bank=@var{str}][,manufacturer=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}][,speed=@var{%d}]
  1803. Specify SMBIOS type 17 fields
  1804. ETEXI
  1805. STEXI
  1806. @end table
  1807. ETEXI
  1808. DEFHEADING()
  1809. DEFHEADING(Network options:)
  1810. STEXI
  1811. @table @option
  1812. ETEXI
  1813. DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
  1814. #ifdef CONFIG_SLIRP
  1815. "-netdev user,id=str[,ipv4[=on|off]][,net=addr[/mask]][,host=addr]\n"
  1816. " [,ipv6[=on|off]][,ipv6-net=addr[/int]][,ipv6-host=addr]\n"
  1817. " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n"
  1818. " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,domainname=domain]\n"
  1819. " [,tftp=dir][,tftp-server-name=name][,bootfile=f][,hostfwd=rule][,guestfwd=rule]"
  1820. #ifndef _WIN32
  1821. "[,smb=dir[,smbserver=addr]]\n"
  1822. #endif
  1823. " configure a user mode network backend with ID 'str',\n"
  1824. " its DHCP server and optional services\n"
  1825. #endif
  1826. #ifdef _WIN32
  1827. "-netdev tap,id=str,ifname=name\n"
  1828. " configure a host TAP network backend with ID 'str'\n"
  1829. #else
  1830. "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n"
  1831. " [,br=bridge][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n"
  1832. " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n"
  1833. " [,poll-us=n]\n"
  1834. " configure a host TAP network backend with ID 'str'\n"
  1835. " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n"
  1836. " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
  1837. " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
  1838. " to deconfigure it\n"
  1839. " use '[down]script=no' to disable script execution\n"
  1840. " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
  1841. " configure it\n"
  1842. " use 'fd=h' to connect to an already opened TAP interface\n"
  1843. " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n"
  1844. " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
  1845. " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
  1846. " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
  1847. " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
  1848. " use vhost=on to enable experimental in kernel accelerator\n"
  1849. " (only has effect for virtio guests which use MSIX)\n"
  1850. " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
  1851. " use 'vhostfd=h' to connect to an already opened vhost net device\n"
  1852. " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n"
  1853. " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n"
  1854. " use 'poll-us=n' to speciy the maximum number of microseconds that could be\n"
  1855. " spent on busy polling for vhost net\n"
  1856. "-netdev bridge,id=str[,br=bridge][,helper=helper]\n"
  1857. " configure a host TAP network backend with ID 'str' that is\n"
  1858. " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n"
  1859. " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n"
  1860. #endif
  1861. #ifdef __linux__
  1862. "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n"
  1863. " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n"
  1864. " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n"
  1865. " [,rxcookie=rxcookie][,offset=offset]\n"
  1866. " configure a network backend with ID 'str' connected to\n"
  1867. " an Ethernet over L2TPv3 pseudowire.\n"
  1868. " Linux kernel 3.3+ as well as most routers can talk\n"
  1869. " L2TPv3. This transport allows connecting a VM to a VM,\n"
  1870. " VM to a router and even VM to Host. It is a nearly-universal\n"
  1871. " standard (RFC3391). Note - this implementation uses static\n"
  1872. " pre-configured tunnels (same as the Linux kernel).\n"
  1873. " use 'src=' to specify source address\n"
  1874. " use 'dst=' to specify destination address\n"
  1875. " use 'udp=on' to specify udp encapsulation\n"
  1876. " use 'srcport=' to specify source udp port\n"
  1877. " use 'dstport=' to specify destination udp port\n"
  1878. " use 'ipv6=on' to force v6\n"
  1879. " L2TPv3 uses cookies to prevent misconfiguration as\n"
  1880. " well as a weak security measure\n"
  1881. " use 'rxcookie=0x012345678' to specify a rxcookie\n"
  1882. " use 'txcookie=0x012345678' to specify a txcookie\n"
  1883. " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n"
  1884. " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n"
  1885. " use 'pincounter=on' to work around broken counter handling in peer\n"
  1886. " use 'offset=X' to add an extra offset between header and data\n"
  1887. #endif
  1888. "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n"
  1889. " configure a network backend to connect to another network\n"
  1890. " using a socket connection\n"
  1891. "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
  1892. " configure a network backend to connect to a multicast maddr and port\n"
  1893. " use 'localaddr=addr' to specify the host address to send packets from\n"
  1894. "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n"
  1895. " configure a network backend to connect to another network\n"
  1896. " using an UDP tunnel\n"
  1897. #ifdef CONFIG_VDE
  1898. "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
  1899. " configure a network backend to connect to port 'n' of a vde switch\n"
  1900. " running on host and listening for incoming connections on 'socketpath'.\n"
  1901. " Use group 'groupname' and mode 'octalmode' to change default\n"
  1902. " ownership and permissions for communication port.\n"
  1903. #endif
  1904. #ifdef CONFIG_NETMAP
  1905. "-netdev netmap,id=str,ifname=name[,devname=nmname]\n"
  1906. " attach to the existing netmap-enabled network interface 'name', or to a\n"
  1907. " VALE port (created on the fly) called 'name' ('nmname' is name of the \n"
  1908. " netmap device, defaults to '/dev/netmap')\n"
  1909. #endif
  1910. #ifdef CONFIG_POSIX
  1911. "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n"
  1912. " configure a vhost-user network, backed by a chardev 'dev'\n"
  1913. #endif
  1914. "-netdev hubport,id=str,hubid=n[,netdev=nd]\n"
  1915. " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL)
  1916. DEF("nic", HAS_ARG, QEMU_OPTION_nic,
  1917. "-nic [tap|bridge|"
  1918. #ifdef CONFIG_SLIRP
  1919. "user|"
  1920. #endif
  1921. #ifdef __linux__
  1922. "l2tpv3|"
  1923. #endif
  1924. #ifdef CONFIG_VDE
  1925. "vde|"
  1926. #endif
  1927. #ifdef CONFIG_NETMAP
  1928. "netmap|"
  1929. #endif
  1930. #ifdef CONFIG_POSIX
  1931. "vhost-user|"
  1932. #endif
  1933. "socket][,option][,...][mac=macaddr]\n"
  1934. " initialize an on-board / default host NIC (using MAC address\n"
  1935. " macaddr) and connect it to the given host network backend\n"
  1936. "-nic none use it alone to have zero network devices (the default is to\n"
  1937. " provided a 'user' network connection)\n",
  1938. QEMU_ARCH_ALL)
  1939. DEF("net", HAS_ARG, QEMU_OPTION_net,
  1940. "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
  1941. " configure or create an on-board (or machine default) NIC and\n"
  1942. " connect it to hub 0 (please use -nic unless you need a hub)\n"
  1943. "-net ["
  1944. #ifdef CONFIG_SLIRP
  1945. "user|"
  1946. #endif
  1947. "tap|"
  1948. "bridge|"
  1949. #ifdef CONFIG_VDE
  1950. "vde|"
  1951. #endif
  1952. #ifdef CONFIG_NETMAP
  1953. "netmap|"
  1954. #endif
  1955. "socket][,option][,option][,...]\n"
  1956. " old way to initialize a host network interface\n"
  1957. " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL)
  1958. STEXI
  1959. @item -nic [tap|bridge|user|l2tpv3|vde|netmap|vhost-user|socket][,...][,mac=macaddr][,model=mn]
  1960. @findex -nic
  1961. This option is a shortcut for configuring both the on-board (default) guest
  1962. NIC hardware and the host network backend in one go. The host backend options
  1963. are the same as with the corresponding @option{-netdev} options below.
  1964. The guest NIC model can be set with @option{model=@var{modelname}}.
  1965. Use @option{model=help} to list the available device types.
  1966. The hardware MAC address can be set with @option{mac=@var{macaddr}}.
  1967. The following two example do exactly the same, to show how @option{-nic} can
  1968. be used to shorten the command line length (note that the e1000 is the default
  1969. on i386, so the @option{model=e1000} parameter could even be omitted here, too):
  1970. @example
  1971. qemu-system-i386 -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32
  1972. qemu-system-i386 -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32
  1973. @end example
  1974. @item -nic none
  1975. Indicate that no network devices should be configured. It is used to override
  1976. the default configuration (default NIC with ``user'' host network backend)
  1977. which is activated if no other networking options are provided.
  1978. @item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
  1979. @findex -netdev
  1980. Configure user mode host network backend which requires no administrator
  1981. privilege to run. Valid options are:
  1982. @table @option
  1983. @item id=@var{id}
  1984. Assign symbolic name for use in monitor commands.
  1985. @item ipv4=on|off and ipv6=on|off
  1986. Specify that either IPv4 or IPv6 must be enabled. If neither is specified
  1987. both protocols are enabled.
  1988. @item net=@var{addr}[/@var{mask}]
  1989. Set IP network address the guest will see. Optionally specify the netmask,
  1990. either in the form a.b.c.d or as number of valid top-most bits. Default is
  1992. @item host=@var{addr}
  1993. Specify the guest-visible address of the host. Default is the 2nd IP in the
  1994. guest network, i.e. x.x.x.2.
  1995. @item ipv6-net=@var{addr}[/@var{int}]
  1996. Set IPv6 network address the guest will see (default is fec0::/64). The
  1997. network prefix is given in the usual hexadecimal IPv6 address
  1998. notation. The prefix size is optional, and is given as the number of
  1999. valid top-most bits (default is 64).
  2000. @item ipv6-host=@var{addr}
  2001. Specify the guest-visible IPv6 address of the host. Default is the 2nd IPv6 in
  2002. the guest network, i.e. xxxx::2.
  2003. @item restrict=on|off
  2004. If this option is enabled, the guest will be isolated, i.e. it will not be
  2005. able to contact the host and no guest IP packets will be routed over the host
  2006. to the outside. This option does not affect any explicitly set forwarding rules.
  2007. @item hostname=@var{name}
  2008. Specifies the client hostname reported by the built-in DHCP server.
  2009. @item dhcpstart=@var{addr}
  2010. Specify the first of the 16 IPs the built-in DHCP server can assign. Default
  2011. is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
  2012. @item dns=@var{addr}
  2013. Specify the guest-visible address of the virtual nameserver. The address must
  2014. be different from the host address. Default is the 3rd IP in the guest network,
  2015. i.e. x.x.x.3.
  2016. @item ipv6-dns=@var{addr}
  2017. Specify the guest-visible address of the IPv6 virtual nameserver. The address
  2018. must be different from the host address. Default is the 3rd IP in the guest
  2019. network, i.e. xxxx::3.
  2020. @item dnssearch=@var{domain}
  2021. Provides an entry for the domain-search list sent by the built-in
  2022. DHCP server. More than one domain suffix can be transmitted by specifying
  2023. this option multiple times. If supported, this will cause the guest to
  2024. automatically try to append the given domain suffix(es) in case a domain name
  2025. can not be resolved.
  2026. Example:
  2027. @example
  2028. qemu-system-i386 -nic user,,
  2029. @end example
  2030. @item domainname=@var{domain}
  2031. Specifies the client domain name reported by the built-in DHCP server.
  2032. @item tftp=@var{dir}
  2033. When using the user mode network stack, activate a built-in TFTP
  2034. server. The files in @var{dir} will be exposed as the root of a TFTP server.
  2035. The TFTP client on the guest must be configured in binary mode (use the command
  2036. @code{bin} of the Unix TFTP client).
  2037. @item tftp-server-name=@var{name}
  2038. In BOOTP reply, broadcast @var{name} as the "TFTP server name" (RFC2132 option
  2039. 66). This can be used to advise the guest to load boot files or configurations
  2040. from a different server than the host address.
  2041. @item bootfile=@var{file}
  2042. When using the user mode network stack, broadcast @var{file} as the BOOTP
  2043. filename. In conjunction with @option{tftp}, this can be used to network boot
  2044. a guest from a local directory.
  2045. Example (using pxelinux):
  2046. @example
  2047. qemu-system-i386 -hda linux.img -boot n -device e1000,netdev=n1 \
  2048. -netdev user,id=n1,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
  2049. @end example
  2050. @item smb=@var{dir}[,smbserver=@var{addr}]
  2051. When using the user mode network stack, activate a built-in SMB
  2052. server so that Windows OSes can access to the host files in @file{@var{dir}}
  2053. transparently. The IP address of the SMB server can be set to @var{addr}. By
  2054. default the 4th IP in the guest network is used, i.e. x.x.x.4.
  2055. In the guest Windows OS, the line:
  2056. @example
  2057. smbserver
  2058. @end example
  2059. must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
  2060. or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
  2061. Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
  2062. Note that a SAMBA server must be installed on the host OS.
  2063. @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
  2064. Redirect incoming TCP or UDP connections to the host port @var{hostport} to
  2065. the guest IP address @var{guestaddr} on guest port @var{guestport}. If
  2066. @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
  2067. given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
  2068. be bound to a specific host interface. If no connection type is set, TCP is
  2069. used. This option can be given multiple times.
  2070. For example, to redirect host X11 connection from screen 1 to guest
  2071. screen 0, use the following:
  2072. @example
  2073. # on the host
  2074. qemu-system-i386 -nic user,hostfwd=tcp:
  2075. # this host xterm should open in the guest X11 server
  2076. xterm -display :1
  2077. @end example
  2078. To redirect telnet connections from host port 5555 to telnet port on
  2079. the guest, use the following:
  2080. @example
  2081. # on the host
  2082. qemu-system-i386 -nic user,hostfwd=tcp::5555-:23
  2083. telnet localhost 5555
  2084. @end example
  2085. Then when you use on the host @code{telnet localhost 5555}, you
  2086. connect to the guest telnet server.
  2087. @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
  2088. @itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
  2089. Forward guest TCP connections to the IP address @var{server} on port @var{port}
  2090. to the character device @var{dev} or to a program executed by @var{cmd:command}
  2091. which gets spawned for each connection. This option can be given multiple times.
  2092. You can either use a chardev directly and have that one used throughout QEMU's
  2093. lifetime, like in the following example:
  2094. @example
  2095. # open on bootup, connect to it whenever
  2096. # the guest accesses it
  2097. qemu-system-i386 -nic user,guestfwd=tcp:
  2098. @end example
  2099. Or you can execute a command on every TCP connection established by the guest,
  2100. so that QEMU behaves similar to an inetd process for that virtual server:
  2101. @example
  2102. # call "netcat 4321" on every TCP connection to
  2103. # and connect the TCP stream to its stdin/stdout
  2104. qemu-system-i386 -nic 'user,id=n1,guestfwd=tcp: 4321'
  2105. @end example
  2106. @end table
  2107. @item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,br=@var{bridge}][,helper=@var{helper}]
  2108. Configure a host TAP network backend with ID @var{id}.
  2109. Use the network script @var{file} to configure it and the network script
  2110. @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
  2111. automatically provides one. The default network configure script is
  2112. @file{/etc/qemu-ifup} and the default network deconfigure script is
  2113. @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
  2114. to disable script execution.
  2115. If running QEMU as an unprivileged user, use the network helper
  2116. @var{helper} to configure the TAP interface and attach it to the bridge.
  2117. The default network helper executable is @file{/path/to/qemu-bridge-helper}
  2118. and the default bridge device is @file{br0}.
  2119. @option{fd}=@var{h} can be used to specify the handle of an already
  2120. opened host TAP interface.
  2121. Examples:
  2122. @example
  2123. #launch a QEMU instance with the default network script
  2124. qemu-system-i386 linux.img -nic tap
  2125. @end example
  2126. @example
  2127. #launch a QEMU instance with two NICs, each one connected
  2128. #to a TAP device
  2129. qemu-system-i386 linux.img \
  2130. -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \
  2131. -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1
  2132. @end example
  2133. @example
  2134. #launch a QEMU instance with the default network helper to
  2135. #connect a TAP device to bridge br0
  2136. qemu-system-i386 linux.img -device virtio-net-pci,netdev=n1 \
  2137. -netdev tap,id=n1,"helper=/path/to/qemu-bridge-helper"
  2138. @end example
  2139. @item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
  2140. Connect a host TAP network interface to a host bridge device.
  2141. Use the network helper @var{helper} to configure the TAP interface and
  2142. attach it to the bridge. The default network helper executable is
  2143. @file{/path/to/qemu-bridge-helper} and the default bridge
  2144. device is @file{br0}.
  2145. Examples:
  2146. @example
  2147. #launch a QEMU instance with the default network helper to
  2148. #connect a TAP device to bridge br0
  2149. qemu-system-i386 linux.img -netdev bridge,id=n1 -device virtio-net,netdev=n1
  2150. @end example
  2151. @example
  2152. #launch a QEMU instance with the default network helper to
  2153. #connect a TAP device to bridge qemubr0
  2154. qemu-system-i386 linux.img -netdev bridge,br=qemubr0,id=n1 -device virtio-net,netdev=n1
  2155. @end example
  2156. @item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
  2157. This host network backend can be used to connect the guest's network to
  2158. another QEMU virtual machine using a TCP socket connection. If @option{listen}
  2159. is specified, QEMU waits for incoming connections on @var{port}
  2160. (@var{host} is optional). @option{connect} is used to connect to
  2161. another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
  2162. specifies an already opened TCP socket.
  2163. Example:
  2164. @example
  2165. # launch a first QEMU instance
  2166. qemu-system-i386 linux.img \
  2167. -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
  2168. -netdev socket,id=n1,listen=:1234
  2169. # connect the network of this instance to the network of the first instance
  2170. qemu-system-i386 linux.img \
  2171. -device e1000,netdev=n2,mac=52:54:00:12:34:57 \
  2172. -netdev socket,id=n2,connect=
  2173. @end example
  2174. @item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
  2175. Configure a socket host network backend to share the guest's network traffic
  2176. with another QEMU virtual machines using a UDP multicast socket, effectively
  2177. making a bus for every QEMU with same multicast address @var{maddr} and @var{port}.
  2178. NOTES:
  2179. @enumerate
  2180. @item
  2181. Several QEMU can be running on different hosts and share same bus (assuming
  2182. correct multicast setup for these hosts).
  2183. @item
  2184. mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
  2185. @url{}.
  2186. @item
  2187. Use @option{fd=h} to specify an already opened UDP multicast socket.
  2188. @end enumerate
  2189. Example:
  2190. @example
  2191. # launch one QEMU instance
  2192. qemu-system-i386 linux.img \
  2193. -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
  2194. -netdev socket,id=n1,mcast=
  2195. # launch another QEMU instance on same "bus"
  2196. qemu-system-i386 linux.img \
  2197. -device e1000,netdev=n2,mac=52:54:00:12:34:57 \
  2198. -netdev socket,id=n2,mcast=
  2199. # launch yet another QEMU instance on same "bus"
  2200. qemu-system-i386 linux.img \
  2201. -device e1000,netdev=n3,mac=52:54:00:12:34:58 \
  2202. -netdev socket,id=n3,mcast=
  2203. @end example
  2204. Example (User Mode Linux compat.):
  2205. @example
  2206. # launch QEMU instance (note mcast address selected is UML's default)
  2207. qemu-system-i386 linux.img \
  2208. -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
  2209. -netdev socket,id=n1,mcast=
  2210. # launch UML
  2211. /path/to/linux ubd0=/path/to/root_fs eth0=mcast
  2212. @end example
  2213. Example (send packets from host's
  2214. @example
  2215. qemu-system-i386 linux.img \
  2216. -device e1000,netdev=n1,mac=52:54:00:12:34:56 \
  2217. -netdev socket,id=n1,mcast=,localaddr=
  2218. @end example
  2219. @item -netdev l2tpv3,id=@var{id},src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}]
  2220. Configure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3391) is a
  2221. popular protocol to transport Ethernet (and other Layer 2) data frames between
  2222. two systems. It is present in routers, firewalls and the Linux kernel
  2223. (from version 3.3 onwards).
  2224. This transport allows a VM to communicate to another VM, router or firewall directly.
  2225. @table @option
  2226. @item src=@var{srcaddr}
  2227. source address (mandatory)
  2228. @item dst=@var{dstaddr}
  2229. destination address (mandatory)
  2230. @item udp
  2231. select udp encapsulation (default is ip).
  2232. @item srcport=@var{srcport}
  2233. source udp port.
  2234. @item dstport=@var{dstport}
  2235. destination udp port.
  2236. @item ipv6
  2237. force v6, otherwise defaults to v4.
  2238. @item rxcookie=@var{rxcookie}
  2239. @itemx txcookie=@var{txcookie}
  2240. Cookies are a weak form of security in the l2tpv3 specification.
  2241. Their function is mostly to prevent misconfiguration. By default they are 32
  2242. bit.
  2243. @item cookie64
  2244. Set cookie size to 64 bit instead of the default 32
  2245. @item counter=off
  2246. Force a 'cut-down' L2TPv3 with no counter as in
  2247. draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
  2248. @item pincounter=on
  2249. Work around broken counter handling in peer. This may also help on
  2250. networks which have packet reorder.
  2251. @item offset=@var{offset}
  2252. Add an extra offset between header and data
  2253. @end table
  2254. For example, to attach a VM running on host via L2TPv3 to the bridge br-lan
  2255. on the remote Linux host
  2256. @example
  2257. # Setup tunnel on linux host using raw ip as encapsulation
  2258. # on
  2259. ip l2tp add tunnel remote local tunnel_id 1 peer_tunnel_id 1 \
  2260. encap udp udp_sport 16384 udp_dport 16384
  2261. ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \
  2262. 0xFFFFFFFF peer_session_id 0xFFFFFFFF
  2263. ifconfig vmtunnel0 mtu 1500
  2264. ifconfig vmtunnel0 up
  2265. brctl addif br-lan vmtunnel0
  2266. # on
  2267. # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
  2268. qemu-system-i386 linux.img -device e1000,netdev=n1 \
  2269. -netdev l2tpv3,id=n1,src=,dst=,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter
  2270. @end example
  2271. @item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
  2272. Configure VDE backend to connect to PORT @var{n} of a vde switch running on host and
  2273. listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
  2274. and MODE @var{octalmode} to change default ownership and permissions for
  2275. communication port. This option is only available if QEMU has been compiled
  2276. with vde support enabled.
  2277. Example:
  2278. @example
  2279. # launch vde switch
  2280. vde_switch -F -sock /tmp/myswitch
  2281. # launch QEMU instance
  2282. qemu-system-i386 linux.img -nic vde,sock=/tmp/myswitch
  2283. @end example
  2284. @item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n]
  2285. Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should
  2286. be a unix domain socket backed one. The vhost-user uses a specifically defined
  2287. protocol to pass vhost ioctl replacement messages to an application on the other
  2288. end of the socket. On non-MSIX guests, the feature can be forced with
  2289. @var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to
  2290. be created for multiqueue vhost-user.
  2291. Example:
  2292. @example
  2293. qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
  2294. -numa node,memdev=mem \
  2295. -chardev socket,id=chr0,path=/path/to/socket \
  2296. -netdev type=vhost-user,id=net0,chardev=chr0 \
  2297. -device virtio-net-pci,netdev=net0
  2298. @end example
  2299. @item -netdev hubport,id=@var{id},hubid=@var{hubid}[,netdev=@var{nd}]
  2300. Create a hub port on the emulated hub with ID @var{hubid}.
  2301. The hubport netdev lets you connect a NIC to a QEMU emulated hub instead of a
  2302. single netdev. Alternatively, you can also connect the hubport to another
  2303. netdev with ID @var{nd} by using the @option{netdev=@var{nd}} option.
  2304. @item -net nic[,netdev=@var{nd}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
  2305. @findex -net
  2306. Legacy option to configure or create an on-board (or machine default) Network
  2307. Interface Card(NIC) and connect it either to the emulated hub with ID 0 (i.e.
  2308. the default hub), or to the netdev @var{nd}.
  2309. The NIC is an e1000 by default on the PC target. Optionally, the MAC address
  2310. can be changed to @var{mac}, the device address set to @var{addr} (PCI cards
  2311. only), and a @var{name} can be assigned for use in monitor commands.
  2312. Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
  2313. that the card should have; this option currently only affects virtio cards; set
  2314. @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
  2315. NIC is created. QEMU can emulate several different models of network card.
  2316. Use @code{-net nic,model=help} for a list of available devices for your target.
  2317. @item -net user|tap|bridge|socket|l2tpv3|vde[,...][,name=@var{name}]
  2318. Configure a host network backend (with the options corresponding to the same
  2319. @option{-netdev} option) and connect it to the emulated hub 0 (the default
  2320. hub). Use @var{name} to specify the name of the hub port.
  2321. ETEXI
  2322. STEXI
  2323. @end table
  2324. ETEXI
  2325. DEFHEADING()
  2326. DEFHEADING(Character device options:)
  2327. DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
  2328. "-chardev help\n"
  2329. "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2330. "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n"
  2331. " [,server][,nowait][,telnet][,websocket][,reconnect=seconds][,mux=on|off]\n"
  2332. " [,logfile=PATH][,logappend=on|off][,tls-creds=ID][,tls-authz=ID] (tcp)\n"
  2333. "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,websocket][,reconnect=seconds]\n"
  2334. " [,mux=on|off][,logfile=PATH][,logappend=on|off] (unix)\n"
  2335. "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
  2336. " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
  2337. " [,logfile=PATH][,logappend=on|off]\n"
  2338. "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2339. "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
  2340. " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2341. "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n"
  2342. "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2343. "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2344. #ifdef _WIN32
  2345. "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2346. "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2347. #else
  2348. "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2349. "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n"
  2350. #endif
  2351. #ifdef CONFIG_BRLAPI
  2352. "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2353. #endif
  2354. #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
  2355. || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
  2356. "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2357. "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2358. #endif
  2359. #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
  2360. "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2361. "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
  2362. #endif
  2363. #if defined(CONFIG_SPICE)
  2364. "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
  2365. "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
  2366. #endif
  2367. , QEMU_ARCH_ALL
  2368. )
  2369. STEXI
  2370. The general form of a character device option is:
  2371. @table @option
  2372. @item -chardev @var{backend},id=@var{id}[,mux=on|off][,@var{options}]
  2373. @findex -chardev
  2374. Backend is one of:
  2375. @option{null},
  2376. @option{socket},
  2377. @option{udp},
  2378. @option{msmouse},
  2379. @option{vc},
  2380. @option{ringbuf},
  2381. @option{file},
  2382. @option{pipe},
  2383. @option{console},
  2384. @option{serial},
  2385. @option{pty},
  2386. @option{stdio},
  2387. @option{braille},
  2388. @option{tty},
  2389. @option{parallel},
  2390. @option{parport},
  2391. @option{spicevmc},
  2392. @option{spiceport}.
  2393. The specific backend will determine the applicable options.
  2394. Use @code{-chardev help} to print all available chardev backend types.
  2395. All devices must have an id, which can be any string up to 127 characters long.
  2396. It is used to uniquely identify this device in other command line directives.
  2397. A character device may be used in multiplexing mode by multiple front-ends.
  2398. Specify @option{mux=on} to enable this mode.
  2399. A multiplexer is a "1:N" device, and here the "1" end is your specified chardev
  2400. backend, and the "N" end is the various parts of QEMU that can talk to a chardev.
  2401. If you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will
  2402. create a multiplexer with your specified ID, and you can then configure multiple
  2403. front ends to use that chardev ID for their input/output. Up to four different
  2404. front ends can be connected to a single multiplexed chardev. (Without
  2405. multiplexing enabled, a chardev can only be used by a single front end.)
  2406. For instance you could use this to allow a single stdio chardev to be used by
  2407. two serial ports and the QEMU monitor:
  2408. @example
  2409. -chardev stdio,mux=on,id=char0 \
  2410. -mon chardev=char0,mode=readline \
  2411. -serial chardev:char0 \
  2412. -serial chardev:char0
  2413. @end example
  2414. You can have more than one multiplexer in a system configuration; for instance
  2415. you could have a TCP port multiplexed between UART 0 and UART 1, and stdio
  2416. multiplexed between the QEMU monitor and a parallel port:
  2417. @example
  2418. -chardev stdio,mux=on,id=char0 \
  2419. -mon chardev=char0,mode=readline \
  2420. -parallel chardev:char0 \
  2421. -chardev tcp,...,mux=on,id=char1 \
  2422. -serial chardev:char1 \
  2423. -serial chardev:char1
  2424. @end example
  2425. When you're using a multiplexed character device, some escape sequences are
  2426. interpreted in the input. @xref{mux_keys, Keys in the character backend
  2427. multiplexer}.
  2428. Note that some other command line options may implicitly create multiplexed
  2429. character backends; for instance @option{-serial mon:stdio} creates a
  2430. multiplexed stdio backend connected to the serial port and the QEMU monitor,
  2431. and @option{-nographic} also multiplexes the console and the monitor to
  2432. stdio.
  2433. There is currently no support for multiplexing in the other direction
  2434. (where a single QEMU front end takes input and output from multiple chardevs).
  2435. Every backend supports the @option{logfile} option, which supplies the path
  2436. to a file to record all data transmitted via the backend. The @option{logappend}
  2437. option controls whether the log file will be truncated or appended to when
  2438. opened.
  2439. @end table
  2440. The available backends are:
  2441. @table @option
  2442. @item -chardev null,id=@var{id}
  2443. A void device. This device will not emit any data, and will drop any data it
  2444. receives. The null backend does not take any options.
  2445. @item -chardev socket,id=@var{id}[,@var{TCP options} or @var{unix options}][,server][,nowait][,telnet][,websocket][,reconnect=@var{seconds}][,tls-creds=@var{id}][,tls-authz=@var{id}]
  2446. Create a two-way stream socket, which can be either a TCP or a unix socket. A
  2447. unix socket will be created if @option{path} is specified. Behaviour is
  2448. undefined if TCP options are specified for a unix socket.
  2449. @option{server} specifies that the socket shall be a listening socket.
  2450. @option{nowait} specifies that QEMU should not block waiting for a client to
  2451. connect to a listening socket.
  2452. @option{telnet} specifies that traffic on the socket should interpret telnet
  2453. escape sequences.
  2454. @option{websocket} specifies that the socket uses WebSocket protocol for
  2455. communication.
  2456. @option{reconnect} sets the timeout for reconnecting on non-server sockets when
  2457. the remote end goes away. qemu will delay this many seconds and then attempt
  2458. to reconnect. Zero disables reconnecting, and is the default.
  2459. @option{tls-creds} requests enablement of the TLS protocol for encryption,
  2460. and specifies the id of the TLS credentials to use for the handshake. The
  2461. credentials must be previously created with the @option{-object tls-creds}
  2462. argument.
  2463. @option{tls-auth} provides the ID of the QAuthZ authorization object against
  2464. which the client's x509 distinguished name will be validated. This object is
  2465. only resolved at time of use, so can be deleted and recreated on the fly
  2466. while the chardev server is active. If missing, it will default to denying
  2467. access.
  2468. TCP and unix socket options are given below:
  2469. @table @option
  2470. @item TCP options: port=@var{port}[,host=@var{host}][,to=@var{to}][,ipv4][,ipv6][,nodelay]
  2471. @option{host} for a listening socket specifies the local address to be bound.
  2472. For a connecting socket species the remote host to connect to. @option{host} is
  2473. optional for listening sockets. If not specified it defaults to @code{}.
  2474. @option{port} for a listening socket specifies the local port to be bound. For a
  2475. connecting socket specifies the port on the remote host to connect to.
  2476. @option{port} can be given as either a port number or a service name.
  2477. @option{port} is required.
  2478. @option{to} is only relevant to listening sockets. If it is specified, and
  2479. @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
  2480. to and including @option{to} until it succeeds. @option{to} must be specified
  2481. as a port number.
  2482. @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
  2483. If neither is specified the socket may use either protocol.
  2484. @option{nodelay} disables the Nagle algorithm.
  2485. @item unix options: path=@var{path}
  2486. @option{path} specifies the local path of the unix socket. @option{path} is
  2487. required.
  2488. @end table
  2489. @item -chardev udp,id=@var{id}[,host=@var{host}],port=@var{port}[,localaddr=@var{localaddr}][,localport=@var{localport}][,ipv4][,ipv6]
  2490. Sends all traffic from the guest to a remote host over UDP.
  2491. @option{host} specifies the remote host to connect to. If not specified it
  2492. defaults to @code{localhost}.
  2493. @option{port} specifies the port on the remote host to connect to. @option{port}
  2494. is required.
  2495. @option{localaddr} specifies the local address to bind to. If not specified it
  2496. defaults to @code{}.
  2497. @option{localport} specifies the local port to bind to. If not specified any
  2498. available local port will be used.
  2499. @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
  2500. If neither is specified the device may use either protocol.
  2501. @item -chardev msmouse,id=@var{id}
  2502. Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
  2503. take any options.
  2504. @item -chardev vc,id=@var{id}[[,width=@var{width}][,height=@var{height}]][[,cols=@var{cols}][,rows=@var{rows}]]
  2505. Connect to a QEMU text console. @option{vc} may optionally be given a specific
  2506. size.
  2507. @option{width} and @option{height} specify the width and height respectively of
  2508. the console, in pixels.
  2509. @option{cols} and @option{rows} specify that the console be sized to fit a text
  2510. console with the given dimensions.
  2511. @item -chardev ringbuf,id=@var{id}[,size=@var{size}]
  2512. Create a ring buffer with fixed size @option{size}.
  2513. @var{size} must be a power of two and defaults to @code{64K}.
  2514. @item -chardev file,id=@var{id},path=@var{path}
  2515. Log all traffic received from the guest to a file.
  2516. @option{path} specifies the path of the file to be opened. This file will be
  2517. created if it does not already exist, and overwritten if it does. @option{path}
  2518. is required.
  2519. @item -chardev pipe,id=@var{id},path=@var{path}
  2520. Create a two-way connection to the guest. The behaviour differs slightly between
  2521. Windows hosts and other hosts:
  2522. On Windows, a single duplex pipe will be created at
  2523. @file{\\.pipe\@option{path}}.
  2524. On other hosts, 2 pipes will be created called @file{@option{path}.in} and
  2525. @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
  2526. received by the guest. Data written by the guest can be read from
  2527. @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
  2528. be present.
  2529. @option{path} forms part of the pipe path as described above. @option{path} is
  2530. required.
  2531. @item -chardev console,id=@var{id}
  2532. Send traffic from the guest to QEMU's standard output. @option{console} does not
  2533. take any options.
  2534. @option{console} is only available on Windows hosts.
  2535. @item -chardev serial,id=@var{id},path=@option{path}
  2536. Send traffic from the guest to a serial device on the host.
  2537. On Unix hosts serial will actually accept any tty device,
  2538. not only serial lines.
  2539. @option{path} specifies the name of the serial device to open.
  2540. @item -chardev pty,id=@var{id}
  2541. Create a new pseudo-terminal on the host and connect to it. @option{pty} does
  2542. not take any options.
  2543. @option{pty} is not available on Windows hosts.
  2544. @item -chardev stdio,id=@var{id}[,signal=on|off]
  2545. Connect to standard input and standard output of the QEMU process.
  2546. @option{signal} controls if signals are enabled on the terminal, that includes
  2547. exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
  2548. default, use @option{signal=off} to disable it.
  2549. @item -chardev braille,id=@var{id}
  2550. Connect to a local BrlAPI server. @option{braille} does not take any options.
  2551. @item -chardev tty,id=@var{id},path=@var{path}
  2552. @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
  2553. DragonFlyBSD hosts. It is an alias for @option{serial}.
  2554. @option{path} specifies the path to the tty. @option{path} is required.
  2555. @item -chardev parallel,id=@var{id},path=@var{path}
  2556. @itemx -chardev parport,id=@var{id},path=@var{path}
  2557. @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
  2558. Connect to a local parallel port.
  2559. @option{path} specifies the path to the parallel port device. @option{path} is
  2560. required.
  2561. @item -chardev spicevmc,id=@var{id},debug=@var{debug},name=@var{name}
  2562. @option{spicevmc} is only available when spice support is built in.
  2563. @option{debug} debug level for spicevmc
  2564. @option{name} name of spice channel to connect to
  2565. Connect to a spice virtual machine channel, such as vdiport.
  2566. @item -chardev spiceport,id=@var{id},debug=@var{debug},name=@var{name}
  2567. @option{spiceport} is only available when spice support is built in.
  2568. @option{debug} debug level for spicevmc
  2569. @option{name} name of spice port to connect to
  2570. Connect to a spice port, allowing a Spice client to handle the traffic
  2571. identified by a name (preferably a fqdn).
  2572. ETEXI
  2573. STEXI
  2574. @end table
  2575. ETEXI
  2576. DEFHEADING()
  2577. DEFHEADING(Bluetooth(R) options:)
  2578. STEXI
  2579. @table @option
  2580. ETEXI
  2581. DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
  2582. "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
  2583. "-bt hci,host[:id]\n" \
  2584. " use host's HCI with the given name\n" \
  2585. "-bt hci[,vlan=n]\n" \
  2586. " emulate a standard HCI in virtual scatternet 'n'\n" \
  2587. "-bt vhci[,vlan=n]\n" \
  2588. " add host computer to virtual scatternet 'n' using VHCI\n" \
  2589. "-bt device:dev[,vlan=n]\n" \
  2590. " emulate a bluetooth device 'dev' in scatternet 'n'\n",
  2591. QEMU_ARCH_ALL)
  2592. STEXI
  2593. @item -bt hci[...]
  2594. @findex -bt
  2595. Defines the function of the corresponding Bluetooth HCI. -bt options
  2596. are matched with the HCIs present in the chosen machine type. For
  2597. example when emulating a machine with only one HCI built into it, only
  2598. the first @code{-bt hci[...]} option is valid and defines the HCI's
  2599. logic. The Transport Layer is decided by the machine type. Currently
  2600. the machines @code{n800} and @code{n810} have one HCI and all other
  2601. machines have none.
  2602. Note: This option and the whole bluetooth subsystem is considered as deprecated.
  2603. If you still use it, please send a mail to @email{} where
  2604. you describe your usecase.
  2605. @anchor{bt-hcis}
  2606. The following three types are recognized:
  2607. @table @option
  2608. @item -bt hci,null
  2609. (default) The corresponding Bluetooth HCI assumes no internal logic
  2610. and will not respond to any HCI commands or emit events.
  2611. @item -bt hci,host[:@var{id}]
  2612. (@code{bluez} only) The corresponding HCI passes commands / events
  2613. to / from the physical HCI identified by the name @var{id} (default:
  2614. @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
  2615. capable systems like Linux.
  2616. @item -bt hci[,vlan=@var{n}]
  2617. Add a virtual, standard HCI that will participate in the Bluetooth
  2618. scatternet @var{n} (default @code{0}). Similarly to @option{-net}
  2619. VLANs, devices inside a bluetooth network @var{n} can only communicate
  2620. with other devices in the same network (scatternet).
  2621. @end table
  2622. @item -bt vhci[,vlan=@var{n}]
  2623. (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
  2624. to the host bluetooth stack instead of to the emulated target. This
  2625. allows the host and target machines to participate in a common scatternet
  2626. and communicate. Requires the Linux @code{vhci} driver installed. Can
  2627. be used as following:
  2628. @example
  2629. qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
  2630. @end example
  2631. @item -bt device:@var{dev}[,vlan=@var{n}]
  2632. Emulate a bluetooth device @var{dev} and place it in network @var{n}
  2633. (default @code{0}). QEMU can only emulate one type of bluetooth devices
  2634. currently:
  2635. @table @option
  2636. @item keyboard
  2637. Virtual wireless keyboard implementing the HIDP bluetooth profile.
  2638. @end table
  2639. ETEXI
  2640. STEXI
  2641. @end table
  2642. ETEXI
  2643. DEFHEADING()
  2644. #ifdef CONFIG_TPM
  2645. DEFHEADING(TPM device options:)
  2646. DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
  2647. "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n"
  2648. " use path to provide path to a character device; default is /dev/tpm0\n"
  2649. " use cancel-path to provide path to TPM's cancel sysfs entry; if\n"
  2650. " not provided it will be searched for in /sys/class/misc/tpm?/device\n"
  2651. "-tpmdev emulator,id=id,chardev=dev\n"
  2652. " configure the TPM device using chardev backend\n",
  2653. QEMU_ARCH_ALL)
  2654. STEXI
  2655. The general form of a TPM device option is:
  2656. @table @option
  2657. @item -tpmdev @var{backend},id=@var{id}[,@var{options}]
  2658. @findex -tpmdev
  2659. The specific backend type will determine the applicable options.
  2660. The @code{-tpmdev} option creates the TPM backend and requires a
  2661. @code{-device} option that specifies the TPM frontend interface model.
  2662. Use @code{-tpmdev help} to print all available TPM backend types.
  2663. @end table
  2664. The available backends are:
  2665. @table @option
  2666. @item -tpmdev passthrough,id=@var{id},path=@var{path},cancel-path=@var{cancel-path}
  2667. (Linux-host only) Enable access to the host's TPM using the passthrough
  2668. driver.
  2669. @option{path} specifies the path to the host's TPM device, i.e., on
  2670. a Linux host this would be @code{/dev/tpm0}.
  2671. @option{path} is optional and by default @code{/dev/tpm0} is used.
  2672. @option{cancel-path} specifies the path to the host TPM device's sysfs
  2673. entry allowing for cancellation of an ongoing TPM command.
  2674. @option{cancel-path} is optional and by default QEMU will search for the
  2675. sysfs entry to use.
  2676. Some notes about using the host's TPM with the passthrough driver:
  2677. The TPM device accessed by the passthrough driver must not be
  2678. used by any other application on the host.
  2679. Since the host's firmware (BIOS/UEFI) has already initialized the TPM,
  2680. the VM's firmware (BIOS/UEFI) will not be able to initialize the
  2681. TPM again and may therefore not show a TPM-specific menu that would
  2682. otherwise allow the user to configure the TPM, e.g., allow the user to
  2683. enable/disable or activate/deactivate the TPM.
  2684. Further, if TPM ownership is released from within a VM then the host's TPM
  2685. will get disabled and deactivated. To enable and activate the
  2686. TPM again afterwards, the host has to be rebooted and the user is
  2687. required to enter the firmware's menu to enable and activate the TPM.
  2688. If the TPM is left disabled and/or deactivated most TPM commands will fail.
  2689. To create a passthrough TPM use the following two options:
  2690. @example
  2691. -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
  2692. @end example
  2693. Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
  2694. @code{tpmdev=tpm0} in the device option.
  2695. @item -tpmdev emulator,id=@var{id},chardev=@var{dev}
  2696. (Linux-host only) Enable access to a TPM emulator using Unix domain socket based
  2697. chardev backend.
  2698. @option{chardev} specifies the unique ID of a character device backend that provides connection to the software TPM server.
  2699. To create a TPM emulator backend device with chardev socket backend:
  2700. @example
  2701. -chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0
  2702. @end example
  2703. ETEXI
  2704. STEXI
  2705. @end table
  2706. ETEXI
  2707. DEFHEADING()
  2708. #endif
  2709. DEFHEADING(Linux/Multiboot boot specific:)
  2710. STEXI
  2711. When using these options, you can use a given Linux or Multiboot
  2712. kernel without installing it in the disk image. It can be useful
  2713. for easier testing of various kernels.
  2714. @table @option
  2715. ETEXI
  2716. DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
  2717. "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
  2718. STEXI
  2719. @item -kernel @var{bzImage}
  2720. @findex -kernel
  2721. Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
  2722. or in multiboot format.
  2723. ETEXI
  2724. DEF("append", HAS_ARG, QEMU_OPTION_append, \
  2725. "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
  2726. STEXI
  2727. @item -append @var{cmdline}
  2728. @findex -append
  2729. Use @var{cmdline} as kernel command line
  2730. ETEXI
  2731. DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
  2732. "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
  2733. STEXI
  2734. @item -initrd @var{file}
  2735. @findex -initrd
  2736. Use @var{file} as initial ram disk.
  2737. @item -initrd "@var{file1} arg=foo,@var{file2}"
  2738. This syntax is only available with multiboot.
  2739. Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
  2740. first module.
  2741. ETEXI
  2742. DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
  2743. "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL)
  2744. STEXI
  2745. @item -dtb @var{file}
  2746. @findex -dtb
  2747. Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
  2748. on boot.
  2749. ETEXI
  2750. STEXI
  2751. @end table
  2752. ETEXI
  2753. DEFHEADING()
  2754. DEFHEADING(Debug/Expert options:)
  2755. STEXI
  2756. @table @option
  2757. ETEXI
  2758. DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg,
  2759. "-fw_cfg [name=]<name>,file=<file>\n"
  2760. " add named fw_cfg entry with contents from file\n"
  2761. "-fw_cfg [name=]<name>,string=<str>\n"
  2762. " add named fw_cfg entry with contents from string\n",
  2763. QEMU_ARCH_ALL)
  2764. STEXI
  2765. @item -fw_cfg [name=]@var{name},file=@var{file}
  2766. @findex -fw_cfg
  2767. Add named fw_cfg entry with contents from file @var{file}.
  2768. @item -fw_cfg [name=]@var{name},string=@var{str}
  2769. Add named fw_cfg entry with contents from string @var{str}.
  2770. The terminating NUL character of the contents of @var{str} will not be
  2771. included as part of the fw_cfg item data. To insert contents with
  2772. embedded NUL characters, you have to use the @var{file} parameter.
  2773. The fw_cfg entries are passed by QEMU through to the guest.
  2774. Example:
  2775. @example
  2776. -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin
  2777. @end example
  2778. creates an fw_cfg entry named opt/com.mycompany/blob with contents
  2779. from ./my_blob.bin.
  2780. ETEXI
  2781. DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
  2782. "-serial dev redirect the serial port to char device 'dev'\n",
  2783. QEMU_ARCH_ALL)
  2784. STEXI
  2785. @item -serial @var{dev}
  2786. @findex -serial
  2787. Redirect the virtual serial port to host character device
  2788. @var{dev}. The default device is @code{vc} in graphical mode and
  2789. @code{stdio} in non graphical mode.
  2790. This option can be used several times to simulate up to 4 serial
  2791. ports.
  2792. Use @code{-serial none} to disable all serial ports.
  2793. Available character devices are:
  2794. @table @option
  2795. @item vc[:@var{W}x@var{H}]
  2796. Virtual console. Optionally, a width and height can be given in pixel with
  2797. @example
  2798. vc:800x600
  2799. @end example
  2800. It is also possible to specify width or height in characters:
  2801. @example
  2802. vc:80Cx24C
  2803. @end example
  2804. @item pty
  2805. [Linux only] Pseudo TTY (a new PTY is automatically allocated)
  2806. @item none
  2807. No device is allocated.
  2808. @item null
  2809. void device
  2810. @item chardev:@var{id}
  2811. Use a named character device defined with the @code{-chardev} option.
  2812. @item /dev/XXX
  2813. [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
  2814. parameters are set according to the emulated ones.
  2815. @item /dev/parport@var{N}
  2816. [Linux only, parallel port only] Use host parallel port
  2817. @var{N}. Currently SPP and EPP parallel port features can be used.
  2818. @item file:@var{filename}
  2819. Write output to @var{filename}. No character can be read.
  2820. @item stdio
  2821. [Unix only] standard input/output
  2822. @item pipe:@var{filename}
  2823. name pipe @var{filename}
  2824. @item COM@var{n}
  2825. [Windows only] Use host serial port @var{n}
  2826. @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
  2827. This implements UDP Net Console.
  2828. When @var{remote_host} or @var{src_ip} are not specified
  2829. they default to @code{}.
  2830. When not using a specified @var{src_port} a random port is automatically chosen.
  2831. If you just want a simple readonly console you can use @code{netcat} or
  2832. @code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
  2833. @code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
  2834. will appear in the netconsole session.
  2835. If you plan to send characters back via netconsole or you want to stop
  2836. and start QEMU a lot of times, you should have QEMU use the same
  2837. source port each time by using something like @code{-serial
  2838. udp::4555@@:4556} to QEMU. Another approach is to use a patched
  2839. version of netcat which can listen to a TCP port and send and receive
  2840. characters via udp. If you have a patched version of netcat which
  2841. activates telnet remote echo and single char transfer, then you can
  2842. use the following options to set up a netcat redirector to allow
  2843. telnet on port 5555 to access the QEMU port.
  2844. @table @code
  2845. @item QEMU Options:
  2846. -serial udp::4555@@:4556
  2847. @item netcat options:
  2848. -u -P 4555 -L -t -p 5555 -I -T
  2849. @item telnet options:
  2850. localhost 5555
  2851. @end table
  2852. @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}]
  2853. The TCP Net Console has two modes of operation. It can send the serial
  2854. I/O to a location or wait for a connection from a location. By default
  2855. the TCP Net Console is sent to @var{host} at the @var{port}. If you use
  2856. the @var{server} option QEMU will wait for a client socket application
  2857. to connect to the port before continuing, unless the @code{nowait}
  2858. option was specified. The @code{nodelay} option disables the Nagle buffering
  2859. algorithm. The @code{reconnect} option only applies if @var{noserver} is
  2860. set, if the connection goes down it will attempt to reconnect at the
  2861. given interval. If @var{host} is omitted, is assumed. Only
  2862. one TCP connection at a time is accepted. You can use @code{telnet} to
  2863. connect to the corresponding character device.
  2864. @table @code
  2865. @item Example to send tcp console to port 4444
  2866. -serial tcp:
  2867. @item Example to listen and wait on port 4444 for connection
  2868. -serial tcp::4444,server
  2869. @item Example to not wait and listen on ip port 4444
  2870. -serial tcp:,server,nowait
  2871. @end table
  2872. @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
  2873. The telnet protocol is used instead of raw tcp sockets. The options
  2874. work the same as if you had specified @code{-serial tcp}. The
  2875. difference is that the port acts like a telnet server or client using
  2876. telnet option negotiation. This will also allow you to send the
  2877. MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
  2878. sequence. Typically in unix telnet you do it with Control-] and then
  2879. type "send break" followed by pressing the enter key.
  2880. @item websocket:@var{host}:@var{port},server[,nowait][,nodelay]
  2881. The WebSocket protocol is used instead of raw tcp socket. The port acts as
  2882. a WebSocket server. Client mode is not supported.
  2883. @item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}]
  2884. A unix domain socket is used instead of a tcp socket. The option works the
  2885. same as if you had specified @code{-serial tcp} except the unix domain socket
  2886. @var{path} is used for connections.
  2887. @item mon:@var{dev_string}
  2888. This is a special option to allow the monitor to be multiplexed onto
  2889. another serial port. The monitor is accessed with key sequence of
  2890. @key{Control-a} and then pressing @key{c}.
  2891. @var{dev_string} should be any one of the serial devices specified
  2892. above. An example to multiplex the monitor onto a telnet server
  2893. listening on port 4444 would be:
  2894. @table @code
  2895. @item -serial mon:telnet::4444,server,nowait
  2896. @end table
  2897. When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate
  2898. QEMU any more but will be passed to the guest instead.
  2899. @item braille
  2900. Braille device. This will use BrlAPI to display the braille output on a real
  2901. or fake device.
  2902. @item msmouse
  2903. Three button serial mouse. Configure the guest to use Microsoft protocol.
  2904. @end table
  2905. ETEXI
  2906. DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
  2907. "-parallel dev redirect the parallel port to char device 'dev'\n",
  2908. QEMU_ARCH_ALL)
  2909. STEXI
  2910. @item -parallel @var{dev}
  2911. @findex -parallel
  2912. Redirect the virtual parallel port to host device @var{dev} (same
  2913. devices as the serial port). On Linux hosts, @file{/dev/parportN} can
  2914. be used to use hardware devices connected on the corresponding host
  2915. parallel port.
  2916. This option can be used several times to simulate up to 3 parallel
  2917. ports.
  2918. Use @code{-parallel none} to disable all parallel ports.
  2919. ETEXI
  2920. DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
  2921. "-monitor dev redirect the monitor to char device 'dev'\n",
  2922. QEMU_ARCH_ALL)
  2923. STEXI
  2924. @item -monitor @var{dev}
  2925. @findex -monitor
  2926. Redirect the monitor to host device @var{dev} (same devices as the
  2927. serial port).
  2928. The default device is @code{vc} in graphical mode and @code{stdio} in
  2929. non graphical mode.
  2930. Use @code{-monitor none} to disable the default monitor.
  2931. ETEXI
  2932. DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
  2933. "-qmp dev like -monitor but opens in 'control' mode\n",
  2934. QEMU_ARCH_ALL)
  2935. STEXI
  2936. @item -qmp @var{dev}
  2937. @findex -qmp
  2938. Like -monitor but opens in 'control' mode.
  2939. ETEXI
  2940. DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \
  2941. "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n",
  2942. QEMU_ARCH_ALL)
  2943. STEXI
  2944. @item -qmp-pretty @var{dev}
  2945. @findex -qmp-pretty
  2946. Like -qmp but uses pretty JSON formatting.
  2947. ETEXI
  2948. DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
  2949. "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL)
  2950. STEXI
  2951. @item -mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]
  2952. @findex -mon
  2953. Setup monitor on chardev @var{name}. @code{pretty} turns on JSON pretty printing
  2954. easing human reading and debugging.
  2955. ETEXI
  2956. DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
  2957. "-debugcon dev redirect the debug console to char device 'dev'\n",
  2958. QEMU_ARCH_ALL)
  2959. STEXI
  2960. @item -debugcon @var{dev}
  2961. @findex -debugcon
  2962. Redirect the debug console to host device @var{dev} (same devices as the
  2963. serial port). The debug console is an I/O port which is typically port
  2964. 0xe9; writing to that I/O port sends output to this device.
  2965. The default device is @code{vc} in graphical mode and @code{stdio} in
  2966. non graphical mode.
  2967. ETEXI
  2968. DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
  2969. "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
  2970. STEXI
  2971. @item -pidfile @var{file}
  2972. @findex -pidfile
  2973. Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
  2974. from a script.
  2975. ETEXI
  2976. DEF("singlestep", 0, QEMU_OPTION_singlestep, \
  2977. "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
  2978. STEXI
  2979. @item -singlestep
  2980. @findex -singlestep
  2981. Run the emulation in single step mode.
  2982. ETEXI
  2983. DEF("preconfig", 0, QEMU_OPTION_preconfig, \
  2984. "--preconfig pause QEMU before machine is initialized (experimental)\n",
  2985. QEMU_ARCH_ALL)
  2986. STEXI
  2987. @item --preconfig
  2988. @findex --preconfig
  2989. Pause QEMU for interactive configuration before the machine is created,
  2990. which allows querying and configuring properties that will affect
  2991. machine initialization. Use QMP command 'x-exit-preconfig' to exit
  2992. the preconfig state and move to the next state (i.e. run guest if -S
  2993. isn't used or pause the second time if -S is used). This option is
  2994. experimental.
  2995. ETEXI
  2996. DEF("S", 0, QEMU_OPTION_S, \
  2997. "-S freeze CPU at startup (use 'c' to start execution)\n",
  2998. QEMU_ARCH_ALL)
  2999. STEXI
  3000. @item -S
  3001. @findex -S
  3002. Do not start CPU at startup (you must type 'c' in the monitor).
  3003. ETEXI
  3004. DEF("realtime", HAS_ARG, QEMU_OPTION_realtime,
  3005. "-realtime [mlock=on|off]\n"
  3006. " run qemu with realtime features\n"
  3007. " mlock=on|off controls mlock support (default: on)\n",
  3008. QEMU_ARCH_ALL)
  3009. STEXI
  3010. @item -realtime mlock=on|off
  3011. @findex -realtime
  3012. Run qemu with realtime features.
  3013. mlocking qemu and guest memory can be enabled via @option{mlock=on}
  3014. (enabled by default).
  3015. ETEXI
  3016. DEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit,
  3017. "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n"
  3018. " run qemu with overcommit hints\n"
  3019. " mem-lock=on|off controls memory lock support (default: off)\n"
  3020. " cpu-pm=on|off controls cpu power management (default: off)\n",
  3021. QEMU_ARCH_ALL)
  3022. STEXI
  3023. @item -overcommit mem-lock=on|off
  3024. @item -overcommit cpu-pm=on|off
  3025. @findex -overcommit
  3026. Run qemu with hints about host resource overcommit. The default is
  3027. to assume that host overcommits all resources.
  3028. Locking qemu and guest memory can be enabled via @option{mem-lock=on} (disabled
  3029. by default). This works when host memory is not overcommitted and reduces the
  3030. worst-case latency for guest. This is equivalent to @option{realtime}.
  3031. Guest ability to manage power state of host cpus (increasing latency for other
  3032. processes on the same host cpu, but decreasing latency for guest) can be
  3033. enabled via @option{cpu-pm=on} (disabled by default). This works best when
  3034. host CPU is not overcommitted. When used, host estimates of CPU cycle and power
  3035. utilization will be incorrect, not taking into account guest idle time.
  3036. ETEXI
  3037. DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
  3038. "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
  3039. STEXI
  3040. @item -gdb @var{dev}
  3041. @findex -gdb
  3042. Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
  3043. connections will likely be TCP-based, but also UDP, pseudo TTY, or even
  3044. stdio are reasonable use case. The latter is allowing to start QEMU from
  3045. within gdb and establish the connection via a pipe:
  3046. @example
  3047. (gdb) target remote | exec qemu-system-i386 -gdb stdio ...
  3048. @end example
  3049. ETEXI
  3050. DEF("s", 0, QEMU_OPTION_s, \
  3051. "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
  3052. QEMU_ARCH_ALL)
  3053. STEXI
  3054. @item -s
  3055. @findex -s
  3056. Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
  3057. (@pxref{gdb_usage}).
  3058. ETEXI
  3059. DEF("d", HAS_ARG, QEMU_OPTION_d, \
  3060. "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n",
  3061. QEMU_ARCH_ALL)
  3062. STEXI
  3063. @item -d @var{item1}[,...]
  3064. @findex -d
  3065. Enable logging of specified items. Use '-d help' for a list of log items.
  3066. ETEXI
  3067. DEF("D", HAS_ARG, QEMU_OPTION_D, \
  3068. "-D logfile output log to logfile (default stderr)\n",
  3069. QEMU_ARCH_ALL)
  3070. STEXI
  3071. @item -D @var{logfile}
  3072. @findex -D
  3073. Output log in @var{logfile} instead of to stderr
  3074. ETEXI
  3075. DEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \
  3076. "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n",
  3077. QEMU_ARCH_ALL)
  3078. STEXI
  3079. @item -dfilter @var{range1}[,...]
  3080. @findex -dfilter
  3081. Filter debug output to that relevant to a range of target addresses. The filter
  3082. spec can be either @var{start}+@var{size}, @var{start}-@var{size} or
  3083. @var{start}..@var{end} where @var{start} @var{end} and @var{size} are the
  3084. addresses and sizes required. For example:
  3085. @example
  3086. -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000
  3087. @end example
  3088. Will dump output for any code in the 0x1000 sized block starting at 0x8000 and
  3089. the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized
  3090. block starting at 0xffffffc00005f000.
  3091. ETEXI
  3092. DEF("seed", HAS_ARG, QEMU_OPTION_seed, \
  3093. "-seed number seed the pseudo-random number generator\n",
  3094. QEMU_ARCH_ALL)
  3095. STEXI
  3096. @item -seed @var{number}
  3097. @findex -seed
  3098. Force the guest to use a deterministic pseudo-random number generator, seeded
  3099. with @var{number}. This does not affect crypto routines within the host.
  3100. ETEXI
  3101. DEF("L", HAS_ARG, QEMU_OPTION_L, \
  3102. "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
  3103. QEMU_ARCH_ALL)
  3104. STEXI
  3105. @item -L @var{path}
  3106. @findex -L
  3107. Set the directory for the BIOS, VGA BIOS and keymaps.
  3108. To list all the data directories, use @code{-L help}.
  3109. ETEXI
  3110. DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
  3111. "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
  3112. STEXI
  3113. @item -bios @var{file}
  3114. @findex -bios
  3115. Set the filename for the BIOS.
  3116. ETEXI
  3117. DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
  3118. "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
  3119. STEXI
  3120. @item -enable-kvm
  3121. @findex -enable-kvm
  3122. Enable KVM full virtualization support. This option is only available
  3123. if KVM support is enabled when compiling.
  3124. ETEXI
  3125. DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
  3126. "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
  3127. DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
  3128. "-xen-attach attach to existing xen domain\n"
  3129. " libxl will use this when starting QEMU\n",
  3130. QEMU_ARCH_ALL)
  3131. DEF("xen-domid-restrict", 0, QEMU_OPTION_xen_domid_restrict,
  3132. "-xen-domid-restrict restrict set of available xen operations\n"
  3133. " to specified domain id. (Does not affect\n"
  3134. " xenpv machine type).\n",
  3135. QEMU_ARCH_ALL)
  3136. STEXI
  3137. @item -xen-domid @var{id}
  3138. @findex -xen-domid
  3139. Specify xen guest domain @var{id} (XEN only).
  3140. @item -xen-attach
  3141. @findex -xen-attach
  3142. Attach to existing xen domain.
  3143. libxl will use this when starting QEMU (XEN only).
  3144. @findex -xen-domid-restrict
  3145. Restrict set of available xen operations to specified domain id (XEN only).
  3146. ETEXI
  3147. DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
  3148. "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
  3149. STEXI
  3150. @item -no-reboot
  3151. @findex -no-reboot
  3152. Exit instead of rebooting.
  3153. ETEXI
  3154. DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
  3155. "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
  3156. STEXI
  3157. @item -no-shutdown
  3158. @findex -no-shutdown
  3159. Don't exit QEMU on guest shutdown, but instead only stop the emulation.
  3160. This allows for instance switching to monitor to commit changes to the
  3161. disk image.
  3162. ETEXI
  3163. DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
  3164. "-loadvm [tag|id]\n" \
  3165. " start right away with a saved state (loadvm in monitor)\n",
  3166. QEMU_ARCH_ALL)
  3167. STEXI
  3168. @item -loadvm @var{file}
  3169. @findex -loadvm
  3170. Start right away with a saved state (@code{loadvm} in monitor)
  3171. ETEXI
  3172. #ifndef _WIN32
  3173. DEF("daemonize", 0, QEMU_OPTION_daemonize, \
  3174. "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
  3175. #endif
  3176. STEXI
  3177. @item -daemonize
  3178. @findex -daemonize
  3179. Daemonize the QEMU process after initialization. QEMU will not detach from
  3180. standard IO until it is ready to receive connections on any of its devices.
  3181. This option is a useful way for external programs to launch QEMU without having
  3182. to cope with initialization race conditions.
  3183. ETEXI
  3184. DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
  3185. "-option-rom rom load a file, rom, into the option ROM space\n",
  3186. QEMU_ARCH_ALL)
  3187. STEXI
  3188. @item -option-rom @var{file}
  3189. @findex -option-rom
  3190. Load the contents of @var{file} as an option ROM.
  3191. This option is useful to load things like EtherBoot.
  3192. ETEXI
  3193. DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
  3194. "-rtc [base=utc|localtime|<datetime>][,clock=host|rt|vm][,driftfix=none|slew]\n" \
  3195. " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
  3196. QEMU_ARCH_ALL)
  3197. STEXI
  3198. @item -rtc [base=utc|localtime|@var{datetime}][,clock=host|rt|vm][,driftfix=none|slew]
  3199. @findex -rtc
  3200. Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
  3201. UTC or local time, respectively. @code{localtime} is required for correct date in
  3202. MS-DOS or Windows. To start at a specific point in time, provide @var{datetime} in the
  3203. format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
  3204. By default the RTC is driven by the host system time. This allows using of the
  3205. RTC as accurate reference clock inside the guest, specifically if the host
  3206. time is smoothly following an accurate external reference clock, e.g. via NTP.
  3207. If you want to isolate the guest time from the host, you can set @option{clock}
  3208. to @code{rt} instead, which provides a host monotonic clock if host support it.
  3209. To even prevent the RTC from progressing during suspension, you can set @option{clock}
  3210. to @code{vm} (virtual clock). @samp{clock=vm} is recommended especially in
  3211. icount mode in order to preserve determinism; however, note that in icount mode
  3212. the speed of the virtual clock is variable and can in general differ from the
  3213. host clock.
  3214. Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
  3215. specifically with Windows' ACPI HAL. This option will try to figure out how
  3216. many timer interrupts were not processed by the Windows guest and will
  3217. re-inject them.
  3218. ETEXI
  3219. DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
  3220. "-icount [shift=N|auto][,align=on|off][,sleep=on|off,rr=record|replay,rrfile=<filename>,rrsnapshot=<snapshot>]\n" \
  3221. " enable virtual instruction counter with 2^N clock ticks per\n" \
  3222. " instruction, enable aligning the host and virtual clocks\n" \
  3223. " or disable real time cpu sleeping\n", QEMU_ARCH_ALL)
  3224. STEXI
  3225. @item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename},rrsnapshot=@var{snapshot}]
  3226. @findex -icount
  3227. Enable virtual instruction counter. The virtual cpu will execute one
  3228. instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
  3229. then the virtual cpu speed will be automatically adjusted to keep virtual
  3230. time within a few seconds of real time.
  3231. When the virtual cpu is sleeping, the virtual time will advance at default
  3232. speed unless @option{sleep=on|off} is specified.
  3233. With @option{sleep=on|off}, the virtual time will jump to the next timer deadline
  3234. instantly whenever the virtual cpu goes to sleep mode and will not advance
  3235. if no timer is enabled. This behavior give deterministic execution times from
  3236. the guest point of view.
  3237. Note that while this option can give deterministic behavior, it does not
  3238. provide cycle accurate emulation. Modern CPUs contain superscalar out of
  3239. order cores with complex cache hierarchies. The number of instructions
  3240. executed often has little or no correlation with actual performance.
  3241. @option{align=on} will activate the delay algorithm which will try
  3242. to synchronise the host clock and the virtual clock. The goal is to
  3243. have a guest running at the real frequency imposed by the shift option.
  3244. Whenever the guest clock is behind the host clock and if
  3245. @option{align=on} is specified then we print a message to the user
  3246. to inform about the delay.
  3247. Currently this option does not work when @option{shift} is @code{auto}.
  3248. Note: The sync algorithm will work for those shift values for which
  3249. the guest clock runs ahead of the host clock. Typically this happens
  3250. when the shift value is high (how high depends on the host machine).
  3251. When @option{rr} option is specified deterministic record/replay is enabled.
  3252. Replay log is written into @var{filename} file in record mode and
  3253. read from this file in replay mode.
  3254. Option rrsnapshot is used to create new vm snapshot named @var{snapshot}
  3255. at the start of execution recording. In replay mode this option is used
  3256. to load the initial VM state.
  3257. ETEXI
  3258. DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
  3259. "-watchdog model\n" \
  3260. " enable virtual hardware watchdog [default=none]\n",
  3261. QEMU_ARCH_ALL)
  3262. STEXI
  3263. @item -watchdog @var{model}
  3264. @findex -watchdog
  3265. Create a virtual hardware watchdog device. Once enabled (by a guest
  3266. action), the watchdog must be periodically polled by an agent inside
  3267. the guest or else the guest will be restarted. Choose a model for
  3268. which your guest has drivers.
  3269. The @var{model} is the model of hardware watchdog to emulate. Use
  3270. @code{-watchdog help} to list available hardware models. Only one
  3271. watchdog can be enabled for a guest.
  3272. The following models may be available:
  3273. @table @option
  3274. @item ib700
  3275. iBASE 700 is a very simple ISA watchdog with a single timer.
  3276. @item i6300esb
  3277. Intel 6300ESB I/O controller hub is a much more featureful PCI-based
  3278. dual-timer watchdog.
  3279. @item diag288
  3280. A virtual watchdog for s390x backed by the diagnose 288 hypercall
  3281. (currently KVM only).
  3282. @end table
  3283. ETEXI
  3284. DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
  3285. "-watchdog-action reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" \
  3286. " action when watchdog fires [default=reset]\n",
  3287. QEMU_ARCH_ALL)
  3288. STEXI
  3289. @item -watchdog-action @var{action}
  3290. @findex -watchdog-action
  3291. The @var{action} controls what QEMU will do when the watchdog timer
  3292. expires.
  3293. The default is
  3294. @code{reset} (forcefully reset the guest).
  3295. Other possible actions are:
  3296. @code{shutdown} (attempt to gracefully shutdown the guest),
  3297. @code{poweroff} (forcefully poweroff the guest),
  3298. @code{inject-nmi} (inject a NMI into the guest),
  3299. @code{pause} (pause the guest),
  3300. @code{debug} (print a debug message and continue), or
  3301. @code{none} (do nothing).
  3302. Note that the @code{shutdown} action requires that the guest responds
  3303. to ACPI signals, which it may not be able to do in the sort of
  3304. situations where the watchdog would have expired, and thus
  3305. @code{-watchdog-action shutdown} is not recommended for production use.
  3306. Examples:
  3307. @table @code
  3308. @item -watchdog i6300esb -watchdog-action pause
  3309. @itemx -watchdog ib700
  3310. @end table
  3311. ETEXI
  3312. DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
  3313. "-echr chr set terminal escape character instead of ctrl-a\n",
  3314. QEMU_ARCH_ALL)
  3315. STEXI
  3316. @item -echr @var{numeric_ascii_value}
  3317. @findex -echr
  3318. Change the escape character used for switching to the monitor when using
  3319. monitor and serial sharing. The default is @code{0x01} when using the
  3320. @code{-nographic} option. @code{0x01} is equal to pressing
  3321. @code{Control-a}. You can select a different character from the ascii
  3322. control keys where 1 through 26 map to Control-a through Control-z. For
  3323. instance you could use the either of the following to change the escape
  3324. character to Control-t.
  3325. @table @code
  3326. @item -echr 0x14
  3327. @itemx -echr 20
  3328. @end table
  3329. ETEXI
  3330. DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
  3331. "-show-cursor show cursor\n", QEMU_ARCH_ALL)
  3332. STEXI
  3333. @item -show-cursor
  3334. @findex -show-cursor
  3335. Show cursor.
  3336. ETEXI
  3337. DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
  3338. "-tb-size n set TB size\n", QEMU_ARCH_ALL)
  3339. STEXI
  3340. @item -tb-size @var{n}
  3341. @findex -tb-size
  3342. Set TB size.
  3343. ETEXI
  3344. DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
  3345. "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \
  3346. "-incoming rdma:host:port[,ipv4][,ipv6]\n" \
  3347. "-incoming unix:socketpath\n" \
  3348. " prepare for incoming migration, listen on\n" \
  3349. " specified protocol and socket address\n" \
  3350. "-incoming fd:fd\n" \
  3351. "-incoming exec:cmdline\n" \
  3352. " accept incoming migration on given file descriptor\n" \
  3353. " or from given external command\n" \
  3354. "-incoming defer\n" \
  3355. " wait for the URI to be specified via migrate_incoming\n",
  3356. QEMU_ARCH_ALL)
  3357. STEXI
  3358. @item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]
  3359. @itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6]
  3360. @findex -incoming
  3361. Prepare for incoming migration, listen on a given tcp port.
  3362. @item -incoming unix:@var{socketpath}
  3363. Prepare for incoming migration, listen on a given unix socket.
  3364. @item -incoming fd:@var{fd}
  3365. Accept incoming migration from a given filedescriptor.
  3366. @item -incoming exec:@var{cmdline}
  3367. Accept incoming migration as an output from specified external command.
  3368. @item -incoming defer
  3369. Wait for the URI to be specified via migrate_incoming. The monitor can
  3370. be used to change settings (such as migration parameters) prior to issuing
  3371. the migrate_incoming to allow the migration to begin.
  3372. ETEXI
  3373. DEF("only-migratable", 0, QEMU_OPTION_only_migratable, \
  3374. "-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL)
  3375. STEXI
  3376. @item -only-migratable
  3377. @findex -only-migratable
  3378. Only allow migratable devices. Devices will not be allowed to enter an
  3379. unmigratable state.
  3380. ETEXI
  3381. DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
  3382. "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
  3383. STEXI
  3384. @item -nodefaults
  3385. @findex -nodefaults
  3386. Don't create default devices. Normally, QEMU sets the default devices like serial
  3387. port, parallel port, virtual console, monitor device, VGA adapter, floppy and
  3388. CD-ROM drive and others. The @code{-nodefaults} option will disable all those
  3389. default devices.
  3390. ETEXI
  3391. #ifndef _WIN32
  3392. DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
  3393. "-chroot dir chroot to dir just before starting the VM\n",
  3394. QEMU_ARCH_ALL)
  3395. #endif
  3396. STEXI
  3397. @item -chroot @var{dir}
  3398. @findex -chroot
  3399. Immediately before starting guest execution, chroot to the specified
  3400. directory. Especially useful in combination with -runas.
  3401. ETEXI
  3402. #ifndef _WIN32
  3403. DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
  3404. "-runas user change to user id user just before starting the VM\n" \
  3405. " user can be numeric uid:gid instead\n",
  3406. QEMU_ARCH_ALL)
  3407. #endif
  3408. STEXI
  3409. @item -runas @var{user}
  3410. @findex -runas
  3411. Immediately before starting guest execution, drop root privileges, switching
  3412. to the specified user.
  3413. ETEXI
  3414. DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
  3415. "-prom-env variable=value\n"
  3416. " set OpenBIOS nvram variables\n",
  3418. STEXI
  3419. @item -prom-env @var{variable}=@var{value}
  3420. @findex -prom-env
  3421. Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
  3422. ETEXI
  3423. DEF("semihosting", 0, QEMU_OPTION_semihosting,
  3424. "-semihosting semihosting mode\n",
  3427. STEXI
  3428. @item -semihosting
  3429. @findex -semihosting
  3430. Enable semihosting mode (ARM, M68K, Xtensa, MIPS, Nios II only).
  3431. ETEXI
  3432. DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config,
  3433. "-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]\n" \
  3434. " semihosting configuration\n",
  3437. STEXI
  3438. @item -semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,arg=str[,...]]
  3439. @findex -semihosting-config
  3440. Enable and configure semihosting (ARM, M68K, Xtensa, MIPS, Nios II only).
  3441. @table @option
  3442. @item target=@code{native|gdb|auto}
  3443. Defines where the semihosting calls will be addressed, to QEMU (@code{native})
  3444. or to GDB (@code{gdb}). The default is @code{auto}, which means @code{gdb}
  3445. during debug sessions and @code{native} otherwise.
  3446. @item chardev=@var{str1}
  3447. Send the output to a chardev backend output for native or auto output when not in gdb
  3448. @item arg=@var{str1},arg=@var{str2},...
  3449. Allows the user to pass input arguments, and can be used multiple times to build
  3450. up a list. The old-style @code{-kernel}/@code{-append} method of passing a
  3451. command line is still supported for backward compatibility. If both the
  3452. @code{--semihosting-config arg} and the @code{-kernel}/@code{-append} are
  3453. specified, the former is passed to semihosting as it always takes precedence.
  3454. @end table
  3455. ETEXI
  3456. DEF("old-param", 0, QEMU_OPTION_old_param,
  3457. "-old-param old param mode\n", QEMU_ARCH_ARM)
  3458. STEXI
  3459. @item -old-param
  3460. @findex -old-param (ARM)
  3461. Old param mode (ARM only).
  3462. ETEXI
  3463. DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \
  3464. "-sandbox on[,obsolete=allow|deny][,elevateprivileges=allow|deny|children]\n" \
  3465. " [,spawn=allow|deny][,resourcecontrol=allow|deny]\n" \
  3466. " Enable seccomp mode 2 system call filter (default 'off').\n" \
  3467. " use 'obsolete' to allow obsolete system calls that are provided\n" \
  3468. " by the kernel, but typically no longer used by modern\n" \
  3469. " C library implementations.\n" \
  3470. " use 'elevateprivileges' to allow or deny QEMU process to elevate\n" \
  3471. " its privileges by blacklisting all set*uid|gid system calls.\n" \
  3472. " The value 'children' will deny set*uid|gid system calls for\n" \
  3473. " main QEMU process but will allow forks and execves to run unprivileged\n" \
  3474. " use 'spawn' to avoid QEMU to spawn new threads or processes by\n" \
  3475. " blacklisting *fork and execve\n" \
  3476. " use 'resourcecontrol' to disable process affinity and schedular priority\n",
  3477. QEMU_ARCH_ALL)
  3478. STEXI
  3479. @item -sandbox @var{arg}[,obsolete=@var{string}][,elevateprivileges=@var{string}][,spawn=@var{string}][,resourcecontrol=@var{string}]
  3480. @findex -sandbox
  3481. Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will
  3482. disable it. The default is 'off'.
  3483. @table @option
  3484. @item obsolete=@var{string}
  3485. Enable Obsolete system calls
  3486. @item elevateprivileges=@var{string}
  3487. Disable set*uid|gid system calls
  3488. @item spawn=@var{string}
  3489. Disable *fork and execve
  3490. @item resourcecontrol=@var{string}
  3491. Disable process affinity and schedular priority
  3492. @end table
  3493. ETEXI
  3494. DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
  3495. "-readconfig <file>\n", QEMU_ARCH_ALL)
  3496. STEXI
  3497. @item -readconfig @var{file}
  3498. @findex -readconfig
  3499. Read device configuration from @var{file}. This approach is useful when you want to spawn
  3500. QEMU process with many command line options but you don't want to exceed the command line
  3501. character limit.
  3502. ETEXI
  3503. DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
  3504. "-writeconfig <file>\n"
  3505. " read/write config file\n", QEMU_ARCH_ALL)
  3506. STEXI
  3507. @item -writeconfig @var{file}
  3508. @findex -writeconfig
  3509. Write device configuration to @var{file}. The @var{file} can be either filename to save
  3510. command line and device configuration into file or dash @code{-}) character to print the
  3511. output to stdout. This can be later used as input file for @code{-readconfig} option.
  3512. ETEXI
  3513. DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
  3514. "-no-user-config\n"
  3515. " do not load default user-provided config files at startup\n",
  3516. QEMU_ARCH_ALL)
  3517. STEXI
  3518. @item -no-user-config
  3519. @findex -no-user-config
  3520. The @code{-no-user-config} option makes QEMU not load any of the user-provided
  3521. config files on @var{sysconfdir}.
  3522. ETEXI
  3523. DEF("trace", HAS_ARG, QEMU_OPTION_trace,
  3524. "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
  3525. " specify tracing options\n",
  3526. QEMU_ARCH_ALL)
  3527. STEXI
  3528. HXCOMM This line is not accurate, as some sub-options are backend-specific but
  3529. HXCOMM HX does not support conditional compilation of text.
  3530. @item -trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}]
  3531. @findex -trace
  3532. @include qemu-option-trace.texi
  3533. ETEXI
  3534. HXCOMM Internal use
  3535. DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL)
  3536. DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL)
  3537. #ifdef __linux__
  3538. DEF("enable-fips", 0, QEMU_OPTION_enablefips,
  3539. "-enable-fips enable FIPS 140-2 compliance\n",
  3540. QEMU_ARCH_ALL)
  3541. #endif
  3542. STEXI
  3543. @item -enable-fips
  3544. @findex -enable-fips
  3545. Enable FIPS 140-2 compliance mode.
  3546. ETEXI
  3547. HXCOMM Deprecated by -machine accel=tcg property
  3548. DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386)
  3549. DEF("msg", HAS_ARG, QEMU_OPTION_msg,
  3550. "-msg timestamp[=on|off]\n"
  3551. " change the format of messages\n"
  3552. " on|off controls leading timestamps (default:on)\n",
  3553. QEMU_ARCH_ALL)
  3554. STEXI
  3555. @item -msg timestamp[=on|off]
  3556. @findex -msg
  3557. prepend a timestamp to each log message.(default:on)
  3558. ETEXI
  3559. DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate,
  3560. "-dump-vmstate <file>\n"
  3561. " Output vmstate information in JSON format to file.\n"
  3562. " Use the scripts/ file to\n"
  3563. " check for possible regressions in migration code\n"
  3564. " by comparing two such vmstate dumps.\n",
  3565. QEMU_ARCH_ALL)
  3566. STEXI
  3567. @item -dump-vmstate @var{file}
  3568. @findex -dump-vmstate
  3569. Dump json-encoded vmstate information for current machine type to file
  3570. in @var{file}
  3571. ETEXI
  3572. DEF("enable-sync-profile", 0, QEMU_OPTION_enable_sync_profile,
  3573. "-enable-sync-profile\n"
  3574. " enable synchronization profiling\n",
  3575. QEMU_ARCH_ALL)
  3576. STEXI
  3577. @item -enable-sync-profile
  3578. @findex -enable-sync-profile
  3579. Enable synchronization profiling.
  3580. ETEXI
  3581. STEXI
  3582. @end table
  3583. ETEXI
  3584. DEFHEADING()
  3585. DEFHEADING(Generic object creation:)
  3586. STEXI
  3587. @table @option
  3588. ETEXI
  3589. DEF("object", HAS_ARG, QEMU_OPTION_object,
  3590. "-object TYPENAME[,PROP1=VALUE1,...]\n"
  3591. " create a new object of type TYPENAME setting properties\n"
  3592. " in the order they are specified. Note that the 'id'\n"
  3593. " property must be set. These objects are placed in the\n"
  3594. " '/objects' path.\n",
  3595. QEMU_ARCH_ALL)
  3596. STEXI
  3597. @item -object @var{typename}[,@var{prop1}=@var{value1},...]
  3598. @findex -object
  3599. Create a new object of type @var{typename} setting properties
  3600. in the order they are specified. Note that the 'id'
  3601. property must be set. These objects are placed in the
  3602. '/objects' path.
  3603. @table @option
  3604. @item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off},discard-data=@var{on|off},merge=@var{on|off},dump=@var{on|off},prealloc=@var{on|off},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave},align=@var{align}
  3605. Creates a memory file backend object, which can be used to back
  3606. the guest RAM with huge pages.
  3607. The @option{id} parameter is a unique ID that will be used to reference this
  3608. memory region when configuring the @option{-numa} argument.
  3609. The @option{size} option provides the size of the memory region, and accepts
  3610. common suffixes, eg @option{500M}.
  3611. The @option{mem-path} provides the path to either a shared memory or huge page
  3612. filesystem mount.
  3613. The @option{share} boolean option determines whether the memory
  3614. region is marked as private to QEMU, or shared. The latter allows
  3615. a co-operating external process to access the QEMU memory region.
  3616. The @option{share} is also required for pvrdma devices due to
  3617. limitations in the RDMA API provided by Linux.
  3618. Setting share=on might affect the ability to configure NUMA
  3619. bindings for the memory backend under some circumstances, see
  3620. Documentation/vm/numa_memory_policy.txt on the Linux kernel
  3621. source tree for additional details.
  3622. Setting the @option{discard-data} boolean option to @var{on}
  3623. indicates that file contents can be destroyed when QEMU exits,
  3624. to avoid unnecessarily flushing data to the backing file. Note
  3625. that @option{discard-data} is only an optimization, and QEMU
  3626. might not discard file contents if it aborts unexpectedly or is
  3627. terminated using SIGKILL.
  3628. The @option{merge} boolean option enables memory merge, also known as
  3629. MADV_MERGEABLE, so that Kernel Samepage Merging will consider the pages for
  3630. memory deduplication.
  3631. Setting the @option{dump} boolean option to @var{off} excludes the memory from
  3632. core dumps. This feature is also known as MADV_DONTDUMP.
  3633. The @option{prealloc} boolean option enables memory preallocation.
  3634. The @option{host-nodes} option binds the memory range to a list of NUMA host
  3635. nodes.
  3636. The @option{policy} option sets the NUMA policy to one of the following values:
  3637. @table @option
  3638. @item @var{default}
  3639. default host policy
  3640. @item @var{preferred}
  3641. prefer the given host node list for allocation
  3642. @item @var{bind}
  3643. restrict memory allocation to the given host node list
  3644. @item @var{interleave}
  3645. interleave memory allocations across the given host node list
  3646. @end table
  3647. The @option{align} option specifies the base address alignment when
  3648. QEMU mmap(2) @option{mem-path}, and accepts common suffixes, eg
  3649. @option{2M}. Some backend store specified by @option{mem-path}
  3650. requires an alignment different than the default one used by QEMU, eg
  3651. the device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In
  3652. such cases, users can specify the required alignment via this option.
  3653. The @option{pmem} option specifies whether the backing file specified
  3654. by @option{mem-path} is in host persistent memory that can be accessed
  3655. using the SNIA NVM programming model (e.g. Intel NVDIMM).
  3656. If @option{pmem} is set to 'on', QEMU will take necessary operations to
  3657. guarantee the persistence of its own writes to @option{mem-path}
  3658. (e.g. in vNVDIMM label emulation and live migration).
  3659. Also, we will map the backend-file with MAP_SYNC flag, which ensures the
  3660. file metadata is in sync for @option{mem-path} in case of host crash
  3661. or a power failure. MAP_SYNC requires support from both the host kernel
  3662. (since Linux kernel 4.15) and the filesystem of @option{mem-path} mounted
  3663. with DAX option.
  3664. @item -object memory-backend-ram,id=@var{id},merge=@var{on|off},dump=@var{on|off},share=@var{on|off},prealloc=@var{on|off},size=@var{size},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave}
  3665. Creates a memory backend object, which can be used to back the guest RAM.
  3666. Memory backend objects offer more control than the @option{-m} option that is
  3667. traditionally used to define guest RAM. Please refer to
  3668. @option{memory-backend-file} for a description of the options.
  3669. @item -object memory-backend-memfd,id=@var{id},merge=@var{on|off},dump=@var{on|off},share=@var{on|off},prealloc=@var{on|off},size=@var{size},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave},seal=@var{on|off},hugetlb=@var{on|off},hugetlbsize=@var{size}
  3670. Creates an anonymous memory file backend object, which allows QEMU to
  3671. share the memory with an external process (e.g. when using
  3672. vhost-user). The memory is allocated with memfd and optional
  3673. sealing. (Linux only)
  3674. The @option{seal} option creates a sealed-file, that will block
  3675. further resizing the memory ('on' by default).
  3676. The @option{hugetlb} option specify the file to be created resides in
  3677. the hugetlbfs filesystem (since Linux 4.14). Used in conjunction with
  3678. the @option{hugetlb} option, the @option{hugetlbsize} option specify
  3679. the hugetlb page size on systems that support multiple hugetlb page
  3680. sizes (it must be a power of 2 value supported by the system).
  3681. In some versions of Linux, the @option{hugetlb} option is incompatible
  3682. with the @option{seal} option (requires at least Linux 4.16).
  3683. Please refer to @option{memory-backend-file} for a description of the
  3684. other options.
  3685. The @option{share} boolean option is @var{on} by default with memfd.
  3686. @item -object rng-random,id=@var{id},filename=@var{/dev/random}
  3687. Creates a random number generator backend which obtains entropy from
  3688. a device on the host. The @option{id} parameter is a unique ID that
  3689. will be used to reference this entropy backend from the @option{virtio-rng}
  3690. device. The @option{filename} parameter specifies which file to obtain
  3691. entropy from and if omitted defaults to @option{/dev/urandom}.
  3692. @item -object rng-egd,id=@var{id},chardev=@var{chardevid}
  3693. Creates a random number generator backend which obtains entropy from
  3694. an external daemon running on the host. The @option{id} parameter is
  3695. a unique ID that will be used to reference this entropy backend from
  3696. the @option{virtio-rng} device. The @option{chardev} parameter is
  3697. the unique ID of a character device backend that provides the connection
  3698. to the RNG daemon.
  3699. @item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off}
  3700. Creates a TLS anonymous credentials object, which can be used to provide
  3701. TLS support on network backends. The @option{id} parameter is a unique
  3702. ID which network backends will use to access the credentials. The
  3703. @option{endpoint} is either @option{server} or @option{client} depending
  3704. on whether the QEMU network backend that uses the credentials will be
  3705. acting as a client or as a server. If @option{verify-peer} is enabled
  3706. (the default) then once the handshake is completed, the peer credentials
  3707. will be verified, though this is a no-op for anonymous credentials.
  3708. The @var{dir} parameter tells QEMU where to find the credential
  3709. files. For server endpoints, this directory may contain a file
  3710. @var{dh-params.pem} providing diffie-hellman parameters to use
  3711. for the TLS server. If the file is missing, QEMU will generate
  3712. a set of DH parameters at startup. This is a computationally
  3713. expensive operation that consumes random pool entropy, so it is
  3714. recommended that a persistent set of parameters be generated
  3715. upfront and saved.
  3716. @item -object tls-creds-psk,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/keys/dir}[,username=@var{username}]
  3717. Creates a TLS Pre-Shared Keys (PSK) credentials object, which can be used to provide
  3718. TLS support on network backends. The @option{id} parameter is a unique
  3719. ID which network backends will use to access the credentials. The
  3720. @option{endpoint} is either @option{server} or @option{client} depending
  3721. on whether the QEMU network backend that uses the credentials will be
  3722. acting as a client or as a server. For clients only, @option{username}
  3723. is the username which will be sent to the server. If omitted
  3724. it defaults to ``qemu''.
  3725. The @var{dir} parameter tells QEMU where to find the keys file.
  3726. It is called ``@var{dir}/keys.psk'' and contains ``username:key''
  3727. pairs. This file can most easily be created using the GnuTLS
  3728. @code{psktool} program.
  3729. For server endpoints, @var{dir} may also contain a file
  3730. @var{dh-params.pem} providing diffie-hellman parameters to use
  3731. for the TLS server. If the file is missing, QEMU will generate
  3732. a set of DH parameters at startup. This is a computationally
  3733. expensive operation that consumes random pool entropy, so it is
  3734. recommended that a persistent set of parameters be generated
  3735. up front and saved.
  3736. @item -object tls-creds-x509,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},priority=@var{priority},verify-peer=@var{on|off},passwordid=@var{id}
  3737. Creates a TLS anonymous credentials object, which can be used to provide
  3738. TLS support on network backends. The @option{id} parameter is a unique
  3739. ID which network backends will use to access the credentials. The
  3740. @option{endpoint} is either @option{server} or @option{client} depending
  3741. on whether the QEMU network backend that uses the credentials will be
  3742. acting as a client or as a server. If @option{verify-peer} is enabled
  3743. (the default) then once the handshake is completed, the peer credentials
  3744. will be verified. With x509 certificates, this implies that the clients
  3745. must be provided with valid client certificates too.
  3746. The @var{dir} parameter tells QEMU where to find the credential
  3747. files. For server endpoints, this directory may contain a file
  3748. @var{dh-params.pem} providing diffie-hellman parameters to use
  3749. for the TLS server. If the file is missing, QEMU will generate
  3750. a set of DH parameters at startup. This is a computationally
  3751. expensive operation that consumes random pool entropy, so it is
  3752. recommended that a persistent set of parameters be generated
  3753. upfront and saved.
  3754. For x509 certificate credentials the directory will contain further files
  3755. providing the x509 certificates. The certificates must be stored
  3756. in PEM format, in filenames @var{ca-cert.pem}, @var{ca-crl.pem} (optional),
  3757. @var{server-cert.pem} (only servers), @var{server-key.pem} (only servers),
  3758. @var{client-cert.pem} (only clients), and @var{client-key.pem} (only clients).
  3759. For the @var{server-key.pem} and @var{client-key.pem} files which
  3760. contain sensitive private keys, it is possible to use an encrypted
  3761. version by providing the @var{passwordid} parameter. This provides
  3762. the ID of a previously created @code{secret} object containing the
  3763. password for decryption.
  3764. The @var{priority} parameter allows to override the global default
  3765. priority used by gnutls. This can be useful if the system administrator
  3766. needs to use a weaker set of crypto priorities for QEMU without
  3767. potentially forcing the weakness onto all applications. Or conversely
  3768. if one wants wants a stronger default for QEMU than for all other
  3769. applications, they can do this through this parameter. Its format is
  3770. a gnutls priority string as described at
  3771. @url{}.
  3772. @item -object filter-buffer,id=@var{id},netdev=@var{netdevid},interval=@var{t}[,queue=@var{all|rx|tx}][,status=@var{on|off}]
  3773. Interval @var{t} can't be 0, this filter batches the packet delivery: all
  3774. packets arriving in a given interval on netdev @var{netdevid} are delayed
  3775. until the end of the interval. Interval is in microseconds.
  3776. @option{status} is optional that indicate whether the netfilter is
  3777. on (enabled) or off (disabled), the default status for netfilter will be 'on'.
  3778. queue @var{all|rx|tx} is an option that can be applied to any netfilter.
  3779. @option{all}: the filter is attached both to the receive and the transmit
  3780. queue of the netdev (default).
  3781. @option{rx}: the filter is attached to the receive queue of the netdev,
  3782. where it will receive packets sent to the netdev.
  3783. @option{tx}: the filter is attached to the transmit queue of the netdev,
  3784. where it will receive packets sent by the netdev.
  3785. @item -object filter-mirror,id=@var{id},netdev=@var{netdevid},outdev=@var{chardevid},queue=@var{all|rx|tx}[,vnet_hdr_support]
  3786. filter-mirror on netdev @var{netdevid},mirror net packet to chardev@var{chardevid}, if it has the vnet_hdr_support flag, filter-mirror will mirror packet with vnet_hdr_len.
  3787. @item -object filter-redirector,id=@var{id},netdev=@var{netdevid},indev=@var{chardevid},outdev=@var{chardevid},queue=@var{all|rx|tx}[,vnet_hdr_support]
  3788. filter-redirector on netdev @var{netdevid},redirect filter's net packet to chardev
  3789. @var{chardevid},and redirect indev's packet to filter.if it has the vnet_hdr_support flag,
  3790. filter-redirector will redirect packet with vnet_hdr_len.
  3791. Create a filter-redirector we need to differ outdev id from indev id, id can not
  3792. be the same. we can just use indev or outdev, but at least one of indev or outdev
  3793. need to be specified.
  3794. @item -object filter-rewriter,id=@var{id},netdev=@var{netdevid},queue=@var{all|rx|tx},[vnet_hdr_support]
  3795. Filter-rewriter is a part of COLO project.It will rewrite tcp packet to
  3796. secondary from primary to keep secondary tcp connection,and rewrite
  3797. tcp packet to primary from secondary make tcp packet can be handled by
  3798. client.if it has the vnet_hdr_support flag, we can parse packet with vnet header.
  3799. usage:
  3800. colo secondary:
  3801. -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0
  3802. -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1
  3803. -object filter-rewriter,id=rew0,netdev=hn0,queue=all
  3804. @item -object filter-dump,id=@var{id},netdev=@var{dev}[,file=@var{filename}][,maxlen=@var{len}]
  3805. Dump the network traffic on netdev @var{dev} to the file specified by
  3806. @var{filename}. At most @var{len} bytes (64k by default) per packet are stored.
  3807. The file format is libpcap, so it can be analyzed with tools such as tcpdump
  3808. or Wireshark.
  3809. @item -object colo-compare,id=@var{id},primary_in=@var{chardevid},secondary_in=@var{chardevid},outdev=@var{chardevid},iothread=@var{id}[,vnet_hdr_support][,notify_dev=@var{id}]
  3810. Colo-compare gets packet from primary_in@var{chardevid} and secondary_in@var{chardevid}, than compare primary packet with
  3811. secondary packet. If the packets are same, we will output primary
  3812. packet to outdev@var{chardevid}, else we will notify colo-frame
  3813. do checkpoint and send primary packet to outdev@var{chardevid}.
  3814. In order to improve efficiency, we need to put the task of comparison
  3815. in another thread. If it has the vnet_hdr_support flag, colo compare
  3816. will send/recv packet with vnet_hdr_len.
  3817. If you want to use Xen COLO, will need the notify_dev to notify Xen
  3818. colo-frame to do checkpoint.
  3819. we must use it with the help of filter-mirror and filter-redirector.
  3820. @example
  3821. KVM COLO
  3822. primary:
  3823. -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
  3824. -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
  3825. -chardev socket,id=mirror0,host=,port=9003,server,nowait
  3826. -chardev socket,id=compare1,host=,port=9004,server,nowait
  3827. -chardev socket,id=compare0,host=,port=9001,server,nowait
  3828. -chardev socket,id=compare0-0,host=,port=9001
  3829. -chardev socket,id=compare_out,host=,port=9005,server,nowait
  3830. -chardev socket,id=compare_out0,host=,port=9005
  3831. -object iothread,id=iothread1
  3832. -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0
  3833. -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out
  3834. -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0
  3835. -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,iothread=iothread1
  3836. secondary:
  3837. -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown
  3838. -device e1000,netdev=hn0,mac=52:a4:00:12:78:66
  3839. -chardev socket,id=red0,host=,port=9003
  3840. -chardev socket,id=red1,host=,port=9004
  3841. -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0
  3842. -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1
  3843. Xen COLO
  3844. primary:
  3845. -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
  3846. -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
  3847. -chardev socket,id=mirror0,host=,port=9003,server,nowait
  3848. -chardev socket,id=compare1,host=,port=9004,server,nowait
  3849. -chardev socket,id=compare0,host=,port=9001,server,nowait
  3850. -chardev socket,id=compare0-0,host=,port=9001
  3851. -chardev socket,id=compare_out,host=,port=9005,server,nowait
  3852. -chardev socket,id=compare_out0,host=,port=9005
  3853. -chardev socket,id=notify_way,host=,port=9009,server,nowait
  3854. -object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0
  3855. -object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out
  3856. -object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0
  3857. -object iothread,id=iothread1
  3858. -object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0,notify_dev=nofity_way,iothread=iothread1
  3859. secondary:
  3860. -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown
  3861. -device e1000,netdev=hn0,mac=52:a4:00:12:78:66
  3862. -chardev socket,id=red0,host=,port=9003
  3863. -chardev socket,id=red1,host=,port=9004
  3864. -object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0
  3865. -object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1
  3866. @end example
  3867. If you want to know the detail of above command line, you can read
  3868. the colo-compare git log.
  3869. @item -object cryptodev-backend-builtin,id=@var{id}[,queues=@var{queues}]
  3870. Creates a cryptodev backend which executes crypto opreation from
  3871. the QEMU cipher APIS. The @var{id} parameter is
  3872. a unique ID that will be used to reference this cryptodev backend from
  3873. the @option{virtio-crypto} device. The @var{queues} parameter is optional,
  3874. which specify the queue number of cryptodev backend, the default of
  3875. @var{queues} is 1.
  3876. @example
  3877. # qemu-system-x86_64 \
  3878. [...] \
  3879. -object cryptodev-backend-builtin,id=cryptodev0 \
  3880. -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \
  3881. [...]
  3882. @end example
  3883. @item -object cryptodev-vhost-user,id=@var{id},chardev=@var{chardevid}[,queues=@var{queues}]
  3884. Creates a vhost-user cryptodev backend, backed by a chardev @var{chardevid}.
  3885. The @var{id} parameter is a unique ID that will be used to reference this
  3886. cryptodev backend from the @option{virtio-crypto} device.
  3887. The chardev should be a unix domain socket backed one. The vhost-user uses
  3888. a specifically defined protocol to pass vhost ioctl replacement messages
  3889. to an application on the other end of the socket.
  3890. The @var{queues} parameter is optional, which specify the queue number
  3891. of cryptodev backend for multiqueue vhost-user, the default of @var{queues} is 1.
  3892. @example
  3893. # qemu-system-x86_64 \
  3894. [...] \
  3895. -chardev socket,id=chardev0,path=/path/to/socket \
  3896. -object cryptodev-vhost-user,id=cryptodev0,chardev=chardev0 \
  3897. -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \
  3898. [...]
  3899. @end example
  3900. @item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
  3901. @item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
  3902. Defines a secret to store a password, encryption key, or some other sensitive
  3903. data. The sensitive data can either be passed directly via the @var{data}
  3904. parameter, or indirectly via the @var{file} parameter. Using the @var{data}
  3905. parameter is insecure unless the sensitive data is encrypted.
  3906. The sensitive data can be provided in raw format (the default), or base64.
  3907. When encoded as JSON, the raw format only supports valid UTF-8 characters,
  3908. so base64 is recommended for sending binary data. QEMU will convert from
  3909. which ever format is provided to the format it needs internally. eg, an
  3910. RBD password can be provided in raw format, even though it will be base64
  3911. encoded when passed onto the RBD sever.
  3912. For added protection, it is possible to encrypt the data associated with
  3913. a secret using the AES-256-CBC cipher. Use of encryption is indicated
  3914. by providing the @var{keyid} and @var{iv} parameters. The @var{keyid}
  3915. parameter provides the ID of a previously defined secret that contains
  3916. the AES-256 decryption key. This key should be 32-bytes long and be
  3917. base64 encoded. The @var{iv} parameter provides the random initialization
  3918. vector used for encryption of this particular secret and should be a
  3919. base64 encrypted string of the 16-byte IV.
  3920. The simplest (insecure) usage is to provide the secret inline
  3921. @example
  3922. # $QEMU -object secret,id=sec0,data=letmein,format=raw
  3923. @end example
  3924. The simplest secure usage is to provide the secret via a file
  3925. # printf "letmein" > mypasswd.txt
  3926. # $QEMU -object secret,id=sec0,file=mypasswd.txt,format=raw
  3927. For greater security, AES-256-CBC should be used. To illustrate usage,
  3928. consider the openssl command line tool which can encrypt the data. Note
  3929. that when encrypting, the plaintext must be padded to the cipher block
  3930. size (32 bytes) using the standard PKCS#5/6 compatible padding algorithm.
  3931. First a master key needs to be created in base64 encoding:
  3932. @example
  3933. # openssl rand -base64 32 > key.b64
  3934. # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"')
  3935. @end example
  3936. Each secret to be encrypted needs to have a random initialization vector
  3937. generated. These do not need to be kept secret
  3938. @example
  3939. # openssl rand -base64 16 > iv.b64
  3940. # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"')
  3941. @end example
  3942. The secret to be defined can now be encrypted, in this case we're
  3943. telling openssl to base64 encode the result, but it could be left
  3944. as raw bytes if desired.
  3945. @example
  3946. # SECRET=$(printf "letmein" |
  3947. openssl enc -aes-256-cbc -a -K $KEY -iv $IV)
  3948. @end example
  3949. When launching QEMU, create a master secret pointing to @code{key.b64}
  3950. and specify that to be used to decrypt the user password. Pass the
  3951. contents of @code{iv.b64} to the second secret
  3952. @example
  3953. # $QEMU \
  3954. -object secret,id=secmaster0,format=base64,file=key.b64 \
  3955. -object secret,id=sec0,keyid=secmaster0,format=base64,\
  3956. data=$SECRET,iv=$(<iv.b64)
  3957. @end example
  3958. @item -object sev-guest,id=@var{id},cbitpos=@var{cbitpos},reduced-phys-bits=@var{val},[sev-device=@var{string},policy=@var{policy},handle=@var{handle},dh-cert-file=@var{file},session-file=@var{file}]
  3959. Create a Secure Encrypted Virtualization (SEV) guest object, which can be used
  3960. to provide the guest memory encryption support on AMD processors.
  3961. When memory encryption is enabled, one of the physical address bit (aka the
  3962. C-bit) is utilized to mark if a memory page is protected. The @option{cbitpos}
  3963. is used to provide the C-bit position. The C-bit position is Host family dependent
  3964. hence user must provide this value. On EPYC, the value should be 47.
  3965. When memory encryption is enabled, we loose certain bits in physical address space.
  3966. The @option{reduced-phys-bits} is used to provide the number of bits we loose in
  3967. physical address space. Similar to C-bit, the value is Host family dependent.
  3968. On EPYC, the value should be 5.
  3969. The @option{sev-device} provides the device file to use for communicating with
  3970. the SEV firmware running inside AMD Secure Processor. The default device is
  3971. '/dev/sev'. If hardware supports memory encryption then /dev/sev devices are
  3972. created by CCP driver.
  3973. The @option{policy} provides the guest policy to be enforced by the SEV firmware
  3974. and restrict what configuration and operational commands can be performed on this
  3975. guest by the hypervisor. The policy should be provided by the guest owner and is
  3976. bound to the guest and cannot be changed throughout the lifetime of the guest.
  3977. The default is 0.
  3978. If guest @option{policy} allows sharing the key with another SEV guest then
  3979. @option{handle} can be use to provide handle of the guest from which to share
  3980. the key.
  3981. The @option{dh-cert-file} and @option{session-file} provides the guest owner's
  3982. Public Diffie-Hillman key defined in SEV spec. The PDH and session parameters
  3983. are used for establishing a cryptographic session with the guest owner to
  3984. negotiate keys used for attestation. The file must be encoded in base64.
  3985. e.g to launch a SEV guest
  3986. @example
  3987. # $QEMU \
  3988. ......
  3989. -object sev-guest,id=sev0,cbitpos=47,reduced-phys-bits=5 \
  3990. -machine ...,memory-encryption=sev0
  3991. .....
  3992. @end example
  3993. @item -object authz-simple,id=@var{id},identity=@var{string}
  3994. Create an authorization object that will control access to network services.
  3995. The @option{identity} parameter is identifies the user and its format
  3996. depends on the network service that authorization object is associated
  3997. with. For authorizing based on TLS x509 certificates, the identity must
  3998. be the x509 distinguished name. Note that care must be taken to escape
  3999. any commas in the distinguished name.
  4000. An example authorization object to validate a x509 distinguished name
  4001. would look like:
  4002. @example
  4003. # $QEMU \
  4004. ...
  4005. -object 'authz-simple,id=auth0,,,O=Example Org,,L=London,,ST=London,,C=GB' \
  4006. ...
  4007. @end example
  4008. Note the use of quotes due to the x509 distinguished name containing
  4009. whitespace, and escaping of ','.
  4010. @item -object authz-listfile,id=@var{id},filename=@var{path},refresh=@var{yes|no}
  4011. Create an authorization object that will control access to network services.
  4012. The @option{filename} parameter is the fully qualified path to a file
  4013. containing the access control list rules in JSON format.
  4014. An example set of rules that match against SASL usernames might look
  4015. like:
  4016. @example
  4017. @{
  4018. "rules": [
  4019. @{ "match": "fred", "policy": "allow", "format": "exact" @},
  4020. @{ "match": "bob", "policy": "allow", "format": "exact" @},
  4021. @{ "match": "danb", "policy": "deny", "format": "glob" @},
  4022. @{ "match": "dan*", "policy": "allow", "format": "exact" @},
  4023. ],
  4024. "policy": "deny"
  4025. @}
  4026. @end example
  4027. When checking access the object will iterate over all the rules and
  4028. the first rule to match will have its @option{policy} value returned
  4029. as the result. If no rules match, then the default @option{policy}
  4030. value is returned.
  4031. The rules can either be an exact string match, or they can use the
  4032. simple UNIX glob pattern matching to allow wildcards to be used.
  4033. If @option{refresh} is set to true the file will be monitored
  4034. and automatically reloaded whenever its content changes.
  4035. As with the @code{authz-simple} object, the format of the identity
  4036. strings being matched depends on the network service, but is usually
  4037. a TLS x509 distinguished name, or a SASL username.
  4038. An example authorization object to validate a SASL username
  4039. would look like:
  4040. @example
  4041. # $QEMU \
  4042. ...
  4043. -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=yes
  4044. ...
  4045. @end example
  4046. @item -object authz-pam,id=@var{id},service=@var{string}
  4047. Create an authorization object that will control access to network services.
  4048. The @option{service} parameter provides the name of a PAM service to use
  4049. for authorization. It requires that a file @code{/etc/pam.d/@var{service}}
  4050. exist to provide the configuration for the @code{account} subsystem.
  4051. An example authorization object to validate a TLS x509 distinguished
  4052. name would look like:
  4053. @example
  4054. # $QEMU \
  4055. ...
  4056. -object authz-pam,id=auth0,service=qemu-vnc
  4057. ...
  4058. @end example
  4059. There would then be a corresponding config file for PAM at
  4060. @code{/etc/pam.d/qemu-vnc} that contains:
  4061. @example
  4062. account requisite item=user sense=allow \
  4063. file=/etc/qemu/vnc.allow
  4064. @end example
  4065. Finally the @code{/etc/qemu/vnc.allow} file would contain
  4066. the list of x509 distingished names that are permitted
  4067. access
  4068. @example
  4069.,O=Example Home,L=London,ST=London,C=GB
  4070. @end example
  4071. @end table
  4072. ETEXI
  4073. HXCOMM This is the last statement. Insert new options before this line!
  4074. STEXI
  4075. @end table
  4076. ETEXI