blob: 6106520c56e01c7271d17cdb97130615c9d346b6 [file] [log] [blame]
blueswir15824d652009-03-28 06:44:27 +00001HXCOMM Use DEFHEADING() to define headings in both help text and texi
2HXCOMM Text between STEXI and ETEXI are copied to texi version and
3HXCOMM discarded from C version
Blue Swirlad960902010-03-29 19:23:52 +00004HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to
5HXCOMM construct option structures, enums and help message for specified
6HXCOMM architectures.
blueswir15824d652009-03-28 06:44:27 +00007HXCOMM HXCOMM can be used for comments, discarded from both texi and C
8
9DEFHEADING(Standard options:)
10STEXI
11@table @option
12ETEXI
13
14DEF("help", 0, QEMU_OPTION_h,
Blue Swirlad960902010-03-29 19:23:52 +000015 "-h or -help display this help and exit\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000016STEXI
17@item -h
Stefan Weil6616b2a2010-02-05 23:52:05 +010018@findex -h
blueswir15824d652009-03-28 06:44:27 +000019Display help and exit
20ETEXI
21
pbrook9bd7e6d2009-04-07 22:58:45 +000022DEF("version", 0, QEMU_OPTION_version,
Blue Swirlad960902010-03-29 19:23:52 +000023 "-version display version information and exit\n", QEMU_ARCH_ALL)
pbrook9bd7e6d2009-04-07 22:58:45 +000024STEXI
25@item -version
Stefan Weil6616b2a2010-02-05 23:52:05 +010026@findex -version
pbrook9bd7e6d2009-04-07 22:58:45 +000027Display version information and exit
28ETEXI
29
Jan Kiszka80f52a62011-07-23 12:39:46 +020030DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
31 "-machine [type=]name[,prop[=value][,...]]\n"
Peter Maydell585f6032012-10-04 16:22:01 +010032 " selects emulated machine ('-machine help' for list)\n"
Jan Kiszka80f52a62011-07-23 12:39:46 +020033 " property accel=accel1[:accel2[:...]] selects accelerator\n"
Jan Kiszka6a48ffa2011-10-15 13:43:48 +020034 " supported accelerators are kvm, xen, tcg (default: tcg)\n"
Jan Kiszka39d69602012-01-25 18:14:15 +010035 " kernel_irqchip=on|off controls accelerated irqchip support\n"
Matt Gingell32c18a22015-11-16 10:03:06 -080036 " kernel_irqchip=on|off|split controls accelerated irqchip support (default=off)\n"
Don Slutzd1048be2014-11-21 11:18:52 -050037 " vmport=on|off|auto controls emulation of vmport (default: auto)\n"
Jason Baronddb97f12012-08-02 15:44:16 -040038 " kvm_shadow_mem=size of KVM shadow MMU\n"
Luiz Capitulino8490fc72012-09-05 16:50:16 -030039 " dump-guest-core=on|off include guest memory in a core dump (default=on)\n"
Le Tana52a7fd2014-08-16 13:55:40 +080040 " mem-merge=on|off controls memory merge support (default: on)\n"
Tony Krowiak2eb1cd02015-03-12 13:53:51 +010041 " iommu=on|off controls emulated Intel IOMMU (VT-d) support (default=off)\n"
Tiejun Chen79814172015-07-15 13:37:45 +080042 " igd-passthru=on|off controls IGD GFX passthrough support (default=off)\n"
Tony Krowiak2eb1cd02015-03-12 13:53:51 +010043 " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n"
Alexander Graf9850c602015-02-23 13:56:42 +010044 " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n"
Xiao Guangrong87252e12015-12-02 15:20:58 +080045 " suppress-vmdesc=on|off disables self-describing migration (default=off)\n"
Greg Kurz902c0532016-02-18 12:32:25 +010046 " nvdimm=on|off controls NVDIMM support (default=off)\n"
47 " enforce-config-section=on|off enforce configuration section migration (default=off)\n",
Jan Kiszka80f52a62011-07-23 12:39:46 +020048 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000049STEXI
Jan Kiszka80f52a62011-07-23 12:39:46 +020050@item -machine [type=]@var{name}[,prop=@var{value}[,...]]
51@findex -machine
Peter Maydell585f6032012-10-04 16:22:01 +010052Select the emulated machine by @var{name}. Use @code{-machine help} to list
Jan Kiszka80f52a62011-07-23 12:39:46 +020053available machines. Supported machine properties are:
54@table @option
55@item accel=@var{accels1}[:@var{accels2}[:...]]
56This is used to enable an accelerator. Depending on the target architecture,
57kvm, xen, or tcg can be available. By default, tcg is used. If there is more
58than one accelerator specified, the next one is used if the previous one fails
59to initialize.
Jan Kiszka6a48ffa2011-10-15 13:43:48 +020060@item kernel_irqchip=on|off
Matt Gingell32c18a22015-11-16 10:03:06 -080061Controls in-kernel irqchip support for the chosen accelerator when available.
Tiejun Chen79814172015-07-15 13:37:45 +080062@item gfx_passthru=on|off
63Enables IGD GFX passthrough support for the chosen machine when available.
Don Slutzd1048be2014-11-21 11:18:52 -050064@item vmport=on|off|auto
65Enables emulation of VMWare IO port, for vmmouse etc. auto says to select the
66value based on accel. For accel=xen the default is off otherwise the default
67is on.
Jan Kiszka39d69602012-01-25 18:14:15 +010068@item kvm_shadow_mem=size
69Defines the size of the KVM shadow MMU.
Jason Baronddb97f12012-08-02 15:44:16 -040070@item dump-guest-core=on|off
71Include guest memory in a core dump. The default is on.
Luiz Capitulino8490fc72012-09-05 16:50:16 -030072@item mem-merge=on|off
73Enables or disables memory merge support. This feature, when supported by
74the host, de-duplicates identical memory pages among VMs instances
75(enabled by default).
Le Tana52a7fd2014-08-16 13:55:40 +080076@item iommu=on|off
77Enables or disables emulated Intel IOMMU (VT-d) support. The default is off.
Tony Krowiak2eb1cd02015-03-12 13:53:51 +010078@item aes-key-wrap=on|off
79Enables or disables AES key wrapping support on s390-ccw hosts. This feature
80controls whether AES wrapping keys will be created to allow
81execution of AES cryptographic functions. The default is on.
82@item dea-key-wrap=on|off
83Enables or disables DEA key wrapping support on s390-ccw hosts. This feature
84controls whether DEA wrapping keys will be created to allow
85execution of DEA cryptographic functions. The default is on.
Xiao Guangrong87252e12015-12-02 15:20:58 +080086@item nvdimm=on|off
87Enables or disables NVDIMM support. The default is off.
Jan Kiszka80f52a62011-07-23 12:39:46 +020088@end table
blueswir15824d652009-03-28 06:44:27 +000089ETEXI
90
Jan Kiszka80f52a62011-07-23 12:39:46 +020091HXCOMM Deprecated by -machine
92DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
93
blueswir15824d652009-03-28 06:44:27 +000094DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
Peter Maydell585f6032012-10-04 16:22:01 +010095 "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000096STEXI
97@item -cpu @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +010098@findex -cpu
Peter Maydell585f6032012-10-04 16:22:01 +010099Select CPU model (@code{-cpu help} for list and additional feature selection)
blueswir15824d652009-03-28 06:44:27 +0000100ETEXI
101
102DEF("smp", HAS_ARG, QEMU_OPTION_smp,
Michael Tokarev12b7f572013-06-24 15:06:52 +0400103 "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
Jes Sorensen6be68d72009-07-23 17:03:42 +0200104 " set the number of CPUs to 'n' [default=1]\n"
105 " maxcpus= maximum number of total cpus, including\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -0700106 " offline CPUs for hotplug, etc\n"
Andre Przywara58a04db2009-08-28 10:49:57 +0200107 " cores= number of CPU cores on one socket\n"
108 " threads= number of threads on one CPU core\n"
Blue Swirlad960902010-03-29 19:23:52 +0000109 " sockets= number of discrete sockets in the system\n",
110 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000111STEXI
Michael Tokarev12b7f572013-06-24 15:06:52 +0400112@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100113@findex -smp
blueswir15824d652009-03-28 06:44:27 +0000114Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
115CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
116to 4.
Andre Przywara58a04db2009-08-28 10:49:57 +0200117For the PC target, the number of @var{cores} per socket, the number
118of @var{threads} per cores and the total number of @var{sockets} can be
119specified. Missing values will be computed. If any on the three values is
120given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
121specifies the maximum number of hotpluggable CPUs.
blueswir15824d652009-03-28 06:44:27 +0000122ETEXI
123
aliguori268a3622009-04-21 22:30:27 +0000124DEF("numa", HAS_ARG, QEMU_OPTION_numa,
Paolo Bonzini7febe362014-05-14 17:43:17 +0800125 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n"
126 "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
aliguori268a3622009-04-21 22:30:27 +0000127STEXI
Luiz Capitulino4932b892014-05-14 17:43:10 +0800128@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +0200129@itemx -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100130@findex -numa
Paolo Bonzini7febe362014-05-14 17:43:17 +0800131Simulate a multi node NUMA system. If @samp{mem}, @samp{memdev}
Luiz Capitulino4932b892014-05-14 17:43:10 +0800132and @samp{cpus} are omitted, resources are split equally. Also, note
133that the -@option{numa} option doesn't allocate any of the specified
134resources. That is, it just assigns existing resources to NUMA nodes. This
135means that one still has to use the @option{-m}, @option{-smp} options
Paolo Bonzini7febe362014-05-14 17:43:17 +0800136to allocate RAM and VCPUs respectively, and possibly @option{-object}
137to specify the memory backend for the @samp{memdev} suboption.
138
139@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one
140node uses @samp{memdev}, all of them have to use it.
aliguori268a3622009-04-21 22:30:27 +0000141ETEXI
142
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100143DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
144 "-add-fd fd=fd,set=set[,opaque=opaque]\n"
145 " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL)
146STEXI
147@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
148@findex -add-fd
149
150Add a file descriptor to an fd set. Valid options are:
151
152@table @option
153@item fd=@var{fd}
154This option defines the file descriptor of which a duplicate is added to fd set.
155The file descriptor cannot be stdin, stdout, or stderr.
156@item set=@var{set}
157This option defines the ID of the fd set to add the file descriptor to.
158@item opaque=@var{opaque}
159This option defines a free-form string that can be used to describe @var{fd}.
160@end table
161
162You can open an image using pre-opened file descriptors from an fd set:
163@example
164qemu-system-i386
165-add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
166-add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
167-drive file=/dev/fdset/2,index=0,media=disk
168@end example
169ETEXI
170
171DEF("set", HAS_ARG, QEMU_OPTION_set,
172 "-set group.id.arg=value\n"
173 " set <arg> parameter for item <id> of type <group>\n"
174 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
175STEXI
176@item -set @var{group}.@var{id}.@var{arg}=@var{value}
177@findex -set
178Set parameter @var{arg} for item @var{id} of type @var{group}\n"
179ETEXI
180
181DEF("global", HAS_ARG, QEMU_OPTION_global,
Paolo Bonzini3751d7c2015-04-09 14:16:19 +0200182 "-global driver.property=value\n"
183 "-global driver=driver,property=property,value=value\n"
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100184 " set a global default for a driver property\n",
185 QEMU_ARCH_ALL)
186STEXI
187@item -global @var{driver}.@var{prop}=@var{value}
Paolo Bonzini3751d7c2015-04-09 14:16:19 +0200188@itemx -global driver=@var{driver},property=@var{property},value=@var{value}
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100189@findex -global
190Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
191
192@example
193qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
194@end example
195
196In particular, you can use this to set driver properties for devices which are
197created automatically by the machine model. To create a device which is not
198created automatically and set properties on it, use -@option{device}.
Paolo Bonzini3751d7c2015-04-09 14:16:19 +0200199
Markus Armbrusterae08fd52015-06-15 14:35:58 +0200200-global @var{driver}.@var{prop}=@var{value} is shorthand for -global
201driver=@var{driver},property=@var{prop},value=@var{value}. The
202longhand syntax works even when @var{driver} contains a dot.
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100203ETEXI
204
205DEF("boot", HAS_ARG, QEMU_OPTION_boot,
206 "-boot [order=drives][,once=drives][,menu=on|off]\n"
Amos Kongc8a6ae82013-03-19 14:23:27 +0800207 " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n"
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100208 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
209 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
210 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n"
211 " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n",
212 QEMU_ARCH_ALL)
213STEXI
Amos Kongc8a6ae82013-03-19 14:23:27 +0800214@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]
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100215@findex -boot
216Specify boot order @var{drives} as a string of drive letters. Valid
Gongleid274e072015-07-03 17:50:57 +0800217drive letters depend on the target architecture. The x86 PC uses: a, b
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100218(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
219from network adapter 1-4), hard disk boot is the default. To apply a
220particular boot order only on the first startup, specify it via
221@option{once}.
222
223Interactive boot menus/prompts can be enabled via @option{menu=on} as far
224as firmware/BIOS supports them. The default is non-interactive boot.
225
226A splash picture could be passed to bios, enabling user to show it as logo,
227when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
228supports them. Currently Seabios for X86 system support it.
229limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
230format(true color). The resolution should be supported by the SVGA mode, so
231the recommended is 320x240, 640x480, 800x640.
232
233A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
234when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
235reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
236system support it.
237
Amos Kongc8a6ae82013-03-19 14:23:27 +0800238Do strict boot via @option{strict=on} as far as firmware/BIOS
239supports it. This only effects when boot priority is changed by
240bootindex options. The default is non-strict boot.
241
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100242@example
243# try to boot from network first, then from hard disk
244qemu-system-i386 -boot order=nc
245# boot from CD-ROM first, switch back to default order after reboot
246qemu-system-i386 -boot once=d
247# boot with a splash picture for 5 seconds.
248qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
249@end example
250
251Note: The legacy format '-boot @var{drives}' is still supported but its
252use is discouraged as it may be removed from future versions.
253ETEXI
254
255DEF("m", HAS_ARG, QEMU_OPTION_m,
Igor Mammedovc270fb92014-06-02 15:25:02 +0200256 "-m[emory] [size=]megs[,slots=n,maxmem=size]\n"
Igor Mammedov6e1d3c12013-11-27 01:27:35 +0100257 " configure guest RAM\n"
Alexander Graf0daba1f2015-06-05 11:05:03 +0200258 " size: initial amount of guest memory\n"
Igor Mammedovc270fb92014-06-02 15:25:02 +0200259 " slots: number of hotplug slots (default: none)\n"
Matthew Rosatob6fe0122014-08-28 11:25:33 -0400260 " maxmem: maximum amount of guest memory (default: none)\n"
261 "NOTE: Some architectures might enforce a specific granularity\n",
Igor Mammedov6e1d3c12013-11-27 01:27:35 +0100262 QEMU_ARCH_ALL)
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100263STEXI
Luiz Capitulino9fcc0792015-02-26 14:35:45 -0500264@item -m [size=]@var{megs}[,slots=n,maxmem=size]
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100265@findex -m
Luiz Capitulino9fcc0792015-02-26 14:35:45 -0500266Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB.
267Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in
268megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem}
269could be used to set amount of hotpluggable memory slots and maximum amount of
270memory. Note that @var{maxmem} must be aligned to the page size.
271
272For example, the following command-line sets the guest startup RAM size to
2731GB, creates 3 slots to hotplug additional memory and sets the maximum
274memory the guest can reach to 4GB:
275
276@example
277qemu-system-x86_64 -m 1G,slots=3,maxmem=4G
278@end example
279
280If @var{slots} and @var{maxmem} are not specified, memory hotplug won't
281be enabled and the guest startup RAM will never increase.
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100282ETEXI
283
284DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
285 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
286STEXI
287@item -mem-path @var{path}
288@findex -mem-path
289Allocate guest RAM from a temporarily created file in @var{path}.
290ETEXI
291
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100292DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
293 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
294 QEMU_ARCH_ALL)
295STEXI
296@item -mem-prealloc
297@findex -mem-prealloc
298Preallocate memory when using -mem-path.
299ETEXI
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100300
301DEF("k", HAS_ARG, QEMU_OPTION_k,
302 "-k language use keyboard layout (for example 'fr' for French)\n",
303 QEMU_ARCH_ALL)
304STEXI
305@item -k @var{language}
306@findex -k
307Use keyboard layout @var{language} (for example @code{fr} for
308French). This option is only needed where it is not easy to get raw PC
309keycodes (e.g. on Macs, with some X11 servers or with a VNC
310display). You don't normally need to use it on PC/Linux or PC/Windows
311hosts.
312
313The available layouts are:
314@example
315ar de-ch es fo fr-ca hu ja mk no pt-br sv
316da en-gb et fr fr-ch is lt nl pl ru th
317de en-us fi fr-be hr it lv nl-be pt sl tr
318@end example
319
320The default is @code{en-us}.
321ETEXI
322
323
324DEF("audio-help", 0, QEMU_OPTION_audio_help,
325 "-audio-help print list of audio drivers and their options\n",
326 QEMU_ARCH_ALL)
327STEXI
328@item -audio-help
329@findex -audio-help
330Will show the audio subsystem help: list of drivers, tunable
331parameters.
332ETEXI
333
334DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
335 "-soundhw c1,... enable audio support\n"
336 " and only specified sound cards (comma separated list)\n"
337 " use '-soundhw help' to get the list of supported cards\n"
338 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL)
339STEXI
340@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
341@findex -soundhw
342Enable audio and selected sound hardware. Use 'help' to print all
343available sound hardware.
344
345@example
346qemu-system-i386 -soundhw sb16,adlib disk.img
347qemu-system-i386 -soundhw es1370 disk.img
348qemu-system-i386 -soundhw ac97 disk.img
349qemu-system-i386 -soundhw hda disk.img
350qemu-system-i386 -soundhw all disk.img
351qemu-system-i386 -soundhw help
352@end example
353
354Note that Linux's i810_audio OSS kernel (for AC97) module might
355require manually specifying clocking.
356
357@example
358modprobe i810_audio clocking=48000
359@end example
360ETEXI
361
362DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
363 "-balloon none disable balloon device\n"
364 "-balloon virtio[,addr=str]\n"
365 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
366STEXI
367@item -balloon none
368@findex -balloon
369Disable balloon device.
370@item -balloon virtio[,addr=@var{addr}]
371Enable virtio balloon device (default), optionally with PCI address
372@var{addr}.
373ETEXI
374
375DEF("device", HAS_ARG, QEMU_OPTION_device,
376 "-device driver[,prop[=value][,...]]\n"
377 " add device (based on driver)\n"
378 " prop=value,... sets driver properties\n"
379 " use '-device help' to print all possible drivers\n"
380 " use '-device driver,help' to print all possible properties\n",
381 QEMU_ARCH_ALL)
382STEXI
383@item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
384@findex -device
385Add device @var{driver}. @var{prop}=@var{value} sets driver
386properties. Valid properties depend on the driver. To get help on
387possible drivers and properties, use @code{-device help} and
388@code{-device @var{driver},help}.
Corey Minyardf8490452015-12-17 12:50:10 -0600389
390Some drivers are:
391@item -device ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}]
392
393Add an IPMI BMC. This is a simulation of a hardware management
394interface processor that normally sits on a system. It provides
395a watchdog and the ability to reset and power control the system.
396You need to connect this to an IPMI interface to make it useful
397
398The IPMI slave address to use for the BMC. The default is 0x20.
399This address is the BMC's address on the I2C network of management
400controllers. If you don't know what this means, it is safe to ignore
401it.
402
403@item -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}]
404
405Add a connection to an external IPMI BMC simulator. Instead of
406locally emulating the BMC like the above item, instead connect
407to an external entity that provides the IPMI services.
408
409A connection is made to an external BMC simulator. If you do this, it
410is strongly recommended that you use the "reconnect=" chardev option
411to reconnect to the simulator if the connection is lost. Note that if
412this is not used carefully, it can be a security issue, as the
413interface has the ability to send resets, NMIs, and power off the VM.
414It's best if QEMU makes a connection to an external simulator running
415on a secure port on localhost, so neither the simulator nor QEMU is
416exposed to any outside network.
417
418See the "lanserv/README.vm" file in the OpenIPMI library for more
419details on the external interface.
420
421@item -device isa-ipmi-kcs,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}]
422
423Add a KCS IPMI interafce on the ISA bus. This also adds a
424corresponding ACPI and SMBIOS entries, if appropriate.
425
426@table @option
427@item bmc=@var{id}
428The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above.
429@item ioport=@var{val}
430Define the I/O address of the interface. The default is 0xca0 for KCS.
431@item irq=@var{val}
432Define the interrupt to use. The default is 5. To disable interrupts,
433set this to 0.
434@end table
435
436@item -device isa-ipmi-bt,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}]
437
438Like the KCS interface, but defines a BT interface. The default port is
4390xe4 and the default interrupt is 5.
440
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100441ETEXI
442
443DEF("name", HAS_ARG, QEMU_OPTION_name,
Dr. David Alan Gilbert8f480de2014-01-30 10:20:31 +0000444 "-name string1[,process=string2][,debug-threads=on|off]\n"
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100445 " set the name of the guest\n"
Dr. David Alan Gilbert8f480de2014-01-30 10:20:31 +0000446 " string1 sets the window title and string2 the process name (on Linux)\n"
447 " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n"
448 " NOTE: The thread names are for debugging and not a stable API.\n",
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100449 QEMU_ARCH_ALL)
450STEXI
451@item -name @var{name}
452@findex -name
453Sets the @var{name} of the guest.
454This name will be displayed in the SDL window caption.
455The @var{name} will also be used for the VNC server.
456Also optionally set the top visible process name in Linux.
Dr. David Alan Gilbert8f480de2014-01-30 10:20:31 +0000457Naming of individual threads can also be enabled on Linux to aid debugging.
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100458ETEXI
459
460DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
461 "-uuid %08x-%04x-%04x-%04x-%012x\n"
462 " specify machine UUID\n", QEMU_ARCH_ALL)
463STEXI
464@item -uuid @var{uuid}
465@findex -uuid
466Set system UUID.
467ETEXI
468
469STEXI
470@end table
471ETEXI
472DEFHEADING()
473
474DEFHEADING(Block device options:)
475STEXI
476@table @option
477ETEXI
478
blueswir15824d652009-03-28 06:44:27 +0000479DEF("fda", HAS_ARG, QEMU_OPTION_fda,
Blue Swirlad960902010-03-29 19:23:52 +0000480 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
481DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000482STEXI
483@item -fda @var{file}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +0200484@itemx -fdb @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100485@findex -fda
486@findex -fdb
Markus Armbruster92a539d2015-03-17 17:02:20 +0100487Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}).
blueswir15824d652009-03-28 06:44:27 +0000488ETEXI
489
490DEF("hda", HAS_ARG, QEMU_OPTION_hda,
Blue Swirlad960902010-03-29 19:23:52 +0000491 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
492DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000493DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
Blue Swirlad960902010-03-29 19:23:52 +0000494 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
495DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000496STEXI
497@item -hda @var{file}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +0200498@itemx -hdb @var{file}
499@itemx -hdc @var{file}
500@itemx -hdd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100501@findex -hda
502@findex -hdb
503@findex -hdc
504@findex -hdd
blueswir15824d652009-03-28 06:44:27 +0000505Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
506ETEXI
507
508DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
Blue Swirlad960902010-03-29 19:23:52 +0000509 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
510 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000511STEXI
512@item -cdrom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100513@findex -cdrom
blueswir15824d652009-03-28 06:44:27 +0000514Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
515@option{-cdrom} at the same time). You can use the host CD-ROM by
516using @file{/dev/cdrom} as filename (@pxref{host_drives}).
517ETEXI
518
519DEF("drive", HAS_ARG, QEMU_OPTION_drive,
520 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
521 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100522 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
Stefan Hajnoczid1db7602014-04-23 13:55:37 +0200523 " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n"
524 " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000525 " [,readonly=on|off][,copy-on-read=on|off]\n"
Peter Lieven2f7133b2014-07-28 21:53:02 +0200526 " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n"
Benoît Canet3e9fab62013-09-02 14:14:40 +0200527 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n"
528 " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n"
529 " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n"
530 " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n"
Benoît Canet2024c1d2013-09-02 14:14:41 +0200531 " [[,iops_size=is]]\n"
Alberto Garcia76f4afb2015-06-08 18:17:44 +0200532 " [[,group=g]]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000533 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000534STEXI
535@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100536@findex -drive
blueswir15824d652009-03-28 06:44:27 +0000537
538Define a new drive. Valid options are:
539
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200540@table @option
blueswir15824d652009-03-28 06:44:27 +0000541@item file=@var{file}
542This option defines which disk image (@pxref{disk_images}) to use with
543this drive. If the filename contains comma, you must double it
544(for instance, "file=my,,file" to use file "my,file").
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +1100545
546Special files such as iSCSI devices can be specified using protocol
547specific URLs. See the section for "Device URL Syntax" for more information.
blueswir15824d652009-03-28 06:44:27 +0000548@item if=@var{interface}
549This option defines on which type on interface the drive is connected.
550Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
551@item bus=@var{bus},unit=@var{unit}
552These options define where is connected the drive by defining the bus number and
553the unit id.
554@item index=@var{index}
555This option defines where is connected the drive by using an index in the list
556of available connectors of a given interface type.
557@item media=@var{media}
558This option defines the type of the media: disk or cdrom.
559@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
560These options have the same definition as they have in @option{-hdachs}.
561@item snapshot=@var{snapshot}
Michael Tokarev9d85d552014-04-07 13:34:58 +0400562@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive
563(see @option{-snapshot}).
blueswir15824d652009-03-28 06:44:27 +0000564@item cache=@var{cache}
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100565@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data.
Christoph Hellwig5c6c3a62009-08-20 16:58:35 +0200566@item aio=@var{aio}
567@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
Paolo Bonzinia9384af2013-02-08 14:06:12 +0100568@item discard=@var{discard}
569@var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) requests are ignored or passed to the filesystem. Some machine types may not support discard requests.
blueswir15824d652009-03-28 06:44:27 +0000570@item format=@var{format}
571Specify which disk @var{format} will be used rather than detecting
572the format. Can be used to specifiy format=raw to avoid interpreting
573an untrusted format header.
574@item serial=@var{serial}
575This option specifies the serial number to assign to the device.
Markus Armbrusterc2cc47a2009-06-18 15:14:10 +0200576@item addr=@var{addr}
577Specify the controller's PCI address (if=virtio only).
Luiz Capitulinoae73e592011-07-12 17:35:08 -0300578@item werror=@var{action},rerror=@var{action}
579Specify which @var{action} to take on write and read errors. Valid actions are:
580"ignore" (ignore the error and try to continue), "stop" (pause QEMU),
581"report" (report the error to the guest), "enospc" (pause QEMU only if the
582host disk is full; report the error to the guest otherwise).
583The default setting is @option{werror=enospc} and @option{rerror=report}.
584@item readonly
585Open drive @option{file} as read-only. Guest write attempts will fail.
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000586@item copy-on-read=@var{copy-on-read}
587@var{copy-on-read} is "on" or "off" and enables whether to copy read backing
588file sectors into the image file.
Peter Lieven465bee12014-05-18 00:58:19 +0200589@item detect-zeroes=@var{detect-zeroes}
590@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic
591conversion of plain zero writes by the OS to driver specific optimized
592zero write commands. You may even choose "unmap" if @var{discard} is set
593to "unmap" to allow a zero write to be converted to an UNMAP operation.
blueswir15824d652009-03-28 06:44:27 +0000594@end table
595
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100596By default, the @option{cache=writeback} mode is used. It will report data
597writes as completed as soon as the data is present in the host page cache.
598This is safe as long as your guest OS makes sure to correctly flush disk caches
599where needed. If your guest OS does not handle volatile disk write caches
600correctly and your host crashes or loses power, then the guest may experience
601data corruption.
blueswir15824d652009-03-28 06:44:27 +0000602
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100603For such guests, you should consider using @option{cache=writethrough}. This
604means that the host page cache will be used to read and write data, but write
605notification will be sent to the guest only after QEMU has made sure to flush
606each write to the disk. Be aware that this has a major impact on performance.
blueswir15824d652009-03-28 06:44:27 +0000607
Aurelien Jarnoc304d312009-05-03 23:29:14 +0200608The host page cache can be avoided entirely with @option{cache=none}. This will
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100609attempt to do disk IO directly to the guest's memory. QEMU may still perform
610an internal copy of the data. Note that this is considered a writeback mode and
611the guest OS must handle the disk write cache correctly in order to avoid data
612corruption on host crashes.
blueswir15824d652009-03-28 06:44:27 +0000613
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100614The host page cache can be avoided while only sending write notifications to
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100615the guest when the data has been flushed to the disk using
616@option{cache=directsync}.
blueswir15824d652009-03-28 06:44:27 +0000617
Alexander Graf016f5cf2010-05-26 17:51:49 +0200618In case you don't care about data integrity over host failures, use
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100619@option{cache=unsafe}. This option tells QEMU that it never needs to write any
620data to the disk but can instead keep things in cache. If anything goes wrong,
Stefan Weile7d81002011-12-10 00:19:46 +0100621like your host losing power, the disk storage getting disconnected accidentally,
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100622etc. your image will most probably be rendered unusable. When using
Alexander Grafc3177282010-05-26 21:04:32 +0200623the @option{-snapshot} option, unsafe caching is always used.
Alexander Graf016f5cf2010-05-26 17:51:49 +0200624
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000625Copy-on-read avoids accessing the same backing file sectors repeatedly and is
626useful when the backing file is over a slow network. By default copy-on-read
627is off.
628
blueswir15824d652009-03-28 06:44:27 +0000629Instead of @option{-cdrom} you can use:
630@example
Stefan Weil3804da92012-05-11 22:21:50 +0200631qemu-system-i386 -drive file=file,index=2,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000632@end example
633
634Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
635use:
636@example
Stefan Weil3804da92012-05-11 22:21:50 +0200637qemu-system-i386 -drive file=file,index=0,media=disk
638qemu-system-i386 -drive file=file,index=1,media=disk
639qemu-system-i386 -drive file=file,index=2,media=disk
640qemu-system-i386 -drive file=file,index=3,media=disk
blueswir15824d652009-03-28 06:44:27 +0000641@end example
642
Corey Bryant587ed6b2012-10-18 15:19:34 -0400643You can open an image using pre-opened file descriptors from an fd set:
644@example
645qemu-system-i386
646-add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
647-add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
648-drive file=/dev/fdset/2,index=0,media=disk
649@end example
650
blueswir15824d652009-03-28 06:44:27 +0000651You can connect a CDROM to the slave of ide0:
652@example
Stefan Weil3804da92012-05-11 22:21:50 +0200653qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000654@end example
655
656If you don't specify the "file=" argument, you define an empty drive:
657@example
Stefan Weil3804da92012-05-11 22:21:50 +0200658qemu-system-i386 -drive if=ide,index=1,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000659@end example
660
661You can connect a SCSI disk with unit ID 6 on the bus #0:
662@example
Stefan Weil3804da92012-05-11 22:21:50 +0200663qemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6
blueswir15824d652009-03-28 06:44:27 +0000664@end example
665
666Instead of @option{-fda}, @option{-fdb}, you can use:
667@example
Stefan Weil3804da92012-05-11 22:21:50 +0200668qemu-system-i386 -drive file=file,index=0,if=floppy
669qemu-system-i386 -drive file=file,index=1,if=floppy
blueswir15824d652009-03-28 06:44:27 +0000670@end example
671
672By default, @var{interface} is "ide" and @var{index} is automatically
673incremented:
674@example
Stefan Weil3804da92012-05-11 22:21:50 +0200675qemu-system-i386 -drive file=a -drive file=b"
blueswir15824d652009-03-28 06:44:27 +0000676@end example
677is interpreted like:
678@example
Stefan Weil3804da92012-05-11 22:21:50 +0200679qemu-system-i386 -hda a -hdb b
blueswir15824d652009-03-28 06:44:27 +0000680@end example
681ETEXI
682
683DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
Blue Swirlad960902010-03-29 19:23:52 +0000684 "-mtdblock file use 'file' as on-board Flash memory image\n",
685 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000686STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200687@item -mtdblock @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100688@findex -mtdblock
Kevin Wolf4e257e52009-10-09 10:58:36 +0200689Use @var{file} as on-board Flash memory image.
blueswir15824d652009-03-28 06:44:27 +0000690ETEXI
691
692DEF("sd", HAS_ARG, QEMU_OPTION_sd,
Blue Swirlad960902010-03-29 19:23:52 +0000693 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000694STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200695@item -sd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100696@findex -sd
Kevin Wolf4e257e52009-10-09 10:58:36 +0200697Use @var{file} as SecureDigital card image.
blueswir15824d652009-03-28 06:44:27 +0000698ETEXI
699
700DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
Blue Swirlad960902010-03-29 19:23:52 +0000701 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000702STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200703@item -pflash @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100704@findex -pflash
Kevin Wolf4e257e52009-10-09 10:58:36 +0200705Use @var{file} as a parallel flash image.
blueswir15824d652009-03-28 06:44:27 +0000706ETEXI
707
blueswir15824d652009-03-28 06:44:27 +0000708DEF("snapshot", 0, QEMU_OPTION_snapshot,
Blue Swirlad960902010-03-29 19:23:52 +0000709 "-snapshot write to temporary files instead of disk image files\n",
710 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000711STEXI
712@item -snapshot
Stefan Weil6616b2a2010-02-05 23:52:05 +0100713@findex -snapshot
blueswir15824d652009-03-28 06:44:27 +0000714Write to temporary files instead of disk image files. In this case,
715the raw disk image you use is not written back. You can however force
716the write back by pressing @key{C-a s} (@pxref{disk_images}).
717ETEXI
718
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100719DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
720 "-hdachs c,h,s[,t]\n" \
721 " force hard disk 0 physical geometry and the optional BIOS\n" \
722 " translation (t=none or lba) (usually QEMU can guess them)\n",
Blue Swirlad960902010-03-29 19:23:52 +0000723 QEMU_ARCH_ALL)
Marcelo Tosattic9027602010-03-01 20:25:08 -0300724STEXI
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100725@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
726@findex -hdachs
727Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
728@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
729translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
730all those parameters. This option is useful for old MS-DOS disk
731images.
Markus Armbrusterc70a01e2013-02-13 19:49:40 +0100732ETEXI
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530733
734DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530735 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530736 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530737 QEMU_ARCH_ALL)
738
739STEXI
740
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530741@item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530742@findex -fsdev
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530743Define a new file system device. Valid options are:
744@table @option
745@item @var{fsdriver}
746This option specifies the fs driver backend to use.
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530747Currently "local", "handle" and "proxy" file system drivers are supported.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530748@item id=@var{id}
749Specifies identifier for this device
750@item path=@var{path}
751Specifies the export path for the file system device. Files under
752this path will be available to the 9p client on the guest.
753@item security_model=@var{security_model}
754Specifies the security model to be used for this export path.
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530755Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530756In "passthrough" security model, files are stored using the same
Stefan Weilb65ee4f2012-05-11 22:25:50 +0200757credentials as they are created on the guest. This requires QEMU
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530758to run as root. In "mapped-xattr" security model, some of the file
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530759attributes like uid, gid, mode bits and link target are stored as
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530760file attributes. For "mapped-file" these attributes are stored in the
761hidden .virtfs_metadata directory. Directories exported by this security model cannot
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530762interact with other unix tools. "none" security model is same as
763passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530764set file attributes like ownership. Security model is mandatory
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530765only for local fsdriver. Other fsdrivers (like handle, proxy) don't take
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530766security model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530767@item writeout=@var{writeout}
768This is an optional argument. The only supported value is "immediate".
769This means that host page cache will be used to read and write data but
770write notification will be sent to the guest only when the data has been
771reported as written by the storage subsystem.
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +0530772@item readonly
773Enables exporting 9p share as a readonly mount for guests. By default
774read-write access is given.
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530775@item socket=@var{socket}
776Enables proxy filesystem driver to use passed socket file for communicating
777with virtfs-proxy-helper
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530778@item sock_fd=@var{sock_fd}
779Enables proxy filesystem driver to use passed socket descriptor for
780communicating with virtfs-proxy-helper. Usually a helper like libvirt
781will create socketpair and pass one of the fds as sock_fd
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530782@end table
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530783
784-fsdev option is used along with -device driver "virtio-9p-pci".
785@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
786Options for virtio-9p-pci driver are:
787@table @option
788@item fsdev=@var{id}
789Specifies the id value specified along with -fsdev option
790@item mount_tag=@var{mount_tag}
791Specifies the tag name to be used by the guest to mount this export point
792@end table
793
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530794ETEXI
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530795
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530796DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530797 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530798 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530799 QEMU_ARCH_ALL)
800
801STEXI
802
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530803@item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530804@findex -virtfs
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530805
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530806The general form of a Virtual File system pass-through options are:
807@table @option
808@item @var{fsdriver}
809This option specifies the fs driver backend to use.
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530810Currently "local", "handle" and "proxy" file system drivers are supported.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530811@item id=@var{id}
812Specifies identifier for this device
813@item path=@var{path}
814Specifies the export path for the file system device. Files under
815this path will be available to the 9p client on the guest.
816@item security_model=@var{security_model}
817Specifies the security model to be used for this export path.
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530818Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530819In "passthrough" security model, files are stored using the same
Stefan Weilb65ee4f2012-05-11 22:25:50 +0200820credentials as they are created on the guest. This requires QEMU
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530821to run as root. In "mapped-xattr" security model, some of the file
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530822attributes like uid, gid, mode bits and link target are stored as
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530823file attributes. For "mapped-file" these attributes are stored in the
824hidden .virtfs_metadata directory. Directories exported by this security model cannot
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530825interact with other unix tools. "none" security model is same as
826passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530827set file attributes like ownership. Security model is mandatory only
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530828for local fsdriver. Other fsdrivers (like handle, proxy) don't take security
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530829model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530830@item writeout=@var{writeout}
831This is an optional argument. The only supported value is "immediate".
832This means that host page cache will be used to read and write data but
833write notification will be sent to the guest only when the data has been
834reported as written by the storage subsystem.
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +0530835@item readonly
836Enables exporting 9p share as a readonly mount for guests. By default
837read-write access is given.
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530838@item socket=@var{socket}
839Enables proxy filesystem driver to use passed socket file for
840communicating with virtfs-proxy-helper. Usually a helper like libvirt
841will create socketpair and pass one of the fds as sock_fd
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530842@item sock_fd
843Enables proxy filesystem driver to use passed 'sock_fd' as the socket
844descriptor for interfacing with virtfs-proxy-helper
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530845@end table
846ETEXI
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530847
Aneesh Kumar K.V9db221a2011-10-25 12:10:40 +0530848DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
849 "-virtfs_synth Create synthetic file system image\n",
850 QEMU_ARCH_ALL)
851STEXI
852@item -virtfs_synth
853@findex -virtfs_synth
854Create synthetic file system image
855ETEXI
856
blueswir15824d652009-03-28 06:44:27 +0000857STEXI
858@end table
859ETEXI
blueswir15824d652009-03-28 06:44:27 +0000860DEFHEADING()
861
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100862DEFHEADING(USB options:)
863STEXI
864@table @option
865ETEXI
866
867DEF("usb", 0, QEMU_OPTION_usb,
868 "-usb enable the USB driver (will be the default soon)\n",
869 QEMU_ARCH_ALL)
870STEXI
871@item -usb
872@findex -usb
873Enable the USB driver (will be the default soon)
874ETEXI
875
876DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
877 "-usbdevice name add the host or guest USB device 'name'\n",
878 QEMU_ARCH_ALL)
879STEXI
880
881@item -usbdevice @var{devname}
882@findex -usbdevice
883Add the USB device @var{devname}. @xref{usb_devices}.
884
885@table @option
886
887@item mouse
888Virtual Mouse. This will override the PS/2 mouse emulation when activated.
889
890@item tablet
891Pointer device that uses absolute coordinates (like a touchscreen). This
892means QEMU is able to report the mouse position without having to grab the
893mouse. Also overrides the PS/2 mouse emulation when activated.
894
895@item disk:[format=@var{format}]:@var{file}
896Mass storage device based on file. The optional @var{format} argument
897will be used rather than detecting the format. Can be used to specifiy
898@code{format=raw} to avoid interpreting an untrusted format header.
899
900@item host:@var{bus}.@var{addr}
901Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
902
903@item host:@var{vendor_id}:@var{product_id}
904Pass through the host device identified by @var{vendor_id}:@var{product_id}
905(Linux only).
906
907@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
908Serial converter to host character device @var{dev}, see @code{-serial} for the
909available devices.
910
911@item braille
912Braille device. This will use BrlAPI to display the braille output on a real
913or fake device.
914
915@item net:@var{options}
916Network adapter that supports CDC ethernet and RNDIS protocols.
917
918@end table
919ETEXI
920
921STEXI
922@end table
923ETEXI
924DEFHEADING()
925
blueswir15824d652009-03-28 06:44:27 +0000926DEFHEADING(Display options:)
blueswir15824d652009-03-28 06:44:27 +0000927STEXI
928@table @option
929ETEXI
930
Jes Sorensen1472a952011-03-16 13:33:31 +0100931DEF("display", HAS_ARG, QEMU_OPTION_display,
932 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
Jes Sorensen3264ff12011-03-16 13:33:33 +0100933 " [,window_close=on|off]|curses|none|\n"
Jan Kiszka881249c2014-03-12 08:33:50 +0100934 " gtk[,grab_on_hover=on|off]|\n"
Jes Sorensen3264ff12011-03-16 13:33:33 +0100935 " vnc=<display>[,<optargs>]\n"
Jes Sorensen1472a952011-03-16 13:33:31 +0100936 " select display type\n", QEMU_ARCH_ALL)
937STEXI
938@item -display @var{type}
939@findex -display
940Select type of display to use. This option is a replacement for the
941old style -sdl/-curses/... options. Valid values for @var{type} are
942@table @option
943@item sdl
944Display video output via SDL (usually in a separate graphics
945window; see the SDL documentation for other possibilities).
946@item curses
947Display video output via curses. For graphics device models which
948support a text mode, QEMU can display this output using a
949curses/ncurses interface. Nothing is displayed when the graphics
950device is in graphical mode or if the graphics device does not support
951a text mode. Generally only the VGA device models support text mode.
Jes Sorensen4171d322011-03-16 13:33:32 +0100952@item none
953Do not display video output. The guest will still see an emulated
954graphics card, but its output will not be displayed to the QEMU
955user. This option differs from the -nographic option in that it
956only affects what is done with video output; -nographic also changes
957the destination of the serial and parallel port data.
Jan Kiszka881249c2014-03-12 08:33:50 +0100958@item gtk
959Display video output in a GTK window. This interface provides drop-down
960menus and other UI elements to configure and control the VM during
961runtime.
Jes Sorensen3264ff12011-03-16 13:33:33 +0100962@item vnc
963Start a VNC server on display <arg>
Jes Sorensen1472a952011-03-16 13:33:31 +0100964@end table
965ETEXI
966
blueswir15824d652009-03-28 06:44:27 +0000967DEF("nographic", 0, QEMU_OPTION_nographic,
Blue Swirlad960902010-03-29 19:23:52 +0000968 "-nographic disable graphical output and redirect serial I/Os to console\n",
969 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000970STEXI
971@item -nographic
Stefan Weil6616b2a2010-02-05 23:52:05 +0100972@findex -nographic
blueswir15824d652009-03-28 06:44:27 +0000973Normally, QEMU uses SDL to display the VGA output. With this option,
974you can totally disable graphical output so that QEMU is a simple
975command line application. The emulated serial port is redirected on
Paolo Bonzini02c4bdf2013-07-03 20:29:45 +0400976the console and muxed with the monitor (unless redirected elsewhere
977explicitly). Therefore, you can still use QEMU to debug a Linux kernel
Ramkumar Ramachandrab031f412013-07-20 16:53:09 +0530978with a serial console. Use @key{C-a h} for help on switching between
979the console and monitor.
blueswir15824d652009-03-28 06:44:27 +0000980ETEXI
981
blueswir15824d652009-03-28 06:44:27 +0000982DEF("curses", 0, QEMU_OPTION_curses,
Blue Swirlad960902010-03-29 19:23:52 +0000983 "-curses use a curses/ncurses interface instead of SDL\n",
984 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000985STEXI
986@item -curses
Markus Armbrusterb8f490e2013-02-13 19:49:38 +0100987@findex -curses
blueswir15824d652009-03-28 06:44:27 +0000988Normally, QEMU uses SDL to display the VGA output. With this option,
989QEMU can display the VGA output when in text mode using a
990curses/ncurses interface. Nothing is displayed in graphical mode.
991ETEXI
992
blueswir15824d652009-03-28 06:44:27 +0000993DEF("no-frame", 0, QEMU_OPTION_no_frame,
Blue Swirlad960902010-03-29 19:23:52 +0000994 "-no-frame open SDL window without a frame and window decorations\n",
995 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000996STEXI
997@item -no-frame
Stefan Weil6616b2a2010-02-05 23:52:05 +0100998@findex -no-frame
blueswir15824d652009-03-28 06:44:27 +0000999Do not use decorations for SDL windows and start them using the whole
1000available screen space. This makes the using QEMU in a dedicated desktop
1001workspace more convenient.
1002ETEXI
1003
blueswir15824d652009-03-28 06:44:27 +00001004DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
Blue Swirlad960902010-03-29 19:23:52 +00001005 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
1006 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001007STEXI
1008@item -alt-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +01001009@findex -alt-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +10001010Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
1011affects the special keys (for fullscreen, monitor-mode switching, etc).
blueswir15824d652009-03-28 06:44:27 +00001012ETEXI
1013
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -05001014DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
Blue Swirlad960902010-03-29 19:23:52 +00001015 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
1016 QEMU_ARCH_ALL)
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -05001017STEXI
1018@item -ctrl-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +01001019@findex -ctrl-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +10001020Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
1021affects the special keys (for fullscreen, monitor-mode switching, etc).
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -05001022ETEXI
1023
blueswir15824d652009-03-28 06:44:27 +00001024DEF("no-quit", 0, QEMU_OPTION_no_quit,
Blue Swirlad960902010-03-29 19:23:52 +00001025 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001026STEXI
1027@item -no-quit
Stefan Weil6616b2a2010-02-05 23:52:05 +01001028@findex -no-quit
blueswir15824d652009-03-28 06:44:27 +00001029Disable SDL window close capability.
1030ETEXI
1031
blueswir15824d652009-03-28 06:44:27 +00001032DEF("sdl", 0, QEMU_OPTION_sdl,
Blue Swirlad960902010-03-29 19:23:52 +00001033 "-sdl enable SDL\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001034STEXI
1035@item -sdl
Stefan Weil6616b2a2010-02-05 23:52:05 +01001036@findex -sdl
blueswir15824d652009-03-28 06:44:27 +00001037Enable SDL.
1038ETEXI
1039
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001040DEF("spice", HAS_ARG, QEMU_OPTION_spice,
Yonit Halperin27af7782012-08-21 13:54:20 +03001041 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
1042 " [,x509-key-file=<file>][,x509-key-password=<file>]\n"
1043 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n"
Marc-André Lureaufe4831b2015-01-13 17:57:51 +01001044 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n"
Yonit Halperin27af7782012-08-21 13:54:20 +03001045 " [,tls-ciphers=<list>]\n"
1046 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n"
1047 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n"
1048 " [,sasl][,password=<secret>][,disable-ticketing]\n"
1049 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n"
1050 " [,jpeg-wan-compression=[auto|never|always]]\n"
1051 " [,zlib-glz-wan-compression=[auto|never|always]]\n"
1052 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n"
Hans de Goede5ad24e52013-06-08 15:37:27 +02001053 " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n"
1054 " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n"
Gerd Hoffmann474114b2015-10-13 15:39:34 +02001055 " [,gl=[on|off]]\n"
Yonit Halperin27af7782012-08-21 13:54:20 +03001056 " enable spice\n"
1057 " at least one of {port, tls-port} is mandatory\n",
1058 QEMU_ARCH_ALL)
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001059STEXI
1060@item -spice @var{option}[,@var{option}[,...]]
1061@findex -spice
1062Enable the spice remote desktop protocol. Valid options are
1063
1064@table @option
1065
1066@item port=<nr>
Gerd Hoffmannc448e852010-03-11 11:13:32 -03001067Set the TCP port spice is listening on for plaintext channels.
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001068
Gerd Hoffmann333b0ee2010-08-27 14:29:16 +02001069@item addr=<addr>
1070Set the IP address spice is listening on. Default is any address.
1071
1072@item ipv4
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001073@itemx ipv6
1074@itemx unix
Gerd Hoffmann333b0ee2010-08-27 14:29:16 +02001075Force using the specified IP version.
1076
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001077@item password=<secret>
1078Set the password you need to authenticate.
1079
Marc-André Lureau48b3ed02011-05-17 10:40:33 +02001080@item sasl
1081Require that the client use SASL to authenticate with the spice.
1082The exact choice of authentication method used is controlled from the
1083system / user's SASL configuration file for the 'qemu' service. This
1084is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1085unprivileged user, an environment variable SASL_CONF_PATH can be used
1086to make it search alternate locations for the service config.
1087While some SASL auth methods can also provide data encryption (eg GSSAPI),
1088it is recommended that SASL always be combined with the 'tls' and
1089'x509' settings to enable use of SSL and server certificates. This
1090ensures a data encryption preventing compromise of authentication
1091credentials.
1092
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001093@item disable-ticketing
1094Allow client connects without authentication.
1095
Hans de Goeded4970b02011-03-27 16:43:54 +02001096@item disable-copy-paste
1097Disable copy paste between the client and the guest.
1098
Hans de Goede5ad24e52013-06-08 15:37:27 +02001099@item disable-agent-file-xfer
1100Disable spice-vdagent based file-xfer between the client and the guest.
1101
Gerd Hoffmannc448e852010-03-11 11:13:32 -03001102@item tls-port=<nr>
1103Set the TCP port spice is listening on for encrypted channels.
1104
1105@item x509-dir=<dir>
1106Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
1107
1108@item x509-key-file=<file>
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001109@itemx x509-key-password=<file>
1110@itemx x509-cert-file=<file>
1111@itemx x509-cacert-file=<file>
1112@itemx x509-dh-key-file=<file>
Gerd Hoffmannc448e852010-03-11 11:13:32 -03001113The x509 file names can also be configured individually.
1114
1115@item tls-ciphers=<list>
1116Specify which ciphers to use.
1117
Alon Levyd70d6b32011-12-20 13:05:18 +02001118@item tls-channel=[main|display|cursor|inputs|record|playback]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001119@itemx plaintext-channel=[main|display|cursor|inputs|record|playback]
Gerd Hoffmann17b6dea2010-08-27 14:09:56 +02001120Force specific channel to be used with or without TLS encryption. The
1121options can be specified multiple times to configure multiple
1122channels. The special name "default" can be used to set the default
1123mode. For channels which are not explicitly forced into one mode the
1124spice client is allowed to pick tls/plaintext as he pleases.
1125
Yonit Halperin9f04e092010-07-14 13:26:34 +03001126@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
1127Configure image compression (lossless).
1128Default is auto_glz.
1129
1130@item jpeg-wan-compression=[auto|never|always]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001131@itemx zlib-glz-wan-compression=[auto|never|always]
Yonit Halperin9f04e092010-07-14 13:26:34 +03001132Configure wan image compression (lossy for slow links).
1133Default is auto.
1134
Gerd Hoffmann84a23f22010-08-30 16:36:53 +02001135@item streaming-video=[off|all|filter]
1136Configure video stream detection. Default is filter.
1137
1138@item agent-mouse=[on|off]
1139Enable/disable passing mouse events via vdagent. Default is on.
1140
1141@item playback-compression=[on|off]
1142Enable/disable audio stream compression (using celt 0.5.1). Default is on.
1143
Yonit Halperin8c957052012-08-21 11:51:59 +03001144@item seamless-migration=[on|off]
1145Enable/disable spice seamless migration. Default is off.
1146
Gerd Hoffmann474114b2015-10-13 15:39:34 +02001147@item gl=[on|off]
1148Enable/disable OpenGL context. Default is off.
1149
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001150@end table
1151ETEXI
1152
blueswir15824d652009-03-28 06:44:27 +00001153DEF("portrait", 0, QEMU_OPTION_portrait,
Blue Swirlad960902010-03-29 19:23:52 +00001154 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
1155 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001156STEXI
1157@item -portrait
Stefan Weil6616b2a2010-02-05 23:52:05 +01001158@findex -portrait
blueswir15824d652009-03-28 06:44:27 +00001159Rotate graphical output 90 deg left (only PXA LCD).
1160ETEXI
1161
Vasily Khoruzhick93128052011-06-17 13:04:36 +03001162DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
1163 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
1164 QEMU_ARCH_ALL)
1165STEXI
Markus Armbruster6265c432013-02-13 19:49:39 +01001166@item -rotate @var{deg}
Vasily Khoruzhick93128052011-06-17 13:04:36 +03001167@findex -rotate
1168Rotate graphical output some deg left (only PXA LCD).
1169ETEXI
1170
blueswir15824d652009-03-28 06:44:27 +00001171DEF("vga", HAS_ARG, QEMU_OPTION_vga,
Gerd Hoffmanna94f0c52014-09-10 14:28:48 +02001172 "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n"
Blue Swirlad960902010-03-29 19:23:52 +00001173 " select video card type\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001174STEXI
malce4558dc2012-08-27 18:33:21 +04001175@item -vga @var{type}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001176@findex -vga
blueswir15824d652009-03-28 06:44:27 +00001177Select type of VGA card to emulate. Valid values for @var{type} are
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001178@table @option
blueswir15824d652009-03-28 06:44:27 +00001179@item cirrus
1180Cirrus Logic GD5446 Video card. All Windows versions starting from
1181Windows 95 should recognize and use this graphic card. For optimal
1182performances, use 16 bit color depth in the guest and the host OS.
1183(This one is the default)
1184@item std
1185Standard VGA card with Bochs VBE extensions. If your guest OS
1186supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
1187to use high resolution modes (>= 1280x1024x16) then you should use
1188this option.
1189@item vmware
1190VMWare SVGA-II compatible adapter. Use it if you have sufficiently
1191recent XFree86/XOrg server or Windows guest with a driver for this
1192card.
Gerd Hoffmanna19cbfb2010-04-27 11:50:11 +02001193@item qxl
1194QXL paravirtual graphic card. It is VGA compatible (including VESA
11952.0 VBE support). Works best with qxl guest drivers installed though.
1196Recommended choice when using the spice protocol.
Mark Cave-Ayland33632782014-03-17 21:46:25 +00001197@item tcx
1198(sun4m only) Sun TCX framebuffer. This is the default framebuffer for
1199sun4m machines and offers both 8-bit and 24-bit colour depths at a
1200fixed resolution of 1024x768.
1201@item cg3
1202(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer
1203for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP)
1204resolutions aimed at people wishing to run older Solaris versions.
Gerd Hoffmanna94f0c52014-09-10 14:28:48 +02001205@item virtio
1206Virtio VGA card.
blueswir15824d652009-03-28 06:44:27 +00001207@item none
1208Disable VGA card.
1209@end table
1210ETEXI
1211
1212DEF("full-screen", 0, QEMU_OPTION_full_screen,
Blue Swirlad960902010-03-29 19:23:52 +00001213 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001214STEXI
1215@item -full-screen
Stefan Weil6616b2a2010-02-05 23:52:05 +01001216@findex -full-screen
blueswir15824d652009-03-28 06:44:27 +00001217Start in full screen.
1218ETEXI
1219
blueswir15824d652009-03-28 06:44:27 +00001220DEF("g", 1, QEMU_OPTION_g ,
Blue Swirlad960902010-03-29 19:23:52 +00001221 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
1222 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
blueswir15824d652009-03-28 06:44:27 +00001223STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01001224@item -g @var{width}x@var{height}[x@var{depth}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001225@findex -g
Stefan Weil95d5f082010-01-20 22:25:27 +01001226Set the initial graphical resolution and depth (PPC, SPARC only).
blueswir15824d652009-03-28 06:44:27 +00001227ETEXI
1228
1229DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
Blue Swirlad960902010-03-29 19:23:52 +00001230 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001231STEXI
1232@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001233@findex -vnc
blueswir15824d652009-03-28 06:44:27 +00001234Normally, QEMU uses SDL to display the VGA output. With this option,
1235you can have QEMU listen on VNC display @var{display} and redirect the VGA
1236display over the VNC session. It is very useful to enable the usb
1237tablet device when using this option (option @option{-usbdevice
1238tablet}). When using the VNC display, you must use the @option{-k}
1239parameter to set the keyboard layout if you are not using en-us. Valid
1240syntax for the @var{display} is
1241
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001242@table @option
blueswir15824d652009-03-28 06:44:27 +00001243
1244@item @var{host}:@var{d}
1245
1246TCP connections will only be allowed from @var{host} on display @var{d}.
1247By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
1248be omitted in which case the server will accept connections from any host.
1249
Kevin Wolf4e257e52009-10-09 10:58:36 +02001250@item unix:@var{path}
blueswir15824d652009-03-28 06:44:27 +00001251
1252Connections will be allowed over UNIX domain sockets where @var{path} is the
1253location of a unix socket to listen for connections on.
1254
1255@item none
1256
1257VNC is initialized but not started. The monitor @code{change} command
1258can be used to later start the VNC server.
1259
1260@end table
1261
1262Following the @var{display} value there may be one or more @var{option} flags
1263separated by commas. Valid options are
1264
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001265@table @option
blueswir15824d652009-03-28 06:44:27 +00001266
1267@item reverse
1268
1269Connect to a listening VNC client via a ``reverse'' connection. The
1270client is specified by the @var{display}. For reverse network
1271connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
1272is a TCP port number, not a display number.
1273
Tim Hardeck7536ee42013-01-21 11:04:44 +01001274@item websocket
1275
1276Opens an additional TCP listening port dedicated to VNC Websocket connections.
Peter Maydell085d8132013-03-18 17:20:07 +00001277By definition the Websocket port is 5700+@var{display}. If @var{host} is
Tim Hardeck7536ee42013-01-21 11:04:44 +01001278specified connections will only be allowed from this host.
1279As an alternative the Websocket port could be specified by using
1280@code{websocket}=@var{port}.
Daniel P. Berrange3e305e42015-08-06 14:39:32 +01001281If no TLS credentials are provided, the websocket connection runs in
1282unencrypted mode. If TLS credentials are provided, the websocket connection
1283requires encrypted client connections.
Tim Hardeck7536ee42013-01-21 11:04:44 +01001284
blueswir15824d652009-03-28 06:44:27 +00001285@item password
1286
1287Require that password based authentication is used for client connections.
Michal Novotny86ee5bc2012-07-16 15:54:38 +02001288
1289The password must be set separately using the @code{set_password} command in
1290the @ref{pcsys_monitor}. The syntax to change your password is:
1291@code{set_password <protocol> <password>} where <protocol> could be either
1292"vnc" or "spice".
1293
1294If you would like to change <protocol> password expiration, you should use
1295@code{expire_password <protocol> <expiration-time>} where expiration time could
1296be one of the following options: now, never, +seconds or UNIX time of
1297expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800
1298to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this
1299date and time).
1300
1301You can also use keywords "now" or "never" for the expiration time to
1302allow <protocol> password to expire immediately or never expire.
blueswir15824d652009-03-28 06:44:27 +00001303
Daniel P. Berrange3e305e42015-08-06 14:39:32 +01001304@item tls-creds=@var{ID}
1305
1306Provides the ID of a set of TLS credentials to use to secure the
1307VNC server. They will apply to both the normal VNC server socket
1308and the websocket socket (if enabled). Setting TLS credentials
1309will cause the VNC server socket to enable the VeNCrypt auth
1310mechanism. The credentials should have been previously created
1311using the @option{-object tls-creds} argument.
1312
1313The @option{tls-creds} parameter obsoletes the @option{tls},
1314@option{x509}, and @option{x509verify} options, and as such
1315it is not permitted to set both new and old type options at
1316the same time.
1317
blueswir15824d652009-03-28 06:44:27 +00001318@item tls
1319
1320Require that client use TLS when communicating with the VNC server. This
1321uses anonymous TLS credentials so is susceptible to a man-in-the-middle
1322attack. It is recommended that this option be combined with either the
Kevin Wolf4e257e52009-10-09 10:58:36 +02001323@option{x509} or @option{x509verify} options.
blueswir15824d652009-03-28 06:44:27 +00001324
Daniel P. Berrange3e305e42015-08-06 14:39:32 +01001325This option is now deprecated in favor of using the @option{tls-creds}
1326argument.
1327
blueswir15824d652009-03-28 06:44:27 +00001328@item x509=@var{/path/to/certificate/dir}
1329
1330Valid if @option{tls} is specified. Require that x509 credentials are used
1331for negotiating the TLS session. The server will send its x509 certificate
1332to the client. It is recommended that a password be set on the VNC server
1333to provide authentication of the client when this is used. The path following
1334this option specifies where the x509 certificates are to be loaded from.
1335See the @ref{vnc_security} section for details on generating certificates.
1336
Daniel P. Berrange3e305e42015-08-06 14:39:32 +01001337This option is now deprecated in favour of using the @option{tls-creds}
1338argument.
1339
blueswir15824d652009-03-28 06:44:27 +00001340@item x509verify=@var{/path/to/certificate/dir}
1341
1342Valid if @option{tls} is specified. Require that x509 credentials are used
1343for negotiating the TLS session. The server will send its x509 certificate
1344to the client, and request that the client send its own x509 certificate.
1345The server will validate the client's certificate against the CA certificate,
1346and reject clients when validation fails. If the certificate authority is
1347trusted, this is a sufficient authentication mechanism. You may still wish
1348to set a password on the VNC server as a second authentication layer. The
1349path following this option specifies where the x509 certificates are to
1350be loaded from. See the @ref{vnc_security} section for details on generating
1351certificates.
1352
Daniel P. Berrange3e305e42015-08-06 14:39:32 +01001353This option is now deprecated in favour of using the @option{tls-creds}
1354argument.
1355
blueswir15824d652009-03-28 06:44:27 +00001356@item sasl
1357
1358Require that the client use SASL to authenticate with the VNC server.
1359The exact choice of authentication method used is controlled from the
1360system / user's SASL configuration file for the 'qemu' service. This
1361is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1362unprivileged user, an environment variable SASL_CONF_PATH can be used
1363to make it search alternate locations for the service config.
1364While some SASL auth methods can also provide data encryption (eg GSSAPI),
1365it is recommended that SASL always be combined with the 'tls' and
1366'x509' settings to enable use of SSL and server certificates. This
1367ensures a data encryption preventing compromise of authentication
1368credentials. See the @ref{vnc_security} section for details on using
1369SASL authentication.
1370
1371@item acl
1372
1373Turn on access control lists for checking of the x509 client certificate
1374and SASL party. For x509 certs, the ACL check is made against the
1375certificate's distinguished name. This is something that looks like
1376@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1377made against the username, which depending on the SASL plugin, may
1378include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1379When the @option{acl} flag is set, the initial access list will be
1380empty, with a @code{deny} policy. Thus no one will be allowed to
1381use the VNC server until the ACLs have been loaded. This can be
1382achieved using the @code{acl} monitor command.
1383
Corentin Chary6f9c78c2010-07-07 20:57:51 +02001384@item lossy
1385
1386Enable lossy compression methods (gradient, JPEG, ...). If this
1387option is set, VNC client may receive lossy framebuffer updates
1388depending on its encoding settings. Enabling this option can save
1389a lot of bandwidth at the expense of quality.
1390
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001391@item non-adaptive
1392
1393Disable adaptive encodings. Adaptive encodings are enabled by default.
1394An adaptive encoding will try to detect frequently updated screen regions,
1395and send updates in these regions using a lossy encoding (like JPEG).
Stefan Weil61cc8702011-04-13 22:45:22 +02001396This can be really helpful to save bandwidth when playing videos. Disabling
Michael Tokarev9d85d552014-04-07 13:34:58 +04001397adaptive encodings restores the original static behavior of encodings
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001398like Tight.
1399
Gerd Hoffmann8cf36482011-11-24 18:10:49 +01001400@item share=[allow-exclusive|force-shared|ignore]
1401
1402Set display sharing policy. 'allow-exclusive' allows clients to ask
1403for exclusive access. As suggested by the rfb spec this is
1404implemented by dropping other connections. Connecting multiple
1405clients in parallel requires all clients asking for a shared session
1406(vncviewer: -shared switch). This is the default. 'force-shared'
1407disables exclusive client access. Useful for shared desktop sessions,
1408where you don't want someone forgetting specify -shared disconnect
1409everybody else. 'ignore' completely ignores the shared flag and
1410allows everybody connect unconditionally. Doesn't conform to the rfb
Stefan Weilb65ee4f2012-05-11 22:25:50 +02001411spec but is traditional QEMU behavior.
Gerd Hoffmann8cf36482011-11-24 18:10:49 +01001412
blueswir15824d652009-03-28 06:44:27 +00001413@end table
1414ETEXI
1415
1416STEXI
1417@end table
1418ETEXI
Michael Ellermana3adb7a2011-12-19 17:19:31 +11001419ARCHHEADING(, QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001420
Michael Ellermana3adb7a2011-12-19 17:19:31 +11001421ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001422STEXI
1423@table @option
1424ETEXI
1425
blueswir15824d652009-03-28 06:44:27 +00001426DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
Blue Swirlad960902010-03-29 19:23:52 +00001427 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1428 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001429STEXI
1430@item -win2k-hack
Stefan Weil6616b2a2010-02-05 23:52:05 +01001431@findex -win2k-hack
blueswir15824d652009-03-28 06:44:27 +00001432Use it when installing Windows 2000 to avoid a disk full bug. After
1433Windows 2000 is installed, you no longer need this option (this option
1434slows down the IDE transfers).
1435ETEXI
1436
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001437HXCOMM Deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00001438DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001439
blueswir15824d652009-03-28 06:44:27 +00001440DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
Blue Swirlad960902010-03-29 19:23:52 +00001441 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1442 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001443STEXI
1444@item -no-fd-bootchk
Stefan Weil6616b2a2010-02-05 23:52:05 +01001445@findex -no-fd-bootchk
Markus Armbruster4eda32f2013-06-14 13:15:06 +02001446Disable boot signature checking for floppy disks in BIOS. May
blueswir15824d652009-03-28 06:44:27 +00001447be needed to boot from old floppy disks.
1448ETEXI
1449
blueswir15824d652009-03-28 06:44:27 +00001450DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
Shannon Zhaof5d8c8c2015-05-29 11:28:54 +01001451 "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM)
blueswir15824d652009-03-28 06:44:27 +00001452STEXI
1453@item -no-acpi
Stefan Weil6616b2a2010-02-05 23:52:05 +01001454@findex -no-acpi
blueswir15824d652009-03-28 06:44:27 +00001455Disable ACPI (Advanced Configuration and Power Interface) support. Use
1456it if your guest OS complains about ACPI problems (PC target machine
1457only).
1458ETEXI
1459
blueswir15824d652009-03-28 06:44:27 +00001460DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
Blue Swirlad960902010-03-29 19:23:52 +00001461 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001462STEXI
1463@item -no-hpet
Stefan Weil6616b2a2010-02-05 23:52:05 +01001464@findex -no-hpet
blueswir15824d652009-03-28 06:44:27 +00001465Disable HPET support.
1466ETEXI
1467
blueswir15824d652009-03-28 06:44:27 +00001468DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
Michael Tokarev104bf022011-05-12 18:44:17 +04001469 "-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"
Blue Swirlad960902010-03-29 19:23:52 +00001470 " ACPI table description\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001471STEXI
1472@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}]...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001473@findex -acpitable
blueswir15824d652009-03-28 06:44:27 +00001474Add ACPI table with specified header fields and context from specified files.
Michael Tokarev104bf022011-05-12 18:44:17 +04001475For file=, take whole ACPI table from the specified files, including all
1476ACPI headers (possible overridden by other options).
1477For data=, only data
1478portion of the table is used, all header information is specified in the
1479command line.
Laszlo Ersekae123742016-01-18 15:12:13 +01001480If a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id
1481fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order
1482to ensure the field matches required by the Microsoft SLIC spec and the ACPI
1483spec.
blueswir15824d652009-03-28 06:44:27 +00001484ETEXI
1485
aliguorib6f6e3d2009-04-17 18:59:56 +00001486DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1487 "-smbios file=binary\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001488 " load SMBIOS entry from binary file\n"
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001489 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1490 " [,uefi=on|off]\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001491 " specify SMBIOS type 0 fields\n"
aliguorib6f6e3d2009-04-17 18:59:56 +00001492 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1493 " [,uuid=uuid][,sku=str][,family=str]\n"
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001494 " specify SMBIOS type 1 fields\n"
1495 "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1496 " [,asset=str][,location=str]\n"
1497 " specify SMBIOS type 2 fields\n"
1498 "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n"
1499 " [,sku=str]\n"
1500 " specify SMBIOS type 3 fields\n"
1501 "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n"
1502 " [,asset=str][,part=str]\n"
1503 " specify SMBIOS type 4 fields\n"
1504 "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n"
Gabriel L. Somlo3ebd6cc2015-03-11 13:58:01 -04001505 " [,asset=str][,part=str][,speed=%d]\n"
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001506 " specify SMBIOS type 17 fields\n",
Wei Huangc30e1562015-09-07 10:39:29 +01001507 QEMU_ARCH_I386 | QEMU_ARCH_ARM)
aliguorib6f6e3d2009-04-17 18:59:56 +00001508STEXI
1509@item -smbios file=@var{binary}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001510@findex -smbios
aliguorib6f6e3d2009-04-17 18:59:56 +00001511Load SMBIOS entry from binary file.
1512
Gabriel L. Somlo84351842014-05-19 10:09:54 -04001513@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off]
aliguorib6f6e3d2009-04-17 18:59:56 +00001514Specify SMBIOS type 0 fields
1515
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001516@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}]
aliguorib6f6e3d2009-04-17 18:59:56 +00001517Specify SMBIOS type 1 fields
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001518
1519@item -smbios type=2[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,location=@var{str}][,family=@var{str}]
1520Specify SMBIOS type 2 fields
1521
1522@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}]
1523Specify SMBIOS type 3 fields
1524
1525@item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}]
1526Specify SMBIOS type 4 fields
1527
Gabriel L. Somlo3ebd6cc2015-03-11 13:58:01 -04001528@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}]
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001529Specify SMBIOS type 17 fields
aliguorib6f6e3d2009-04-17 18:59:56 +00001530ETEXI
1531
blueswir15824d652009-03-28 06:44:27 +00001532STEXI
1533@end table
1534ETEXI
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01001535DEFHEADING()
blueswir15824d652009-03-28 06:44:27 +00001536
1537DEFHEADING(Network options:)
1538STEXI
1539@table @option
1540ETEXI
1541
Jan Kiszkaad196a92009-06-24 14:42:28 +02001542HXCOMM Legacy slirp options (now moved to -net user):
1543#ifdef CONFIG_SLIRP
Blue Swirlad960902010-03-29 19:23:52 +00001544DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1545DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1546DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001547#ifndef _WIN32
Blue Swirlad960902010-03-29 19:23:52 +00001548DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001549#endif
1550#endif
1551
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001552DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
blueswir15824d652009-03-28 06:44:27 +00001553#ifdef CONFIG_SLIRP
Samuel Thibault0b11c032016-03-20 12:29:54 +01001554 "-netdev user,id=str[,ipv4[=on|off]][,net=addr[/mask]][,host=addr]\n"
1555 " [,ipv6[=on|off]][,ipv6-net=addr[/int]][,ipv6-host=addr]\n"
1556 " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n"
Samuel Thibaultd8eb3862016-03-25 00:02:58 +01001557 " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,tftp=dir]\n"
Klaus Stengel63d29602012-10-27 19:53:39 +02001558 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001559#ifndef _WIN32
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001560 "[,smb=dir[,smbserver=addr]]\n"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001561#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001562 " configure a user mode network backend with ID 'str',\n"
1563 " its DHCP server and optional services\n"
blueswir15824d652009-03-28 06:44:27 +00001564#endif
1565#ifdef _WIN32
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001566 "-netdev tap,id=str,ifname=name\n"
1567 " configure a host TAP network backend with ID 'str'\n"
blueswir15824d652009-03-28 06:44:27 +00001568#else
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001569 "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n"
1570 " [,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n"
1571 " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n"
1572 " configure a host TAP network backend with ID 'str'\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001573 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1574 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1575 " to deconfigure it\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001576 " use '[down]script=no' to disable script execution\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001577 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
1578 " configure it\n"
blueswir15824d652009-03-28 06:44:27 +00001579 " use 'fd=h' to connect to an already opened TAP interface\n"
Jason Wang2ca81ba2013-02-20 18:04:01 +08001580 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001581 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
Michael S. Tsirkinf157ed22011-02-01 14:25:40 +02001582 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001583 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1584 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
Michael S. Tsirkin82b0d802010-03-17 13:08:24 +02001585 " use vhost=on to enable experimental in kernel accelerator\n"
mst@redhat.com5430a282011-02-01 22:13:42 +02001586 " (only has effect for virtio guests which use MSIX)\n"
1587 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
Michael S. Tsirkin82b0d802010-03-17 13:08:24 +02001588 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
Jason Wang2ca81ba2013-02-20 18:04:01 +08001589 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n"
Jason Wangec396012013-02-22 22:57:52 +08001590 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n"
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001591 "-netdev bridge,id=str[,br=bridge][,helper=helper]\n"
1592 " configure a host TAP network backend with ID 'str' that is\n"
1593 " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n"
1594 " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n"
Mark McLoughlin0df0ff62009-06-18 18:21:34 +01001595#endif
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001596#ifdef __linux__
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001597 "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n"
1598 " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n"
1599 " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n"
1600 " [,rxcookie=rxcookie][,offset=offset]\n"
1601 " configure a network backend with ID 'str' connected to\n"
1602 " an Ethernet over L2TPv3 pseudowire.\n"
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001603 " Linux kernel 3.3+ as well as most routers can talk\n"
Michael Tokarev2f47b402014-07-24 20:10:17 +04001604 " L2TPv3. This transport allows connecting a VM to a VM,\n"
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001605 " VM to a router and even VM to Host. It is a nearly-universal\n"
1606 " standard (RFC3391). Note - this implementation uses static\n"
1607 " pre-configured tunnels (same as the Linux kernel).\n"
1608 " use 'src=' to specify source address\n"
1609 " use 'dst=' to specify destination address\n"
1610 " use 'udp=on' to specify udp encapsulation\n"
Gonglei39526512014-08-14 14:35:48 +08001611 " use 'srcport=' to specify source udp port\n"
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001612 " use 'dstport=' to specify destination udp port\n"
1613 " use 'ipv6=on' to force v6\n"
1614 " L2TPv3 uses cookies to prevent misconfiguration as\n"
1615 " well as a weak security measure\n"
1616 " use 'rxcookie=0x012345678' to specify a rxcookie\n"
1617 " use 'txcookie=0x012345678' to specify a txcookie\n"
1618 " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n"
1619 " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n"
1620 " use 'pincounter=on' to work around broken counter handling in peer\n"
1621 " use 'offset=X' to add an extra offset between header and data\n"
1622#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001623 "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n"
1624 " configure a network backend to connect to another network\n"
1625 " using a socket connection\n"
1626 "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1627 " configure a network backend to connect to a multicast maddr and port\n"
Mike Ryan3a75e742010-12-01 11:16:47 -08001628 " use 'localaddr=addr' to specify the host address to send packets from\n"
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001629 "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n"
1630 " configure a network backend to connect to another network\n"
1631 " using an UDP tunnel\n"
blueswir15824d652009-03-28 06:44:27 +00001632#ifdef CONFIG_VDE
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001633 "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1634 " configure a network backend to connect to port 'n' of a vde switch\n"
1635 " running on host and listening for incoming connections on 'socketpath'.\n"
blueswir15824d652009-03-28 06:44:27 +00001636 " Use group 'groupname' and mode 'octalmode' to change default\n"
1637 " ownership and permissions for communication port.\n"
1638#endif
Vincenzo Maffione58952132013-11-06 11:44:06 +01001639#ifdef CONFIG_NETMAP
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001640 "-netdev netmap,id=str,ifname=name[,devname=nmname]\n"
Vincenzo Maffione58952132013-11-06 11:44:06 +01001641 " attach to the existing netmap-enabled network interface 'name', or to a\n"
1642 " VALE port (created on the fly) called 'name' ('nmname' is name of the \n"
1643 " netmap device, defaults to '/dev/netmap')\n"
1644#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001645 "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n"
1646 " configure a vhost-user network, backed by a chardev 'dev'\n"
1647 "-netdev hubport,id=str,hubid=n\n"
1648 " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL)
1649DEF("net", HAS_ARG, QEMU_OPTION_net,
1650 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1651 " old way to create a new NIC and connect it to VLAN 'n'\n"
1652 " (use the '-device devtype,netdev=str' option if possible instead)\n"
aliguoribb9ea792009-04-21 19:56:28 +00001653 "-net dump[,vlan=n][,file=f][,len=n]\n"
1654 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001655 "-net none use it alone to have zero network devices. If no -net option\n"
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001656 " is provided, the default is '-net nic -net user'\n"
1657 "-net ["
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001658#ifdef CONFIG_SLIRP
1659 "user|"
1660#endif
1661 "tap|"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001662 "bridge|"
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001663#ifdef CONFIG_VDE
1664 "vde|"
1665#endif
Vincenzo Maffione58952132013-11-06 11:44:06 +01001666#ifdef CONFIG_NETMAP
1667 "netmap|"
1668#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001669 "socket][,vlan=n][,option][,option][,...]\n"
1670 " old way to initialize a host network interface\n"
1671 " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001672STEXI
Blue Swirl609c1da2010-03-18 18:41:49 +00001673@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001674@findex -net
blueswir15824d652009-03-28 06:44:27 +00001675Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
Anthony Liguori0d6b0b12009-08-14 11:20:47 -05001676= 0 is the default). The NIC is an e1000 by default on the PC
Markus Armbruster5607c382009-06-18 15:14:08 +02001677target. Optionally, the MAC address can be changed to @var{mac}, the
1678device address set to @var{addr} (PCI cards only),
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001679and a @var{name} can be assigned for use in monitor commands.
1680Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1681that the card should have; this option currently only affects virtio cards; set
1682@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
Stefan Weil071c9392012-04-07 09:23:36 +02001683NIC is created. QEMU can emulate several different models of network card.
blueswir15824d652009-03-28 06:44:27 +00001684Valid values for @var{type} are
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001685@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
blueswir15824d652009-03-28 06:44:27 +00001686@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1687@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
Peter Maydell585f6032012-10-04 16:22:01 +01001688Not all devices are supported on all targets. Use @code{-net nic,model=help}
blueswir15824d652009-03-28 06:44:27 +00001689for a list of available devices for your target.
1690
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001691@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
Markus Armbrusterb8f490e2013-02-13 19:49:38 +01001692@findex -netdev
Jan Kiszkaad196a92009-06-24 14:42:28 +02001693@item -net user[,@var{option}][,@var{option}][,...]
blueswir15824d652009-03-28 06:44:27 +00001694Use the user mode network stack which requires no administrator
Jan Kiszkaad196a92009-06-24 14:42:28 +02001695privilege to run. Valid options are:
blueswir15824d652009-03-28 06:44:27 +00001696
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001697@table @option
Jan Kiszkaad196a92009-06-24 14:42:28 +02001698@item vlan=@var{n}
1699Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1700
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001701@item id=@var{id}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001702@itemx name=@var{name}
Jan Kiszkaad196a92009-06-24 14:42:28 +02001703Assign symbolic name for use in monitor commands.
1704
Samuel Thibault0b11c032016-03-20 12:29:54 +01001705@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must
1706be enabled. If neither is specified both protocols are enabled.
1707
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001708@item net=@var{addr}[/@var{mask}]
1709Set IP network address the guest will see. Optionally specify the netmask,
1710either in the form a.b.c.d or as number of valid top-most bits. Default is
Brad Hardsb0b36e52011-04-24 17:19:56 +1000171110.0.2.0/24.
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001712
1713@item host=@var{addr}
1714Specify the guest-visible address of the host. Default is the 2nd IP in the
1715guest network, i.e. x.x.x.2.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001716
Samuel Thibaultd8eb3862016-03-25 00:02:58 +01001717@item ipv6-net=@var{addr}[/@var{int}]
1718Set IPv6 network address the guest will see (default is fec0::/64). The
1719network prefix is given in the usual hexadecimal IPv6 address
1720notation. The prefix size is optional, and is given as the number of
1721valid top-most bits (default is 64).
Yann Bordenave7aac5312016-03-15 10:31:22 +01001722
Samuel Thibaultd8eb3862016-03-25 00:02:58 +01001723@item ipv6-host=@var{addr}
Yann Bordenave7aac5312016-03-15 10:31:22 +01001724Specify the guest-visible IPv6 address of the host. Default is the 2nd IPv6 in
1725the guest network, i.e. xxxx::2.
1726
Jan Kiszkac54ed5b2011-07-20 12:20:14 +02001727@item restrict=on|off
Brad Hardscaef55e2011-06-09 07:50:43 +10001728If this option is enabled, the guest will be isolated, i.e. it will not be
Jan Kiszkaad196a92009-06-24 14:42:28 +02001729able to contact the host and no guest IP packets will be routed over the host
Brad Hardscaef55e2011-06-09 07:50:43 +10001730to the outside. This option does not affect any explicitly set forwarding rules.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001731
1732@item hostname=@var{name}
Klaus Stengel63d29602012-10-27 19:53:39 +02001733Specifies the client hostname reported by the built-in DHCP server.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001734
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001735@item dhcpstart=@var{addr}
1736Specify the first of the 16 IPs the built-in DHCP server can assign. Default
Brad Hardsb0b36e52011-04-24 17:19:56 +10001737is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001738
1739@item dns=@var{addr}
1740Specify the guest-visible address of the virtual nameserver. The address must
1741be different from the host address. Default is the 3rd IP in the guest network,
1742i.e. x.x.x.3.
1743
Samuel Thibaultd8eb3862016-03-25 00:02:58 +01001744@item ipv6-dns=@var{addr}
Yann Bordenave7aac5312016-03-15 10:31:22 +01001745Specify the guest-visible address of the IPv6 virtual nameserver. The address
1746must be different from the host address. Default is the 3rd IP in the guest
1747network, i.e. xxxx::3.
1748
Klaus Stengel63d29602012-10-27 19:53:39 +02001749@item dnssearch=@var{domain}
1750Provides an entry for the domain-search list sent by the built-in
1751DHCP server. More than one domain suffix can be transmitted by specifying
1752this option multiple times. If supported, this will cause the guest to
1753automatically try to append the given domain suffix(es) in case a domain name
1754can not be resolved.
1755
1756Example:
1757@example
1758qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...]
1759@end example
1760
Jan Kiszkaad196a92009-06-24 14:42:28 +02001761@item tftp=@var{dir}
1762When using the user mode network stack, activate a built-in TFTP
1763server. The files in @var{dir} will be exposed as the root of a TFTP server.
1764The TFTP client on the guest must be configured in binary mode (use the command
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001765@code{bin} of the Unix TFTP client).
Jan Kiszkaad196a92009-06-24 14:42:28 +02001766
1767@item bootfile=@var{file}
1768When using the user mode network stack, broadcast @var{file} as the BOOTP
1769filename. In conjunction with @option{tftp}, this can be used to network boot
1770a guest from a local directory.
1771
1772Example (using pxelinux):
1773@example
Stefan Weil3804da92012-05-11 22:21:50 +02001774qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
Jan Kiszkaad196a92009-06-24 14:42:28 +02001775@end example
1776
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001777@item smb=@var{dir}[,smbserver=@var{addr}]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001778When using the user mode network stack, activate a built-in SMB
1779server so that Windows OSes can access to the host files in @file{@var{dir}}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001780transparently. The IP address of the SMB server can be set to @var{addr}. By
1781default the 4th IP in the guest network is used, i.e. x.x.x.4.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001782
1783In the guest Windows OS, the line:
1784@example
178510.0.2.4 smbserver
1786@end example
1787must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1788or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1789
1790Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1791
Brade2d88302011-09-02 16:53:28 -04001792Note that a SAMBA server must be installed on the host OS.
1793QEMU was tested successfully with smbd versions from Red Hat 9,
1794Fedora Core 3 and OpenSUSE 11.x.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001795
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001796@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001797Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1798the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1799@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001800given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1801be bound to a specific host interface. If no connection type is set, TCP is
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001802used. This option can be given multiple times.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001803
1804For example, to redirect host X11 connection from screen 1 to guest
1805screen 0, use the following:
1806
1807@example
1808# on the host
Stefan Weil3804da92012-05-11 22:21:50 +02001809qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001810# this host xterm should open in the guest X11 server
1811xterm -display :1
1812@end example
1813
1814To redirect telnet connections from host port 5555 to telnet port on
1815the guest, use the following:
1816
1817@example
1818# on the host
Stefan Weil3804da92012-05-11 22:21:50 +02001819qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001820telnet localhost 5555
1821@end example
1822
1823Then when you use on the host @code{telnet localhost 5555}, you
1824connect to the guest telnet server.
1825
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001826@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001827@itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001828Forward guest TCP connections to the IP address @var{server} on port @var{port}
Alexander Grafb412eb62012-06-03 09:45:01 +02001829to the character device @var{dev} or to a program executed by @var{cmd:command}
1830which gets spawned for each connection. This option can be given multiple times.
1831
Stefan Weil43ffe612012-07-20 23:26:02 +02001832You can either use a chardev directly and have that one used throughout QEMU's
Alexander Grafb412eb62012-06-03 09:45:01 +02001833lifetime, like in the following example:
1834
1835@example
1836# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
1837# the guest accesses it
1838qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...]
1839@end example
1840
1841Or you can execute a command on every TCP connection established by the guest,
Stefan Weil43ffe612012-07-20 23:26:02 +02001842so that QEMU behaves similar to an inetd process for that virtual server:
Alexander Grafb412eb62012-06-03 09:45:01 +02001843
1844@example
1845# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234
1846# and connect the TCP stream to its stdin/stdout
1847qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
1848@end example
Jan Kiszkaad196a92009-06-24 14:42:28 +02001849
1850@end table
1851
1852Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1853processed and applied to -net user. Mixing them with the new configuration
1854syntax gives undefined results. Their use for new applications is discouraged
1855as they will be removed from future versions.
blueswir15824d652009-03-28 06:44:27 +00001856
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001857@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001858@itemx -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001859Connect the host TAP network interface @var{name} to VLAN @var{n}.
1860
1861Use the network script @var{file} to configure it and the network script
blueswir15824d652009-03-28 06:44:27 +00001862@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001863automatically provides one. The default network configure script is
1864@file{/etc/qemu-ifup} and the default network deconfigure script is
1865@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1866to disable script execution.
1867
1868If running QEMU as an unprivileged user, use the network helper
1869@var{helper} to configure the TAP interface. The default network
Amos Kong420508f2013-10-23 04:49:28 +08001870helper executable is @file{/path/to/qemu-bridge-helper}.
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001871
1872@option{fd}=@var{h} can be used to specify the handle of an already
1873opened host TAP interface.
1874
1875Examples:
blueswir15824d652009-03-28 06:44:27 +00001876
1877@example
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001878#launch a QEMU instance with the default network script
Stefan Weil3804da92012-05-11 22:21:50 +02001879qemu-system-i386 linux.img -net nic -net tap
blueswir15824d652009-03-28 06:44:27 +00001880@end example
1881
blueswir15824d652009-03-28 06:44:27 +00001882@example
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001883#launch a QEMU instance with two NICs, each one connected
1884#to a TAP device
Stefan Weil3804da92012-05-11 22:21:50 +02001885qemu-system-i386 linux.img \
1886 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1887 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
blueswir15824d652009-03-28 06:44:27 +00001888@end example
1889
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001890@example
1891#launch a QEMU instance with the default network helper to
1892#connect a TAP device to bridge br0
Stefan Weil3804da92012-05-11 22:21:50 +02001893qemu-system-i386 linux.img \
Amos Kong420508f2013-10-23 04:49:28 +08001894 -net nic -net tap,"helper=/path/to/qemu-bridge-helper"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001895@end example
1896
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001897@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001898@itemx -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001899Connect a host TAP network interface to a host bridge device.
1900
1901Use the network helper @var{helper} to configure the TAP interface and
1902attach it to the bridge. The default network helper executable is
Amos Kong420508f2013-10-23 04:49:28 +08001903@file{/path/to/qemu-bridge-helper} and the default bridge
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001904device is @file{br0}.
1905
1906Examples:
1907
1908@example
1909#launch a QEMU instance with the default network helper to
1910#connect a TAP device to bridge br0
Stefan Weil3804da92012-05-11 22:21:50 +02001911qemu-system-i386 linux.img -net bridge -net nic,model=virtio
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001912@end example
1913
1914@example
1915#launch a QEMU instance with the default network helper to
1916#connect a TAP device to bridge qemubr0
Stefan Weil3804da92012-05-11 22:21:50 +02001917qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001918@end example
1919
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001920@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001921@itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
blueswir15824d652009-03-28 06:44:27 +00001922
1923Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1924machine using a TCP socket connection. If @option{listen} is
1925specified, QEMU waits for incoming connections on @var{port}
1926(@var{host} is optional). @option{connect} is used to connect to
1927another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1928specifies an already opened TCP socket.
1929
1930Example:
1931@example
1932# launch a first QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02001933qemu-system-i386 linux.img \
1934 -net nic,macaddr=52:54:00:12:34:56 \
1935 -net socket,listen=:1234
blueswir15824d652009-03-28 06:44:27 +00001936# connect the VLAN 0 of this instance to the VLAN 0
1937# of the first instance
Stefan Weil3804da92012-05-11 22:21:50 +02001938qemu-system-i386 linux.img \
1939 -net nic,macaddr=52:54:00:12:34:57 \
1940 -net socket,connect=127.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001941@end example
1942
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001943@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001944@itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
blueswir15824d652009-03-28 06:44:27 +00001945
1946Create a VLAN @var{n} shared with another QEMU virtual
1947machines using a UDP multicast socket, effectively making a bus for
1948every QEMU with same multicast address @var{maddr} and @var{port}.
1949NOTES:
1950@enumerate
1951@item
1952Several QEMU can be running on different hosts and share same bus (assuming
1953correct multicast setup for these hosts).
1954@item
1955mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1956@url{http://user-mode-linux.sf.net}.
1957@item
1958Use @option{fd=h} to specify an already opened UDP multicast socket.
1959@end enumerate
1960
1961Example:
1962@example
1963# launch one QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02001964qemu-system-i386 linux.img \
1965 -net nic,macaddr=52:54:00:12:34:56 \
1966 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001967# launch another QEMU instance on same "bus"
Stefan Weil3804da92012-05-11 22:21:50 +02001968qemu-system-i386 linux.img \
1969 -net nic,macaddr=52:54:00:12:34:57 \
1970 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001971# launch yet another QEMU instance on same "bus"
Stefan Weil3804da92012-05-11 22:21:50 +02001972qemu-system-i386 linux.img \
1973 -net nic,macaddr=52:54:00:12:34:58 \
1974 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001975@end example
1976
1977Example (User Mode Linux compat.):
1978@example
1979# launch QEMU instance (note mcast address selected
1980# is UML's default)
Stefan Weil3804da92012-05-11 22:21:50 +02001981qemu-system-i386 linux.img \
1982 -net nic,macaddr=52:54:00:12:34:56 \
1983 -net socket,mcast=239.192.168.1:1102
blueswir15824d652009-03-28 06:44:27 +00001984# launch UML
1985/path/to/linux ubd0=/path/to/root_fs eth0=mcast
1986@end example
1987
Mike Ryan3a75e742010-12-01 11:16:47 -08001988Example (send packets from host's 1.2.3.4):
1989@example
Stefan Weil3804da92012-05-11 22:21:50 +02001990qemu-system-i386 linux.img \
1991 -net nic,macaddr=52:54:00:12:34:56 \
1992 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
Mike Ryan3a75e742010-12-01 11:16:47 -08001993@end example
1994
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001995@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}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001996@itemx -net l2tpv3[,vlan=@var{n}][,name=@var{name}],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}]
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001997Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular
1998protocol to transport Ethernet (and other Layer 2) data frames between
1999two systems. It is present in routers, firewalls and the Linux kernel
2000(from version 3.3 onwards).
2001
2002This transport allows a VM to communicate to another VM, router or firewall directly.
2003
2004@item src=@var{srcaddr}
2005 source address (mandatory)
2006@item dst=@var{dstaddr}
2007 destination address (mandatory)
2008@item udp
2009 select udp encapsulation (default is ip).
2010@item srcport=@var{srcport}
2011 source udp port.
2012@item dstport=@var{dstport}
2013 destination udp port.
2014@item ipv6
2015 force v6, otherwise defaults to v4.
2016@item rxcookie=@var{rxcookie}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02002017@itemx txcookie=@var{txcookie}
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01002018 Cookies are a weak form of security in the l2tpv3 specification.
2019Their function is mostly to prevent misconfiguration. By default they are 32
2020bit.
2021@item cookie64
2022 Set cookie size to 64 bit instead of the default 32
2023@item counter=off
2024 Force a 'cut-down' L2TPv3 with no counter as in
2025draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
2026@item pincounter=on
2027 Work around broken counter handling in peer. This may also help on
2028networks which have packet reorder.
2029@item offset=@var{offset}
2030 Add an extra offset between header and data
2031
2032For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan
2033on the remote Linux host 1.2.3.4:
2034@example
2035# Setup tunnel on linux host using raw ip as encapsulation
2036# on 1.2.3.4
2037ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \
2038 encap udp udp_sport 16384 udp_dport 16384
2039ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \
2040 0xFFFFFFFF peer_session_id 0xFFFFFFFF
2041ifconfig vmtunnel0 mtu 1500
2042ifconfig vmtunnel0 up
2043brctl addif br-lan vmtunnel0
2044
2045
2046# on 4.3.2.1
2047# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
2048
2049qemu-system-i386 linux.img -net nic -net l2tpv3,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter
2050
2051
2052@end example
2053
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01002054@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02002055@itemx -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
blueswir15824d652009-03-28 06:44:27 +00002056Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
2057listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
2058and MODE @var{octalmode} to change default ownership and permissions for
Stefan Weilc1ba4e02011-09-05 18:13:03 +02002059communication port. This option is only available if QEMU has been compiled
blueswir15824d652009-03-28 06:44:27 +00002060with vde support enabled.
2061
2062Example:
2063@example
2064# launch vde switch
2065vde_switch -F -sock /tmp/myswitch
2066# launch QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02002067qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
blueswir15824d652009-03-28 06:44:27 +00002068@end example
2069
Stefan Hajnoczi40e8c262013-02-26 11:07:16 +01002070@item -netdev hubport,id=@var{id},hubid=@var{hubid}
2071
2072Create a hub port on QEMU "vlan" @var{hubid}.
2073
2074The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single
2075netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the
2076required hub automatically.
2077
Changchun Ouyangb931bfb2015-09-23 12:20:00 +08002078@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n]
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03002079
2080Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should
2081be a unix domain socket backed one. The vhost-user uses a specifically defined
2082protocol to pass vhost ioctl replacement messages to an application on the other
2083end of the socket. On non-MSIX guests, the feature can be forced with
Changchun Ouyangb931bfb2015-09-23 12:20:00 +08002084@var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to
2085be created for multiqueue vhost-user.
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03002086
2087Example:
2088@example
2089qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
2090 -numa node,memdev=mem \
2091 -chardev socket,path=/path/to/socket \
2092 -netdev type=vhost-user,id=net0,chardev=chr0 \
2093 -device virtio-net-pci,netdev=net0
2094@end example
2095
aliguoribb9ea792009-04-21 19:56:28 +00002096@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
2097Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
2098At most @var{len} bytes (64k by default) per packet are stored. The file format is
2099libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
Thomas Huthd3e0c032015-10-13 12:40:02 +02002100Note: For devices created with '-netdev', use '-object filter-dump,...' instead.
aliguoribb9ea792009-04-21 19:56:28 +00002101
blueswir15824d652009-03-28 06:44:27 +00002102@item -net none
2103Indicate that no network devices should be configured. It is used to
2104override the default configuration (@option{-net nic -net user}) which
2105is activated if no @option{-net} options are provided.
blueswir15824d652009-03-28 06:44:27 +00002106ETEXI
2107
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002108STEXI
2109@end table
2110ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002111DEFHEADING()
2112
2113DEFHEADING(Character device options:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002114STEXI
2115
2116The general form of a character device option is:
2117@table @option
2118ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002119
2120DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002121 "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Corey Minyard5dd1f022014-10-02 11:17:37 -05002122 "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n"
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002123 " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off]\n"
Daniel P. Berrangea8fb5422016-01-19 11:14:31 +00002124 " [,logfile=PATH][,logappend=on|off][,tls-creds=ID] (tcp)\n"
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002125 "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds]\n"
2126 " [,mux=on|off][,logfile=PATH][,logappend=on|off] (unix)\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002127 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02002128 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002129 " [,logfile=PATH][,logappend=on|off]\n"
2130 "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002131 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002132 " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2133 "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n"
2134 "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2135 "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002136#ifdef _WIN32
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002137 "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2138 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002139#else
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002140 "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2141 "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002142#endif
2143#ifdef CONFIG_BRLAPI
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002144 "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002145#endif
2146#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
2147 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002148 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2149 "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002150#endif
2151#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002152 "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2153 "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002154#endif
Alon Levycbcc6332011-01-19 10:49:50 +02002155#if defined(CONFIG_SPICE)
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002156 "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
2157 "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
Alon Levycbcc6332011-01-19 10:49:50 +02002158#endif
Blue Swirlad960902010-03-29 19:23:52 +00002159 , QEMU_ARCH_ALL
Matthew Booth7273a2d2009-10-30 13:41:12 +00002160)
2161
2162STEXI
Jan Kiszka97331282010-04-06 16:55:54 +02002163@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002164@findex -chardev
Matthew Booth7273a2d2009-10-30 13:41:12 +00002165Backend is one of:
2166@option{null},
2167@option{socket},
2168@option{udp},
2169@option{msmouse},
2170@option{vc},
Markus Armbruster4f573782013-07-26 16:44:32 +02002171@option{ringbuf},
Matthew Booth7273a2d2009-10-30 13:41:12 +00002172@option{file},
2173@option{pipe},
2174@option{console},
2175@option{serial},
2176@option{pty},
2177@option{stdio},
2178@option{braille},
2179@option{tty},
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002180@option{parallel},
Alon Levycbcc6332011-01-19 10:49:50 +02002181@option{parport},
2182@option{spicevmc}.
Marc-André Lureau5a49d3e2012-12-05 16:15:34 +01002183@option{spiceport}.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002184The specific backend will determine the applicable options.
2185
2186All devices must have an id, which can be any string up to 127 characters long.
2187It is used to uniquely identify this device in other command line directives.
2188
Jan Kiszka97331282010-04-06 16:55:54 +02002189A character device may be used in multiplexing mode by multiple front-ends.
Peter Maydella40db1b2016-02-16 17:28:58 +00002190Specify @option{mux=on} to enable this mode.
2191A multiplexer is a "1:N" device, and here the "1" end is your specified chardev
2192backend, and the "N" end is the various parts of QEMU that can talk to a chardev.
2193If you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will
2194create a multiplexer with your specified ID, and you can then configure multiple
2195front ends to use that chardev ID for their input/output. Up to four different
2196front ends can be connected to a single multiplexed chardev. (Without
2197multiplexing enabled, a chardev can only be used by a single front end.)
2198For instance you could use this to allow a single stdio chardev to be used by
2199two serial ports and the QEMU monitor:
2200
2201@example
2202-chardev stdio,mux=on,id=char0 \
2203-mon chardev=char0,mode=readline,default \
2204-serial chardev:char0 \
2205-serial chardev:char0
2206@end example
2207
2208You can have more than one multiplexer in a system configuration; for instance
2209you could have a TCP port multiplexed between UART 0 and UART 1, and stdio
2210multiplexed between the QEMU monitor and a parallel port:
2211
2212@example
2213-chardev stdio,mux=on,id=char0 \
2214-mon chardev=char0,mode=readline,default \
2215-parallel chardev:char0 \
2216-chardev tcp,...,mux=on,id=char1 \
2217-serial chardev:char1 \
2218-serial chardev:char1
2219@end example
2220
2221When you're using a multiplexed character device, some escape sequences are
2222interpreted in the input. @xref{mux_keys, Keys in the character backend
2223multiplexer}.
2224
2225Note that some other command line options may implicitly create multiplexed
2226character backends; for instance @option{-serial mon:stdio} creates a
2227multiplexed stdio backend connected to the serial port and the QEMU monitor,
2228and @option{-nographic} also multiplexes the console and the monitor to
2229stdio.
2230
2231There is currently no support for multiplexing in the other direction
2232(where a single QEMU front end takes input and output from multiple chardevs).
Jan Kiszka97331282010-04-06 16:55:54 +02002233
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002234Every backend supports the @option{logfile} option, which supplies the path
2235to a file to record all data transmitted via the backend. The @option{logappend}
2236option controls whether the log file will be truncated or appended to when
2237opened.
2238
2239Further options to each backend are described below.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002240
2241@item -chardev null ,id=@var{id}
2242A void device. This device will not emit any data, and will drop any data it
2243receives. The null backend does not take any options.
2244
Daniel P. Berrangea8fb5422016-01-19 11:14:31 +00002245@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] [,tls-creds=@var{id}]
Matthew Booth7273a2d2009-10-30 13:41:12 +00002246
2247Create a two-way stream socket, which can be either a TCP or a unix socket. A
2248unix socket will be created if @option{path} is specified. Behaviour is
2249undefined if TCP options are specified for a unix socket.
2250
2251@option{server} specifies that the socket shall be a listening socket.
2252
2253@option{nowait} specifies that QEMU should not block waiting for a client to
2254connect to a listening socket.
2255
2256@option{telnet} specifies that traffic on the socket should interpret telnet
2257escape sequences.
2258
Corey Minyard5dd1f022014-10-02 11:17:37 -05002259@option{reconnect} sets the timeout for reconnecting on non-server sockets when
2260the remote end goes away. qemu will delay this many seconds and then attempt
2261to reconnect. Zero disables reconnecting, and is the default.
2262
Daniel P. Berrangea8fb5422016-01-19 11:14:31 +00002263@option{tls-creds} requests enablement of the TLS protocol for encryption,
2264and specifies the id of the TLS credentials to use for the handshake. The
2265credentials must be previously created with the @option{-object tls-creds}
2266argument.
2267
Matthew Booth7273a2d2009-10-30 13:41:12 +00002268TCP and unix socket options are given below:
2269
2270@table @option
2271
Aurelien Jarno8d533562010-03-27 11:52:05 +01002272@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
Matthew Booth7273a2d2009-10-30 13:41:12 +00002273
2274@option{host} for a listening socket specifies the local address to be bound.
2275For a connecting socket species the remote host to connect to. @option{host} is
2276optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
2277
2278@option{port} for a listening socket specifies the local port to be bound. For a
2279connecting socket specifies the port on the remote host to connect to.
2280@option{port} can be given as either a port number or a service name.
2281@option{port} is required.
2282
2283@option{to} is only relevant to listening sockets. If it is specified, and
2284@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
2285to and including @option{to} until it succeeds. @option{to} must be specified
2286as a port number.
2287
2288@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2289If neither is specified the socket may use either protocol.
2290
2291@option{nodelay} disables the Nagle algorithm.
2292
2293@item unix options: path=@var{path}
2294
2295@option{path} specifies the local path of the unix socket. @option{path} is
2296required.
2297
2298@end table
2299
2300@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
2301
2302Sends all traffic from the guest to a remote host over UDP.
2303
2304@option{host} specifies the remote host to connect to. If not specified it
2305defaults to @code{localhost}.
2306
2307@option{port} specifies the port on the remote host to connect to. @option{port}
2308is required.
2309
2310@option{localaddr} specifies the local address to bind to. If not specified it
2311defaults to @code{0.0.0.0}.
2312
2313@option{localport} specifies the local port to bind to. If not specified any
2314available local port will be used.
2315
2316@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2317If neither is specified the device may use either protocol.
2318
2319@item -chardev msmouse ,id=@var{id}
2320
2321Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
2322take any options.
2323
2324@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
2325
2326Connect to a QEMU text console. @option{vc} may optionally be given a specific
2327size.
2328
2329@option{width} and @option{height} specify the width and height respectively of
2330the console, in pixels.
2331
2332@option{cols} and @option{rows} specify that the console be sized to fit a text
2333console with the given dimensions.
2334
Markus Armbruster4f573782013-07-26 16:44:32 +02002335@item -chardev ringbuf ,id=@var{id} [,size=@var{size}]
Lei Li51767e72013-01-25 00:03:19 +08002336
Markus Armbruster3949e592013-02-06 21:27:24 +01002337Create a ring buffer with fixed size @option{size}.
2338@var{size} must be a power of two, and defaults to @code{64K}).
Lei Li51767e72013-01-25 00:03:19 +08002339
Matthew Booth7273a2d2009-10-30 13:41:12 +00002340@item -chardev file ,id=@var{id} ,path=@var{path}
2341
2342Log all traffic received from the guest to a file.
2343
2344@option{path} specifies the path of the file to be opened. This file will be
2345created if it does not already exist, and overwritten if it does. @option{path}
2346is required.
2347
2348@item -chardev pipe ,id=@var{id} ,path=@var{path}
2349
2350Create a two-way connection to the guest. The behaviour differs slightly between
2351Windows hosts and other hosts:
2352
2353On Windows, a single duplex pipe will be created at
2354@file{\\.pipe\@option{path}}.
2355
2356On other hosts, 2 pipes will be created called @file{@option{path}.in} and
2357@file{@option{path}.out}. Data written to @file{@option{path}.in} will be
2358received by the guest. Data written by the guest can be read from
2359@file{@option{path}.out}. QEMU will not create these fifos, and requires them to
2360be present.
2361
2362@option{path} forms part of the pipe path as described above. @option{path} is
2363required.
2364
2365@item -chardev console ,id=@var{id}
2366
2367Send traffic from the guest to QEMU's standard output. @option{console} does not
2368take any options.
2369
2370@option{console} is only available on Windows hosts.
2371
2372@item -chardev serial ,id=@var{id} ,path=@option{path}
2373
2374Send traffic from the guest to a serial device on the host.
2375
Gerd Hoffmannd59044e2012-12-19 13:50:29 +01002376On Unix hosts serial will actually accept any tty device,
2377not only serial lines.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002378
2379@option{path} specifies the name of the serial device to open.
2380
2381@item -chardev pty ,id=@var{id}
2382
2383Create a new pseudo-terminal on the host and connect to it. @option{pty} does
2384not take any options.
2385
2386@option{pty} is not available on Windows hosts.
2387
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02002388@item -chardev stdio ,id=@var{id} [,signal=on|off]
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002389Connect to standard input and standard output of the QEMU process.
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02002390
2391@option{signal} controls if signals are enabled on the terminal, that includes
2392exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
2393default, use @option{signal=off} to disable it.
2394
2395@option{stdio} is not available on Windows hosts.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002396
2397@item -chardev braille ,id=@var{id}
2398
2399Connect to a local BrlAPI server. @option{braille} does not take any options.
2400
2401@item -chardev tty ,id=@var{id} ,path=@var{path}
2402
Matthew Booth7273a2d2009-10-30 13:41:12 +00002403@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
Markus Armbrusterd037d6b2013-02-13 15:54:15 +01002404DragonFlyBSD hosts. It is an alias for @option{serial}.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002405
2406@option{path} specifies the path to the tty. @option{path} is required.
2407
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002408@item -chardev parallel ,id=@var{id} ,path=@var{path}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02002409@itemx -chardev parport ,id=@var{id} ,path=@var{path}
Matthew Booth7273a2d2009-10-30 13:41:12 +00002410
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002411@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002412
2413Connect to a local parallel port.
2414
2415@option{path} specifies the path to the parallel port device. @option{path} is
2416required.
2417
Alon Levycbcc6332011-01-19 10:49:50 +02002418@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2419
Stefan Hajnoczi3a846902011-10-06 11:24:12 +01002420@option{spicevmc} is only available when spice support is built in.
2421
Alon Levycbcc6332011-01-19 10:49:50 +02002422@option{debug} debug level for spicevmc
2423
2424@option{name} name of spice channel to connect to
2425
2426Connect to a spice virtual machine channel, such as vdiport.
Alon Levycbcc6332011-01-19 10:49:50 +02002427
Marc-André Lureau5a49d3e2012-12-05 16:15:34 +01002428@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2429
2430@option{spiceport} is only available when spice support is built in.
2431
2432@option{debug} debug level for spicevmc
2433
2434@option{name} name of spice port to connect to
2435
2436Connect to a spice port, allowing a Spice client to handle the traffic
2437identified by a name (preferably a fqdn).
Matthew Booth7273a2d2009-10-30 13:41:12 +00002438ETEXI
2439
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002440STEXI
2441@end table
2442ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002443DEFHEADING()
2444
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002445DEFHEADING(Device URL Syntax:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002446STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002447
2448In addition to using normal file images for the emulated storage devices,
2449QEMU can also use networked resources such as iSCSI devices. These are
2450specified using a special URL syntax.
2451
2452@table @option
2453@item iSCSI
2454iSCSI support allows QEMU to access iSCSI resources directly and use as
2455images for the guest storage. Both disk and cdrom images are supported.
2456
2457Syntax for specifying iSCSI LUNs is
2458``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
2459
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002460By default qemu will use the iSCSI initiator-name
2461'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
2462line or a configuration file.
2463
Peter Lieven5dd7a532015-06-16 13:45:07 +02002464Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect
2465stalled requests and force a reestablishment of the session. The timeout
Peter Lieven90497362015-06-26 12:18:01 +02002466is specified in seconds. The default is 0 which means no timeout. Libiscsi
24671.15.0 or greater is required for this feature.
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002468
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002469Example (without authentication):
2470@example
Stefan Weil3804da92012-05-11 22:21:50 +02002471qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
2472 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
2473 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002474@end example
2475
2476Example (CHAP username/password via URL):
2477@example
Stefan Weil3804da92012-05-11 22:21:50 +02002478qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002479@end example
2480
2481Example (CHAP username/password via environment variables):
2482@example
2483LIBISCSI_CHAP_USERNAME="user" \
2484LIBISCSI_CHAP_PASSWORD="password" \
Stefan Weil3804da92012-05-11 22:21:50 +02002485qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002486@end example
2487
2488iSCSI support is an optional feature of QEMU and only available when
2489compiled and linked against libiscsi.
Ronnie Sahlbergf9dadc92012-01-26 09:39:02 +11002490ETEXI
2491DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
2492 "-iscsi [user=user][,password=password]\n"
2493 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n"
Paolo Bonzini2fe37982013-12-06 16:08:05 +01002494 " [,initiator-name=initiator-iqn][,id=target-iqn]\n"
Peter Lieven5dd7a532015-06-16 13:45:07 +02002495 " [,timeout=timeout]\n"
Ronnie Sahlbergf9dadc92012-01-26 09:39:02 +11002496 " iSCSI session parameters\n", QEMU_ARCH_ALL)
2497STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002498
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002499iSCSI parameters such as username and password can also be specified via
2500a configuration file. See qemu-doc for more information and examples.
2501
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002502@item NBD
2503QEMU supports NBD (Network Block Devices) both using TCP protocol as well
2504as Unix Domain Sockets.
2505
2506Syntax for specifying a NBD device using TCP
2507``nbd:<server-ip>:<port>[:exportname=<export>]''
2508
2509Syntax for specifying a NBD device using Unix Domain Sockets
2510``nbd:unix:<domain-socket>[:exportname=<export>]''
2511
2512
2513Example for TCP
2514@example
Stefan Weil3804da92012-05-11 22:21:50 +02002515qemu-system-i386 --drive file=nbd:192.0.2.1:30000
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002516@end example
2517
2518Example for Unix Domain Sockets
2519@example
Stefan Weil3804da92012-05-11 22:21:50 +02002520qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002521@end example
2522
Richard W.M. Jones0a12ec82013-04-09 15:30:53 +01002523@item SSH
2524QEMU supports SSH (Secure Shell) access to remote disks.
2525
2526Examples:
2527@example
2528qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img
2529qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
2530@end example
2531
2532Currently authentication must be done using ssh-agent. Other
2533authentication methods may be supported in future.
2534
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002535@item Sheepdog
2536Sheepdog is a distributed storage system for QEMU.
2537QEMU supports using either local sheepdog devices or remote networked
2538devices.
2539
2540Syntax for specifying a sheepdog device
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002541@example
MORITA Kazutaka1b8bbb42013-02-22 12:39:53 +09002542sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002543@end example
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002544
2545Example
2546@example
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002547qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002548@end example
2549
2550See also @url{http://http://www.osrg.net/sheepdog/}.
2551
Bharata B Rao8809e282012-10-24 17:17:53 +05302552@item GlusterFS
2553GlusterFS is an user space distributed file system.
2554QEMU supports the use of GlusterFS volumes for hosting VM disk images using
2555TCP, Unix Domain Sockets and RDMA transport protocols.
2556
2557Syntax for specifying a VM disk image on GlusterFS volume is
2558@example
2559gluster[+transport]://[server[:port]]/volname/image[?socket=...]
2560@end example
2561
2562
2563Example
2564@example
Lei Lidb2d5eb2013-03-07 15:50:26 +08002565qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img
Bharata B Rao8809e282012-10-24 17:17:53 +05302566@end example
2567
2568See also @url{http://www.gluster.org}.
Matthew Booth0a86cb72014-05-14 19:28:43 -04002569
2570@item HTTP/HTTPS/FTP/FTPS/TFTP
2571QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp.
2572
2573Syntax using a single filename:
2574@example
2575<protocol>://[<username>[:<password>]@@]<host>/<path>
2576@end example
2577
2578where:
2579@table @option
2580@item protocol
2581'http', 'https', 'ftp', 'ftps', or 'tftp'.
2582
2583@item username
2584Optional username for authentication to the remote server.
2585
2586@item password
2587Optional password for authentication to the remote server.
2588
2589@item host
2590Address of the remote server.
2591
2592@item path
2593Path on the remote server, including any query string.
2594@end table
2595
2596The following options are also supported:
2597@table @option
2598@item url
2599The full URL when passing options to the driver explicitly.
2600
2601@item readahead
2602The amount of data to read ahead with each range request to the remote server.
2603This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it
2604does not have a suffix, it will be assumed to be in bytes. The value must be a
2605multiple of 512 bytes. It defaults to 256k.
2606
2607@item sslverify
2608Whether to verify the remote server's certificate when connecting over SSL. It
2609can have the value 'on' or 'off'. It defaults to 'on'.
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002610
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +01002611@item cookie
2612Send this cookie (it can also be a list of cookies separated by ';') with
2613each outgoing request. Only supported when using protocols such as HTTP
2614which support cookies, otherwise ignored.
2615
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002616@item timeout
2617Set the timeout in seconds of the CURL connection. This timeout is the time
2618that CURL waits for a response from the remote server to get the size of the
2619image to be downloaded. If not set, the default timeout of 5 seconds is used.
Matthew Booth0a86cb72014-05-14 19:28:43 -04002620@end table
2621
2622Note that when passing options to qemu explicitly, @option{driver} is the value
2623of <protocol>.
2624
2625Example: boot from a remote Fedora 20 live ISO image
2626@example
2627qemu-system-x86_64 --drive media=cdrom,file=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
2628
2629qemu-system-x86_64 --drive media=cdrom,file.driver=http,file.url=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
2630@end example
2631
2632Example: boot from a remote Fedora 20 cloud image using a local overlay for
2633writes, copy-on-read, and a readahead of 64k
2634@example
2635qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, "file.url":"https://dl.fedoraproject.org/pub/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2
2636
2637qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on
2638@end example
2639
2640Example: boot from an image stored on a VMware vSphere server with a self-signed
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002641certificate using a local overlay for writes, a readahead of 64k and a timeout
2642of 10 seconds.
Matthew Booth0a86cb72014-05-14 19:28:43 -04002643@example
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002644qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10@}' /tmp/test.qcow2
Matthew Booth0a86cb72014-05-14 19:28:43 -04002645
2646qemu-system-x86_64 -drive file=/tmp/test.qcow2
2647@end example
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002648ETEXI
2649
2650STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002651@end table
2652ETEXI
2653
Matthew Booth7273a2d2009-10-30 13:41:12 +00002654DEFHEADING(Bluetooth(R) options:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002655STEXI
2656@table @option
2657ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002658
blueswir15824d652009-03-28 06:44:27 +00002659DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
blueswir15824d652009-03-28 06:44:27 +00002660 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
2661 "-bt hci,host[:id]\n" \
2662 " use host's HCI with the given name\n" \
2663 "-bt hci[,vlan=n]\n" \
2664 " emulate a standard HCI in virtual scatternet 'n'\n" \
2665 "-bt vhci[,vlan=n]\n" \
2666 " add host computer to virtual scatternet 'n' using VHCI\n" \
2667 "-bt device:dev[,vlan=n]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002668 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
2669 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002670STEXI
blueswir15824d652009-03-28 06:44:27 +00002671@item -bt hci[...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002672@findex -bt
blueswir15824d652009-03-28 06:44:27 +00002673Defines the function of the corresponding Bluetooth HCI. -bt options
2674are matched with the HCIs present in the chosen machine type. For
2675example when emulating a machine with only one HCI built into it, only
2676the first @code{-bt hci[...]} option is valid and defines the HCI's
2677logic. The Transport Layer is decided by the machine type. Currently
2678the machines @code{n800} and @code{n810} have one HCI and all other
2679machines have none.
2680
2681@anchor{bt-hcis}
2682The following three types are recognized:
2683
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002684@table @option
blueswir15824d652009-03-28 06:44:27 +00002685@item -bt hci,null
2686(default) The corresponding Bluetooth HCI assumes no internal logic
2687and will not respond to any HCI commands or emit events.
2688
2689@item -bt hci,host[:@var{id}]
2690(@code{bluez} only) The corresponding HCI passes commands / events
2691to / from the physical HCI identified by the name @var{id} (default:
2692@code{hci0}) on the computer running QEMU. Only available on @code{bluez}
2693capable systems like Linux.
2694
2695@item -bt hci[,vlan=@var{n}]
2696Add a virtual, standard HCI that will participate in the Bluetooth
2697scatternet @var{n} (default @code{0}). Similarly to @option{-net}
2698VLANs, devices inside a bluetooth network @var{n} can only communicate
2699with other devices in the same network (scatternet).
2700@end table
2701
2702@item -bt vhci[,vlan=@var{n}]
2703(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
2704to the host bluetooth stack instead of to the emulated target. This
2705allows the host and target machines to participate in a common scatternet
2706and communicate. Requires the Linux @code{vhci} driver installed. Can
2707be used as following:
2708
2709@example
Stefan Weil3804da92012-05-11 22:21:50 +02002710qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
blueswir15824d652009-03-28 06:44:27 +00002711@end example
2712
2713@item -bt device:@var{dev}[,vlan=@var{n}]
2714Emulate a bluetooth device @var{dev} and place it in network @var{n}
2715(default @code{0}). QEMU can only emulate one type of bluetooth devices
2716currently:
2717
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002718@table @option
blueswir15824d652009-03-28 06:44:27 +00002719@item keyboard
2720Virtual wireless keyboard implementing the HIDP bluetooth profile.
2721@end table
blueswir15824d652009-03-28 06:44:27 +00002722ETEXI
2723
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002724STEXI
2725@end table
2726ETEXI
blueswir15824d652009-03-28 06:44:27 +00002727DEFHEADING()
2728
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002729#ifdef CONFIG_TPM
2730DEFHEADING(TPM device options:)
2731
2732DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
Stefan Berger92dcc232013-02-27 12:47:54 -05002733 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n"
2734 " use path to provide path to a character device; default is /dev/tpm0\n"
2735 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n"
2736 " not provided it will be searched for in /sys/class/misc/tpm?/device\n",
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002737 QEMU_ARCH_ALL)
2738STEXI
2739
2740The general form of a TPM device option is:
2741@table @option
2742
2743@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
2744@findex -tpmdev
2745Backend type must be:
Stefan Berger4549a8b2013-02-27 12:47:53 -05002746@option{passthrough}.
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002747
2748The specific backend type will determine the applicable options.
Corey Bryant28c4fa32013-03-20 12:34:49 -04002749The @code{-tpmdev} option creates the TPM backend and requires a
2750@code{-device} option that specifies the TPM frontend interface model.
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002751
2752Options to each backend are described below.
2753
2754Use 'help' to print all available TPM backend types.
2755@example
2756qemu -tpmdev help
2757@end example
2758
Stefan Berger92dcc232013-02-27 12:47:54 -05002759@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
Stefan Berger4549a8b2013-02-27 12:47:53 -05002760
2761(Linux-host only) Enable access to the host's TPM using the passthrough
2762driver.
2763
2764@option{path} specifies the path to the host's TPM device, i.e., on
2765a Linux host this would be @code{/dev/tpm0}.
2766@option{path} is optional and by default @code{/dev/tpm0} is used.
2767
Stefan Berger92dcc232013-02-27 12:47:54 -05002768@option{cancel-path} specifies the path to the host TPM device's sysfs
2769entry allowing for cancellation of an ongoing TPM command.
2770@option{cancel-path} is optional and by default QEMU will search for the
2771sysfs entry to use.
2772
Stefan Berger4549a8b2013-02-27 12:47:53 -05002773Some notes about using the host's TPM with the passthrough driver:
2774
2775The TPM device accessed by the passthrough driver must not be
2776used by any other application on the host.
2777
2778Since the host's firmware (BIOS/UEFI) has already initialized the TPM,
2779the VM's firmware (BIOS/UEFI) will not be able to initialize the
2780TPM again and may therefore not show a TPM-specific menu that would
2781otherwise allow the user to configure the TPM, e.g., allow the user to
2782enable/disable or activate/deactivate the TPM.
2783Further, if TPM ownership is released from within a VM then the host's TPM
2784will get disabled and deactivated. To enable and activate the
2785TPM again afterwards, the host has to be rebooted and the user is
2786required to enter the firmware's menu to enable and activate the TPM.
2787If the TPM is left disabled and/or deactivated most TPM commands will fail.
2788
2789To create a passthrough TPM use the following two options:
2790@example
2791-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
2792@end example
2793Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
2794@code{tpmdev=tpm0} in the device option.
2795
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002796@end table
2797
2798ETEXI
2799
2800DEFHEADING()
2801
2802#endif
2803
Alexander Graf7677f052009-06-28 16:55:55 +02002804DEFHEADING(Linux/Multiboot boot specific:)
blueswir15824d652009-03-28 06:44:27 +00002805STEXI
Alexander Graf7677f052009-06-28 16:55:55 +02002806
2807When using these options, you can use a given Linux or Multiboot
2808kernel without installing it in the disk image. It can be useful
blueswir15824d652009-03-28 06:44:27 +00002809for easier testing of various kernels.
2810
2811@table @option
2812ETEXI
2813
2814DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
Blue Swirlad960902010-03-29 19:23:52 +00002815 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002816STEXI
2817@item -kernel @var{bzImage}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002818@findex -kernel
Alexander Graf7677f052009-06-28 16:55:55 +02002819Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2820or in multiboot format.
blueswir15824d652009-03-28 06:44:27 +00002821ETEXI
2822
2823DEF("append", HAS_ARG, QEMU_OPTION_append, \
Blue Swirlad960902010-03-29 19:23:52 +00002824 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002825STEXI
2826@item -append @var{cmdline}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002827@findex -append
blueswir15824d652009-03-28 06:44:27 +00002828Use @var{cmdline} as kernel command line
2829ETEXI
2830
2831DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
Blue Swirlad960902010-03-29 19:23:52 +00002832 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002833STEXI
2834@item -initrd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002835@findex -initrd
blueswir15824d652009-03-28 06:44:27 +00002836Use @var{file} as initial ram disk.
Alexander Graf7677f052009-06-28 16:55:55 +02002837
2838@item -initrd "@var{file1} arg=foo,@var{file2}"
2839
2840This syntax is only available with multiboot.
2841
2842Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2843first module.
blueswir15824d652009-03-28 06:44:27 +00002844ETEXI
2845
Grant Likely412beee2012-03-02 11:56:38 +00002846DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
Peter A. G. Crosthwaite379b5c72012-03-04 21:03:54 +10002847 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL)
Grant Likely412beee2012-03-02 11:56:38 +00002848STEXI
2849@item -dtb @var{file}
2850@findex -dtb
2851Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
2852on boot.
2853ETEXI
2854
blueswir15824d652009-03-28 06:44:27 +00002855STEXI
2856@end table
2857ETEXI
blueswir15824d652009-03-28 06:44:27 +00002858DEFHEADING()
2859
2860DEFHEADING(Debug/Expert options:)
blueswir15824d652009-03-28 06:44:27 +00002861STEXI
2862@table @option
2863ETEXI
2864
Gabriel L. Somlo81b2b812015-04-29 11:21:53 -04002865DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg,
2866 "-fw_cfg [name=]<name>,file=<file>\n"
Markus Armbruster63d31452016-04-18 18:29:50 +02002867 " add named fw_cfg entry with contents from file\n"
Gabriel L. Somlo6407d762015-09-29 12:29:01 -04002868 "-fw_cfg [name=]<name>,string=<str>\n"
Markus Armbruster63d31452016-04-18 18:29:50 +02002869 " add named fw_cfg entry with contents from string\n",
Gabriel L. Somlo81b2b812015-04-29 11:21:53 -04002870 QEMU_ARCH_ALL)
2871STEXI
Markus Armbruster63d31452016-04-18 18:29:50 +02002872
Gabriel L. Somlo81b2b812015-04-29 11:21:53 -04002873@item -fw_cfg [name=]@var{name},file=@var{file}
2874@findex -fw_cfg
Markus Armbruster63d31452016-04-18 18:29:50 +02002875Add named fw_cfg entry with contents from file @var{file}.
Gabriel L. Somlo6407d762015-09-29 12:29:01 -04002876
2877@item -fw_cfg [name=]@var{name},string=@var{str}
Markus Armbruster63d31452016-04-18 18:29:50 +02002878Add named fw_cfg entry with contents from string @var{str}.
2879
2880The terminating NUL character of the contents of @var{str} will not be
2881included as part of the fw_cfg item data. To insert contents with
2882embedded NUL characters, you have to use the @var{file} parameter.
2883
2884The fw_cfg entries are passed by QEMU through to the guest.
2885
2886Example:
2887@example
2888 -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin
2889@end example
2890creates an fw_cfg entry named opt/com.mycompany/blob with contents
2891from ./my_blob.bin.
2892
Gabriel L. Somlo81b2b812015-04-29 11:21:53 -04002893ETEXI
2894
blueswir15824d652009-03-28 06:44:27 +00002895DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
Blue Swirlad960902010-03-29 19:23:52 +00002896 "-serial dev redirect the serial port to char device 'dev'\n",
2897 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002898STEXI
2899@item -serial @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002900@findex -serial
blueswir15824d652009-03-28 06:44:27 +00002901Redirect the virtual serial port to host character device
2902@var{dev}. The default device is @code{vc} in graphical mode and
2903@code{stdio} in non graphical mode.
2904
2905This option can be used several times to simulate up to 4 serial
2906ports.
2907
2908Use @code{-serial none} to disable all serial ports.
2909
2910Available character devices are:
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002911@table @option
Kevin Wolf4e257e52009-10-09 10:58:36 +02002912@item vc[:@var{W}x@var{H}]
blueswir15824d652009-03-28 06:44:27 +00002913Virtual console. Optionally, a width and height can be given in pixel with
2914@example
2915vc:800x600
2916@end example
2917It is also possible to specify width or height in characters:
2918@example
2919vc:80Cx24C
2920@end example
2921@item pty
2922[Linux only] Pseudo TTY (a new PTY is automatically allocated)
2923@item none
2924No device is allocated.
2925@item null
2926void device
Ingo van Lil88e020e2013-12-20 14:44:53 +01002927@item chardev:@var{id}
2928Use a named character device defined with the @code{-chardev} option.
blueswir15824d652009-03-28 06:44:27 +00002929@item /dev/XXX
2930[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2931parameters are set according to the emulated ones.
2932@item /dev/parport@var{N}
2933[Linux only, parallel port only] Use host parallel port
2934@var{N}. Currently SPP and EPP parallel port features can be used.
2935@item file:@var{filename}
2936Write output to @var{filename}. No character can be read.
2937@item stdio
2938[Unix only] standard input/output
2939@item pipe:@var{filename}
2940name pipe @var{filename}
2941@item COM@var{n}
2942[Windows only] Use host serial port @var{n}
2943@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2944This implements UDP Net Console.
2945When @var{remote_host} or @var{src_ip} are not specified
2946they default to @code{0.0.0.0}.
2947When not using a specified @var{src_port} a random port is automatically chosen.
blueswir15824d652009-03-28 06:44:27 +00002948
2949If you just want a simple readonly console you can use @code{netcat} or
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002950@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
2951@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
blueswir15824d652009-03-28 06:44:27 +00002952will appear in the netconsole session.
2953
2954If you plan to send characters back via netconsole or you want to stop
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002955and start QEMU a lot of times, you should have QEMU use the same
blueswir15824d652009-03-28 06:44:27 +00002956source port each time by using something like @code{-serial
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002957udp::4555@@:4556} to QEMU. Another approach is to use a patched
blueswir15824d652009-03-28 06:44:27 +00002958version of netcat which can listen to a TCP port and send and receive
2959characters via udp. If you have a patched version of netcat which
2960activates telnet remote echo and single char transfer, then you can
2961use the following options to step up a netcat redirector to allow
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002962telnet on port 5555 to access the QEMU port.
blueswir15824d652009-03-28 06:44:27 +00002963@table @code
Stefan Weil071c9392012-04-07 09:23:36 +02002964@item QEMU Options:
blueswir15824d652009-03-28 06:44:27 +00002965-serial udp::4555@@:4556
2966@item netcat options:
2967-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2968@item telnet options:
2969localhost 5555
2970@end table
2971
Corey Minyard5dd1f022014-10-02 11:17:37 -05002972@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}]
blueswir15824d652009-03-28 06:44:27 +00002973The TCP Net Console has two modes of operation. It can send the serial
2974I/O to a location or wait for a connection from a location. By default
2975the TCP Net Console is sent to @var{host} at the @var{port}. If you use
2976the @var{server} option QEMU will wait for a client socket application
2977to connect to the port before continuing, unless the @code{nowait}
2978option was specified. The @code{nodelay} option disables the Nagle buffering
Corey Minyard5dd1f022014-10-02 11:17:37 -05002979algorithm. The @code{reconnect} option only applies if @var{noserver} is
2980set, if the connection goes down it will attempt to reconnect at the
2981given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only
blueswir15824d652009-03-28 06:44:27 +00002982one TCP connection at a time is accepted. You can use @code{telnet} to
2983connect to the corresponding character device.
2984@table @code
2985@item Example to send tcp console to 192.168.0.2 port 4444
2986-serial tcp:192.168.0.2:4444
2987@item Example to listen and wait on port 4444 for connection
2988-serial tcp::4444,server
2989@item Example to not wait and listen on ip 192.168.0.100 port 4444
2990-serial tcp:192.168.0.100:4444,server,nowait
2991@end table
2992
2993@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
2994The telnet protocol is used instead of raw tcp sockets. The options
2995work the same as if you had specified @code{-serial tcp}. The
2996difference is that the port acts like a telnet server or client using
2997telnet option negotiation. This will also allow you to send the
2998MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
2999sequence. Typically in unix telnet you do it with Control-] and then
3000type "send break" followed by pressing the enter key.
3001
Corey Minyard5dd1f022014-10-02 11:17:37 -05003002@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}]
blueswir15824d652009-03-28 06:44:27 +00003003A unix domain socket is used instead of a tcp socket. The option works the
3004same as if you had specified @code{-serial tcp} except the unix domain socket
3005@var{path} is used for connections.
3006
3007@item mon:@var{dev_string}
3008This is a special option to allow the monitor to be multiplexed onto
3009another serial port. The monitor is accessed with key sequence of
Paolo Bonzini02c4bdf2013-07-03 20:29:45 +04003010@key{Control-a} and then pressing @key{c}.
blueswir15824d652009-03-28 06:44:27 +00003011@var{dev_string} should be any one of the serial devices specified
3012above. An example to multiplex the monitor onto a telnet server
3013listening on port 4444 would be:
3014@table @code
3015@item -serial mon:telnet::4444,server,nowait
3016@end table
Michael Tokarevbe022d62013-07-11 12:55:50 +04003017When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate
3018QEMU any more but will be passed to the guest instead.
blueswir15824d652009-03-28 06:44:27 +00003019
3020@item braille
3021Braille device. This will use BrlAPI to display the braille output on a real
3022or fake device.
3023
Kevin Wolfbe8b28a2009-10-09 10:58:37 +02003024@item msmouse
3025Three button serial mouse. Configure the guest to use Microsoft protocol.
blueswir15824d652009-03-28 06:44:27 +00003026@end table
3027ETEXI
3028
3029DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
Blue Swirlad960902010-03-29 19:23:52 +00003030 "-parallel dev redirect the parallel port to char device 'dev'\n",
3031 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003032STEXI
3033@item -parallel @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003034@findex -parallel
blueswir15824d652009-03-28 06:44:27 +00003035Redirect the virtual parallel port to host device @var{dev} (same
3036devices as the serial port). On Linux hosts, @file{/dev/parportN} can
3037be used to use hardware devices connected on the corresponding host
3038parallel port.
3039
3040This option can be used several times to simulate up to 3 parallel
3041ports.
3042
3043Use @code{-parallel none} to disable all parallel ports.
3044ETEXI
3045
3046DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
Blue Swirlad960902010-03-29 19:23:52 +00003047 "-monitor dev redirect the monitor to char device 'dev'\n",
3048 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003049STEXI
Gerd Hoffmann4e307fc2009-12-08 13:11:37 +01003050@item -monitor @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003051@findex -monitor
blueswir15824d652009-03-28 06:44:27 +00003052Redirect the monitor to host device @var{dev} (same devices as the
3053serial port).
3054The default device is @code{vc} in graphical mode and @code{stdio} in
3055non graphical mode.
Luiz Capitulino70e098a2013-05-16 12:02:55 -04003056Use @code{-monitor none} to disable the default monitor.
blueswir15824d652009-03-28 06:44:27 +00003057ETEXI
Gerd Hoffmann6ca55822009-12-08 13:11:52 +01003058DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
Blue Swirlad960902010-03-29 19:23:52 +00003059 "-qmp dev like -monitor but opens in 'control' mode\n",
3060 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01003061STEXI
3062@item -qmp @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003063@findex -qmp
Stefan Weil95d5f082010-01-20 22:25:27 +01003064Like -monitor but opens in 'control' mode.
3065ETEXI
Max Reitz4821cd42014-11-17 13:31:04 +01003066DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \
3067 "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n",
3068 QEMU_ARCH_ALL)
3069STEXI
3070@item -qmp-pretty @var{dev}
3071@findex -qmp-pretty
3072Like -qmp but uses pretty JSON formatting.
3073ETEXI
blueswir15824d652009-03-28 06:44:27 +00003074
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01003075DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
Michael Tokarevf17e4ea2013-06-15 13:47:32 +04003076 "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01003077STEXI
Michael Tokarevf17e4ea2013-06-15 13:47:32 +04003078@item -mon [chardev=]name[,mode=readline|control][,default]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003079@findex -mon
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01003080Setup monitor on chardev @var{name}.
3081ETEXI
3082
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08003083DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
Blue Swirlad960902010-03-29 19:23:52 +00003084 "-debugcon dev redirect the debug console to char device 'dev'\n",
3085 QEMU_ARCH_ALL)
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08003086STEXI
3087@item -debugcon @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003088@findex -debugcon
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08003089Redirect the debug console to host device @var{dev} (same devices as the
3090serial port). The debug console is an I/O port which is typically port
30910xe9; writing to that I/O port sends output to this device.
3092The default device is @code{vc} in graphical mode and @code{stdio} in
3093non graphical mode.
3094ETEXI
3095
blueswir15824d652009-03-28 06:44:27 +00003096DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
Blue Swirlad960902010-03-29 19:23:52 +00003097 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003098STEXI
3099@item -pidfile @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003100@findex -pidfile
blueswir15824d652009-03-28 06:44:27 +00003101Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
3102from a script.
3103ETEXI
3104
aurel321b530a62009-04-05 20:08:59 +00003105DEF("singlestep", 0, QEMU_OPTION_singlestep, \
Blue Swirlad960902010-03-29 19:23:52 +00003106 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
aurel321b530a62009-04-05 20:08:59 +00003107STEXI
3108@item -singlestep
Stefan Weil6616b2a2010-02-05 23:52:05 +01003109@findex -singlestep
aurel321b530a62009-04-05 20:08:59 +00003110Run the emulation in single step mode.
3111ETEXI
3112
blueswir15824d652009-03-28 06:44:27 +00003113DEF("S", 0, QEMU_OPTION_S, \
Blue Swirlad960902010-03-29 19:23:52 +00003114 "-S freeze CPU at startup (use 'c' to start execution)\n",
3115 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003116STEXI
3117@item -S
Stefan Weil6616b2a2010-02-05 23:52:05 +01003118@findex -S
blueswir15824d652009-03-28 06:44:27 +00003119Do not start CPU at startup (you must type 'c' in the monitor).
3120ETEXI
3121
Satoru Moriya888a6bc2013-04-19 16:42:06 +02003122DEF("realtime", HAS_ARG, QEMU_OPTION_realtime,
3123 "-realtime [mlock=on|off]\n"
3124 " run qemu with realtime features\n"
3125 " mlock=on|off controls mlock support (default: on)\n",
3126 QEMU_ARCH_ALL)
3127STEXI
3128@item -realtime mlock=on|off
3129@findex -realtime
3130Run qemu with realtime features.
3131mlocking qemu and guest memory can be enabled via @option{mlock=on}
3132(enabled by default).
3133ETEXI
3134
aliguori59030a82009-04-05 18:43:41 +00003135DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
Blue Swirlad960902010-03-29 19:23:52 +00003136 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003137STEXI
aliguori59030a82009-04-05 18:43:41 +00003138@item -gdb @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003139@findex -gdb
aliguori59030a82009-04-05 18:43:41 +00003140Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
3141connections will likely be TCP-based, but also UDP, pseudo TTY, or even
Stefan Weilb65ee4f2012-05-11 22:25:50 +02003142stdio are reasonable use case. The latter is allowing to start QEMU from
aliguori59030a82009-04-05 18:43:41 +00003143within gdb and establish the connection via a pipe:
3144@example
Stefan Weil3804da92012-05-11 22:21:50 +02003145(gdb) target remote | exec qemu-system-i386 -gdb stdio ...
aliguori59030a82009-04-05 18:43:41 +00003146@end example
blueswir15824d652009-03-28 06:44:27 +00003147ETEXI
3148
aliguori59030a82009-04-05 18:43:41 +00003149DEF("s", 0, QEMU_OPTION_s, \
Blue Swirlad960902010-03-29 19:23:52 +00003150 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
3151 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003152STEXI
aliguori59030a82009-04-05 18:43:41 +00003153@item -s
Stefan Weil6616b2a2010-02-05 23:52:05 +01003154@findex -s
aliguori59030a82009-04-05 18:43:41 +00003155Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
3156(@pxref{gdb_usage}).
blueswir15824d652009-03-28 06:44:27 +00003157ETEXI
3158
3159DEF("d", HAS_ARG, QEMU_OPTION_d, \
Peter Maydell989b6972013-02-26 17:52:40 +00003160 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n",
Blue Swirlad960902010-03-29 19:23:52 +00003161 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003162STEXI
Peter Maydell989b6972013-02-26 17:52:40 +00003163@item -d @var{item1}[,...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003164@findex -d
Peter Maydell989b6972013-02-26 17:52:40 +00003165Enable logging of specified items. Use '-d help' for a list of log items.
blueswir15824d652009-03-28 06:44:27 +00003166ETEXI
3167
Matthew Fernandezc235d732011-06-07 16:32:40 +00003168DEF("D", HAS_ARG, QEMU_OPTION_D, \
Peter Maydell989b6972013-02-26 17:52:40 +00003169 "-D logfile output log to logfile (default stderr)\n",
Matthew Fernandezc235d732011-06-07 16:32:40 +00003170 QEMU_ARCH_ALL)
3171STEXI
Stefan Weil8bd383b2012-05-11 22:40:50 +02003172@item -D @var{logfile}
Matthew Fernandezc235d732011-06-07 16:32:40 +00003173@findex -D
Peter Maydell989b6972013-02-26 17:52:40 +00003174Output log in @var{logfile} instead of to stderr
Matthew Fernandezc235d732011-06-07 16:32:40 +00003175ETEXI
3176
Alex Bennée35145522016-03-15 14:30:20 +00003177DEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \
3178 "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n",
3179 QEMU_ARCH_ALL)
3180STEXI
3181@item -dfilter @var{range1}[,...]
3182@findex -dfilter
3183Filter debug output to that relevant to a range of target addresses. The filter
3184spec can be either @var{start}+@var{size}, @var{start}-@var{size} or
3185@var{start}..@var{end} where @var{start} @var{end} and @var{size} are the
3186addresses and sizes required. For example:
3187@example
3188 -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000
3189@end example
3190Will dump output for any code in the 0x1000 sized block starting at 0x8000 and
3191the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized
3192block starting at 0xffffffc00005f000.
3193ETEXI
3194
blueswir15824d652009-03-28 06:44:27 +00003195DEF("L", HAS_ARG, QEMU_OPTION_L, \
Blue Swirlad960902010-03-29 19:23:52 +00003196 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
3197 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003198STEXI
3199@item -L @var{path}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003200@findex -L
blueswir15824d652009-03-28 06:44:27 +00003201Set the directory for the BIOS, VGA BIOS and keymaps.
3202ETEXI
3203
3204DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
Blue Swirlad960902010-03-29 19:23:52 +00003205 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003206STEXI
3207@item -bios @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003208@findex -bios
blueswir15824d652009-03-28 06:44:27 +00003209Set the filename for the BIOS.
3210ETEXI
3211
blueswir15824d652009-03-28 06:44:27 +00003212DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
Blue Swirlad960902010-03-29 19:23:52 +00003213 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003214STEXI
3215@item -enable-kvm
Stefan Weil6616b2a2010-02-05 23:52:05 +01003216@findex -enable-kvm
blueswir15824d652009-03-28 06:44:27 +00003217Enable KVM full virtualization support. This option is only available
3218if KVM support is enabled when compiling.
3219ETEXI
3220
aliguorie37630c2009-04-22 15:19:10 +00003221DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
Blue Swirlad960902010-03-29 19:23:52 +00003222 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00003223DEF("xen-create", 0, QEMU_OPTION_xen_create,
3224 "-xen-create create domain using xen hypercalls, bypassing xend\n"
Blue Swirlad960902010-03-29 19:23:52 +00003225 " warning: should not be used when xend is in use\n",
3226 QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00003227DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
3228 "-xen-attach attach to existing xen domain\n"
Stefan Weilb65ee4f2012-05-11 22:25:50 +02003229 " xend will use this when starting QEMU\n",
Blue Swirlad960902010-03-29 19:23:52 +00003230 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01003231STEXI
3232@item -xen-domid @var{id}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003233@findex -xen-domid
Stefan Weil95d5f082010-01-20 22:25:27 +01003234Specify xen guest domain @var{id} (XEN only).
3235@item -xen-create
Stefan Weil6616b2a2010-02-05 23:52:05 +01003236@findex -xen-create
Stefan Weil95d5f082010-01-20 22:25:27 +01003237Create domain using xen hypercalls, bypassing xend.
3238Warning: should not be used when xend is in use (XEN only).
3239@item -xen-attach
Stefan Weil6616b2a2010-02-05 23:52:05 +01003240@findex -xen-attach
Stefan Weil95d5f082010-01-20 22:25:27 +01003241Attach to existing xen domain.
Stefan Weilb65ee4f2012-05-11 22:25:50 +02003242xend will use this when starting QEMU (XEN only).
Stefan Weil95d5f082010-01-20 22:25:27 +01003243ETEXI
aliguorie37630c2009-04-22 15:19:10 +00003244
blueswir15824d652009-03-28 06:44:27 +00003245DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
Blue Swirlad960902010-03-29 19:23:52 +00003246 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003247STEXI
3248@item -no-reboot
Stefan Weil6616b2a2010-02-05 23:52:05 +01003249@findex -no-reboot
blueswir15824d652009-03-28 06:44:27 +00003250Exit instead of rebooting.
3251ETEXI
3252
3253DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
Blue Swirlad960902010-03-29 19:23:52 +00003254 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003255STEXI
3256@item -no-shutdown
Stefan Weil6616b2a2010-02-05 23:52:05 +01003257@findex -no-shutdown
blueswir15824d652009-03-28 06:44:27 +00003258Don't exit QEMU on guest shutdown, but instead only stop the emulation.
3259This allows for instance switching to monitor to commit changes to the
3260disk image.
3261ETEXI
3262
3263DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
3264 "-loadvm [tag|id]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003265 " start right away with a saved state (loadvm in monitor)\n",
3266 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003267STEXI
3268@item -loadvm @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003269@findex -loadvm
blueswir15824d652009-03-28 06:44:27 +00003270Start right away with a saved state (@code{loadvm} in monitor)
3271ETEXI
3272
3273#ifndef _WIN32
3274DEF("daemonize", 0, QEMU_OPTION_daemonize, \
Blue Swirlad960902010-03-29 19:23:52 +00003275 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003276#endif
3277STEXI
3278@item -daemonize
Stefan Weil6616b2a2010-02-05 23:52:05 +01003279@findex -daemonize
blueswir15824d652009-03-28 06:44:27 +00003280Daemonize the QEMU process after initialization. QEMU will not detach from
3281standard IO until it is ready to receive connections on any of its devices.
3282This option is a useful way for external programs to launch QEMU without having
3283to cope with initialization race conditions.
3284ETEXI
3285
3286DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
Blue Swirlad960902010-03-29 19:23:52 +00003287 "-option-rom rom load a file, rom, into the option ROM space\n",
3288 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003289STEXI
3290@item -option-rom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003291@findex -option-rom
blueswir15824d652009-03-28 06:44:27 +00003292Load the contents of @var{file} as an option ROM.
3293This option is useful to load things like EtherBoot.
3294ETEXI
3295
Markus Armbrustere2180522014-10-06 16:19:07 +02003296HXCOMM Silently ignored for compatibility
3297DEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003298
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003299HXCOMM Options deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00003300DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
3301DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003302
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003303DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
Paolo Bonzini78808142012-03-30 10:31:21 +00003304 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003305 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
3306 QEMU_ARCH_ALL)
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003307
blueswir15824d652009-03-28 06:44:27 +00003308STEXI
3309
Jan Kiszka68752042009-09-15 13:36:04 +02003310@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003311@findex -rtc
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003312Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
3313UTC or local time, respectively. @code{localtime} is required for correct date in
3314MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
3315format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
3316
Michael Tokarev9d85d552014-04-07 13:34:58 +04003317By default the RTC is driven by the host system time. This allows using of the
Jan Kiszka68752042009-09-15 13:36:04 +02003318RTC as accurate reference clock inside the guest, specifically if the host
3319time is smoothly following an accurate external reference clock, e.g. via NTP.
Paolo Bonzini78808142012-03-30 10:31:21 +00003320If you want to isolate the guest time from the host, you can set @option{clock}
3321to @code{rt} instead. To even prevent it from progressing during suspension,
3322you can set it to @code{vm}.
Jan Kiszka68752042009-09-15 13:36:04 +02003323
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003324Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
3325specifically with Windows' ACPI HAL. This option will try to figure out how
3326many timer interrupts were not processed by the Windows guest and will
3327re-inject them.
blueswir15824d652009-03-28 06:44:27 +00003328ETEXI
3329
3330DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
Pranith Kumar778d9f92016-02-26 10:16:51 -05003331 "-icount [shift=N|auto][,align=on|off][,sleep=on|off,rr=record|replay,rrfile=<filename>]\n" \
aliguoribc14ca22009-04-05 18:43:37 +00003332 " enable virtual instruction counter with 2^N clock ticks per\n" \
Victor CLEMENTf1f4b572015-05-29 17:14:05 +02003333 " instruction, enable aligning the host and virtual clocks\n" \
3334 " or disable real time cpu sleeping\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003335STEXI
Pavel Dovgalyuk4c27b852015-09-17 19:25:18 +03003336@item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003337@findex -icount
blueswir15824d652009-03-28 06:44:27 +00003338Enable virtual instruction counter. The virtual cpu will execute one
Kevin Wolf4e257e52009-10-09 10:58:36 +02003339instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
blueswir15824d652009-03-28 06:44:27 +00003340then the virtual cpu speed will be automatically adjusted to keep virtual
3341time within a few seconds of real time.
3342
Victor CLEMENTf1f4b572015-05-29 17:14:05 +02003343When the virtual cpu is sleeping, the virtual time will advance at default
Pranith Kumar778d9f92016-02-26 10:16:51 -05003344speed unless @option{sleep=on|off} is specified.
3345With @option{sleep=on|off}, the virtual time will jump to the next timer deadline
Victor CLEMENTf1f4b572015-05-29 17:14:05 +02003346instantly whenever the virtual cpu goes to sleep mode and will not advance
3347if no timer is enabled. This behavior give deterministic execution times from
3348the guest point of view.
3349
blueswir15824d652009-03-28 06:44:27 +00003350Note that while this option can give deterministic behavior, it does not
3351provide cycle accurate emulation. Modern CPUs contain superscalar out of
3352order cores with complex cache hierarchies. The number of instructions
3353executed often has little or no correlation with actual performance.
Sebastian Tanasea8bfac32014-07-25 11:56:29 +02003354
Daniel P. Berrangeb6af0972015-08-26 12:17:13 +01003355@option{align=on} will activate the delay algorithm which will try
Sebastian Tanasea8bfac32014-07-25 11:56:29 +02003356to synchronise the host clock and the virtual clock. The goal is to
3357have a guest running at the real frequency imposed by the shift option.
3358Whenever the guest clock is behind the host clock and if
Michael Tokarev82597612015-04-27 11:12:49 +03003359@option{align=on} is specified then we print a message to the user
Sebastian Tanasea8bfac32014-07-25 11:56:29 +02003360to inform about the delay.
3361Currently this option does not work when @option{shift} is @code{auto}.
3362Note: The sync algorithm will work for those shift values for which
3363the guest clock runs ahead of the host clock. Typically this happens
3364when the shift value is high (how high depends on the host machine).
Pavel Dovgalyuk4c27b852015-09-17 19:25:18 +03003365
3366When @option{rr} option is specified deterministic record/replay is enabled.
3367Replay log is written into @var{filename} file in record mode and
3368read from this file in replay mode.
blueswir15824d652009-03-28 06:44:27 +00003369ETEXI
3370
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003371DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
Xu Wangd7933ef2015-06-11 17:32:05 +02003372 "-watchdog model\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003373 " enable virtual hardware watchdog [default=none]\n",
3374 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003375STEXI
3376@item -watchdog @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003377@findex -watchdog
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003378Create a virtual hardware watchdog device. Once enabled (by a guest
3379action), the watchdog must be periodically polled by an agent inside
Xu Wangd7933ef2015-06-11 17:32:05 +02003380the guest or else the guest will be restarted. Choose a model for
3381which your guest has drivers.
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003382
Xu Wangd7933ef2015-06-11 17:32:05 +02003383The @var{model} is the model of hardware watchdog to emulate. Use
3384@code{-watchdog help} to list available hardware models. Only one
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003385watchdog can be enabled for a guest.
Xu Wangd7933ef2015-06-11 17:32:05 +02003386
3387The following models may be available:
3388@table @option
3389@item ib700
3390iBASE 700 is a very simple ISA watchdog with a single timer.
3391@item i6300esb
3392Intel 6300ESB I/O controller hub is a much more featureful PCI-based
3393dual-timer watchdog.
Xu Wang188f24c2015-02-05 18:28:32 +08003394@item diag288
3395A virtual watchdog for s390x backed by the diagnose 288 hypercall
3396(currently KVM only).
Xu Wangd7933ef2015-06-11 17:32:05 +02003397@end table
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003398ETEXI
3399
3400DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
3401 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003402 " action when watchdog fires [default=reset]\n",
3403 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003404STEXI
3405@item -watchdog-action @var{action}
Markus Armbrusterb8f490e2013-02-13 19:49:38 +01003406@findex -watchdog-action
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003407
3408The @var{action} controls what QEMU will do when the watchdog timer
3409expires.
3410The default is
3411@code{reset} (forcefully reset the guest).
3412Other possible actions are:
3413@code{shutdown} (attempt to gracefully shutdown the guest),
3414@code{poweroff} (forcefully poweroff the guest),
3415@code{pause} (pause the guest),
3416@code{debug} (print a debug message and continue), or
3417@code{none} (do nothing).
3418
3419Note that the @code{shutdown} action requires that the guest responds
3420to ACPI signals, which it may not be able to do in the sort of
3421situations where the watchdog would have expired, and thus
3422@code{-watchdog-action shutdown} is not recommended for production use.
3423
3424Examples:
3425
3426@table @code
3427@item -watchdog i6300esb -watchdog-action pause
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02003428@itemx -watchdog ib700
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003429@end table
3430ETEXI
3431
blueswir15824d652009-03-28 06:44:27 +00003432DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
Blue Swirlad960902010-03-29 19:23:52 +00003433 "-echr chr set terminal escape character instead of ctrl-a\n",
3434 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003435STEXI
3436
Kevin Wolf4e257e52009-10-09 10:58:36 +02003437@item -echr @var{numeric_ascii_value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003438@findex -echr
blueswir15824d652009-03-28 06:44:27 +00003439Change the escape character used for switching to the monitor when using
3440monitor and serial sharing. The default is @code{0x01} when using the
3441@code{-nographic} option. @code{0x01} is equal to pressing
3442@code{Control-a}. You can select a different character from the ascii
3443control keys where 1 through 26 map to Control-a through Control-z. For
3444instance you could use the either of the following to change the escape
3445character to Control-t.
3446@table @code
3447@item -echr 0x14
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02003448@itemx -echr 20
blueswir15824d652009-03-28 06:44:27 +00003449@end table
3450ETEXI
3451
3452DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
3453 "-virtioconsole c\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003454 " set virtio console\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003455STEXI
3456@item -virtioconsole @var{c}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003457@findex -virtioconsole
blueswir15824d652009-03-28 06:44:27 +00003458Set virtio console.
Amit Shah98b19252010-01-20 00:36:52 +05303459
3460This option is maintained for backward compatibility.
3461
3462Please use @code{-device virtconsole} for the new way of invocation.
blueswir15824d652009-03-28 06:44:27 +00003463ETEXI
3464
3465DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
Blue Swirlad960902010-03-29 19:23:52 +00003466 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003467STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01003468@item -show-cursor
Stefan Weil6616b2a2010-02-05 23:52:05 +01003469@findex -show-cursor
Stefan Weil95d5f082010-01-20 22:25:27 +01003470Show cursor.
blueswir15824d652009-03-28 06:44:27 +00003471ETEXI
3472
3473DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
Blue Swirlad960902010-03-29 19:23:52 +00003474 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003475STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01003476@item -tb-size @var{n}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003477@findex -tb-size
Stefan Weil95d5f082010-01-20 22:25:27 +01003478Set TB size.
blueswir15824d652009-03-28 06:44:27 +00003479ETEXI
3480
3481DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
Michael Tokarev7c601802015-02-10 22:40:47 +03003482 "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \
3483 "-incoming rdma:host:port[,ipv4][,ipv6]\n" \
3484 "-incoming unix:socketpath\n" \
3485 " prepare for incoming migration, listen on\n" \
3486 " specified protocol and socket address\n" \
3487 "-incoming fd:fd\n" \
3488 "-incoming exec:cmdline\n" \
3489 " accept incoming migration on given file descriptor\n" \
Dr. David Alan Gilbert15970512015-05-29 19:52:52 +01003490 " or from given external command\n" \
3491 "-incoming defer\n" \
3492 " wait for the URI to be specified via migrate_incoming\n",
Blue Swirlad960902010-03-29 19:23:52 +00003493 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003494STEXI
Michael Tokarev7c601802015-02-10 22:40:47 +03003495@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02003496@itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003497@findex -incoming
Michael Tokarev7c601802015-02-10 22:40:47 +03003498Prepare for incoming migration, listen on a given tcp port.
3499
3500@item -incoming unix:@var{socketpath}
3501Prepare for incoming migration, listen on a given unix socket.
3502
3503@item -incoming fd:@var{fd}
3504Accept incoming migration from a given filedescriptor.
3505
3506@item -incoming exec:@var{cmdline}
3507Accept incoming migration as an output from specified external command.
Dr. David Alan Gilbert15970512015-05-29 19:52:52 +01003508
3509@item -incoming defer
3510Wait for the URI to be specified via migrate_incoming. The monitor can
3511be used to change settings (such as migration parameters) prior to issuing
3512the migrate_incoming to allow the migration to begin.
blueswir15824d652009-03-28 06:44:27 +00003513ETEXI
3514
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01003515DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
Blue Swirlad960902010-03-29 19:23:52 +00003516 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01003517STEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003518@item -nodefaults
Stefan Weil6616b2a2010-02-05 23:52:05 +01003519@findex -nodefaults
Michal Novotny66c19bf2012-07-16 14:35:10 +02003520Don't create default devices. Normally, QEMU sets the default devices like serial
3521port, parallel port, virtual console, monitor device, VGA adapter, floppy and
3522CD-ROM drive and others. The @code{-nodefaults} option will disable all those
3523default devices.
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01003524ETEXI
3525
blueswir15824d652009-03-28 06:44:27 +00003526#ifndef _WIN32
3527DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
Blue Swirlad960902010-03-29 19:23:52 +00003528 "-chroot dir chroot to dir just before starting the VM\n",
3529 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003530#endif
3531STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02003532@item -chroot @var{dir}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003533@findex -chroot
blueswir15824d652009-03-28 06:44:27 +00003534Immediately before starting guest execution, chroot to the specified
3535directory. Especially useful in combination with -runas.
3536ETEXI
3537
3538#ifndef _WIN32
3539DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
Blue Swirlad960902010-03-29 19:23:52 +00003540 "-runas user change to user id user just before starting the VM\n",
3541 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003542#endif
3543STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02003544@item -runas @var{user}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003545@findex -runas
blueswir15824d652009-03-28 06:44:27 +00003546Immediately before starting guest execution, drop root privileges, switching
3547to the specified user.
3548ETEXI
3549
blueswir15824d652009-03-28 06:44:27 +00003550DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
3551 "-prom-env variable=value\n"
Blue Swirlad960902010-03-29 19:23:52 +00003552 " set OpenBIOS nvram variables\n",
3553 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
Stefan Weil95d5f082010-01-20 22:25:27 +01003554STEXI
3555@item -prom-env @var{variable}=@var{value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003556@findex -prom-env
Stefan Weil95d5f082010-01-20 22:25:27 +01003557Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
3558ETEXI
blueswir15824d652009-03-28 06:44:27 +00003559DEF("semihosting", 0, QEMU_OPTION_semihosting,
Michael Wallef7bbcfb2014-04-22 20:18:42 +02003560 "-semihosting semihosting mode\n",
Leon Alrae3b3c1692015-06-19 11:08:43 +01003561 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
3562 QEMU_ARCH_MIPS)
Stefan Weil95d5f082010-01-20 22:25:27 +01003563STEXI
3564@item -semihosting
Stefan Weil6616b2a2010-02-05 23:52:05 +01003565@findex -semihosting
Leon Alrae3b3c1692015-06-19 11:08:43 +01003566Enable semihosting mode (ARM, M68K, Xtensa, MIPS only).
Liviu Ionescua38bb072014-12-11 12:07:48 +00003567ETEXI
3568DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config,
Leon Alraea59d31a2015-06-19 14:17:45 +01003569 "-semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]]\n" \
3570 " semihosting configuration\n",
Leon Alrae3b3c1692015-06-19 11:08:43 +01003571QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
3572QEMU_ARCH_MIPS)
Liviu Ionescua38bb072014-12-11 12:07:48 +00003573STEXI
Leon Alraea59d31a2015-06-19 14:17:45 +01003574@item -semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]]
Liviu Ionescua38bb072014-12-11 12:07:48 +00003575@findex -semihosting-config
Leon Alrae3b3c1692015-06-19 11:08:43 +01003576Enable and configure semihosting (ARM, M68K, Xtensa, MIPS only).
Leon Alraea59d31a2015-06-19 14:17:45 +01003577@table @option
3578@item target=@code{native|gdb|auto}
3579Defines where the semihosting calls will be addressed, to QEMU (@code{native})
3580or to GDB (@code{gdb}). The default is @code{auto}, which means @code{gdb}
3581during debug sessions and @code{native} otherwise.
3582@item arg=@var{str1},arg=@var{str2},...
3583Allows the user to pass input arguments, and can be used multiple times to build
3584up a list. The old-style @code{-kernel}/@code{-append} method of passing a
3585command line is still supported for backward compatibility. If both the
3586@code{--semihosting-config arg} and the @code{-kernel}/@code{-append} are
3587specified, the former is passed to semihosting as it always takes precedence.
3588@end table
Stefan Weil95d5f082010-01-20 22:25:27 +01003589ETEXI
blueswir15824d652009-03-28 06:44:27 +00003590DEF("old-param", 0, QEMU_OPTION_old_param,
Blue Swirlad960902010-03-29 19:23:52 +00003591 "-old-param old param mode\n", QEMU_ARCH_ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01003592STEXI
3593@item -old-param
Stefan Weil6616b2a2010-02-05 23:52:05 +01003594@findex -old-param (ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01003595Old param mode (ARM only).
3596ETEXI
3597
Eduardo Otubo7d76ad42012-08-14 18:44:08 -03003598DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \
3599 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n",
3600 QEMU_ARCH_ALL)
3601STEXI
Markus Armbruster6265c432013-02-13 19:49:39 +01003602@item -sandbox @var{arg}
Eduardo Otubo7d76ad42012-08-14 18:44:08 -03003603@findex -sandbox
3604Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will
3605disable it. The default is 'off'.
3606ETEXI
3607
Gerd Hoffmann715a6642009-10-14 10:39:28 +02003608DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
Blue Swirlad960902010-03-29 19:23:52 +00003609 "-readconfig <file>\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003610STEXI
3611@item -readconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003612@findex -readconfig
Michal Novotnyed24cfa2012-07-16 14:28:32 +02003613Read device configuration from @var{file}. This approach is useful when you want to spawn
3614QEMU process with many command line options but you don't want to exceed the command line
3615character limit.
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003616ETEXI
Gerd Hoffmann715a6642009-10-14 10:39:28 +02003617DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
3618 "-writeconfig <file>\n"
Blue Swirlad960902010-03-29 19:23:52 +00003619 " read/write config file\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003620STEXI
3621@item -writeconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003622@findex -writeconfig
Michal Novotnyed24cfa2012-07-16 14:28:32 +02003623Write device configuration to @var{file}. The @var{file} can be either filename to save
3624command line and device configuration into file or dash @code{-}) character to print the
3625output to stdout. This can be later used as input file for @code{-readconfig} option.
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003626ETEXI
Anthony Liguori292444c2010-01-21 10:57:58 -06003627DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
3628 "-nodefconfig\n"
Blue Swirlad960902010-03-29 19:23:52 +00003629 " do not load default config files at startup\n",
3630 QEMU_ARCH_ALL)
Anthony Liguori292444c2010-01-21 10:57:58 -06003631STEXI
3632@item -nodefconfig
Stefan Weil6616b2a2010-02-05 23:52:05 +01003633@findex -nodefconfig
Eduardo Habkostf29a5612012-05-02 13:07:29 -03003634Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
3635The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
3636ETEXI
3637DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
3638 "-no-user-config\n"
3639 " do not load user-provided config files at startup\n",
3640 QEMU_ARCH_ALL)
3641STEXI
3642@item -no-user-config
3643@findex -no-user-config
3644The @code{-no-user-config} option makes QEMU not load any of the user-provided
3645config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config
3646files from @var{datadir}.
Anthony Liguori292444c2010-01-21 10:57:58 -06003647ETEXI
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003648DEF("trace", HAS_ARG, QEMU_OPTION_trace,
Paolo Bonzini10578a22016-01-07 16:55:26 +03003649 "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
Lluís23d15e82011-08-31 20:31:31 +02003650 " specify tracing options\n",
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003651 QEMU_ARCH_ALL)
3652STEXI
Lluís23d15e82011-08-31 20:31:31 +02003653HXCOMM This line is not accurate, as some sub-options are backend-specific but
3654HXCOMM HX does not support conditional compilation of text.
3655@item -trace [events=@var{file}][,file=@var{file}]
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003656@findex -trace
Lluíse4858972011-08-31 20:31:03 +02003657
Lluís23d15e82011-08-31 20:31:31 +02003658Specify tracing options.
3659
3660@table @option
Paolo Bonzini10578a22016-01-07 16:55:26 +03003661@item [enable=]@var{pattern}
3662Immediately enable events matching @var{pattern}.
3663The file must contain one event name (as listed in the @file{trace-events} file)
3664per line; globbing patterns are accepted too. This option is only
3665available if QEMU has been compiled with the @var{simple}, @var{stderr}
3666or @var{ftrace} tracing backend. To specify multiple events or patterns,
3667specify the @option{-trace} option multiple times.
3668
Paolo Bonzinie9527dd2016-01-07 16:55:27 +03003669Use @code{-trace help} to print a list of names of trace points.
3670
Lluís23d15e82011-08-31 20:31:31 +02003671@item events=@var{file}
3672Immediately enable events listed in @var{file}.
Paolo Bonzini52449a32016-01-07 16:55:22 +03003673The file must contain one event name (as listed in the @file{trace-events} file)
3674per line; globbing patterns are accepted too. This option is only
3675available if QEMU has been compiled with the @var{simple}, @var{stderr} or
3676@var{ftrace} tracing backend.
3677
Lluís23d15e82011-08-31 20:31:31 +02003678@item file=@var{file}
3679Log output traces to @var{file}.
Stefan Weilc1ba4e02011-09-05 18:13:03 +02003680This option is only available if QEMU has been compiled with
3681the @var{simple} tracing backend.
Lluís23d15e82011-08-31 20:31:31 +02003682@end table
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003683ETEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003684
Markus Armbruster31e70d62013-02-13 19:49:37 +01003685HXCOMM Internal use
3686DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL)
3687DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL)
Anthony Liguoric7f0f3b2012-03-28 15:42:02 +02003688
Paul Moore0f669982012-08-03 14:39:21 -04003689#ifdef __linux__
3690DEF("enable-fips", 0, QEMU_OPTION_enablefips,
3691 "-enable-fips enable FIPS 140-2 compliance\n",
3692 QEMU_ARCH_ALL)
3693#endif
3694STEXI
3695@item -enable-fips
3696@findex -enable-fips
3697Enable FIPS 140-2 compliance mode.
3698ETEXI
3699
Jan Kiszkaa0dac022012-10-05 14:51:45 -03003700HXCOMM Deprecated by -machine accel=tcg property
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003701DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386)
Jan Kiszkaa0dac022012-10-05 14:51:45 -03003702
Jan Kiszkac21fb4f2012-10-05 14:51:42 -03003703HXCOMM Deprecated by kvm-pit driver properties
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003704DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection,
Jan Kiszkac21fb4f2012-10-05 14:51:42 -03003705 "", QEMU_ARCH_I386)
3706
Jan Kiszka4086bde2012-10-05 14:51:41 -03003707HXCOMM Deprecated (ignored)
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003708DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386)
Jan Kiszka4086bde2012-10-05 14:51:41 -03003709
Jan Kiszkae43d5942012-10-05 14:51:40 -03003710HXCOMM Deprecated by -machine kernel_irqchip=on|off property
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003711DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386)
Jan Kiszkae43d5942012-10-05 14:51:40 -03003712
Jan Kiszka88eed342012-10-05 14:51:44 -03003713HXCOMM Deprecated (ignored)
3714DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL)
3715
Seiji Aguchi5e2ac512013-07-03 23:02:46 -04003716DEF("msg", HAS_ARG, QEMU_OPTION_msg,
3717 "-msg timestamp[=on|off]\n"
3718 " change the format of messages\n"
3719 " on|off controls leading timestamps (default:on)\n",
3720 QEMU_ARCH_ALL)
3721STEXI
3722@item -msg timestamp[=on|off]
3723@findex -msg
3724prepend a timestamp to each log message.(default:on)
3725ETEXI
3726
Amit Shahabfd9ce2014-06-20 18:56:08 +05303727DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate,
3728 "-dump-vmstate <file>\n"
3729 " Output vmstate information in JSON format to file.\n"
3730 " Use the scripts/vmstate-static-checker.py file to\n"
3731 " check for possible regressions in migration code\n"
Laurent Vivier23820532015-09-04 21:30:04 +02003732 " by comparing two such vmstate dumps.\n",
Amit Shahabfd9ce2014-06-20 18:56:08 +05303733 QEMU_ARCH_ALL)
3734STEXI
3735@item -dump-vmstate @var{file}
3736@findex -dump-vmstate
3737Dump json-encoded vmstate information for current machine type to file
3738in @var{file}
3739ETEXI
3740
Daniel P. Berrangeb9174d42015-05-13 17:14:03 +01003741DEFHEADING(Generic object creation)
3742
3743DEF("object", HAS_ARG, QEMU_OPTION_object,
3744 "-object TYPENAME[,PROP1=VALUE1,...]\n"
3745 " create a new object of type TYPENAME setting properties\n"
3746 " in the order they are specified. Note that the 'id'\n"
3747 " property must be set. These objects are placed in the\n"
3748 " '/objects' path.\n",
3749 QEMU_ARCH_ALL)
3750STEXI
3751@item -object @var{typename}[,@var{prop1}=@var{value1},...]
3752@findex -object
3753Create a new object of type @var{typename} setting properties
3754in the order they are specified. Note that the 'id'
3755property must be set. These objects are placed in the
3756'/objects' path.
3757
3758@table @option
3759
3760@item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off}
3761
3762Creates a memory file backend object, which can be used to back
3763the guest RAM with huge pages. The @option{id} parameter is a
3764unique ID that will be used to reference this memory region
3765when configuring the @option{-numa} argument. The @option{size}
3766option provides the size of the memory region, and accepts
3767common suffixes, eg @option{500M}. The @option{mem-path} provides
3768the path to either a shared memory or huge page filesystem mount.
3769The @option{share} boolean option determines whether the memory
3770region is marked as private to QEMU, or shared. The latter allows
3771a co-operating external process to access the QEMU memory region.
3772
3773@item -object rng-random,id=@var{id},filename=@var{/dev/random}
3774
3775Creates a random number generator backend which obtains entropy from
3776a device on the host. The @option{id} parameter is a unique ID that
3777will be used to reference this entropy backend from the @option{virtio-rng}
3778device. The @option{filename} parameter specifies which file to obtain
3779entropy from and if omitted defaults to @option{/dev/random}.
3780
3781@item -object rng-egd,id=@var{id},chardev=@var{chardevid}
3782
3783Creates a random number generator backend which obtains entropy from
3784an external daemon running on the host. The @option{id} parameter is
3785a unique ID that will be used to reference this entropy backend from
3786the @option{virtio-rng} device. The @option{chardev} parameter is
3787the unique ID of a character device backend that provides the connection
3788to the RNG daemon.
3789
Daniel P. Berrangee00adf62015-03-13 17:39:26 +00003790@item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off}
3791
3792Creates a TLS anonymous credentials object, which can be used to provide
3793TLS support on network backends. The @option{id} parameter is a unique
3794ID which network backends will use to access the credentials. The
3795@option{endpoint} is either @option{server} or @option{client} depending
3796on whether the QEMU network backend that uses the credentials will be
3797acting as a client or as a server. If @option{verify-peer} is enabled
3798(the default) then once the handshake is completed, the peer credentials
3799will be verified, though this is a no-op for anonymous credentials.
3800
3801The @var{dir} parameter tells QEMU where to find the credential
3802files. For server endpoints, this directory may contain a file
3803@var{dh-params.pem} providing diffie-hellman parameters to use
3804for the TLS server. If the file is missing, QEMU will generate
3805a set of DH parameters at startup. This is a computationally
3806expensive operation that consumes random pool entropy, so it is
3807recommended that a persistent set of parameters be generated
3808upfront and saved.
3809
Daniel P. Berrange1d7b5b42015-10-15 16:14:42 +01003810@item -object tls-creds-x509,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off},passwordid=@var{id}
Daniel P. Berrange85bcbc72015-03-13 17:39:26 +00003811
3812Creates a TLS anonymous credentials object, which can be used to provide
3813TLS support on network backends. The @option{id} parameter is a unique
3814ID which network backends will use to access the credentials. The
3815@option{endpoint} is either @option{server} or @option{client} depending
3816on whether the QEMU network backend that uses the credentials will be
3817acting as a client or as a server. If @option{verify-peer} is enabled
3818(the default) then once the handshake is completed, the peer credentials
3819will be verified. With x509 certificates, this implies that the clients
3820must be provided with valid client certificates too.
3821
3822The @var{dir} parameter tells QEMU where to find the credential
3823files. For server endpoints, this directory may contain a file
3824@var{dh-params.pem} providing diffie-hellman parameters to use
3825for the TLS server. If the file is missing, QEMU will generate
3826a set of DH parameters at startup. This is a computationally
3827expensive operation that consumes random pool entropy, so it is
3828recommended that a persistent set of parameters be generated
3829upfront and saved.
3830
3831For x509 certificate credentials the directory will contain further files
3832providing the x509 certificates. The certificates must be stored
3833in PEM format, in filenames @var{ca-cert.pem}, @var{ca-crl.pem} (optional),
3834@var{server-cert.pem} (only servers), @var{server-key.pem} (only servers),
3835@var{client-cert.pem} (only clients), and @var{client-key.pem} (only clients).
3836
Daniel P. Berrange1d7b5b42015-10-15 16:14:42 +01003837For the @var{server-key.pem} and @var{client-key.pem} files which
3838contain sensitive private keys, it is possible to use an encrypted
3839version by providing the @var{passwordid} parameter. This provides
3840the ID of a previously created @code{secret} object containing the
3841password for decryption.
3842
zhanghailiang338d3f42016-03-01 13:37:02 +08003843@item -object filter-buffer,id=@var{id},netdev=@var{netdevid},interval=@var{t}[,queue=@var{all|rx|tx}][,status=@var{on|off}]
Yang Hongyang7dbb11c2015-10-07 11:52:21 +08003844
3845Interval @var{t} can't be 0, this filter batches the packet delivery: all
3846packets arriving in a given interval on netdev @var{netdevid} are delayed
3847until the end of the interval. Interval is in microseconds.
zhanghailiang338d3f42016-03-01 13:37:02 +08003848@option{status} is optional that indicate whether the netfilter is
3849on (enabled) or off (disabled), the default status for netfilter will be 'on'.
Yang Hongyang7dbb11c2015-10-07 11:52:21 +08003850
3851queue @var{all|rx|tx} is an option that can be applied to any netfilter.
3852
3853@option{all}: the filter is attached both to the receive and the transmit
3854 queue of the netdev (default).
3855
3856@option{rx}: the filter is attached to the receive queue of the netdev,
3857 where it will receive packets sent to the netdev.
3858
3859@option{tx}: the filter is attached to the transmit queue of the netdev,
3860 where it will receive packets sent by the netdev.
3861
Zhang Chenf6d3afb2016-03-15 15:41:33 +08003862@item -object filter-mirror,id=@var{id},netdev=@var{netdevid},outdev=@var{chardevid}[,queue=@var{all|rx|tx}]
3863
3864filter-mirror on netdev @var{netdevid},mirror net packet to chardev
3865@var{chardevid}
3866
Zhang Chend46f75b2016-03-17 16:16:26 +08003867@item -object filter-redirector,id=@var{id},netdev=@var{netdevid},indev=@var{chardevid},
3868outdev=@var{chardevid}[,queue=@var{all|rx|tx}]
3869
3870filter-redirector on netdev @var{netdevid},redirect filter's net packet to chardev
3871@var{chardevid},and redirect indev's packet to filter.
3872Create a filter-redirector we need to differ outdev id from indev id, id can not
3873be the same. we can just use indev or outdev, but at least one of indev or outdev
3874need to be specified.
3875
Thomas Huthd3e0c032015-10-13 12:40:02 +02003876@item -object filter-dump,id=@var{id},netdev=@var{dev},file=@var{filename}][,maxlen=@var{len}]
3877
3878Dump the network traffic on netdev @var{dev} to the file specified by
3879@var{filename}. At most @var{len} bytes (64k by default) per packet are stored.
3880The file format is libpcap, so it can be analyzed with tools such as tcpdump
3881or Wireshark.
3882
Daniel P. Berrangeac1d8872015-10-14 09:58:38 +01003883@item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
3884@item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
3885
3886Defines a secret to store a password, encryption key, or some other sensitive
3887data. The sensitive data can either be passed directly via the @var{data}
3888parameter, or indirectly via the @var{file} parameter. Using the @var{data}
3889parameter is insecure unless the sensitive data is encrypted.
3890
3891The sensitive data can be provided in raw format (the default), or base64.
3892When encoded as JSON, the raw format only supports valid UTF-8 characters,
3893so base64 is recommended for sending binary data. QEMU will convert from
3894which ever format is provided to the format it needs internally. eg, an
3895RBD password can be provided in raw format, even though it will be base64
3896encoded when passed onto the RBD sever.
3897
3898For added protection, it is possible to encrypt the data associated with
3899a secret using the AES-256-CBC cipher. Use of encryption is indicated
3900by providing the @var{keyid} and @var{iv} parameters. The @var{keyid}
3901parameter provides the ID of a previously defined secret that contains
3902the AES-256 decryption key. This key should be 32-bytes long and be
3903base64 encoded. The @var{iv} parameter provides the random initialization
3904vector used for encryption of this particular secret and should be a
Daniel P. Berrange69c0b272016-04-04 10:33:55 +01003905base64 encrypted string of the 16-byte IV.
Daniel P. Berrangeac1d8872015-10-14 09:58:38 +01003906
3907The simplest (insecure) usage is to provide the secret inline
3908
3909@example
3910
3911 # $QEMU -object secret,id=sec0,data=letmein,format=raw
3912
3913@end example
3914
3915The simplest secure usage is to provide the secret via a file
3916
3917 # echo -n "letmein" > mypasswd.txt
3918 # $QEMU -object secret,id=sec0,file=mypasswd.txt,format=raw
3919
3920For greater security, AES-256-CBC should be used. To illustrate usage,
3921consider the openssl command line tool which can encrypt the data. Note
3922that when encrypting, the plaintext must be padded to the cipher block
3923size (32 bytes) using the standard PKCS#5/6 compatible padding algorithm.
3924
3925First a master key needs to be created in base64 encoding:
3926
3927@example
3928 # openssl rand -base64 32 > key.b64
3929 # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"')
3930@end example
3931
3932Each secret to be encrypted needs to have a random initialization vector
3933generated. These do not need to be kept secret
3934
3935@example
3936 # openssl rand -base64 16 > iv.b64
3937 # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"')
3938@end example
3939
3940The secret to be defined can now be encrypted, in this case we're
3941telling openssl to base64 encode the result, but it could be left
3942as raw bytes if desired.
3943
3944@example
3945 # SECRET=$(echo -n "letmein" |
3946 openssl enc -aes-256-cbc -a -K $KEY -iv $IV)
3947@end example
3948
3949When launching QEMU, create a master secret pointing to @code{key.b64}
3950and specify that to be used to decrypt the user password. Pass the
3951contents of @code{iv.b64} to the second secret
3952
3953@example
3954 # $QEMU \
3955 -object secret,id=secmaster0,format=base64,file=key.b64 \
3956 -object secret,id=sec0,keyid=secmaster0,format=base64,\
3957 data=$SECRET,iv=$(<iv.b64)
3958@end example
3959
Daniel P. Berrangeb9174d42015-05-13 17:14:03 +01003960@end table
3961
3962ETEXI
3963
3964
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003965HXCOMM This is the last statement. Insert new options before this line!
3966STEXI
3967@end table
3968ETEXI