blob: a71aaf8ea895ab26d6935a478141e410bf76ad19 [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"
Peter Maydell96404012016-05-10 16:49:29 +010038 " kvm_shadow_mem=size of KVM shadow MMU in bytes\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"
Tiejun Chen79814172015-07-15 13:37:45 +080041 " igd-passthru=on|off controls IGD GFX passthrough support (default=off)\n"
Tony Krowiak2eb1cd02015-03-12 13:53:51 +010042 " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n"
Alexander Graf9850c602015-02-23 13:56:42 +010043 " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n"
Xiao Guangrong87252e12015-12-02 15:20:58 +080044 " suppress-vmdesc=on|off disables self-describing migration (default=off)\n"
Greg Kurz902c0532016-02-18 12:32:25 +010045 " nvdimm=on|off controls NVDIMM support (default=off)\n"
46 " enforce-config-section=on|off enforce configuration section migration (default=off)\n",
Jan Kiszka80f52a62011-07-23 12:39:46 +020047 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000048STEXI
Jan Kiszka80f52a62011-07-23 12:39:46 +020049@item -machine [type=]@var{name}[,prop=@var{value}[,...]]
50@findex -machine
Peter Maydell585f6032012-10-04 16:22:01 +010051Select the emulated machine by @var{name}. Use @code{-machine help} to list
Jan Kiszka80f52a62011-07-23 12:39:46 +020052available machines. Supported machine properties are:
53@table @option
54@item accel=@var{accels1}[:@var{accels2}[:...]]
55This is used to enable an accelerator. Depending on the target architecture,
56kvm, xen, or tcg can be available. By default, tcg is used. If there is more
57than one accelerator specified, the next one is used if the previous one fails
58to initialize.
Jan Kiszka6a48ffa2011-10-15 13:43:48 +020059@item kernel_irqchip=on|off
Matt Gingell32c18a22015-11-16 10:03:06 -080060Controls in-kernel irqchip support for the chosen accelerator when available.
Tiejun Chen79814172015-07-15 13:37:45 +080061@item gfx_passthru=on|off
62Enables IGD GFX passthrough support for the chosen machine when available.
Don Slutzd1048be2014-11-21 11:18:52 -050063@item vmport=on|off|auto
64Enables emulation of VMWare IO port, for vmmouse etc. auto says to select the
65value based on accel. For accel=xen the default is off otherwise the default
66is on.
Jan Kiszka39d69602012-01-25 18:14:15 +010067@item kvm_shadow_mem=size
68Defines the size of the KVM shadow MMU.
Jason Baronddb97f12012-08-02 15:44:16 -040069@item dump-guest-core=on|off
70Include guest memory in a core dump. The default is on.
Luiz Capitulino8490fc72012-09-05 16:50:16 -030071@item mem-merge=on|off
72Enables or disables memory merge support. This feature, when supported by
73the host, de-duplicates identical memory pages among VMs instances
74(enabled by default).
Tony Krowiak2eb1cd02015-03-12 13:53:51 +010075@item aes-key-wrap=on|off
76Enables or disables AES key wrapping support on s390-ccw hosts. This feature
77controls whether AES wrapping keys will be created to allow
78execution of AES cryptographic functions. The default is on.
79@item dea-key-wrap=on|off
80Enables or disables DEA key wrapping support on s390-ccw hosts. This feature
81controls whether DEA wrapping keys will be created to allow
82execution of DEA cryptographic functions. The default is on.
Xiao Guangrong87252e12015-12-02 15:20:58 +080083@item nvdimm=on|off
84Enables or disables NVDIMM support. The default is off.
Jan Kiszka80f52a62011-07-23 12:39:46 +020085@end table
blueswir15824d652009-03-28 06:44:27 +000086ETEXI
87
Jan Kiszka80f52a62011-07-23 12:39:46 +020088HXCOMM Deprecated by -machine
89DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
90
blueswir15824d652009-03-28 06:44:27 +000091DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
Peter Maydell585f6032012-10-04 16:22:01 +010092 "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +000093STEXI
94@item -cpu @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +010095@findex -cpu
Peter Maydell585f6032012-10-04 16:22:01 +010096Select CPU model (@code{-cpu help} for list and additional feature selection)
blueswir15824d652009-03-28 06:44:27 +000097ETEXI
98
99DEF("smp", HAS_ARG, QEMU_OPTION_smp,
Michael Tokarev12b7f572013-06-24 15:06:52 +0400100 "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
Jes Sorensen6be68d72009-07-23 17:03:42 +0200101 " set the number of CPUs to 'n' [default=1]\n"
102 " maxcpus= maximum number of total cpus, including\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -0700103 " offline CPUs for hotplug, etc\n"
Andre Przywara58a04db2009-08-28 10:49:57 +0200104 " cores= number of CPU cores on one socket\n"
105 " threads= number of threads on one CPU core\n"
Blue Swirlad960902010-03-29 19:23:52 +0000106 " sockets= number of discrete sockets in the system\n",
107 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000108STEXI
Michael Tokarev12b7f572013-06-24 15:06:52 +0400109@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100110@findex -smp
blueswir15824d652009-03-28 06:44:27 +0000111Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
112CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
113to 4.
Andre Przywara58a04db2009-08-28 10:49:57 +0200114For the PC target, the number of @var{cores} per socket, the number
115of @var{threads} per cores and the total number of @var{sockets} can be
116specified. Missing values will be computed. If any on the three values is
117given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
118specifies the maximum number of hotpluggable CPUs.
blueswir15824d652009-03-28 06:44:27 +0000119ETEXI
120
aliguori268a3622009-04-21 22:30:27 +0000121DEF("numa", HAS_ARG, QEMU_OPTION_numa,
Paolo Bonzini7febe362014-05-14 17:43:17 +0800122 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n"
123 "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
aliguori268a3622009-04-21 22:30:27 +0000124STEXI
Luiz Capitulino4932b892014-05-14 17:43:10 +0800125@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +0200126@itemx -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100127@findex -numa
Paolo Bonzini7febe362014-05-14 17:43:17 +0800128Simulate a multi node NUMA system. If @samp{mem}, @samp{memdev}
Luiz Capitulino4932b892014-05-14 17:43:10 +0800129and @samp{cpus} are omitted, resources are split equally. Also, note
130that the -@option{numa} option doesn't allocate any of the specified
131resources. That is, it just assigns existing resources to NUMA nodes. This
132means that one still has to use the @option{-m}, @option{-smp} options
Paolo Bonzini7febe362014-05-14 17:43:17 +0800133to allocate RAM and VCPUs respectively, and possibly @option{-object}
134to specify the memory backend for the @samp{memdev} suboption.
135
136@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one
137node uses @samp{memdev}, all of them have to use it.
aliguori268a3622009-04-21 22:30:27 +0000138ETEXI
139
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100140DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
141 "-add-fd fd=fd,set=set[,opaque=opaque]\n"
142 " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL)
143STEXI
144@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
145@findex -add-fd
146
147Add a file descriptor to an fd set. Valid options are:
148
149@table @option
150@item fd=@var{fd}
151This option defines the file descriptor of which a duplicate is added to fd set.
152The file descriptor cannot be stdin, stdout, or stderr.
153@item set=@var{set}
154This option defines the ID of the fd set to add the file descriptor to.
155@item opaque=@var{opaque}
156This option defines a free-form string that can be used to describe @var{fd}.
157@end table
158
159You can open an image using pre-opened file descriptors from an fd set:
160@example
161qemu-system-i386
162-add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
163-add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
164-drive file=/dev/fdset/2,index=0,media=disk
165@end example
166ETEXI
167
168DEF("set", HAS_ARG, QEMU_OPTION_set,
169 "-set group.id.arg=value\n"
170 " set <arg> parameter for item <id> of type <group>\n"
171 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
172STEXI
173@item -set @var{group}.@var{id}.@var{arg}=@var{value}
174@findex -set
175Set parameter @var{arg} for item @var{id} of type @var{group}\n"
176ETEXI
177
178DEF("global", HAS_ARG, QEMU_OPTION_global,
Paolo Bonzini3751d7c2015-04-09 14:16:19 +0200179 "-global driver.property=value\n"
180 "-global driver=driver,property=property,value=value\n"
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100181 " set a global default for a driver property\n",
182 QEMU_ARCH_ALL)
183STEXI
184@item -global @var{driver}.@var{prop}=@var{value}
Paolo Bonzini3751d7c2015-04-09 14:16:19 +0200185@itemx -global driver=@var{driver},property=@var{property},value=@var{value}
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100186@findex -global
187Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
188
189@example
190qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
191@end example
192
193In particular, you can use this to set driver properties for devices which are
194created automatically by the machine model. To create a device which is not
195created automatically and set properties on it, use -@option{device}.
Paolo Bonzini3751d7c2015-04-09 14:16:19 +0200196
Markus Armbrusterae08fd52015-06-15 14:35:58 +0200197-global @var{driver}.@var{prop}=@var{value} is shorthand for -global
198driver=@var{driver},property=@var{prop},value=@var{value}. The
199longhand syntax works even when @var{driver} contains a dot.
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100200ETEXI
201
202DEF("boot", HAS_ARG, QEMU_OPTION_boot,
203 "-boot [order=drives][,once=drives][,menu=on|off]\n"
Amos Kongc8a6ae82013-03-19 14:23:27 +0800204 " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n"
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100205 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
206 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
207 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n"
208 " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n",
209 QEMU_ARCH_ALL)
210STEXI
Amos Kongc8a6ae82013-03-19 14:23:27 +0800211@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 +0100212@findex -boot
213Specify boot order @var{drives} as a string of drive letters. Valid
Gongleid274e072015-07-03 17:50:57 +0800214drive letters depend on the target architecture. The x86 PC uses: a, b
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100215(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
216from network adapter 1-4), hard disk boot is the default. To apply a
217particular boot order only on the first startup, specify it via
218@option{once}.
219
220Interactive boot menus/prompts can be enabled via @option{menu=on} as far
221as firmware/BIOS supports them. The default is non-interactive boot.
222
223A splash picture could be passed to bios, enabling user to show it as logo,
224when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
225supports them. Currently Seabios for X86 system support it.
226limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
227format(true color). The resolution should be supported by the SVGA mode, so
228the recommended is 320x240, 640x480, 800x640.
229
230A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
231when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
232reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
233system support it.
234
Amos Kongc8a6ae82013-03-19 14:23:27 +0800235Do strict boot via @option{strict=on} as far as firmware/BIOS
236supports it. This only effects when boot priority is changed by
237bootindex options. The default is non-strict boot.
238
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100239@example
240# try to boot from network first, then from hard disk
241qemu-system-i386 -boot order=nc
242# boot from CD-ROM first, switch back to default order after reboot
243qemu-system-i386 -boot once=d
244# boot with a splash picture for 5 seconds.
245qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
246@end example
247
248Note: The legacy format '-boot @var{drives}' is still supported but its
249use is discouraged as it may be removed from future versions.
250ETEXI
251
252DEF("m", HAS_ARG, QEMU_OPTION_m,
Igor Mammedovc270fb92014-06-02 15:25:02 +0200253 "-m[emory] [size=]megs[,slots=n,maxmem=size]\n"
Igor Mammedov6e1d3c12013-11-27 01:27:35 +0100254 " configure guest RAM\n"
Alexander Graf0daba1f2015-06-05 11:05:03 +0200255 " size: initial amount of guest memory\n"
Igor Mammedovc270fb92014-06-02 15:25:02 +0200256 " slots: number of hotplug slots (default: none)\n"
Matthew Rosatob6fe0122014-08-28 11:25:33 -0400257 " maxmem: maximum amount of guest memory (default: none)\n"
258 "NOTE: Some architectures might enforce a specific granularity\n",
Igor Mammedov6e1d3c12013-11-27 01:27:35 +0100259 QEMU_ARCH_ALL)
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100260STEXI
Luiz Capitulino9fcc0792015-02-26 14:35:45 -0500261@item -m [size=]@var{megs}[,slots=n,maxmem=size]
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100262@findex -m
Luiz Capitulino9fcc0792015-02-26 14:35:45 -0500263Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB.
264Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in
265megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem}
266could be used to set amount of hotpluggable memory slots and maximum amount of
267memory. Note that @var{maxmem} must be aligned to the page size.
268
269For example, the following command-line sets the guest startup RAM size to
2701GB, creates 3 slots to hotplug additional memory and sets the maximum
271memory the guest can reach to 4GB:
272
273@example
274qemu-system-x86_64 -m 1G,slots=3,maxmem=4G
275@end example
276
277If @var{slots} and @var{maxmem} are not specified, memory hotplug won't
278be enabled and the guest startup RAM will never increase.
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100279ETEXI
280
281DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
282 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
283STEXI
284@item -mem-path @var{path}
285@findex -mem-path
286Allocate guest RAM from a temporarily created file in @var{path}.
287ETEXI
288
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100289DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
290 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
291 QEMU_ARCH_ALL)
292STEXI
293@item -mem-prealloc
294@findex -mem-prealloc
295Preallocate memory when using -mem-path.
296ETEXI
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100297
298DEF("k", HAS_ARG, QEMU_OPTION_k,
299 "-k language use keyboard layout (for example 'fr' for French)\n",
300 QEMU_ARCH_ALL)
301STEXI
302@item -k @var{language}
303@findex -k
304Use keyboard layout @var{language} (for example @code{fr} for
305French). This option is only needed where it is not easy to get raw PC
306keycodes (e.g. on Macs, with some X11 servers or with a VNC
307display). You don't normally need to use it on PC/Linux or PC/Windows
308hosts.
309
310The available layouts are:
311@example
312ar de-ch es fo fr-ca hu ja mk no pt-br sv
313da en-gb et fr fr-ch is lt nl pl ru th
314de en-us fi fr-be hr it lv nl-be pt sl tr
315@end example
316
317The default is @code{en-us}.
318ETEXI
319
320
321DEF("audio-help", 0, QEMU_OPTION_audio_help,
322 "-audio-help print list of audio drivers and their options\n",
323 QEMU_ARCH_ALL)
324STEXI
325@item -audio-help
326@findex -audio-help
327Will show the audio subsystem help: list of drivers, tunable
328parameters.
329ETEXI
330
331DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
332 "-soundhw c1,... enable audio support\n"
333 " and only specified sound cards (comma separated list)\n"
334 " use '-soundhw help' to get the list of supported cards\n"
335 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL)
336STEXI
337@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
338@findex -soundhw
339Enable audio and selected sound hardware. Use 'help' to print all
340available sound hardware.
341
342@example
343qemu-system-i386 -soundhw sb16,adlib disk.img
344qemu-system-i386 -soundhw es1370 disk.img
345qemu-system-i386 -soundhw ac97 disk.img
346qemu-system-i386 -soundhw hda disk.img
347qemu-system-i386 -soundhw all disk.img
348qemu-system-i386 -soundhw help
349@end example
350
351Note that Linux's i810_audio OSS kernel (for AC97) module might
352require manually specifying clocking.
353
354@example
355modprobe i810_audio clocking=48000
356@end example
357ETEXI
358
359DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
360 "-balloon none disable balloon device\n"
361 "-balloon virtio[,addr=str]\n"
362 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
363STEXI
364@item -balloon none
365@findex -balloon
366Disable balloon device.
367@item -balloon virtio[,addr=@var{addr}]
368Enable virtio balloon device (default), optionally with PCI address
369@var{addr}.
370ETEXI
371
372DEF("device", HAS_ARG, QEMU_OPTION_device,
373 "-device driver[,prop[=value][,...]]\n"
374 " add device (based on driver)\n"
375 " prop=value,... sets driver properties\n"
376 " use '-device help' to print all possible drivers\n"
377 " use '-device driver,help' to print all possible properties\n",
378 QEMU_ARCH_ALL)
379STEXI
380@item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
381@findex -device
382Add device @var{driver}. @var{prop}=@var{value} sets driver
383properties. Valid properties depend on the driver. To get help on
384possible drivers and properties, use @code{-device help} and
385@code{-device @var{driver},help}.
Corey Minyardf8490452015-12-17 12:50:10 -0600386
387Some drivers are:
388@item -device ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}]
389
390Add an IPMI BMC. This is a simulation of a hardware management
391interface processor that normally sits on a system. It provides
392a watchdog and the ability to reset and power control the system.
393You need to connect this to an IPMI interface to make it useful
394
395The IPMI slave address to use for the BMC. The default is 0x20.
396This address is the BMC's address on the I2C network of management
397controllers. If you don't know what this means, it is safe to ignore
398it.
399
400@item -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}]
401
402Add a connection to an external IPMI BMC simulator. Instead of
403locally emulating the BMC like the above item, instead connect
404to an external entity that provides the IPMI services.
405
406A connection is made to an external BMC simulator. If you do this, it
407is strongly recommended that you use the "reconnect=" chardev option
408to reconnect to the simulator if the connection is lost. Note that if
409this is not used carefully, it can be a security issue, as the
410interface has the ability to send resets, NMIs, and power off the VM.
411It's best if QEMU makes a connection to an external simulator running
412on a secure port on localhost, so neither the simulator nor QEMU is
413exposed to any outside network.
414
415See the "lanserv/README.vm" file in the OpenIPMI library for more
416details on the external interface.
417
418@item -device isa-ipmi-kcs,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}]
419
420Add a KCS IPMI interafce on the ISA bus. This also adds a
421corresponding ACPI and SMBIOS entries, if appropriate.
422
423@table @option
424@item bmc=@var{id}
425The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above.
426@item ioport=@var{val}
427Define the I/O address of the interface. The default is 0xca0 for KCS.
428@item irq=@var{val}
429Define the interrupt to use. The default is 5. To disable interrupts,
430set this to 0.
431@end table
432
433@item -device isa-ipmi-bt,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}]
434
435Like the KCS interface, but defines a BT interface. The default port is
4360xe4 and the default interrupt is 5.
437
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100438ETEXI
439
440DEF("name", HAS_ARG, QEMU_OPTION_name,
Dr. David Alan Gilbert8f480de2014-01-30 10:20:31 +0000441 "-name string1[,process=string2][,debug-threads=on|off]\n"
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100442 " set the name of the guest\n"
Dr. David Alan Gilbert8f480de2014-01-30 10:20:31 +0000443 " string1 sets the window title and string2 the process name (on Linux)\n"
444 " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n"
445 " NOTE: The thread names are for debugging and not a stable API.\n",
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100446 QEMU_ARCH_ALL)
447STEXI
448@item -name @var{name}
449@findex -name
450Sets the @var{name} of the guest.
451This name will be displayed in the SDL window caption.
452The @var{name} will also be used for the VNC server.
453Also optionally set the top visible process name in Linux.
Dr. David Alan Gilbert8f480de2014-01-30 10:20:31 +0000454Naming of individual threads can also be enabled on Linux to aid debugging.
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100455ETEXI
456
457DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
458 "-uuid %08x-%04x-%04x-%04x-%012x\n"
459 " specify machine UUID\n", QEMU_ARCH_ALL)
460STEXI
461@item -uuid @var{uuid}
462@findex -uuid
463Set system UUID.
464ETEXI
465
466STEXI
467@end table
468ETEXI
469DEFHEADING()
470
471DEFHEADING(Block device options:)
472STEXI
473@table @option
474ETEXI
475
blueswir15824d652009-03-28 06:44:27 +0000476DEF("fda", HAS_ARG, QEMU_OPTION_fda,
Blue Swirlad960902010-03-29 19:23:52 +0000477 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
478DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000479STEXI
480@item -fda @var{file}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +0200481@itemx -fdb @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100482@findex -fda
483@findex -fdb
Markus Armbruster92a539d2015-03-17 17:02:20 +0100484Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}).
blueswir15824d652009-03-28 06:44:27 +0000485ETEXI
486
487DEF("hda", HAS_ARG, QEMU_OPTION_hda,
Blue Swirlad960902010-03-29 19:23:52 +0000488 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
489DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000490DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
Blue Swirlad960902010-03-29 19:23:52 +0000491 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
492DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000493STEXI
494@item -hda @var{file}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +0200495@itemx -hdb @var{file}
496@itemx -hdc @var{file}
497@itemx -hdd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100498@findex -hda
499@findex -hdb
500@findex -hdc
501@findex -hdd
blueswir15824d652009-03-28 06:44:27 +0000502Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
503ETEXI
504
505DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
Blue Swirlad960902010-03-29 19:23:52 +0000506 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
507 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000508STEXI
509@item -cdrom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100510@findex -cdrom
blueswir15824d652009-03-28 06:44:27 +0000511Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
512@option{-cdrom} at the same time). You can use the host CD-ROM by
513using @file{/dev/cdrom} as filename (@pxref{host_drives}).
514ETEXI
515
516DEF("drive", HAS_ARG, QEMU_OPTION_drive,
517 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
518 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100519 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
Stefan Hajnoczid1db7602014-04-23 13:55:37 +0200520 " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n"
521 " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000522 " [,readonly=on|off][,copy-on-read=on|off]\n"
Peter Lieven2f7133b2014-07-28 21:53:02 +0200523 " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n"
Benoît Canet3e9fab62013-09-02 14:14:40 +0200524 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n"
525 " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n"
526 " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n"
527 " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n"
Benoît Canet2024c1d2013-09-02 14:14:41 +0200528 " [[,iops_size=is]]\n"
Alberto Garcia76f4afb2015-06-08 18:17:44 +0200529 " [[,group=g]]\n"
Blue Swirlad960902010-03-29 19:23:52 +0000530 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000531STEXI
532@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +0100533@findex -drive
blueswir15824d652009-03-28 06:44:27 +0000534
535Define a new drive. Valid options are:
536
Kevin Wolfb3f046c2009-10-09 10:58:35 +0200537@table @option
blueswir15824d652009-03-28 06:44:27 +0000538@item file=@var{file}
539This option defines which disk image (@pxref{disk_images}) to use with
540this drive. If the filename contains comma, you must double it
541(for instance, "file=my,,file" to use file "my,file").
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +1100542
543Special files such as iSCSI devices can be specified using protocol
544specific URLs. See the section for "Device URL Syntax" for more information.
blueswir15824d652009-03-28 06:44:27 +0000545@item if=@var{interface}
546This option defines on which type on interface the drive is connected.
547Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
548@item bus=@var{bus},unit=@var{unit}
549These options define where is connected the drive by defining the bus number and
550the unit id.
551@item index=@var{index}
552This option defines where is connected the drive by using an index in the list
553of available connectors of a given interface type.
554@item media=@var{media}
555This option defines the type of the media: disk or cdrom.
556@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
557These options have the same definition as they have in @option{-hdachs}.
558@item snapshot=@var{snapshot}
Michael Tokarev9d85d552014-04-07 13:34:58 +0400559@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive
560(see @option{-snapshot}).
blueswir15824d652009-03-28 06:44:27 +0000561@item cache=@var{cache}
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100562@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 +0200563@item aio=@var{aio}
564@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 +0100565@item discard=@var{discard}
566@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 +0000567@item format=@var{format}
568Specify which disk @var{format} will be used rather than detecting
Michael Tokarevd33c8a72016-05-18 15:47:53 +0300569the format. Can be used to specify format=raw to avoid interpreting
blueswir15824d652009-03-28 06:44:27 +0000570an untrusted format header.
571@item serial=@var{serial}
572This option specifies the serial number to assign to the device.
Markus Armbrusterc2cc47a2009-06-18 15:14:10 +0200573@item addr=@var{addr}
574Specify the controller's PCI address (if=virtio only).
Luiz Capitulinoae73e592011-07-12 17:35:08 -0300575@item werror=@var{action},rerror=@var{action}
576Specify which @var{action} to take on write and read errors. Valid actions are:
577"ignore" (ignore the error and try to continue), "stop" (pause QEMU),
578"report" (report the error to the guest), "enospc" (pause QEMU only if the
579host disk is full; report the error to the guest otherwise).
580The default setting is @option{werror=enospc} and @option{rerror=report}.
581@item readonly
582Open drive @option{file} as read-only. Guest write attempts will fail.
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000583@item copy-on-read=@var{copy-on-read}
584@var{copy-on-read} is "on" or "off" and enables whether to copy read backing
585file sectors into the image file.
Peter Lieven465bee12014-05-18 00:58:19 +0200586@item detect-zeroes=@var{detect-zeroes}
587@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic
588conversion of plain zero writes by the OS to driver specific optimized
589zero write commands. You may even choose "unmap" if @var{discard} is set
590to "unmap" to allow a zero write to be converted to an UNMAP operation.
blueswir15824d652009-03-28 06:44:27 +0000591@end table
592
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100593By default, the @option{cache=writeback} mode is used. It will report data
594writes as completed as soon as the data is present in the host page cache.
595This is safe as long as your guest OS makes sure to correctly flush disk caches
596where needed. If your guest OS does not handle volatile disk write caches
597correctly and your host crashes or loses power, then the guest may experience
598data corruption.
blueswir15824d652009-03-28 06:44:27 +0000599
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100600For such guests, you should consider using @option{cache=writethrough}. This
601means that the host page cache will be used to read and write data, but write
602notification will be sent to the guest only after QEMU has made sure to flush
603each write to the disk. Be aware that this has a major impact on performance.
blueswir15824d652009-03-28 06:44:27 +0000604
Aurelien Jarnoc304d312009-05-03 23:29:14 +0200605The host page cache can be avoided entirely with @option{cache=none}. This will
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100606attempt to do disk IO directly to the guest's memory. QEMU may still perform
607an internal copy of the data. Note that this is considered a writeback mode and
608the guest OS must handle the disk write cache correctly in order to avoid data
609corruption on host crashes.
blueswir15824d652009-03-28 06:44:27 +0000610
Stefan Hajnoczi92196b22011-08-04 12:26:52 +0100611The host page cache can be avoided while only sending write notifications to
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100612the guest when the data has been flushed to the disk using
613@option{cache=directsync}.
blueswir15824d652009-03-28 06:44:27 +0000614
Alexander Graf016f5cf2010-05-26 17:51:49 +0200615In case you don't care about data integrity over host failures, use
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100616@option{cache=unsafe}. This option tells QEMU that it never needs to write any
617data to the disk but can instead keep things in cache. If anything goes wrong,
Stefan Weile7d81002011-12-10 00:19:46 +0100618like your host losing power, the disk storage getting disconnected accidentally,
Kevin Wolfa13e5e02012-11-21 12:26:56 +0100619etc. your image will most probably be rendered unusable. When using
Alexander Grafc3177282010-05-26 21:04:32 +0200620the @option{-snapshot} option, unsafe caching is always used.
Alexander Graf016f5cf2010-05-26 17:51:49 +0200621
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +0000622Copy-on-read avoids accessing the same backing file sectors repeatedly and is
623useful when the backing file is over a slow network. By default copy-on-read
624is off.
625
blueswir15824d652009-03-28 06:44:27 +0000626Instead of @option{-cdrom} you can use:
627@example
Stefan Weil3804da92012-05-11 22:21:50 +0200628qemu-system-i386 -drive file=file,index=2,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000629@end example
630
631Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
632use:
633@example
Stefan Weil3804da92012-05-11 22:21:50 +0200634qemu-system-i386 -drive file=file,index=0,media=disk
635qemu-system-i386 -drive file=file,index=1,media=disk
636qemu-system-i386 -drive file=file,index=2,media=disk
637qemu-system-i386 -drive file=file,index=3,media=disk
blueswir15824d652009-03-28 06:44:27 +0000638@end example
639
Corey Bryant587ed6b2012-10-18 15:19:34 -0400640You can open an image using pre-opened file descriptors from an fd set:
641@example
642qemu-system-i386
643-add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
644-add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
645-drive file=/dev/fdset/2,index=0,media=disk
646@end example
647
blueswir15824d652009-03-28 06:44:27 +0000648You can connect a CDROM to the slave of ide0:
649@example
Stefan Weil3804da92012-05-11 22:21:50 +0200650qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000651@end example
652
653If you don't specify the "file=" argument, you define an empty drive:
654@example
Stefan Weil3804da92012-05-11 22:21:50 +0200655qemu-system-i386 -drive if=ide,index=1,media=cdrom
blueswir15824d652009-03-28 06:44:27 +0000656@end example
657
658You can connect a SCSI disk with unit ID 6 on the bus #0:
659@example
Stefan Weil3804da92012-05-11 22:21:50 +0200660qemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6
blueswir15824d652009-03-28 06:44:27 +0000661@end example
662
663Instead of @option{-fda}, @option{-fdb}, you can use:
664@example
Stefan Weil3804da92012-05-11 22:21:50 +0200665qemu-system-i386 -drive file=file,index=0,if=floppy
666qemu-system-i386 -drive file=file,index=1,if=floppy
blueswir15824d652009-03-28 06:44:27 +0000667@end example
668
669By default, @var{interface} is "ide" and @var{index} is automatically
670incremented:
671@example
Stefan Weil3804da92012-05-11 22:21:50 +0200672qemu-system-i386 -drive file=a -drive file=b"
blueswir15824d652009-03-28 06:44:27 +0000673@end example
674is interpreted like:
675@example
Stefan Weil3804da92012-05-11 22:21:50 +0200676qemu-system-i386 -hda a -hdb b
blueswir15824d652009-03-28 06:44:27 +0000677@end example
678ETEXI
679
680DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
Blue Swirlad960902010-03-29 19:23:52 +0000681 "-mtdblock file use 'file' as on-board Flash memory image\n",
682 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000683STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200684@item -mtdblock @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100685@findex -mtdblock
Kevin Wolf4e257e52009-10-09 10:58:36 +0200686Use @var{file} as on-board Flash memory image.
blueswir15824d652009-03-28 06:44:27 +0000687ETEXI
688
689DEF("sd", HAS_ARG, QEMU_OPTION_sd,
Blue Swirlad960902010-03-29 19:23:52 +0000690 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000691STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200692@item -sd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100693@findex -sd
Kevin Wolf4e257e52009-10-09 10:58:36 +0200694Use @var{file} as SecureDigital card image.
blueswir15824d652009-03-28 06:44:27 +0000695ETEXI
696
697DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
Blue Swirlad960902010-03-29 19:23:52 +0000698 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000699STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +0200700@item -pflash @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +0100701@findex -pflash
Kevin Wolf4e257e52009-10-09 10:58:36 +0200702Use @var{file} as a parallel flash image.
blueswir15824d652009-03-28 06:44:27 +0000703ETEXI
704
blueswir15824d652009-03-28 06:44:27 +0000705DEF("snapshot", 0, QEMU_OPTION_snapshot,
Blue Swirlad960902010-03-29 19:23:52 +0000706 "-snapshot write to temporary files instead of disk image files\n",
707 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000708STEXI
709@item -snapshot
Stefan Weil6616b2a2010-02-05 23:52:05 +0100710@findex -snapshot
blueswir15824d652009-03-28 06:44:27 +0000711Write to temporary files instead of disk image files. In this case,
712the raw disk image you use is not written back. You can however force
713the write back by pressing @key{C-a s} (@pxref{disk_images}).
714ETEXI
715
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100716DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
717 "-hdachs c,h,s[,t]\n" \
718 " force hard disk 0 physical geometry and the optional BIOS\n" \
719 " translation (t=none or lba) (usually QEMU can guess them)\n",
Blue Swirlad960902010-03-29 19:23:52 +0000720 QEMU_ARCH_ALL)
Marcelo Tosattic9027602010-03-01 20:25:08 -0300721STEXI
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100722@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
723@findex -hdachs
724Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
725@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
726translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
727all those parameters. This option is useful for old MS-DOS disk
728images.
Markus Armbrusterc70a01e2013-02-13 19:49:40 +0100729ETEXI
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530730
731DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530732 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530733 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530734 QEMU_ARCH_ALL)
735
736STEXI
737
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530738@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 +0530739@findex -fsdev
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530740Define a new file system device. Valid options are:
741@table @option
742@item @var{fsdriver}
743This option specifies the fs driver backend to use.
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530744Currently "local", "handle" and "proxy" file system drivers are supported.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530745@item id=@var{id}
746Specifies identifier for this device
747@item path=@var{path}
748Specifies the export path for the file system device. Files under
749this path will be available to the 9p client on the guest.
750@item security_model=@var{security_model}
751Specifies the security model to be used for this export path.
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530752Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530753In "passthrough" security model, files are stored using the same
Stefan Weilb65ee4f2012-05-11 22:25:50 +0200754credentials as they are created on the guest. This requires QEMU
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530755to run as root. In "mapped-xattr" security model, some of the file
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530756attributes like uid, gid, mode bits and link target are stored as
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530757file attributes. For "mapped-file" these attributes are stored in the
758hidden .virtfs_metadata directory. Directories exported by this security model cannot
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530759interact with other unix tools. "none" security model is same as
760passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530761set file attributes like ownership. Security model is mandatory
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530762only for local fsdriver. Other fsdrivers (like handle, proxy) don't take
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530763security model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530764@item writeout=@var{writeout}
765This is an optional argument. The only supported value is "immediate".
766This means that host page cache will be used to read and write data but
767write notification will be sent to the guest only when the data has been
768reported as written by the storage subsystem.
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +0530769@item readonly
770Enables exporting 9p share as a readonly mount for guests. By default
771read-write access is given.
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530772@item socket=@var{socket}
773Enables proxy filesystem driver to use passed socket file for communicating
774with virtfs-proxy-helper
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530775@item sock_fd=@var{sock_fd}
776Enables proxy filesystem driver to use passed socket descriptor for
777communicating with virtfs-proxy-helper. Usually a helper like libvirt
778will create socketpair and pass one of the fds as sock_fd
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530779@end table
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530780
781-fsdev option is used along with -device driver "virtio-9p-pci".
782@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
783Options for virtio-9p-pci driver are:
784@table @option
785@item fsdev=@var{id}
786Specifies the id value specified along with -fsdev option
787@item mount_tag=@var{mount_tag}
788Specifies the tag name to be used by the guest to mount this export point
789@end table
790
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530791ETEXI
Gautham R Shenoy74db9202010-04-29 17:44:43 +0530792
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530793DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530794 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530795 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530796 QEMU_ARCH_ALL)
797
798STEXI
799
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530800@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 +0530801@findex -virtfs
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530802
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530803The general form of a Virtual File system pass-through options are:
804@table @option
805@item @var{fsdriver}
806This option specifies the fs driver backend to use.
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530807Currently "local", "handle" and "proxy" file system drivers are supported.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530808@item id=@var{id}
809Specifies identifier for this device
810@item path=@var{path}
811Specifies the export path for the file system device. Files under
812this path will be available to the 9p client on the guest.
813@item security_model=@var{security_model}
814Specifies the security model to be used for this export path.
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530815Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530816In "passthrough" security model, files are stored using the same
Stefan Weilb65ee4f2012-05-11 22:25:50 +0200817credentials as they are created on the guest. This requires QEMU
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530818to run as root. In "mapped-xattr" security model, some of the file
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530819attributes like uid, gid, mode bits and link target are stored as
Aneesh Kumar K.V2c30dd72012-01-19 12:21:11 +0530820file attributes. For "mapped-file" these attributes are stored in the
821hidden .virtfs_metadata directory. Directories exported by this security model cannot
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530822interact with other unix tools. "none" security model is same as
823passthrough except the sever won't report failures if it fails to
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530824set file attributes like ownership. Security model is mandatory only
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530825for local fsdriver. Other fsdrivers (like handle, proxy) don't take security
M. Mohan Kumard9b36a62011-10-14 12:59:37 +0530826model as a parameter.
Aneesh Kumar K.V7c92a3d2011-10-12 19:11:24 +0530827@item writeout=@var{writeout}
828This is an optional argument. The only supported value is "immediate".
829This means that host page cache will be used to read and write data but
830write notification will be sent to the guest only when the data has been
831reported as written by the storage subsystem.
M. Mohan Kumar2c74c2c2011-10-25 12:10:39 +0530832@item readonly
833Enables exporting 9p share as a readonly mount for guests. By default
834read-write access is given.
M. Mohan Kumar84a87cc2011-12-14 13:58:47 +0530835@item socket=@var{socket}
836Enables proxy filesystem driver to use passed socket file for
837communicating with virtfs-proxy-helper. Usually a helper like libvirt
838will create socketpair and pass one of the fds as sock_fd
M. Mohan Kumarf67e3ff2011-12-14 13:58:46 +0530839@item sock_fd
840Enables proxy filesystem driver to use passed 'sock_fd' as the socket
841descriptor for interfacing with virtfs-proxy-helper
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530842@end table
843ETEXI
Gautham R Shenoy3d54abc2010-04-29 17:45:03 +0530844
Aneesh Kumar K.V9db221a2011-10-25 12:10:40 +0530845DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
846 "-virtfs_synth Create synthetic file system image\n",
847 QEMU_ARCH_ALL)
848STEXI
849@item -virtfs_synth
850@findex -virtfs_synth
851Create synthetic file system image
852ETEXI
853
blueswir15824d652009-03-28 06:44:27 +0000854STEXI
855@end table
856ETEXI
blueswir15824d652009-03-28 06:44:27 +0000857DEFHEADING()
858
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100859DEFHEADING(USB options:)
860STEXI
861@table @option
862ETEXI
863
864DEF("usb", 0, QEMU_OPTION_usb,
865 "-usb enable the USB driver (will be the default soon)\n",
866 QEMU_ARCH_ALL)
867STEXI
868@item -usb
869@findex -usb
870Enable the USB driver (will be the default soon)
871ETEXI
872
873DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
874 "-usbdevice name add the host or guest USB device 'name'\n",
875 QEMU_ARCH_ALL)
876STEXI
877
878@item -usbdevice @var{devname}
879@findex -usbdevice
880Add the USB device @var{devname}. @xref{usb_devices}.
881
882@table @option
883
884@item mouse
885Virtual Mouse. This will override the PS/2 mouse emulation when activated.
886
887@item tablet
888Pointer device that uses absolute coordinates (like a touchscreen). This
889means QEMU is able to report the mouse position without having to grab the
890mouse. Also overrides the PS/2 mouse emulation when activated.
891
892@item disk:[format=@var{format}]:@var{file}
893Mass storage device based on file. The optional @var{format} argument
Michael Tokarevd33c8a72016-05-18 15:47:53 +0300894will be used rather than detecting the format. Can be used to specify
Markus Armbruster10adb8b2013-02-13 19:49:43 +0100895@code{format=raw} to avoid interpreting an untrusted format header.
896
897@item host:@var{bus}.@var{addr}
898Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
899
900@item host:@var{vendor_id}:@var{product_id}
901Pass through the host device identified by @var{vendor_id}:@var{product_id}
902(Linux only).
903
904@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
905Serial converter to host character device @var{dev}, see @code{-serial} for the
906available devices.
907
908@item braille
909Braille device. This will use BrlAPI to display the braille output on a real
910or fake device.
911
912@item net:@var{options}
913Network adapter that supports CDC ethernet and RNDIS protocols.
914
915@end table
916ETEXI
917
918STEXI
919@end table
920ETEXI
921DEFHEADING()
922
blueswir15824d652009-03-28 06:44:27 +0000923DEFHEADING(Display options:)
blueswir15824d652009-03-28 06:44:27 +0000924STEXI
925@table @option
926ETEXI
927
Jes Sorensen1472a952011-03-16 13:33:31 +0100928DEF("display", HAS_ARG, QEMU_OPTION_display,
929 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
Robert Hof04ec5a2016-07-26 18:17:11 +0800930 " [,window_close=on|off][,gl=on|off]|curses|none|\n"
931 "-display gtk[,grab_on_hover=on|off][,gl=on|off]|\n"
932 "-display vnc=<display>[,<optargs>]\n"
933 "-display curses\n"
934 "-display none"
935 " select display type\n"
936 "The default display is equivalent to\n"
937#if defined(CONFIG_GTK)
938 "\t\"-display gtk\"\n"
939#elif defined(CONFIG_SDL)
940 "\t\"-display sdl\"\n"
941#elif defined(CONFIG_COCOA)
942 "\t\"-display cocoa\"\n"
943#elif defined(CONFIG_VNC)
944 "\t\"-vnc localhost:0,to=99,id=default\"\n"
945#else
946 "\t\"-display none\"\n"
947#endif
948 , QEMU_ARCH_ALL)
Jes Sorensen1472a952011-03-16 13:33:31 +0100949STEXI
950@item -display @var{type}
951@findex -display
952Select type of display to use. This option is a replacement for the
953old style -sdl/-curses/... options. Valid values for @var{type} are
954@table @option
955@item sdl
956Display video output via SDL (usually in a separate graphics
957window; see the SDL documentation for other possibilities).
958@item curses
959Display video output via curses. For graphics device models which
960support a text mode, QEMU can display this output using a
961curses/ncurses interface. Nothing is displayed when the graphics
962device is in graphical mode or if the graphics device does not support
963a text mode. Generally only the VGA device models support text mode.
Jes Sorensen4171d322011-03-16 13:33:32 +0100964@item none
965Do not display video output. The guest will still see an emulated
966graphics card, but its output will not be displayed to the QEMU
967user. This option differs from the -nographic option in that it
968only affects what is done with video output; -nographic also changes
969the destination of the serial and parallel port data.
Jan Kiszka881249c2014-03-12 08:33:50 +0100970@item gtk
971Display video output in a GTK window. This interface provides drop-down
972menus and other UI elements to configure and control the VM during
973runtime.
Jes Sorensen3264ff12011-03-16 13:33:33 +0100974@item vnc
975Start a VNC server on display <arg>
Jes Sorensen1472a952011-03-16 13:33:31 +0100976@end table
977ETEXI
978
blueswir15824d652009-03-28 06:44:27 +0000979DEF("nographic", 0, QEMU_OPTION_nographic,
Blue Swirlad960902010-03-29 19:23:52 +0000980 "-nographic disable graphical output and redirect serial I/Os to console\n",
981 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000982STEXI
983@item -nographic
Stefan Weil6616b2a2010-02-05 23:52:05 +0100984@findex -nographic
blueswir15824d652009-03-28 06:44:27 +0000985Normally, QEMU uses SDL to display the VGA output. With this option,
986you can totally disable graphical output so that QEMU is a simple
987command line application. The emulated serial port is redirected on
Paolo Bonzini02c4bdf2013-07-03 20:29:45 +0400988the console and muxed with the monitor (unless redirected elsewhere
989explicitly). Therefore, you can still use QEMU to debug a Linux kernel
Ramkumar Ramachandrab031f412013-07-20 16:53:09 +0530990with a serial console. Use @key{C-a h} for help on switching between
991the console and monitor.
blueswir15824d652009-03-28 06:44:27 +0000992ETEXI
993
blueswir15824d652009-03-28 06:44:27 +0000994DEF("curses", 0, QEMU_OPTION_curses,
Robert Hof04ec5a2016-07-26 18:17:11 +0800995 "-curses shorthand for -display curses\n",
Blue Swirlad960902010-03-29 19:23:52 +0000996 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +0000997STEXI
998@item -curses
Markus Armbrusterb8f490e2013-02-13 19:49:38 +0100999@findex -curses
blueswir15824d652009-03-28 06:44:27 +00001000Normally, QEMU uses SDL to display the VGA output. With this option,
1001QEMU can display the VGA output when in text mode using a
1002curses/ncurses interface. Nothing is displayed in graphical mode.
1003ETEXI
1004
blueswir15824d652009-03-28 06:44:27 +00001005DEF("no-frame", 0, QEMU_OPTION_no_frame,
Blue Swirlad960902010-03-29 19:23:52 +00001006 "-no-frame open SDL window without a frame and window decorations\n",
1007 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001008STEXI
1009@item -no-frame
Stefan Weil6616b2a2010-02-05 23:52:05 +01001010@findex -no-frame
blueswir15824d652009-03-28 06:44:27 +00001011Do not use decorations for SDL windows and start them using the whole
1012available screen space. This makes the using QEMU in a dedicated desktop
1013workspace more convenient.
1014ETEXI
1015
blueswir15824d652009-03-28 06:44:27 +00001016DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
Blue Swirlad960902010-03-29 19:23:52 +00001017 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
1018 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001019STEXI
1020@item -alt-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +01001021@findex -alt-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +10001022Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
1023affects the special keys (for fullscreen, monitor-mode switching, etc).
blueswir15824d652009-03-28 06:44:27 +00001024ETEXI
1025
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -05001026DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
Blue Swirlad960902010-03-29 19:23:52 +00001027 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
1028 QEMU_ARCH_ALL)
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -05001029STEXI
1030@item -ctrl-grab
Stefan Weil6616b2a2010-02-05 23:52:05 +01001031@findex -ctrl-grab
Brad Hardsde1db2a2011-04-29 21:46:12 +10001032Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
1033affects the special keys (for fullscreen, monitor-mode switching, etc).
Dustin Kirkland0ca9f8a2009-09-17 15:48:04 -05001034ETEXI
1035
blueswir15824d652009-03-28 06:44:27 +00001036DEF("no-quit", 0, QEMU_OPTION_no_quit,
Blue Swirlad960902010-03-29 19:23:52 +00001037 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001038STEXI
1039@item -no-quit
Stefan Weil6616b2a2010-02-05 23:52:05 +01001040@findex -no-quit
blueswir15824d652009-03-28 06:44:27 +00001041Disable SDL window close capability.
1042ETEXI
1043
blueswir15824d652009-03-28 06:44:27 +00001044DEF("sdl", 0, QEMU_OPTION_sdl,
Robert Hof04ec5a2016-07-26 18:17:11 +08001045 "-sdl shorthand for -display sdl\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001046STEXI
1047@item -sdl
Stefan Weil6616b2a2010-02-05 23:52:05 +01001048@findex -sdl
blueswir15824d652009-03-28 06:44:27 +00001049Enable SDL.
1050ETEXI
1051
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001052DEF("spice", HAS_ARG, QEMU_OPTION_spice,
Yonit Halperin27af7782012-08-21 13:54:20 +03001053 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
1054 " [,x509-key-file=<file>][,x509-key-password=<file>]\n"
1055 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n"
Marc-André Lureaufe4831b2015-01-13 17:57:51 +01001056 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n"
Yonit Halperin27af7782012-08-21 13:54:20 +03001057 " [,tls-ciphers=<list>]\n"
1058 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n"
1059 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n"
1060 " [,sasl][,password=<secret>][,disable-ticketing]\n"
1061 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n"
1062 " [,jpeg-wan-compression=[auto|never|always]]\n"
1063 " [,zlib-glz-wan-compression=[auto|never|always]]\n"
1064 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n"
Hans de Goede5ad24e52013-06-08 15:37:27 +02001065 " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n"
1066 " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n"
Gerd Hoffmann474114b2015-10-13 15:39:34 +02001067 " [,gl=[on|off]]\n"
Yonit Halperin27af7782012-08-21 13:54:20 +03001068 " enable spice\n"
1069 " at least one of {port, tls-port} is mandatory\n",
1070 QEMU_ARCH_ALL)
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001071STEXI
1072@item -spice @var{option}[,@var{option}[,...]]
1073@findex -spice
1074Enable the spice remote desktop protocol. Valid options are
1075
1076@table @option
1077
1078@item port=<nr>
Gerd Hoffmannc448e852010-03-11 11:13:32 -03001079Set the TCP port spice is listening on for plaintext channels.
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001080
Gerd Hoffmann333b0ee2010-08-27 14:29:16 +02001081@item addr=<addr>
1082Set the IP address spice is listening on. Default is any address.
1083
1084@item ipv4
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001085@itemx ipv6
1086@itemx unix
Gerd Hoffmann333b0ee2010-08-27 14:29:16 +02001087Force using the specified IP version.
1088
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001089@item password=<secret>
1090Set the password you need to authenticate.
1091
Marc-André Lureau48b3ed02011-05-17 10:40:33 +02001092@item sasl
1093Require that the client use SASL to authenticate with the spice.
1094The exact choice of authentication method used is controlled from the
1095system / user's SASL configuration file for the 'qemu' service. This
1096is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1097unprivileged user, an environment variable SASL_CONF_PATH can be used
1098to make it search alternate locations for the service config.
1099While some SASL auth methods can also provide data encryption (eg GSSAPI),
1100it is recommended that SASL always be combined with the 'tls' and
1101'x509' settings to enable use of SSL and server certificates. This
1102ensures a data encryption preventing compromise of authentication
1103credentials.
1104
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001105@item disable-ticketing
1106Allow client connects without authentication.
1107
Hans de Goeded4970b02011-03-27 16:43:54 +02001108@item disable-copy-paste
1109Disable copy paste between the client and the guest.
1110
Hans de Goede5ad24e52013-06-08 15:37:27 +02001111@item disable-agent-file-xfer
1112Disable spice-vdagent based file-xfer between the client and the guest.
1113
Gerd Hoffmannc448e852010-03-11 11:13:32 -03001114@item tls-port=<nr>
1115Set the TCP port spice is listening on for encrypted channels.
1116
1117@item x509-dir=<dir>
1118Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
1119
1120@item x509-key-file=<file>
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001121@itemx x509-key-password=<file>
1122@itemx x509-cert-file=<file>
1123@itemx x509-cacert-file=<file>
1124@itemx x509-dh-key-file=<file>
Gerd Hoffmannc448e852010-03-11 11:13:32 -03001125The x509 file names can also be configured individually.
1126
1127@item tls-ciphers=<list>
1128Specify which ciphers to use.
1129
Alon Levyd70d6b32011-12-20 13:05:18 +02001130@item tls-channel=[main|display|cursor|inputs|record|playback]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001131@itemx plaintext-channel=[main|display|cursor|inputs|record|playback]
Gerd Hoffmann17b6dea2010-08-27 14:09:56 +02001132Force specific channel to be used with or without TLS encryption. The
1133options can be specified multiple times to configure multiple
1134channels. The special name "default" can be used to set the default
1135mode. For channels which are not explicitly forced into one mode the
1136spice client is allowed to pick tls/plaintext as he pleases.
1137
Yonit Halperin9f04e092010-07-14 13:26:34 +03001138@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
1139Configure image compression (lossless).
1140Default is auto_glz.
1141
1142@item jpeg-wan-compression=[auto|never|always]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001143@itemx zlib-glz-wan-compression=[auto|never|always]
Yonit Halperin9f04e092010-07-14 13:26:34 +03001144Configure wan image compression (lossy for slow links).
1145Default is auto.
1146
Gerd Hoffmann84a23f22010-08-30 16:36:53 +02001147@item streaming-video=[off|all|filter]
1148Configure video stream detection. Default is filter.
1149
1150@item agent-mouse=[on|off]
1151Enable/disable passing mouse events via vdagent. Default is on.
1152
1153@item playback-compression=[on|off]
1154Enable/disable audio stream compression (using celt 0.5.1). Default is on.
1155
Yonit Halperin8c957052012-08-21 11:51:59 +03001156@item seamless-migration=[on|off]
1157Enable/disable spice seamless migration. Default is off.
1158
Gerd Hoffmann474114b2015-10-13 15:39:34 +02001159@item gl=[on|off]
1160Enable/disable OpenGL context. Default is off.
1161
Gerd Hoffmann29b00402010-03-11 11:13:27 -03001162@end table
1163ETEXI
1164
blueswir15824d652009-03-28 06:44:27 +00001165DEF("portrait", 0, QEMU_OPTION_portrait,
Blue Swirlad960902010-03-29 19:23:52 +00001166 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
1167 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001168STEXI
1169@item -portrait
Stefan Weil6616b2a2010-02-05 23:52:05 +01001170@findex -portrait
blueswir15824d652009-03-28 06:44:27 +00001171Rotate graphical output 90 deg left (only PXA LCD).
1172ETEXI
1173
Vasily Khoruzhick93128052011-06-17 13:04:36 +03001174DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
1175 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
1176 QEMU_ARCH_ALL)
1177STEXI
Markus Armbruster6265c432013-02-13 19:49:39 +01001178@item -rotate @var{deg}
Vasily Khoruzhick93128052011-06-17 13:04:36 +03001179@findex -rotate
1180Rotate graphical output some deg left (only PXA LCD).
1181ETEXI
1182
blueswir15824d652009-03-28 06:44:27 +00001183DEF("vga", HAS_ARG, QEMU_OPTION_vga,
Gerd Hoffmanna94f0c52014-09-10 14:28:48 +02001184 "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n"
Blue Swirlad960902010-03-29 19:23:52 +00001185 " select video card type\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001186STEXI
malce4558dc2012-08-27 18:33:21 +04001187@item -vga @var{type}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001188@findex -vga
blueswir15824d652009-03-28 06:44:27 +00001189Select type of VGA card to emulate. Valid values for @var{type} are
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001190@table @option
blueswir15824d652009-03-28 06:44:27 +00001191@item cirrus
1192Cirrus Logic GD5446 Video card. All Windows versions starting from
1193Windows 95 should recognize and use this graphic card. For optimal
1194performances, use 16 bit color depth in the guest and the host OS.
1195(This one is the default)
1196@item std
1197Standard VGA card with Bochs VBE extensions. If your guest OS
1198supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
1199to use high resolution modes (>= 1280x1024x16) then you should use
1200this option.
1201@item vmware
1202VMWare SVGA-II compatible adapter. Use it if you have sufficiently
1203recent XFree86/XOrg server or Windows guest with a driver for this
1204card.
Gerd Hoffmanna19cbfb2010-04-27 11:50:11 +02001205@item qxl
1206QXL paravirtual graphic card. It is VGA compatible (including VESA
12072.0 VBE support). Works best with qxl guest drivers installed though.
1208Recommended choice when using the spice protocol.
Mark Cave-Ayland33632782014-03-17 21:46:25 +00001209@item tcx
1210(sun4m only) Sun TCX framebuffer. This is the default framebuffer for
1211sun4m machines and offers both 8-bit and 24-bit colour depths at a
1212fixed resolution of 1024x768.
1213@item cg3
1214(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer
1215for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP)
1216resolutions aimed at people wishing to run older Solaris versions.
Gerd Hoffmanna94f0c52014-09-10 14:28:48 +02001217@item virtio
1218Virtio VGA card.
blueswir15824d652009-03-28 06:44:27 +00001219@item none
1220Disable VGA card.
1221@end table
1222ETEXI
1223
1224DEF("full-screen", 0, QEMU_OPTION_full_screen,
Blue Swirlad960902010-03-29 19:23:52 +00001225 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001226STEXI
1227@item -full-screen
Stefan Weil6616b2a2010-02-05 23:52:05 +01001228@findex -full-screen
blueswir15824d652009-03-28 06:44:27 +00001229Start in full screen.
1230ETEXI
1231
blueswir15824d652009-03-28 06:44:27 +00001232DEF("g", 1, QEMU_OPTION_g ,
Blue Swirlad960902010-03-29 19:23:52 +00001233 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
1234 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
blueswir15824d652009-03-28 06:44:27 +00001235STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01001236@item -g @var{width}x@var{height}[x@var{depth}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001237@findex -g
Stefan Weil95d5f082010-01-20 22:25:27 +01001238Set the initial graphical resolution and depth (PPC, SPARC only).
blueswir15824d652009-03-28 06:44:27 +00001239ETEXI
1240
1241DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
Robert Hof04ec5a2016-07-26 18:17:11 +08001242 "-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001243STEXI
1244@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
Stefan Weil6616b2a2010-02-05 23:52:05 +01001245@findex -vnc
blueswir15824d652009-03-28 06:44:27 +00001246Normally, QEMU uses SDL to display the VGA output. With this option,
1247you can have QEMU listen on VNC display @var{display} and redirect the VGA
1248display over the VNC session. It is very useful to enable the usb
1249tablet device when using this option (option @option{-usbdevice
1250tablet}). When using the VNC display, you must use the @option{-k}
1251parameter to set the keyboard layout if you are not using en-us. Valid
1252syntax for the @var{display} is
1253
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001254@table @option
blueswir15824d652009-03-28 06:44:27 +00001255
Robert Ho99a9a522016-05-31 15:03:09 +08001256@item to=@var{L}
1257
1258With this option, QEMU will try next available VNC @var{display}s, until the
1259number @var{L}, if the origianlly defined "-vnc @var{display}" is not
1260available, e.g. port 5900+@var{display} is already used by another
1261application. By default, to=0.
1262
blueswir15824d652009-03-28 06:44:27 +00001263@item @var{host}:@var{d}
1264
1265TCP connections will only be allowed from @var{host} on display @var{d}.
1266By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
1267be omitted in which case the server will accept connections from any host.
1268
Kevin Wolf4e257e52009-10-09 10:58:36 +02001269@item unix:@var{path}
blueswir15824d652009-03-28 06:44:27 +00001270
1271Connections will be allowed over UNIX domain sockets where @var{path} is the
1272location of a unix socket to listen for connections on.
1273
1274@item none
1275
1276VNC is initialized but not started. The monitor @code{change} command
1277can be used to later start the VNC server.
1278
1279@end table
1280
1281Following the @var{display} value there may be one or more @var{option} flags
1282separated by commas. Valid options are
1283
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001284@table @option
blueswir15824d652009-03-28 06:44:27 +00001285
1286@item reverse
1287
1288Connect to a listening VNC client via a ``reverse'' connection. The
1289client is specified by the @var{display}. For reverse network
1290connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
1291is a TCP port number, not a display number.
1292
Tim Hardeck7536ee42013-01-21 11:04:44 +01001293@item websocket
1294
1295Opens an additional TCP listening port dedicated to VNC Websocket connections.
Peter Maydell085d8132013-03-18 17:20:07 +00001296By definition the Websocket port is 5700+@var{display}. If @var{host} is
Tim Hardeck7536ee42013-01-21 11:04:44 +01001297specified connections will only be allowed from this host.
1298As an alternative the Websocket port could be specified by using
1299@code{websocket}=@var{port}.
Daniel P. Berrange3e305e42015-08-06 14:39:32 +01001300If no TLS credentials are provided, the websocket connection runs in
1301unencrypted mode. If TLS credentials are provided, the websocket connection
1302requires encrypted client connections.
Tim Hardeck7536ee42013-01-21 11:04:44 +01001303
blueswir15824d652009-03-28 06:44:27 +00001304@item password
1305
1306Require that password based authentication is used for client connections.
Michal Novotny86ee5bc2012-07-16 15:54:38 +02001307
1308The password must be set separately using the @code{set_password} command in
1309the @ref{pcsys_monitor}. The syntax to change your password is:
1310@code{set_password <protocol> <password>} where <protocol> could be either
1311"vnc" or "spice".
1312
1313If you would like to change <protocol> password expiration, you should use
1314@code{expire_password <protocol> <expiration-time>} where expiration time could
1315be one of the following options: now, never, +seconds or UNIX time of
1316expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800
1317to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this
1318date and time).
1319
1320You can also use keywords "now" or "never" for the expiration time to
1321allow <protocol> password to expire immediately or never expire.
blueswir15824d652009-03-28 06:44:27 +00001322
Daniel P. Berrange3e305e42015-08-06 14:39:32 +01001323@item tls-creds=@var{ID}
1324
1325Provides the ID of a set of TLS credentials to use to secure the
1326VNC server. They will apply to both the normal VNC server socket
1327and the websocket socket (if enabled). Setting TLS credentials
1328will cause the VNC server socket to enable the VeNCrypt auth
1329mechanism. The credentials should have been previously created
1330using the @option{-object tls-creds} argument.
1331
1332The @option{tls-creds} parameter obsoletes the @option{tls},
1333@option{x509}, and @option{x509verify} options, and as such
1334it is not permitted to set both new and old type options at
1335the same time.
1336
blueswir15824d652009-03-28 06:44:27 +00001337@item tls
1338
1339Require that client use TLS when communicating with the VNC server. This
1340uses anonymous TLS credentials so is susceptible to a man-in-the-middle
1341attack. It is recommended that this option be combined with either the
Kevin Wolf4e257e52009-10-09 10:58:36 +02001342@option{x509} or @option{x509verify} options.
blueswir15824d652009-03-28 06:44:27 +00001343
Daniel P. Berrange3e305e42015-08-06 14:39:32 +01001344This option is now deprecated in favor of using the @option{tls-creds}
1345argument.
1346
blueswir15824d652009-03-28 06:44:27 +00001347@item x509=@var{/path/to/certificate/dir}
1348
1349Valid if @option{tls} is specified. Require that x509 credentials are used
1350for negotiating the TLS session. The server will send its x509 certificate
1351to the client. It is recommended that a password be set on the VNC server
1352to provide authentication of the client when this is used. The path following
1353this option specifies where the x509 certificates are to be loaded from.
1354See the @ref{vnc_security} section for details on generating certificates.
1355
Daniel P. Berrange3e305e42015-08-06 14:39:32 +01001356This option is now deprecated in favour of using the @option{tls-creds}
1357argument.
1358
blueswir15824d652009-03-28 06:44:27 +00001359@item x509verify=@var{/path/to/certificate/dir}
1360
1361Valid if @option{tls} is specified. Require that x509 credentials are used
1362for negotiating the TLS session. The server will send its x509 certificate
1363to the client, and request that the client send its own x509 certificate.
1364The server will validate the client's certificate against the CA certificate,
1365and reject clients when validation fails. If the certificate authority is
1366trusted, this is a sufficient authentication mechanism. You may still wish
1367to set a password on the VNC server as a second authentication layer. The
1368path following this option specifies where the x509 certificates are to
1369be loaded from. See the @ref{vnc_security} section for details on generating
1370certificates.
1371
Daniel P. Berrange3e305e42015-08-06 14:39:32 +01001372This option is now deprecated in favour of using the @option{tls-creds}
1373argument.
1374
blueswir15824d652009-03-28 06:44:27 +00001375@item sasl
1376
1377Require that the client use SASL to authenticate with the VNC server.
1378The exact choice of authentication method used is controlled from the
1379system / user's SASL configuration file for the 'qemu' service. This
1380is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1381unprivileged user, an environment variable SASL_CONF_PATH can be used
1382to make it search alternate locations for the service config.
1383While some SASL auth methods can also provide data encryption (eg GSSAPI),
1384it is recommended that SASL always be combined with the 'tls' and
1385'x509' settings to enable use of SSL and server certificates. This
1386ensures a data encryption preventing compromise of authentication
1387credentials. See the @ref{vnc_security} section for details on using
1388SASL authentication.
1389
1390@item acl
1391
1392Turn on access control lists for checking of the x509 client certificate
1393and SASL party. For x509 certs, the ACL check is made against the
1394certificate's distinguished name. This is something that looks like
1395@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1396made against the username, which depending on the SASL plugin, may
1397include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1398When the @option{acl} flag is set, the initial access list will be
1399empty, with a @code{deny} policy. Thus no one will be allowed to
1400use the VNC server until the ACLs have been loaded. This can be
1401achieved using the @code{acl} monitor command.
1402
Corentin Chary6f9c78c2010-07-07 20:57:51 +02001403@item lossy
1404
1405Enable lossy compression methods (gradient, JPEG, ...). If this
1406option is set, VNC client may receive lossy framebuffer updates
1407depending on its encoding settings. Enabling this option can save
1408a lot of bandwidth at the expense of quality.
1409
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001410@item non-adaptive
1411
1412Disable adaptive encodings. Adaptive encodings are enabled by default.
1413An adaptive encoding will try to detect frequently updated screen regions,
1414and send updates in these regions using a lossy encoding (like JPEG).
Stefan Weil61cc8702011-04-13 22:45:22 +02001415This can be really helpful to save bandwidth when playing videos. Disabling
Michael Tokarev9d85d552014-04-07 13:34:58 +04001416adaptive encodings restores the original static behavior of encodings
Corentin Chary80e0c8c2011-02-04 09:06:08 +01001417like Tight.
1418
Gerd Hoffmann8cf36482011-11-24 18:10:49 +01001419@item share=[allow-exclusive|force-shared|ignore]
1420
1421Set display sharing policy. 'allow-exclusive' allows clients to ask
1422for exclusive access. As suggested by the rfb spec this is
1423implemented by dropping other connections. Connecting multiple
1424clients in parallel requires all clients asking for a shared session
1425(vncviewer: -shared switch). This is the default. 'force-shared'
1426disables exclusive client access. Useful for shared desktop sessions,
1427where you don't want someone forgetting specify -shared disconnect
1428everybody else. 'ignore' completely ignores the shared flag and
1429allows everybody connect unconditionally. Doesn't conform to the rfb
Stefan Weilb65ee4f2012-05-11 22:25:50 +02001430spec but is traditional QEMU behavior.
Gerd Hoffmann8cf36482011-11-24 18:10:49 +01001431
Gerd Hoffmannc5ce8332016-06-01 08:22:30 +02001432@item key-delay-ms
1433
1434Set keyboard delay, for key down and key up events, in milliseconds.
1435Default is 1. Keyboards are low-bandwidth devices, so this slowdown
1436can help the device and guest to keep up and not lose events in case
1437events are arriving in bulk. Possible causes for the latter are flaky
1438network connections, or scripts for automated testing.
1439
blueswir15824d652009-03-28 06:44:27 +00001440@end table
1441ETEXI
1442
1443STEXI
1444@end table
1445ETEXI
Michael Ellermana3adb7a2011-12-19 17:19:31 +11001446ARCHHEADING(, QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001447
Michael Ellermana3adb7a2011-12-19 17:19:31 +11001448ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001449STEXI
1450@table @option
1451ETEXI
1452
blueswir15824d652009-03-28 06:44:27 +00001453DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
Blue Swirlad960902010-03-29 19:23:52 +00001454 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1455 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001456STEXI
1457@item -win2k-hack
Stefan Weil6616b2a2010-02-05 23:52:05 +01001458@findex -win2k-hack
blueswir15824d652009-03-28 06:44:27 +00001459Use it when installing Windows 2000 to avoid a disk full bug. After
1460Windows 2000 is installed, you no longer need this option (this option
1461slows down the IDE transfers).
1462ETEXI
1463
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02001464HXCOMM Deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00001465DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001466
blueswir15824d652009-03-28 06:44:27 +00001467DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
Blue Swirlad960902010-03-29 19:23:52 +00001468 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1469 QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001470STEXI
1471@item -no-fd-bootchk
Stefan Weil6616b2a2010-02-05 23:52:05 +01001472@findex -no-fd-bootchk
Markus Armbruster4eda32f2013-06-14 13:15:06 +02001473Disable boot signature checking for floppy disks in BIOS. May
blueswir15824d652009-03-28 06:44:27 +00001474be needed to boot from old floppy disks.
1475ETEXI
1476
blueswir15824d652009-03-28 06:44:27 +00001477DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
Shannon Zhaof5d8c8c2015-05-29 11:28:54 +01001478 "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM)
blueswir15824d652009-03-28 06:44:27 +00001479STEXI
1480@item -no-acpi
Stefan Weil6616b2a2010-02-05 23:52:05 +01001481@findex -no-acpi
blueswir15824d652009-03-28 06:44:27 +00001482Disable ACPI (Advanced Configuration and Power Interface) support. Use
1483it if your guest OS complains about ACPI problems (PC target machine
1484only).
1485ETEXI
1486
blueswir15824d652009-03-28 06:44:27 +00001487DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
Blue Swirlad960902010-03-29 19:23:52 +00001488 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001489STEXI
1490@item -no-hpet
Stefan Weil6616b2a2010-02-05 23:52:05 +01001491@findex -no-hpet
blueswir15824d652009-03-28 06:44:27 +00001492Disable HPET support.
1493ETEXI
1494
blueswir15824d652009-03-28 06:44:27 +00001495DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
Michael Tokarev104bf022011-05-12 18:44:17 +04001496 "-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 +00001497 " ACPI table description\n", QEMU_ARCH_I386)
blueswir15824d652009-03-28 06:44:27 +00001498STEXI
1499@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 +01001500@findex -acpitable
blueswir15824d652009-03-28 06:44:27 +00001501Add ACPI table with specified header fields and context from specified files.
Michael Tokarev104bf022011-05-12 18:44:17 +04001502For file=, take whole ACPI table from the specified files, including all
1503ACPI headers (possible overridden by other options).
1504For data=, only data
1505portion of the table is used, all header information is specified in the
1506command line.
Laszlo Ersekae123742016-01-18 15:12:13 +01001507If a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id
1508fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order
1509to ensure the field matches required by the Microsoft SLIC spec and the ACPI
1510spec.
blueswir15824d652009-03-28 06:44:27 +00001511ETEXI
1512
aliguorib6f6e3d2009-04-17 18:59:56 +00001513DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1514 "-smbios file=binary\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001515 " load SMBIOS entry from binary file\n"
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001516 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1517 " [,uefi=on|off]\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001518 " specify SMBIOS type 0 fields\n"
aliguorib6f6e3d2009-04-17 18:59:56 +00001519 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1520 " [,uuid=uuid][,sku=str][,family=str]\n"
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001521 " specify SMBIOS type 1 fields\n"
1522 "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1523 " [,asset=str][,location=str]\n"
1524 " specify SMBIOS type 2 fields\n"
1525 "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n"
1526 " [,sku=str]\n"
1527 " specify SMBIOS type 3 fields\n"
1528 "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n"
1529 " [,asset=str][,part=str]\n"
1530 " specify SMBIOS type 4 fields\n"
1531 "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n"
Gabriel L. Somlo3ebd6cc2015-03-11 13:58:01 -04001532 " [,asset=str][,part=str][,speed=%d]\n"
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001533 " specify SMBIOS type 17 fields\n",
Wei Huangc30e1562015-09-07 10:39:29 +01001534 QEMU_ARCH_I386 | QEMU_ARCH_ARM)
aliguorib6f6e3d2009-04-17 18:59:56 +00001535STEXI
1536@item -smbios file=@var{binary}
Stefan Weil6616b2a2010-02-05 23:52:05 +01001537@findex -smbios
aliguorib6f6e3d2009-04-17 18:59:56 +00001538Load SMBIOS entry from binary file.
1539
Gabriel L. Somlo84351842014-05-19 10:09:54 -04001540@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 +00001541Specify SMBIOS type 0 fields
1542
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001543@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 +00001544Specify SMBIOS type 1 fields
Gabriel L. Somlob155eb12015-02-05 11:45:30 -05001545
1546@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}]
1547Specify SMBIOS type 2 fields
1548
1549@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}]
1550Specify SMBIOS type 3 fields
1551
1552@item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}]
1553Specify SMBIOS type 4 fields
1554
Gabriel L. Somlo3ebd6cc2015-03-11 13:58:01 -04001555@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 -05001556Specify SMBIOS type 17 fields
aliguorib6f6e3d2009-04-17 18:59:56 +00001557ETEXI
1558
blueswir15824d652009-03-28 06:44:27 +00001559STEXI
1560@end table
1561ETEXI
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01001562DEFHEADING()
blueswir15824d652009-03-28 06:44:27 +00001563
1564DEFHEADING(Network options:)
1565STEXI
1566@table @option
1567ETEXI
1568
Jan Kiszkaad196a92009-06-24 14:42:28 +02001569HXCOMM Legacy slirp options (now moved to -net user):
1570#ifdef CONFIG_SLIRP
Blue Swirlad960902010-03-29 19:23:52 +00001571DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1572DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1573DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001574#ifndef _WIN32
Blue Swirlad960902010-03-29 19:23:52 +00001575DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
Jan Kiszkaad196a92009-06-24 14:42:28 +02001576#endif
1577#endif
1578
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001579DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
blueswir15824d652009-03-28 06:44:27 +00001580#ifdef CONFIG_SLIRP
Samuel Thibault0b11c032016-03-20 12:29:54 +01001581 "-netdev user,id=str[,ipv4[=on|off]][,net=addr[/mask]][,host=addr]\n"
1582 " [,ipv6[=on|off]][,ipv6-net=addr[/int]][,ipv6-host=addr]\n"
1583 " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n"
Samuel Thibaultd8eb3862016-03-25 00:02:58 +01001584 " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,tftp=dir]\n"
Klaus Stengel63d29602012-10-27 19:53:39 +02001585 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001586#ifndef _WIN32
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001587 "[,smb=dir[,smbserver=addr]]\n"
Jan Kiszkaad196a92009-06-24 14:42:28 +02001588#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001589 " configure a user mode network backend with ID 'str',\n"
1590 " its DHCP server and optional services\n"
blueswir15824d652009-03-28 06:44:27 +00001591#endif
1592#ifdef _WIN32
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001593 "-netdev tap,id=str,ifname=name\n"
1594 " configure a host TAP network backend with ID 'str'\n"
blueswir15824d652009-03-28 06:44:27 +00001595#else
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001596 "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n"
1597 " [,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n"
1598 " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n"
Jason Wang69e87b32016-07-06 09:57:55 +08001599 " [,poll-us=n]\n"
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001600 " configure a host TAP network backend with ID 'str'\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001601 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1602 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1603 " to deconfigure it\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001604 " use '[down]script=no' to disable script execution\n"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001605 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
1606 " configure it\n"
blueswir15824d652009-03-28 06:44:27 +00001607 " use 'fd=h' to connect to an already opened TAP interface\n"
Jason Wang2ca81ba2013-02-20 18:04:01 +08001608 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001609 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
Michael S. Tsirkinf157ed22011-02-01 14:25:40 +02001610 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001611 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1612 " 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 +02001613 " use vhost=on to enable experimental in kernel accelerator\n"
mst@redhat.com5430a282011-02-01 22:13:42 +02001614 " (only has effect for virtio guests which use MSIX)\n"
1615 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
Michael S. Tsirkin82b0d802010-03-17 13:08:24 +02001616 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
Jason Wang2ca81ba2013-02-20 18:04:01 +08001617 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n"
Jason Wangec396012013-02-22 22:57:52 +08001618 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n"
Jason Wang69e87b32016-07-06 09:57:55 +08001619 " use 'poll-us=n' to speciy the maximum number of microseconds that could be\n"
1620 " spent on busy polling for vhost net\n"
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001621 "-netdev bridge,id=str[,br=bridge][,helper=helper]\n"
1622 " configure a host TAP network backend with ID 'str' that is\n"
1623 " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n"
1624 " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n"
Mark McLoughlin0df0ff62009-06-18 18:21:34 +01001625#endif
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001626#ifdef __linux__
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001627 "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n"
1628 " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n"
1629 " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n"
1630 " [,rxcookie=rxcookie][,offset=offset]\n"
1631 " configure a network backend with ID 'str' connected to\n"
1632 " an Ethernet over L2TPv3 pseudowire.\n"
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001633 " Linux kernel 3.3+ as well as most routers can talk\n"
Michael Tokarev2f47b402014-07-24 20:10:17 +04001634 " L2TPv3. This transport allows connecting a VM to a VM,\n"
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001635 " VM to a router and even VM to Host. It is a nearly-universal\n"
1636 " standard (RFC3391). Note - this implementation uses static\n"
1637 " pre-configured tunnels (same as the Linux kernel).\n"
1638 " use 'src=' to specify source address\n"
1639 " use 'dst=' to specify destination address\n"
1640 " use 'udp=on' to specify udp encapsulation\n"
Gonglei39526512014-08-14 14:35:48 +08001641 " use 'srcport=' to specify source udp port\n"
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01001642 " use 'dstport=' to specify destination udp port\n"
1643 " use 'ipv6=on' to force v6\n"
1644 " L2TPv3 uses cookies to prevent misconfiguration as\n"
1645 " well as a weak security measure\n"
1646 " use 'rxcookie=0x012345678' to specify a rxcookie\n"
1647 " use 'txcookie=0x012345678' to specify a txcookie\n"
1648 " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n"
1649 " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n"
1650 " use 'pincounter=on' to work around broken counter handling in peer\n"
1651 " use 'offset=X' to add an extra offset between header and data\n"
1652#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001653 "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n"
1654 " configure a network backend to connect to another network\n"
1655 " using a socket connection\n"
1656 "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1657 " configure a network backend to connect to a multicast maddr and port\n"
Mike Ryan3a75e742010-12-01 11:16:47 -08001658 " use 'localaddr=addr' to specify the host address to send packets from\n"
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001659 "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n"
1660 " configure a network backend to connect to another network\n"
1661 " using an UDP tunnel\n"
blueswir15824d652009-03-28 06:44:27 +00001662#ifdef CONFIG_VDE
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001663 "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1664 " configure a network backend to connect to port 'n' of a vde switch\n"
1665 " running on host and listening for incoming connections on 'socketpath'.\n"
blueswir15824d652009-03-28 06:44:27 +00001666 " Use group 'groupname' and mode 'octalmode' to change default\n"
1667 " ownership and permissions for communication port.\n"
1668#endif
Vincenzo Maffione58952132013-11-06 11:44:06 +01001669#ifdef CONFIG_NETMAP
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001670 "-netdev netmap,id=str,ifname=name[,devname=nmname]\n"
Vincenzo Maffione58952132013-11-06 11:44:06 +01001671 " attach to the existing netmap-enabled network interface 'name', or to a\n"
1672 " VALE port (created on the fly) called 'name' ('nmname' is name of the \n"
1673 " netmap device, defaults to '/dev/netmap')\n"
1674#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001675 "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n"
1676 " configure a vhost-user network, backed by a chardev 'dev'\n"
1677 "-netdev hubport,id=str,hubid=n\n"
1678 " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL)
1679DEF("net", HAS_ARG, QEMU_OPTION_net,
1680 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1681 " old way to create a new NIC and connect it to VLAN 'n'\n"
1682 " (use the '-device devtype,netdev=str' option if possible instead)\n"
aliguoribb9ea792009-04-21 19:56:28 +00001683 "-net dump[,vlan=n][,file=f][,len=n]\n"
1684 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
Bruce Rogersca1a8a02010-01-06 12:33:57 -07001685 "-net none use it alone to have zero network devices. If no -net option\n"
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001686 " is provided, the default is '-net nic -net user'\n"
1687 "-net ["
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001688#ifdef CONFIG_SLIRP
1689 "user|"
1690#endif
1691 "tap|"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001692 "bridge|"
Mark McLoughlina1ea4582009-10-08 19:58:26 +01001693#ifdef CONFIG_VDE
1694 "vde|"
1695#endif
Vincenzo Maffione58952132013-11-06 11:44:06 +01001696#ifdef CONFIG_NETMAP
1697 "netmap|"
1698#endif
Thomas Huth6a8b4a52015-05-15 16:58:24 +02001699 "socket][,vlan=n][,option][,option][,...]\n"
1700 " old way to initialize a host network interface\n"
1701 " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00001702STEXI
Blue Swirl609c1da2010-03-18 18:41:49 +00001703@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 +01001704@findex -net
blueswir15824d652009-03-28 06:44:27 +00001705Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
Anthony Liguori0d6b0b12009-08-14 11:20:47 -05001706= 0 is the default). The NIC is an e1000 by default on the PC
Markus Armbruster5607c382009-06-18 15:14:08 +02001707target. Optionally, the MAC address can be changed to @var{mac}, the
1708device address set to @var{addr} (PCI cards only),
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001709and a @var{name} can be assigned for use in monitor commands.
1710Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1711that the card should have; this option currently only affects virtio cards; set
1712@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
Stefan Weil071c9392012-04-07 09:23:36 +02001713NIC is created. QEMU can emulate several different models of network card.
blueswir15824d652009-03-28 06:44:27 +00001714Valid values for @var{type} are
Michael S. Tsirkinffe63702009-06-21 19:51:18 +03001715@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
blueswir15824d652009-03-28 06:44:27 +00001716@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1717@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
Peter Maydell585f6032012-10-04 16:22:01 +01001718Not all devices are supported on all targets. Use @code{-net nic,model=help}
blueswir15824d652009-03-28 06:44:27 +00001719for a list of available devices for your target.
1720
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001721@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
Markus Armbrusterb8f490e2013-02-13 19:49:38 +01001722@findex -netdev
Jan Kiszkaad196a92009-06-24 14:42:28 +02001723@item -net user[,@var{option}][,@var{option}][,...]
blueswir15824d652009-03-28 06:44:27 +00001724Use the user mode network stack which requires no administrator
Jan Kiszkaad196a92009-06-24 14:42:28 +02001725privilege to run. Valid options are:
blueswir15824d652009-03-28 06:44:27 +00001726
Kevin Wolfb3f046c2009-10-09 10:58:35 +02001727@table @option
Jan Kiszkaad196a92009-06-24 14:42:28 +02001728@item vlan=@var{n}
1729Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1730
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001731@item id=@var{id}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001732@itemx name=@var{name}
Jan Kiszkaad196a92009-06-24 14:42:28 +02001733Assign symbolic name for use in monitor commands.
1734
Samuel Thibault0b11c032016-03-20 12:29:54 +01001735@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must
1736be enabled. If neither is specified both protocols are enabled.
1737
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001738@item net=@var{addr}[/@var{mask}]
1739Set IP network address the guest will see. Optionally specify the netmask,
1740either in the form a.b.c.d or as number of valid top-most bits. Default is
Brad Hardsb0b36e52011-04-24 17:19:56 +1000174110.0.2.0/24.
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001742
1743@item host=@var{addr}
1744Specify the guest-visible address of the host. Default is the 2nd IP in the
1745guest network, i.e. x.x.x.2.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001746
Samuel Thibaultd8eb3862016-03-25 00:02:58 +01001747@item ipv6-net=@var{addr}[/@var{int}]
1748Set IPv6 network address the guest will see (default is fec0::/64). The
1749network prefix is given in the usual hexadecimal IPv6 address
1750notation. The prefix size is optional, and is given as the number of
1751valid top-most bits (default is 64).
Yann Bordenave7aac5312016-03-15 10:31:22 +01001752
Samuel Thibaultd8eb3862016-03-25 00:02:58 +01001753@item ipv6-host=@var{addr}
Yann Bordenave7aac5312016-03-15 10:31:22 +01001754Specify the guest-visible IPv6 address of the host. Default is the 2nd IPv6 in
1755the guest network, i.e. xxxx::2.
1756
Jan Kiszkac54ed5b2011-07-20 12:20:14 +02001757@item restrict=on|off
Brad Hardscaef55e2011-06-09 07:50:43 +10001758If this option is enabled, the guest will be isolated, i.e. it will not be
Jan Kiszkaad196a92009-06-24 14:42:28 +02001759able to contact the host and no guest IP packets will be routed over the host
Brad Hardscaef55e2011-06-09 07:50:43 +10001760to the outside. This option does not affect any explicitly set forwarding rules.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001761
1762@item hostname=@var{name}
Klaus Stengel63d29602012-10-27 19:53:39 +02001763Specifies the client hostname reported by the built-in DHCP server.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001764
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001765@item dhcpstart=@var{addr}
1766Specify the first of the 16 IPs the built-in DHCP server can assign. Default
Brad Hardsb0b36e52011-04-24 17:19:56 +10001767is 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 +02001768
1769@item dns=@var{addr}
1770Specify the guest-visible address of the virtual nameserver. The address must
1771be different from the host address. Default is the 3rd IP in the guest network,
1772i.e. x.x.x.3.
1773
Samuel Thibaultd8eb3862016-03-25 00:02:58 +01001774@item ipv6-dns=@var{addr}
Yann Bordenave7aac5312016-03-15 10:31:22 +01001775Specify the guest-visible address of the IPv6 virtual nameserver. The address
1776must be different from the host address. Default is the 3rd IP in the guest
1777network, i.e. xxxx::3.
1778
Klaus Stengel63d29602012-10-27 19:53:39 +02001779@item dnssearch=@var{domain}
1780Provides an entry for the domain-search list sent by the built-in
1781DHCP server. More than one domain suffix can be transmitted by specifying
1782this option multiple times. If supported, this will cause the guest to
1783automatically try to append the given domain suffix(es) in case a domain name
1784can not be resolved.
1785
1786Example:
1787@example
1788qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...]
1789@end example
1790
Jan Kiszkaad196a92009-06-24 14:42:28 +02001791@item tftp=@var{dir}
1792When using the user mode network stack, activate a built-in TFTP
1793server. The files in @var{dir} will be exposed as the root of a TFTP server.
1794The TFTP client on the guest must be configured in binary mode (use the command
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001795@code{bin} of the Unix TFTP client).
Jan Kiszkaad196a92009-06-24 14:42:28 +02001796
1797@item bootfile=@var{file}
1798When using the user mode network stack, broadcast @var{file} as the BOOTP
1799filename. In conjunction with @option{tftp}, this can be used to network boot
1800a guest from a local directory.
1801
1802Example (using pxelinux):
1803@example
Stefan Weil3804da92012-05-11 22:21:50 +02001804qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
Jan Kiszkaad196a92009-06-24 14:42:28 +02001805@end example
1806
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001807@item smb=@var{dir}[,smbserver=@var{addr}]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001808When using the user mode network stack, activate a built-in SMB
1809server so that Windows OSes can access to the host files in @file{@var{dir}}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001810transparently. The IP address of the SMB server can be set to @var{addr}. By
1811default the 4th IP in the guest network is used, i.e. x.x.x.4.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001812
1813In the guest Windows OS, the line:
1814@example
181510.0.2.4 smbserver
1816@end example
1817must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1818or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1819
1820Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1821
Brade2d88302011-09-02 16:53:28 -04001822Note that a SAMBA server must be installed on the host OS.
1823QEMU was tested successfully with smbd versions from Red Hat 9,
1824Fedora Core 3 and OpenSUSE 11.x.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001825
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001826@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001827Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1828the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1829@var{guestaddr} is not specified, its value is x.x.x.15 (default first address
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001830given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1831be bound to a specific host interface. If no connection type is set, TCP is
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001832used. This option can be given multiple times.
Jan Kiszkaad196a92009-06-24 14:42:28 +02001833
1834For example, to redirect host X11 connection from screen 1 to guest
1835screen 0, use the following:
1836
1837@example
1838# on the host
Stefan Weil3804da92012-05-11 22:21:50 +02001839qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001840# this host xterm should open in the guest X11 server
1841xterm -display :1
1842@end example
1843
1844To redirect telnet connections from host port 5555 to telnet port on
1845the guest, use the following:
1846
1847@example
1848# on the host
Stefan Weil3804da92012-05-11 22:21:50 +02001849qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
Jan Kiszkaad196a92009-06-24 14:42:28 +02001850telnet localhost 5555
1851@end example
1852
1853Then when you use on the host @code{telnet localhost 5555}, you
1854connect to the guest telnet server.
1855
Jan Kiszkac92ef6a2009-06-24 14:42:28 +02001856@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001857@itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
Jan Kiszka3c6a0582009-06-24 14:42:28 +02001858Forward guest TCP connections to the IP address @var{server} on port @var{port}
Alexander Grafb412eb62012-06-03 09:45:01 +02001859to the character device @var{dev} or to a program executed by @var{cmd:command}
1860which gets spawned for each connection. This option can be given multiple times.
1861
Stefan Weil43ffe612012-07-20 23:26:02 +02001862You can either use a chardev directly and have that one used throughout QEMU's
Alexander Grafb412eb62012-06-03 09:45:01 +02001863lifetime, like in the following example:
1864
1865@example
1866# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
1867# the guest accesses it
1868qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...]
1869@end example
1870
1871Or you can execute a command on every TCP connection established by the guest,
Stefan Weil43ffe612012-07-20 23:26:02 +02001872so that QEMU behaves similar to an inetd process for that virtual server:
Alexander Grafb412eb62012-06-03 09:45:01 +02001873
1874@example
1875# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234
1876# and connect the TCP stream to its stdin/stdout
1877qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
1878@end example
Jan Kiszkaad196a92009-06-24 14:42:28 +02001879
1880@end table
1881
1882Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1883processed and applied to -net user. Mixing them with the new configuration
1884syntax gives undefined results. Their use for new applications is discouraged
1885as they will be removed from future versions.
blueswir15824d652009-03-28 06:44:27 +00001886
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001887@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 +02001888@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 -05001889Connect the host TAP network interface @var{name} to VLAN @var{n}.
1890
1891Use the network script @var{file} to configure it and the network script
blueswir15824d652009-03-28 06:44:27 +00001892@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001893automatically provides one. The default network configure script is
1894@file{/etc/qemu-ifup} and the default network deconfigure script is
1895@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1896to disable script execution.
1897
1898If running QEMU as an unprivileged user, use the network helper
1899@var{helper} to configure the TAP interface. The default network
Amos Kong420508f2013-10-23 04:49:28 +08001900helper executable is @file{/path/to/qemu-bridge-helper}.
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001901
1902@option{fd}=@var{h} can be used to specify the handle of an already
1903opened host TAP interface.
1904
1905Examples:
blueswir15824d652009-03-28 06:44:27 +00001906
1907@example
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001908#launch a QEMU instance with the default network script
Stefan Weil3804da92012-05-11 22:21:50 +02001909qemu-system-i386 linux.img -net nic -net tap
blueswir15824d652009-03-28 06:44:27 +00001910@end example
1911
blueswir15824d652009-03-28 06:44:27 +00001912@example
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001913#launch a QEMU instance with two NICs, each one connected
1914#to a TAP device
Stefan Weil3804da92012-05-11 22:21:50 +02001915qemu-system-i386 linux.img \
1916 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1917 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
blueswir15824d652009-03-28 06:44:27 +00001918@end example
1919
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001920@example
1921#launch a QEMU instance with the default network helper to
1922#connect a TAP device to bridge br0
Stefan Weil3804da92012-05-11 22:21:50 +02001923qemu-system-i386 linux.img \
Amos Kong420508f2013-10-23 04:49:28 +08001924 -net nic -net tap,"helper=/path/to/qemu-bridge-helper"
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001925@end example
1926
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001927@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001928@itemx -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001929Connect a host TAP network interface to a host bridge device.
1930
1931Use the network helper @var{helper} to configure the TAP interface and
1932attach it to the bridge. The default network helper executable is
Amos Kong420508f2013-10-23 04:49:28 +08001933@file{/path/to/qemu-bridge-helper} and the default bridge
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001934device is @file{br0}.
1935
1936Examples:
1937
1938@example
1939#launch a QEMU instance with the default network helper to
1940#connect a TAP device to bridge br0
Stefan Weil3804da92012-05-11 22:21:50 +02001941qemu-system-i386 linux.img -net bridge -net nic,model=virtio
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001942@end example
1943
1944@example
1945#launch a QEMU instance with the default network helper to
1946#connect a TAP device to bridge qemubr0
Stefan Weil3804da92012-05-11 22:21:50 +02001947qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
Corey Bryanta7c36ee2012-01-26 09:42:27 -05001948@end example
1949
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001950@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 +02001951@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 +00001952
1953Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1954machine using a TCP socket connection. If @option{listen} is
1955specified, QEMU waits for incoming connections on @var{port}
1956(@var{host} is optional). @option{connect} is used to connect to
1957another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1958specifies an already opened TCP socket.
1959
1960Example:
1961@example
1962# launch a first QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02001963qemu-system-i386 linux.img \
1964 -net nic,macaddr=52:54:00:12:34:56 \
1965 -net socket,listen=:1234
blueswir15824d652009-03-28 06:44:27 +00001966# connect the VLAN 0 of this instance to the VLAN 0
1967# of the first instance
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,connect=127.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001971@end example
1972
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01001973@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02001974@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 +00001975
1976Create a VLAN @var{n} shared with another QEMU virtual
1977machines using a UDP multicast socket, effectively making a bus for
1978every QEMU with same multicast address @var{maddr} and @var{port}.
1979NOTES:
1980@enumerate
1981@item
1982Several QEMU can be running on different hosts and share same bus (assuming
1983correct multicast setup for these hosts).
1984@item
1985mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1986@url{http://user-mode-linux.sf.net}.
1987@item
1988Use @option{fd=h} to specify an already opened UDP multicast socket.
1989@end enumerate
1990
1991Example:
1992@example
1993# launch one QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02001994qemu-system-i386 linux.img \
1995 -net nic,macaddr=52:54:00:12:34:56 \
1996 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00001997# launch another QEMU instance on same "bus"
Stefan Weil3804da92012-05-11 22:21:50 +02001998qemu-system-i386 linux.img \
1999 -net nic,macaddr=52:54:00:12:34:57 \
2000 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00002001# launch yet another QEMU instance on same "bus"
Stefan Weil3804da92012-05-11 22:21:50 +02002002qemu-system-i386 linux.img \
2003 -net nic,macaddr=52:54:00:12:34:58 \
2004 -net socket,mcast=230.0.0.1:1234
blueswir15824d652009-03-28 06:44:27 +00002005@end example
2006
2007Example (User Mode Linux compat.):
2008@example
2009# launch QEMU instance (note mcast address selected
2010# is UML's default)
Stefan Weil3804da92012-05-11 22:21:50 +02002011qemu-system-i386 linux.img \
2012 -net nic,macaddr=52:54:00:12:34:56 \
2013 -net socket,mcast=239.192.168.1:1102
blueswir15824d652009-03-28 06:44:27 +00002014# launch UML
2015/path/to/linux ubd0=/path/to/root_fs eth0=mcast
2016@end example
2017
Mike Ryan3a75e742010-12-01 11:16:47 -08002018Example (send packets from host's 1.2.3.4):
2019@example
Stefan Weil3804da92012-05-11 22:21:50 +02002020qemu-system-i386 linux.img \
2021 -net nic,macaddr=52:54:00:12:34:56 \
2022 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
Mike Ryan3a75e742010-12-01 11:16:47 -08002023@end example
2024
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01002025@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 +02002026@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 +01002027Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular
2028protocol to transport Ethernet (and other Layer 2) data frames between
2029two systems. It is present in routers, firewalls and the Linux kernel
2030(from version 3.3 onwards).
2031
2032This transport allows a VM to communicate to another VM, router or firewall directly.
2033
2034@item src=@var{srcaddr}
2035 source address (mandatory)
2036@item dst=@var{dstaddr}
2037 destination address (mandatory)
2038@item udp
2039 select udp encapsulation (default is ip).
2040@item srcport=@var{srcport}
2041 source udp port.
2042@item dstport=@var{dstport}
2043 destination udp port.
2044@item ipv6
2045 force v6, otherwise defaults to v4.
2046@item rxcookie=@var{rxcookie}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02002047@itemx txcookie=@var{txcookie}
Anton Ivanov3fb69aa2014-06-20 10:34:41 +01002048 Cookies are a weak form of security in the l2tpv3 specification.
2049Their function is mostly to prevent misconfiguration. By default they are 32
2050bit.
2051@item cookie64
2052 Set cookie size to 64 bit instead of the default 32
2053@item counter=off
2054 Force a 'cut-down' L2TPv3 with no counter as in
2055draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
2056@item pincounter=on
2057 Work around broken counter handling in peer. This may also help on
2058networks which have packet reorder.
2059@item offset=@var{offset}
2060 Add an extra offset between header and data
2061
2062For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan
2063on the remote Linux host 1.2.3.4:
2064@example
2065# Setup tunnel on linux host using raw ip as encapsulation
2066# on 1.2.3.4
2067ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \
2068 encap udp udp_sport 16384 udp_dport 16384
2069ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \
2070 0xFFFFFFFF peer_session_id 0xFFFFFFFF
2071ifconfig vmtunnel0 mtu 1500
2072ifconfig vmtunnel0 up
2073brctl addif br-lan vmtunnel0
2074
2075
2076# on 4.3.2.1
2077# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
2078
2079qemu-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
2080
2081
2082@end example
2083
Stefan Hajnoczi08d12022012-08-14 14:14:27 +01002084@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 +02002085@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 +00002086Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
2087listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
2088and MODE @var{octalmode} to change default ownership and permissions for
Stefan Weilc1ba4e02011-09-05 18:13:03 +02002089communication port. This option is only available if QEMU has been compiled
blueswir15824d652009-03-28 06:44:27 +00002090with vde support enabled.
2091
2092Example:
2093@example
2094# launch vde switch
2095vde_switch -F -sock /tmp/myswitch
2096# launch QEMU instance
Stefan Weil3804da92012-05-11 22:21:50 +02002097qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
blueswir15824d652009-03-28 06:44:27 +00002098@end example
2099
Stefan Hajnoczi40e8c262013-02-26 11:07:16 +01002100@item -netdev hubport,id=@var{id},hubid=@var{hubid}
2101
2102Create a hub port on QEMU "vlan" @var{hubid}.
2103
2104The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single
2105netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the
2106required hub automatically.
2107
Changchun Ouyangb931bfb2015-09-23 12:20:00 +08002108@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n]
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03002109
2110Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should
2111be a unix domain socket backed one. The vhost-user uses a specifically defined
2112protocol to pass vhost ioctl replacement messages to an application on the other
2113end of the socket. On non-MSIX guests, the feature can be forced with
Changchun Ouyangb931bfb2015-09-23 12:20:00 +08002114@var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to
2115be created for multiqueue vhost-user.
Nikolay Nikolaev03ce5742014-06-10 13:02:16 +03002116
2117Example:
2118@example
2119qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
2120 -numa node,memdev=mem \
2121 -chardev socket,path=/path/to/socket \
2122 -netdev type=vhost-user,id=net0,chardev=chr0 \
2123 -device virtio-net-pci,netdev=net0
2124@end example
2125
aliguoribb9ea792009-04-21 19:56:28 +00002126@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
2127Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
2128At most @var{len} bytes (64k by default) per packet are stored. The file format is
2129libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
Thomas Huthd3e0c032015-10-13 12:40:02 +02002130Note: For devices created with '-netdev', use '-object filter-dump,...' instead.
aliguoribb9ea792009-04-21 19:56:28 +00002131
blueswir15824d652009-03-28 06:44:27 +00002132@item -net none
2133Indicate that no network devices should be configured. It is used to
2134override the default configuration (@option{-net nic -net user}) which
2135is activated if no @option{-net} options are provided.
blueswir15824d652009-03-28 06:44:27 +00002136ETEXI
2137
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002138STEXI
2139@end table
2140ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002141DEFHEADING()
2142
2143DEFHEADING(Character device options:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002144STEXI
2145
2146The general form of a character device option is:
2147@table @option
2148ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002149
2150DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002151 "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Corey Minyard5dd1f022014-10-02 11:17:37 -05002152 "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n"
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002153 " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off]\n"
Daniel P. Berrangea8fb5422016-01-19 11:14:31 +00002154 " [,logfile=PATH][,logappend=on|off][,tls-creds=ID] (tcp)\n"
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002155 "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds]\n"
2156 " [,mux=on|off][,logfile=PATH][,logappend=on|off] (unix)\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002157 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
Jan Kiszka97331282010-04-06 16:55:54 +02002158 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002159 " [,logfile=PATH][,logappend=on|off]\n"
2160 "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002161 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002162 " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2163 "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n"
2164 "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2165 "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002166#ifdef _WIN32
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002167 "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2168 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002169#else
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002170 "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2171 "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002172#endif
2173#ifdef CONFIG_BRLAPI
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002174 "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002175#endif
2176#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
2177 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002178 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2179 "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002180#endif
2181#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002182 "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
2183 "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
Matthew Booth7273a2d2009-10-30 13:41:12 +00002184#endif
Alon Levycbcc6332011-01-19 10:49:50 +02002185#if defined(CONFIG_SPICE)
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002186 "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
2187 "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
Alon Levycbcc6332011-01-19 10:49:50 +02002188#endif
Blue Swirlad960902010-03-29 19:23:52 +00002189 , QEMU_ARCH_ALL
Matthew Booth7273a2d2009-10-30 13:41:12 +00002190)
2191
2192STEXI
Jan Kiszka97331282010-04-06 16:55:54 +02002193@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002194@findex -chardev
Matthew Booth7273a2d2009-10-30 13:41:12 +00002195Backend is one of:
2196@option{null},
2197@option{socket},
2198@option{udp},
2199@option{msmouse},
2200@option{vc},
Markus Armbruster4f573782013-07-26 16:44:32 +02002201@option{ringbuf},
Matthew Booth7273a2d2009-10-30 13:41:12 +00002202@option{file},
2203@option{pipe},
2204@option{console},
2205@option{serial},
2206@option{pty},
2207@option{stdio},
2208@option{braille},
2209@option{tty},
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002210@option{parallel},
Alon Levycbcc6332011-01-19 10:49:50 +02002211@option{parport},
2212@option{spicevmc}.
Marc-André Lureau5a49d3e2012-12-05 16:15:34 +01002213@option{spiceport}.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002214The specific backend will determine the applicable options.
2215
2216All devices must have an id, which can be any string up to 127 characters long.
2217It is used to uniquely identify this device in other command line directives.
2218
Jan Kiszka97331282010-04-06 16:55:54 +02002219A character device may be used in multiplexing mode by multiple front-ends.
Peter Maydella40db1b2016-02-16 17:28:58 +00002220Specify @option{mux=on} to enable this mode.
2221A multiplexer is a "1:N" device, and here the "1" end is your specified chardev
2222backend, and the "N" end is the various parts of QEMU that can talk to a chardev.
2223If you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will
2224create a multiplexer with your specified ID, and you can then configure multiple
2225front ends to use that chardev ID for their input/output. Up to four different
2226front ends can be connected to a single multiplexed chardev. (Without
2227multiplexing enabled, a chardev can only be used by a single front end.)
2228For instance you could use this to allow a single stdio chardev to be used by
2229two serial ports and the QEMU monitor:
2230
2231@example
2232-chardev stdio,mux=on,id=char0 \
2233-mon chardev=char0,mode=readline,default \
2234-serial chardev:char0 \
2235-serial chardev:char0
2236@end example
2237
2238You can have more than one multiplexer in a system configuration; for instance
2239you could have a TCP port multiplexed between UART 0 and UART 1, and stdio
2240multiplexed between the QEMU monitor and a parallel port:
2241
2242@example
2243-chardev stdio,mux=on,id=char0 \
2244-mon chardev=char0,mode=readline,default \
2245-parallel chardev:char0 \
2246-chardev tcp,...,mux=on,id=char1 \
2247-serial chardev:char1 \
2248-serial chardev:char1
2249@end example
2250
2251When you're using a multiplexed character device, some escape sequences are
2252interpreted in the input. @xref{mux_keys, Keys in the character backend
2253multiplexer}.
2254
2255Note that some other command line options may implicitly create multiplexed
2256character backends; for instance @option{-serial mon:stdio} creates a
2257multiplexed stdio backend connected to the serial port and the QEMU monitor,
2258and @option{-nographic} also multiplexes the console and the monitor to
2259stdio.
2260
2261There is currently no support for multiplexing in the other direction
2262(where a single QEMU front end takes input and output from multiple chardevs).
Jan Kiszka97331282010-04-06 16:55:54 +02002263
Daniel P. Berranged0d77082016-01-11 12:44:41 +00002264Every backend supports the @option{logfile} option, which supplies the path
2265to a file to record all data transmitted via the backend. The @option{logappend}
2266option controls whether the log file will be truncated or appended to when
2267opened.
2268
2269Further options to each backend are described below.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002270
2271@item -chardev null ,id=@var{id}
2272A void device. This device will not emit any data, and will drop any data it
2273receives. The null backend does not take any options.
2274
Daniel P. Berrangea8fb5422016-01-19 11:14:31 +00002275@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 +00002276
2277Create a two-way stream socket, which can be either a TCP or a unix socket. A
2278unix socket will be created if @option{path} is specified. Behaviour is
2279undefined if TCP options are specified for a unix socket.
2280
2281@option{server} specifies that the socket shall be a listening socket.
2282
2283@option{nowait} specifies that QEMU should not block waiting for a client to
2284connect to a listening socket.
2285
2286@option{telnet} specifies that traffic on the socket should interpret telnet
2287escape sequences.
2288
Corey Minyard5dd1f022014-10-02 11:17:37 -05002289@option{reconnect} sets the timeout for reconnecting on non-server sockets when
2290the remote end goes away. qemu will delay this many seconds and then attempt
2291to reconnect. Zero disables reconnecting, and is the default.
2292
Daniel P. Berrangea8fb5422016-01-19 11:14:31 +00002293@option{tls-creds} requests enablement of the TLS protocol for encryption,
2294and specifies the id of the TLS credentials to use for the handshake. The
2295credentials must be previously created with the @option{-object tls-creds}
2296argument.
2297
Matthew Booth7273a2d2009-10-30 13:41:12 +00002298TCP and unix socket options are given below:
2299
2300@table @option
2301
Aurelien Jarno8d533562010-03-27 11:52:05 +01002302@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
Matthew Booth7273a2d2009-10-30 13:41:12 +00002303
2304@option{host} for a listening socket specifies the local address to be bound.
2305For a connecting socket species the remote host to connect to. @option{host} is
2306optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
2307
2308@option{port} for a listening socket specifies the local port to be bound. For a
2309connecting socket specifies the port on the remote host to connect to.
2310@option{port} can be given as either a port number or a service name.
2311@option{port} is required.
2312
2313@option{to} is only relevant to listening sockets. If it is specified, and
2314@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
2315to and including @option{to} until it succeeds. @option{to} must be specified
2316as a port number.
2317
2318@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2319If neither is specified the socket may use either protocol.
2320
2321@option{nodelay} disables the Nagle algorithm.
2322
2323@item unix options: path=@var{path}
2324
2325@option{path} specifies the local path of the unix socket. @option{path} is
2326required.
2327
2328@end table
2329
2330@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
2331
2332Sends all traffic from the guest to a remote host over UDP.
2333
2334@option{host} specifies the remote host to connect to. If not specified it
2335defaults to @code{localhost}.
2336
2337@option{port} specifies the port on the remote host to connect to. @option{port}
2338is required.
2339
2340@option{localaddr} specifies the local address to bind to. If not specified it
2341defaults to @code{0.0.0.0}.
2342
2343@option{localport} specifies the local port to bind to. If not specified any
2344available local port will be used.
2345
2346@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2347If neither is specified the device may use either protocol.
2348
2349@item -chardev msmouse ,id=@var{id}
2350
2351Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
2352take any options.
2353
2354@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
2355
2356Connect to a QEMU text console. @option{vc} may optionally be given a specific
2357size.
2358
2359@option{width} and @option{height} specify the width and height respectively of
2360the console, in pixels.
2361
2362@option{cols} and @option{rows} specify that the console be sized to fit a text
2363console with the given dimensions.
2364
Markus Armbruster4f573782013-07-26 16:44:32 +02002365@item -chardev ringbuf ,id=@var{id} [,size=@var{size}]
Lei Li51767e72013-01-25 00:03:19 +08002366
Markus Armbruster3949e592013-02-06 21:27:24 +01002367Create a ring buffer with fixed size @option{size}.
2368@var{size} must be a power of two, and defaults to @code{64K}).
Lei Li51767e72013-01-25 00:03:19 +08002369
Matthew Booth7273a2d2009-10-30 13:41:12 +00002370@item -chardev file ,id=@var{id} ,path=@var{path}
2371
2372Log all traffic received from the guest to a file.
2373
2374@option{path} specifies the path of the file to be opened. This file will be
2375created if it does not already exist, and overwritten if it does. @option{path}
2376is required.
2377
2378@item -chardev pipe ,id=@var{id} ,path=@var{path}
2379
2380Create a two-way connection to the guest. The behaviour differs slightly between
2381Windows hosts and other hosts:
2382
2383On Windows, a single duplex pipe will be created at
2384@file{\\.pipe\@option{path}}.
2385
2386On other hosts, 2 pipes will be created called @file{@option{path}.in} and
2387@file{@option{path}.out}. Data written to @file{@option{path}.in} will be
2388received by the guest. Data written by the guest can be read from
2389@file{@option{path}.out}. QEMU will not create these fifos, and requires them to
2390be present.
2391
2392@option{path} forms part of the pipe path as described above. @option{path} is
2393required.
2394
2395@item -chardev console ,id=@var{id}
2396
2397Send traffic from the guest to QEMU's standard output. @option{console} does not
2398take any options.
2399
2400@option{console} is only available on Windows hosts.
2401
2402@item -chardev serial ,id=@var{id} ,path=@option{path}
2403
2404Send traffic from the guest to a serial device on the host.
2405
Gerd Hoffmannd59044e2012-12-19 13:50:29 +01002406On Unix hosts serial will actually accept any tty device,
2407not only serial lines.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002408
2409@option{path} specifies the name of the serial device to open.
2410
2411@item -chardev pty ,id=@var{id}
2412
2413Create a new pseudo-terminal on the host and connect to it. @option{pty} does
2414not take any options.
2415
2416@option{pty} is not available on Windows hosts.
2417
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02002418@item -chardev stdio ,id=@var{id} [,signal=on|off]
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002419Connect to standard input and standard output of the QEMU process.
Aurelien Jarnob7fdb3a2010-07-13 21:13:12 +02002420
2421@option{signal} controls if signals are enabled on the terminal, that includes
2422exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
2423default, use @option{signal=off} to disable it.
2424
2425@option{stdio} is not available on Windows hosts.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002426
2427@item -chardev braille ,id=@var{id}
2428
2429Connect to a local BrlAPI server. @option{braille} does not take any options.
2430
2431@item -chardev tty ,id=@var{id} ,path=@var{path}
2432
Matthew Booth7273a2d2009-10-30 13:41:12 +00002433@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
Markus Armbrusterd037d6b2013-02-13 15:54:15 +01002434DragonFlyBSD hosts. It is an alias for @option{serial}.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002435
2436@option{path} specifies the path to the tty. @option{path} is required.
2437
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002438@item -chardev parallel ,id=@var{id} ,path=@var{path}
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02002439@itemx -chardev parport ,id=@var{id} ,path=@var{path}
Matthew Booth7273a2d2009-10-30 13:41:12 +00002440
Gerd Hoffmann88a946d2013-01-10 14:20:58 +01002441@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
Matthew Booth7273a2d2009-10-30 13:41:12 +00002442
2443Connect to a local parallel port.
2444
2445@option{path} specifies the path to the parallel port device. @option{path} is
2446required.
2447
Alon Levycbcc6332011-01-19 10:49:50 +02002448@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2449
Stefan Hajnoczi3a846902011-10-06 11:24:12 +01002450@option{spicevmc} is only available when spice support is built in.
2451
Alon Levycbcc6332011-01-19 10:49:50 +02002452@option{debug} debug level for spicevmc
2453
2454@option{name} name of spice channel to connect to
2455
2456Connect to a spice virtual machine channel, such as vdiport.
Alon Levycbcc6332011-01-19 10:49:50 +02002457
Marc-André Lureau5a49d3e2012-12-05 16:15:34 +01002458@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2459
2460@option{spiceport} is only available when spice support is built in.
2461
2462@option{debug} debug level for spicevmc
2463
2464@option{name} name of spice port to connect to
2465
2466Connect to a spice port, allowing a Spice client to handle the traffic
2467identified by a name (preferably a fqdn).
Matthew Booth7273a2d2009-10-30 13:41:12 +00002468ETEXI
2469
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002470STEXI
2471@end table
2472ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002473DEFHEADING()
2474
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002475DEFHEADING(Device URL Syntax:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002476STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002477
2478In addition to using normal file images for the emulated storage devices,
2479QEMU can also use networked resources such as iSCSI devices. These are
2480specified using a special URL syntax.
2481
2482@table @option
2483@item iSCSI
2484iSCSI support allows QEMU to access iSCSI resources directly and use as
2485images for the guest storage. Both disk and cdrom images are supported.
2486
2487Syntax for specifying iSCSI LUNs is
2488``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
2489
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002490By default qemu will use the iSCSI initiator-name
2491'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
2492line or a configuration file.
2493
Peter Lieven5dd7a532015-06-16 13:45:07 +02002494Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect
2495stalled requests and force a reestablishment of the session. The timeout
Peter Lieven90497362015-06-26 12:18:01 +02002496is specified in seconds. The default is 0 which means no timeout. Libiscsi
24971.15.0 or greater is required for this feature.
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002498
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002499Example (without authentication):
2500@example
Stefan Weil3804da92012-05-11 22:21:50 +02002501qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
2502 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
2503 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002504@end example
2505
2506Example (CHAP username/password via URL):
2507@example
Stefan Weil3804da92012-05-11 22:21:50 +02002508qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002509@end example
2510
2511Example (CHAP username/password via environment variables):
2512@example
2513LIBISCSI_CHAP_USERNAME="user" \
2514LIBISCSI_CHAP_PASSWORD="password" \
Stefan Weil3804da92012-05-11 22:21:50 +02002515qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002516@end example
2517
2518iSCSI support is an optional feature of QEMU and only available when
2519compiled and linked against libiscsi.
Ronnie Sahlbergf9dadc92012-01-26 09:39:02 +11002520ETEXI
2521DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
2522 "-iscsi [user=user][,password=password]\n"
2523 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n"
Paolo Bonzini2fe37982013-12-06 16:08:05 +01002524 " [,initiator-name=initiator-iqn][,id=target-iqn]\n"
Peter Lieven5dd7a532015-06-16 13:45:07 +02002525 " [,timeout=timeout]\n"
Ronnie Sahlbergf9dadc92012-01-26 09:39:02 +11002526 " iSCSI session parameters\n", QEMU_ARCH_ALL)
2527STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002528
Ronnie Sahlberg31459f42012-08-06 18:24:55 +10002529iSCSI parameters such as username and password can also be specified via
2530a configuration file. See qemu-doc for more information and examples.
2531
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002532@item NBD
2533QEMU supports NBD (Network Block Devices) both using TCP protocol as well
2534as Unix Domain Sockets.
2535
2536Syntax for specifying a NBD device using TCP
2537``nbd:<server-ip>:<port>[:exportname=<export>]''
2538
2539Syntax for specifying a NBD device using Unix Domain Sockets
2540``nbd:unix:<domain-socket>[:exportname=<export>]''
2541
2542
2543Example for TCP
2544@example
Stefan Weil3804da92012-05-11 22:21:50 +02002545qemu-system-i386 --drive file=nbd:192.0.2.1:30000
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002546@end example
2547
2548Example for Unix Domain Sockets
2549@example
Stefan Weil3804da92012-05-11 22:21:50 +02002550qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
Ronnie Sahlberg08ae3302011-10-27 20:33:21 +11002551@end example
2552
Richard W.M. Jones0a12ec82013-04-09 15:30:53 +01002553@item SSH
2554QEMU supports SSH (Secure Shell) access to remote disks.
2555
2556Examples:
2557@example
2558qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img
2559qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
2560@end example
2561
2562Currently authentication must be done using ssh-agent. Other
2563authentication methods may be supported in future.
2564
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002565@item Sheepdog
2566Sheepdog is a distributed storage system for QEMU.
2567QEMU supports using either local sheepdog devices or remote networked
2568devices.
2569
2570Syntax for specifying a sheepdog device
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002571@example
MORITA Kazutaka1b8bbb42013-02-22 12:39:53 +09002572sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002573@end example
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002574
2575Example
2576@example
MORITA Kazutaka5d6768e2013-02-22 12:39:51 +09002577qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
Ronnie Sahlbergd9990222011-10-28 20:13:39 +11002578@end example
2579
2580See also @url{http://http://www.osrg.net/sheepdog/}.
2581
Bharata B Rao8809e282012-10-24 17:17:53 +05302582@item GlusterFS
2583GlusterFS is an user space distributed file system.
2584QEMU supports the use of GlusterFS volumes for hosting VM disk images using
2585TCP, Unix Domain Sockets and RDMA transport protocols.
2586
2587Syntax for specifying a VM disk image on GlusterFS volume is
2588@example
2589gluster[+transport]://[server[:port]]/volname/image[?socket=...]
2590@end example
2591
2592
2593Example
2594@example
Lei Lidb2d5eb2013-03-07 15:50:26 +08002595qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img
Bharata B Rao8809e282012-10-24 17:17:53 +05302596@end example
2597
2598See also @url{http://www.gluster.org}.
Matthew Booth0a86cb72014-05-14 19:28:43 -04002599
2600@item HTTP/HTTPS/FTP/FTPS/TFTP
2601QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp.
2602
2603Syntax using a single filename:
2604@example
2605<protocol>://[<username>[:<password>]@@]<host>/<path>
2606@end example
2607
2608where:
2609@table @option
2610@item protocol
2611'http', 'https', 'ftp', 'ftps', or 'tftp'.
2612
2613@item username
2614Optional username for authentication to the remote server.
2615
2616@item password
2617Optional password for authentication to the remote server.
2618
2619@item host
2620Address of the remote server.
2621
2622@item path
2623Path on the remote server, including any query string.
2624@end table
2625
2626The following options are also supported:
2627@table @option
2628@item url
2629The full URL when passing options to the driver explicitly.
2630
2631@item readahead
2632The amount of data to read ahead with each range request to the remote server.
2633This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it
2634does not have a suffix, it will be assumed to be in bytes. The value must be a
2635multiple of 512 bytes. It defaults to 256k.
2636
2637@item sslverify
2638Whether to verify the remote server's certificate when connecting over SSL. It
2639can have the value 'on' or 'off'. It defaults to 'on'.
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002640
Richard W.M. Jonesa94f83d2014-08-29 16:03:12 +01002641@item cookie
2642Send this cookie (it can also be a list of cookies separated by ';') with
2643each outgoing request. Only supported when using protocols such as HTTP
2644which support cookies, otherwise ignored.
2645
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002646@item timeout
2647Set the timeout in seconds of the CURL connection. This timeout is the time
2648that CURL waits for a response from the remote server to get the size of the
2649image to be downloaded. If not set, the default timeout of 5 seconds is used.
Matthew Booth0a86cb72014-05-14 19:28:43 -04002650@end table
2651
2652Note that when passing options to qemu explicitly, @option{driver} is the value
2653of <protocol>.
2654
2655Example: boot from a remote Fedora 20 live ISO image
2656@example
2657qemu-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
2658
2659qemu-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
2660@end example
2661
2662Example: boot from a remote Fedora 20 cloud image using a local overlay for
2663writes, copy-on-read, and a readahead of 64k
2664@example
2665qemu-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
2666
2667qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on
2668@end example
2669
2670Example: boot from an image stored on a VMware vSphere server with a self-signed
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002671certificate using a local overlay for writes, a readahead of 64k and a timeout
2672of 10 seconds.
Matthew Booth0a86cb72014-05-14 19:28:43 -04002673@example
Daniel Henrique Barboza212aefa2014-08-13 12:44:27 -03002674qemu-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 -04002675
2676qemu-system-x86_64 -drive file=/tmp/test.qcow2
2677@end example
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002678ETEXI
2679
2680STEXI
Ronnie Sahlberg0f5314a2011-10-26 23:51:37 +11002681@end table
2682ETEXI
2683
Matthew Booth7273a2d2009-10-30 13:41:12 +00002684DEFHEADING(Bluetooth(R) options:)
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002685STEXI
2686@table @option
2687ETEXI
Matthew Booth7273a2d2009-10-30 13:41:12 +00002688
blueswir15824d652009-03-28 06:44:27 +00002689DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
blueswir15824d652009-03-28 06:44:27 +00002690 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
2691 "-bt hci,host[:id]\n" \
2692 " use host's HCI with the given name\n" \
2693 "-bt hci[,vlan=n]\n" \
2694 " emulate a standard HCI in virtual scatternet 'n'\n" \
2695 "-bt vhci[,vlan=n]\n" \
2696 " add host computer to virtual scatternet 'n' using VHCI\n" \
2697 "-bt device:dev[,vlan=n]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00002698 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
2699 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002700STEXI
blueswir15824d652009-03-28 06:44:27 +00002701@item -bt hci[...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01002702@findex -bt
blueswir15824d652009-03-28 06:44:27 +00002703Defines the function of the corresponding Bluetooth HCI. -bt options
2704are matched with the HCIs present in the chosen machine type. For
2705example when emulating a machine with only one HCI built into it, only
2706the first @code{-bt hci[...]} option is valid and defines the HCI's
2707logic. The Transport Layer is decided by the machine type. Currently
2708the machines @code{n800} and @code{n810} have one HCI and all other
2709machines have none.
2710
2711@anchor{bt-hcis}
2712The following three types are recognized:
2713
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002714@table @option
blueswir15824d652009-03-28 06:44:27 +00002715@item -bt hci,null
2716(default) The corresponding Bluetooth HCI assumes no internal logic
2717and will not respond to any HCI commands or emit events.
2718
2719@item -bt hci,host[:@var{id}]
2720(@code{bluez} only) The corresponding HCI passes commands / events
2721to / from the physical HCI identified by the name @var{id} (default:
2722@code{hci0}) on the computer running QEMU. Only available on @code{bluez}
2723capable systems like Linux.
2724
2725@item -bt hci[,vlan=@var{n}]
2726Add a virtual, standard HCI that will participate in the Bluetooth
2727scatternet @var{n} (default @code{0}). Similarly to @option{-net}
2728VLANs, devices inside a bluetooth network @var{n} can only communicate
2729with other devices in the same network (scatternet).
2730@end table
2731
2732@item -bt vhci[,vlan=@var{n}]
2733(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
2734to the host bluetooth stack instead of to the emulated target. This
2735allows the host and target machines to participate in a common scatternet
2736and communicate. Requires the Linux @code{vhci} driver installed. Can
2737be used as following:
2738
2739@example
Stefan Weil3804da92012-05-11 22:21:50 +02002740qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
blueswir15824d652009-03-28 06:44:27 +00002741@end example
2742
2743@item -bt device:@var{dev}[,vlan=@var{n}]
2744Emulate a bluetooth device @var{dev} and place it in network @var{n}
2745(default @code{0}). QEMU can only emulate one type of bluetooth devices
2746currently:
2747
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002748@table @option
blueswir15824d652009-03-28 06:44:27 +00002749@item keyboard
2750Virtual wireless keyboard implementing the HIDP bluetooth profile.
2751@end table
blueswir15824d652009-03-28 06:44:27 +00002752ETEXI
2753
Markus Armbrusterc70a01e2013-02-13 19:49:40 +01002754STEXI
2755@end table
2756ETEXI
blueswir15824d652009-03-28 06:44:27 +00002757DEFHEADING()
2758
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002759#ifdef CONFIG_TPM
2760DEFHEADING(TPM device options:)
2761
2762DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
Stefan Berger92dcc232013-02-27 12:47:54 -05002763 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n"
2764 " use path to provide path to a character device; default is /dev/tpm0\n"
2765 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n"
2766 " not provided it will be searched for in /sys/class/misc/tpm?/device\n",
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002767 QEMU_ARCH_ALL)
2768STEXI
2769
2770The general form of a TPM device option is:
2771@table @option
2772
2773@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
2774@findex -tpmdev
2775Backend type must be:
Stefan Berger4549a8b2013-02-27 12:47:53 -05002776@option{passthrough}.
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002777
2778The specific backend type will determine the applicable options.
Corey Bryant28c4fa32013-03-20 12:34:49 -04002779The @code{-tpmdev} option creates the TPM backend and requires a
2780@code{-device} option that specifies the TPM frontend interface model.
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002781
2782Options to each backend are described below.
2783
2784Use 'help' to print all available TPM backend types.
2785@example
2786qemu -tpmdev help
2787@end example
2788
Stefan Berger92dcc232013-02-27 12:47:54 -05002789@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
Stefan Berger4549a8b2013-02-27 12:47:53 -05002790
2791(Linux-host only) Enable access to the host's TPM using the passthrough
2792driver.
2793
2794@option{path} specifies the path to the host's TPM device, i.e., on
2795a Linux host this would be @code{/dev/tpm0}.
2796@option{path} is optional and by default @code{/dev/tpm0} is used.
2797
Stefan Berger92dcc232013-02-27 12:47:54 -05002798@option{cancel-path} specifies the path to the host TPM device's sysfs
2799entry allowing for cancellation of an ongoing TPM command.
2800@option{cancel-path} is optional and by default QEMU will search for the
2801sysfs entry to use.
2802
Stefan Berger4549a8b2013-02-27 12:47:53 -05002803Some notes about using the host's TPM with the passthrough driver:
2804
2805The TPM device accessed by the passthrough driver must not be
2806used by any other application on the host.
2807
2808Since the host's firmware (BIOS/UEFI) has already initialized the TPM,
2809the VM's firmware (BIOS/UEFI) will not be able to initialize the
2810TPM again and may therefore not show a TPM-specific menu that would
2811otherwise allow the user to configure the TPM, e.g., allow the user to
2812enable/disable or activate/deactivate the TPM.
2813Further, if TPM ownership is released from within a VM then the host's TPM
2814will get disabled and deactivated. To enable and activate the
2815TPM again afterwards, the host has to be rebooted and the user is
2816required to enter the firmware's menu to enable and activate the TPM.
2817If the TPM is left disabled and/or deactivated most TPM commands will fail.
2818
2819To create a passthrough TPM use the following two options:
2820@example
2821-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
2822@end example
2823Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
2824@code{tpmdev=tpm0} in the device option.
2825
Stefan Bergerd1a0cf72013-02-27 12:47:49 -05002826@end table
2827
2828ETEXI
2829
2830DEFHEADING()
2831
2832#endif
2833
Alexander Graf7677f052009-06-28 16:55:55 +02002834DEFHEADING(Linux/Multiboot boot specific:)
blueswir15824d652009-03-28 06:44:27 +00002835STEXI
Alexander Graf7677f052009-06-28 16:55:55 +02002836
2837When using these options, you can use a given Linux or Multiboot
2838kernel without installing it in the disk image. It can be useful
blueswir15824d652009-03-28 06:44:27 +00002839for easier testing of various kernels.
2840
2841@table @option
2842ETEXI
2843
2844DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
Blue Swirlad960902010-03-29 19:23:52 +00002845 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002846STEXI
2847@item -kernel @var{bzImage}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002848@findex -kernel
Alexander Graf7677f052009-06-28 16:55:55 +02002849Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2850or in multiboot format.
blueswir15824d652009-03-28 06:44:27 +00002851ETEXI
2852
2853DEF("append", HAS_ARG, QEMU_OPTION_append, \
Blue Swirlad960902010-03-29 19:23:52 +00002854 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002855STEXI
2856@item -append @var{cmdline}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002857@findex -append
blueswir15824d652009-03-28 06:44:27 +00002858Use @var{cmdline} as kernel command line
2859ETEXI
2860
2861DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
Blue Swirlad960902010-03-29 19:23:52 +00002862 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002863STEXI
2864@item -initrd @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002865@findex -initrd
blueswir15824d652009-03-28 06:44:27 +00002866Use @var{file} as initial ram disk.
Alexander Graf7677f052009-06-28 16:55:55 +02002867
2868@item -initrd "@var{file1} arg=foo,@var{file2}"
2869
2870This syntax is only available with multiboot.
2871
2872Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2873first module.
blueswir15824d652009-03-28 06:44:27 +00002874ETEXI
2875
Grant Likely412beee2012-03-02 11:56:38 +00002876DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
Peter A. G. Crosthwaite379b5c72012-03-04 21:03:54 +10002877 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL)
Grant Likely412beee2012-03-02 11:56:38 +00002878STEXI
2879@item -dtb @var{file}
2880@findex -dtb
2881Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
2882on boot.
2883ETEXI
2884
blueswir15824d652009-03-28 06:44:27 +00002885STEXI
2886@end table
2887ETEXI
blueswir15824d652009-03-28 06:44:27 +00002888DEFHEADING()
2889
2890DEFHEADING(Debug/Expert options:)
blueswir15824d652009-03-28 06:44:27 +00002891STEXI
2892@table @option
2893ETEXI
2894
Gabriel L. Somlo81b2b812015-04-29 11:21:53 -04002895DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg,
2896 "-fw_cfg [name=]<name>,file=<file>\n"
Markus Armbruster63d31452016-04-18 18:29:50 +02002897 " add named fw_cfg entry with contents from file\n"
Gabriel L. Somlo6407d762015-09-29 12:29:01 -04002898 "-fw_cfg [name=]<name>,string=<str>\n"
Markus Armbruster63d31452016-04-18 18:29:50 +02002899 " add named fw_cfg entry with contents from string\n",
Gabriel L. Somlo81b2b812015-04-29 11:21:53 -04002900 QEMU_ARCH_ALL)
2901STEXI
Markus Armbruster63d31452016-04-18 18:29:50 +02002902
Gabriel L. Somlo81b2b812015-04-29 11:21:53 -04002903@item -fw_cfg [name=]@var{name},file=@var{file}
2904@findex -fw_cfg
Markus Armbruster63d31452016-04-18 18:29:50 +02002905Add named fw_cfg entry with contents from file @var{file}.
Gabriel L. Somlo6407d762015-09-29 12:29:01 -04002906
2907@item -fw_cfg [name=]@var{name},string=@var{str}
Markus Armbruster63d31452016-04-18 18:29:50 +02002908Add named fw_cfg entry with contents from string @var{str}.
2909
2910The terminating NUL character of the contents of @var{str} will not be
2911included as part of the fw_cfg item data. To insert contents with
2912embedded NUL characters, you have to use the @var{file} parameter.
2913
2914The fw_cfg entries are passed by QEMU through to the guest.
2915
2916Example:
2917@example
2918 -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin
2919@end example
2920creates an fw_cfg entry named opt/com.mycompany/blob with contents
2921from ./my_blob.bin.
2922
Gabriel L. Somlo81b2b812015-04-29 11:21:53 -04002923ETEXI
2924
blueswir15824d652009-03-28 06:44:27 +00002925DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
Blue Swirlad960902010-03-29 19:23:52 +00002926 "-serial dev redirect the serial port to char device 'dev'\n",
2927 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00002928STEXI
2929@item -serial @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01002930@findex -serial
blueswir15824d652009-03-28 06:44:27 +00002931Redirect the virtual serial port to host character device
2932@var{dev}. The default device is @code{vc} in graphical mode and
2933@code{stdio} in non graphical mode.
2934
2935This option can be used several times to simulate up to 4 serial
2936ports.
2937
2938Use @code{-serial none} to disable all serial ports.
2939
2940Available character devices are:
Kevin Wolfb3f046c2009-10-09 10:58:35 +02002941@table @option
Kevin Wolf4e257e52009-10-09 10:58:36 +02002942@item vc[:@var{W}x@var{H}]
blueswir15824d652009-03-28 06:44:27 +00002943Virtual console. Optionally, a width and height can be given in pixel with
2944@example
2945vc:800x600
2946@end example
2947It is also possible to specify width or height in characters:
2948@example
2949vc:80Cx24C
2950@end example
2951@item pty
2952[Linux only] Pseudo TTY (a new PTY is automatically allocated)
2953@item none
2954No device is allocated.
2955@item null
2956void device
Ingo van Lil88e020e2013-12-20 14:44:53 +01002957@item chardev:@var{id}
2958Use a named character device defined with the @code{-chardev} option.
blueswir15824d652009-03-28 06:44:27 +00002959@item /dev/XXX
2960[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2961parameters are set according to the emulated ones.
2962@item /dev/parport@var{N}
2963[Linux only, parallel port only] Use host parallel port
2964@var{N}. Currently SPP and EPP parallel port features can be used.
2965@item file:@var{filename}
2966Write output to @var{filename}. No character can be read.
2967@item stdio
2968[Unix only] standard input/output
2969@item pipe:@var{filename}
2970name pipe @var{filename}
2971@item COM@var{n}
2972[Windows only] Use host serial port @var{n}
2973@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2974This implements UDP Net Console.
2975When @var{remote_host} or @var{src_ip} are not specified
2976they default to @code{0.0.0.0}.
2977When not using a specified @var{src_port} a random port is automatically chosen.
blueswir15824d652009-03-28 06:44:27 +00002978
2979If you just want a simple readonly console you can use @code{netcat} or
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002980@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
2981@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
blueswir15824d652009-03-28 06:44:27 +00002982will appear in the netconsole session.
2983
2984If you plan to send characters back via netconsole or you want to stop
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002985and start QEMU a lot of times, you should have QEMU use the same
blueswir15824d652009-03-28 06:44:27 +00002986source port each time by using something like @code{-serial
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002987udp::4555@@:4556} to QEMU. Another approach is to use a patched
blueswir15824d652009-03-28 06:44:27 +00002988version of netcat which can listen to a TCP port and send and receive
2989characters via udp. If you have a patched version of netcat which
2990activates telnet remote echo and single char transfer, then you can
2991use the following options to step up a netcat redirector to allow
Stefan Weilb65ee4f2012-05-11 22:25:50 +02002992telnet on port 5555 to access the QEMU port.
blueswir15824d652009-03-28 06:44:27 +00002993@table @code
Stefan Weil071c9392012-04-07 09:23:36 +02002994@item QEMU Options:
blueswir15824d652009-03-28 06:44:27 +00002995-serial udp::4555@@:4556
2996@item netcat options:
2997-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2998@item telnet options:
2999localhost 5555
3000@end table
3001
Corey Minyard5dd1f022014-10-02 11:17:37 -05003002@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}]
blueswir15824d652009-03-28 06:44:27 +00003003The TCP Net Console has two modes of operation. It can send the serial
3004I/O to a location or wait for a connection from a location. By default
3005the TCP Net Console is sent to @var{host} at the @var{port}. If you use
3006the @var{server} option QEMU will wait for a client socket application
3007to connect to the port before continuing, unless the @code{nowait}
3008option was specified. The @code{nodelay} option disables the Nagle buffering
Corey Minyard5dd1f022014-10-02 11:17:37 -05003009algorithm. The @code{reconnect} option only applies if @var{noserver} is
3010set, if the connection goes down it will attempt to reconnect at the
3011given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only
blueswir15824d652009-03-28 06:44:27 +00003012one TCP connection at a time is accepted. You can use @code{telnet} to
3013connect to the corresponding character device.
3014@table @code
3015@item Example to send tcp console to 192.168.0.2 port 4444
3016-serial tcp:192.168.0.2:4444
3017@item Example to listen and wait on port 4444 for connection
3018-serial tcp::4444,server
3019@item Example to not wait and listen on ip 192.168.0.100 port 4444
3020-serial tcp:192.168.0.100:4444,server,nowait
3021@end table
3022
3023@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
3024The telnet protocol is used instead of raw tcp sockets. The options
3025work the same as if you had specified @code{-serial tcp}. The
3026difference is that the port acts like a telnet server or client using
3027telnet option negotiation. This will also allow you to send the
3028MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
3029sequence. Typically in unix telnet you do it with Control-] and then
3030type "send break" followed by pressing the enter key.
3031
Corey Minyard5dd1f022014-10-02 11:17:37 -05003032@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}]
blueswir15824d652009-03-28 06:44:27 +00003033A unix domain socket is used instead of a tcp socket. The option works the
3034same as if you had specified @code{-serial tcp} except the unix domain socket
3035@var{path} is used for connections.
3036
3037@item mon:@var{dev_string}
3038This is a special option to allow the monitor to be multiplexed onto
3039another serial port. The monitor is accessed with key sequence of
Paolo Bonzini02c4bdf2013-07-03 20:29:45 +04003040@key{Control-a} and then pressing @key{c}.
blueswir15824d652009-03-28 06:44:27 +00003041@var{dev_string} should be any one of the serial devices specified
3042above. An example to multiplex the monitor onto a telnet server
3043listening on port 4444 would be:
3044@table @code
3045@item -serial mon:telnet::4444,server,nowait
3046@end table
Michael Tokarevbe022d62013-07-11 12:55:50 +04003047When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate
3048QEMU any more but will be passed to the guest instead.
blueswir15824d652009-03-28 06:44:27 +00003049
3050@item braille
3051Braille device. This will use BrlAPI to display the braille output on a real
3052or fake device.
3053
Kevin Wolfbe8b28a2009-10-09 10:58:37 +02003054@item msmouse
3055Three button serial mouse. Configure the guest to use Microsoft protocol.
blueswir15824d652009-03-28 06:44:27 +00003056@end table
3057ETEXI
3058
3059DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
Blue Swirlad960902010-03-29 19:23:52 +00003060 "-parallel dev redirect the parallel port to char device 'dev'\n",
3061 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003062STEXI
3063@item -parallel @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003064@findex -parallel
blueswir15824d652009-03-28 06:44:27 +00003065Redirect the virtual parallel port to host device @var{dev} (same
3066devices as the serial port). On Linux hosts, @file{/dev/parportN} can
3067be used to use hardware devices connected on the corresponding host
3068parallel port.
3069
3070This option can be used several times to simulate up to 3 parallel
3071ports.
3072
3073Use @code{-parallel none} to disable all parallel ports.
3074ETEXI
3075
3076DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
Blue Swirlad960902010-03-29 19:23:52 +00003077 "-monitor dev redirect the monitor to char device 'dev'\n",
3078 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003079STEXI
Gerd Hoffmann4e307fc2009-12-08 13:11:37 +01003080@item -monitor @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003081@findex -monitor
blueswir15824d652009-03-28 06:44:27 +00003082Redirect the monitor to host device @var{dev} (same devices as the
3083serial port).
3084The default device is @code{vc} in graphical mode and @code{stdio} in
3085non graphical mode.
Luiz Capitulino70e098a2013-05-16 12:02:55 -04003086Use @code{-monitor none} to disable the default monitor.
blueswir15824d652009-03-28 06:44:27 +00003087ETEXI
Gerd Hoffmann6ca55822009-12-08 13:11:52 +01003088DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
Blue Swirlad960902010-03-29 19:23:52 +00003089 "-qmp dev like -monitor but opens in 'control' mode\n",
3090 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01003091STEXI
3092@item -qmp @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003093@findex -qmp
Stefan Weil95d5f082010-01-20 22:25:27 +01003094Like -monitor but opens in 'control' mode.
3095ETEXI
Max Reitz4821cd42014-11-17 13:31:04 +01003096DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \
3097 "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n",
3098 QEMU_ARCH_ALL)
3099STEXI
3100@item -qmp-pretty @var{dev}
3101@findex -qmp-pretty
3102Like -qmp but uses pretty JSON formatting.
3103ETEXI
blueswir15824d652009-03-28 06:44:27 +00003104
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01003105DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
Michael Tokarevf17e4ea2013-06-15 13:47:32 +04003106 "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01003107STEXI
Michael Tokarevf17e4ea2013-06-15 13:47:32 +04003108@item -mon [chardev=]name[,mode=readline|control][,default]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003109@findex -mon
Gerd Hoffmann22a0e042009-12-08 13:11:51 +01003110Setup monitor on chardev @var{name}.
3111ETEXI
3112
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08003113DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
Blue Swirlad960902010-03-29 19:23:52 +00003114 "-debugcon dev redirect the debug console to char device 'dev'\n",
3115 QEMU_ARCH_ALL)
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08003116STEXI
3117@item -debugcon @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003118@findex -debugcon
H. Peter Anvinc9f398e2009-12-29 13:51:36 -08003119Redirect the debug console to host device @var{dev} (same devices as the
3120serial port). The debug console is an I/O port which is typically port
31210xe9; writing to that I/O port sends output to this device.
3122The default device is @code{vc} in graphical mode and @code{stdio} in
3123non graphical mode.
3124ETEXI
3125
blueswir15824d652009-03-28 06:44:27 +00003126DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
Blue Swirlad960902010-03-29 19:23:52 +00003127 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003128STEXI
3129@item -pidfile @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003130@findex -pidfile
blueswir15824d652009-03-28 06:44:27 +00003131Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
3132from a script.
3133ETEXI
3134
aurel321b530a62009-04-05 20:08:59 +00003135DEF("singlestep", 0, QEMU_OPTION_singlestep, \
Blue Swirlad960902010-03-29 19:23:52 +00003136 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
aurel321b530a62009-04-05 20:08:59 +00003137STEXI
3138@item -singlestep
Stefan Weil6616b2a2010-02-05 23:52:05 +01003139@findex -singlestep
aurel321b530a62009-04-05 20:08:59 +00003140Run the emulation in single step mode.
3141ETEXI
3142
blueswir15824d652009-03-28 06:44:27 +00003143DEF("S", 0, QEMU_OPTION_S, \
Blue Swirlad960902010-03-29 19:23:52 +00003144 "-S freeze CPU at startup (use 'c' to start execution)\n",
3145 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003146STEXI
3147@item -S
Stefan Weil6616b2a2010-02-05 23:52:05 +01003148@findex -S
blueswir15824d652009-03-28 06:44:27 +00003149Do not start CPU at startup (you must type 'c' in the monitor).
3150ETEXI
3151
Satoru Moriya888a6bc2013-04-19 16:42:06 +02003152DEF("realtime", HAS_ARG, QEMU_OPTION_realtime,
3153 "-realtime [mlock=on|off]\n"
3154 " run qemu with realtime features\n"
3155 " mlock=on|off controls mlock support (default: on)\n",
3156 QEMU_ARCH_ALL)
3157STEXI
3158@item -realtime mlock=on|off
3159@findex -realtime
3160Run qemu with realtime features.
3161mlocking qemu and guest memory can be enabled via @option{mlock=on}
3162(enabled by default).
3163ETEXI
3164
aliguori59030a82009-04-05 18:43:41 +00003165DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
Blue Swirlad960902010-03-29 19:23:52 +00003166 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003167STEXI
aliguori59030a82009-04-05 18:43:41 +00003168@item -gdb @var{dev}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003169@findex -gdb
aliguori59030a82009-04-05 18:43:41 +00003170Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
3171connections will likely be TCP-based, but also UDP, pseudo TTY, or even
Stefan Weilb65ee4f2012-05-11 22:25:50 +02003172stdio are reasonable use case. The latter is allowing to start QEMU from
aliguori59030a82009-04-05 18:43:41 +00003173within gdb and establish the connection via a pipe:
3174@example
Stefan Weil3804da92012-05-11 22:21:50 +02003175(gdb) target remote | exec qemu-system-i386 -gdb stdio ...
aliguori59030a82009-04-05 18:43:41 +00003176@end example
blueswir15824d652009-03-28 06:44:27 +00003177ETEXI
3178
aliguori59030a82009-04-05 18:43:41 +00003179DEF("s", 0, QEMU_OPTION_s, \
Blue Swirlad960902010-03-29 19:23:52 +00003180 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
3181 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003182STEXI
aliguori59030a82009-04-05 18:43:41 +00003183@item -s
Stefan Weil6616b2a2010-02-05 23:52:05 +01003184@findex -s
aliguori59030a82009-04-05 18:43:41 +00003185Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
3186(@pxref{gdb_usage}).
blueswir15824d652009-03-28 06:44:27 +00003187ETEXI
3188
3189DEF("d", HAS_ARG, QEMU_OPTION_d, \
Peter Maydell989b6972013-02-26 17:52:40 +00003190 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n",
Blue Swirlad960902010-03-29 19:23:52 +00003191 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003192STEXI
Peter Maydell989b6972013-02-26 17:52:40 +00003193@item -d @var{item1}[,...]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003194@findex -d
Peter Maydell989b6972013-02-26 17:52:40 +00003195Enable logging of specified items. Use '-d help' for a list of log items.
blueswir15824d652009-03-28 06:44:27 +00003196ETEXI
3197
Matthew Fernandezc235d732011-06-07 16:32:40 +00003198DEF("D", HAS_ARG, QEMU_OPTION_D, \
Peter Maydell989b6972013-02-26 17:52:40 +00003199 "-D logfile output log to logfile (default stderr)\n",
Matthew Fernandezc235d732011-06-07 16:32:40 +00003200 QEMU_ARCH_ALL)
3201STEXI
Stefan Weil8bd383b2012-05-11 22:40:50 +02003202@item -D @var{logfile}
Matthew Fernandezc235d732011-06-07 16:32:40 +00003203@findex -D
Peter Maydell989b6972013-02-26 17:52:40 +00003204Output log in @var{logfile} instead of to stderr
Matthew Fernandezc235d732011-06-07 16:32:40 +00003205ETEXI
3206
Alex Bennée35145522016-03-15 14:30:20 +00003207DEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \
3208 "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n",
3209 QEMU_ARCH_ALL)
3210STEXI
3211@item -dfilter @var{range1}[,...]
3212@findex -dfilter
3213Filter debug output to that relevant to a range of target addresses. The filter
3214spec can be either @var{start}+@var{size}, @var{start}-@var{size} or
3215@var{start}..@var{end} where @var{start} @var{end} and @var{size} are the
3216addresses and sizes required. For example:
3217@example
3218 -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000
3219@end example
3220Will dump output for any code in the 0x1000 sized block starting at 0x8000 and
3221the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized
3222block starting at 0xffffffc00005f000.
3223ETEXI
3224
blueswir15824d652009-03-28 06:44:27 +00003225DEF("L", HAS_ARG, QEMU_OPTION_L, \
Blue Swirlad960902010-03-29 19:23:52 +00003226 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
3227 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003228STEXI
3229@item -L @var{path}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003230@findex -L
blueswir15824d652009-03-28 06:44:27 +00003231Set the directory for the BIOS, VGA BIOS and keymaps.
Richard W.M. Jones37146e72016-05-16 17:34:35 +01003232
3233To list all the data directories, use @code{-L help}.
blueswir15824d652009-03-28 06:44:27 +00003234ETEXI
3235
3236DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
Blue Swirlad960902010-03-29 19:23:52 +00003237 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003238STEXI
3239@item -bios @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003240@findex -bios
blueswir15824d652009-03-28 06:44:27 +00003241Set the filename for the BIOS.
3242ETEXI
3243
blueswir15824d652009-03-28 06:44:27 +00003244DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
Blue Swirlad960902010-03-29 19:23:52 +00003245 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003246STEXI
3247@item -enable-kvm
Stefan Weil6616b2a2010-02-05 23:52:05 +01003248@findex -enable-kvm
blueswir15824d652009-03-28 06:44:27 +00003249Enable KVM full virtualization support. This option is only available
3250if KVM support is enabled when compiling.
3251ETEXI
3252
aliguorie37630c2009-04-22 15:19:10 +00003253DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
Blue Swirlad960902010-03-29 19:23:52 +00003254 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00003255DEF("xen-create", 0, QEMU_OPTION_xen_create,
3256 "-xen-create create domain using xen hypercalls, bypassing xend\n"
Blue Swirlad960902010-03-29 19:23:52 +00003257 " warning: should not be used when xend is in use\n",
3258 QEMU_ARCH_ALL)
aliguorie37630c2009-04-22 15:19:10 +00003259DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
3260 "-xen-attach attach to existing xen domain\n"
Stefan Weilb65ee4f2012-05-11 22:25:50 +02003261 " xend will use this when starting QEMU\n",
Blue Swirlad960902010-03-29 19:23:52 +00003262 QEMU_ARCH_ALL)
Stefan Weil95d5f082010-01-20 22:25:27 +01003263STEXI
3264@item -xen-domid @var{id}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003265@findex -xen-domid
Stefan Weil95d5f082010-01-20 22:25:27 +01003266Specify xen guest domain @var{id} (XEN only).
3267@item -xen-create
Stefan Weil6616b2a2010-02-05 23:52:05 +01003268@findex -xen-create
Stefan Weil95d5f082010-01-20 22:25:27 +01003269Create domain using xen hypercalls, bypassing xend.
3270Warning: should not be used when xend is in use (XEN only).
3271@item -xen-attach
Stefan Weil6616b2a2010-02-05 23:52:05 +01003272@findex -xen-attach
Stefan Weil95d5f082010-01-20 22:25:27 +01003273Attach to existing xen domain.
Stefan Weilb65ee4f2012-05-11 22:25:50 +02003274xend will use this when starting QEMU (XEN only).
Stefan Weil95d5f082010-01-20 22:25:27 +01003275ETEXI
aliguorie37630c2009-04-22 15:19:10 +00003276
blueswir15824d652009-03-28 06:44:27 +00003277DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
Blue Swirlad960902010-03-29 19:23:52 +00003278 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003279STEXI
3280@item -no-reboot
Stefan Weil6616b2a2010-02-05 23:52:05 +01003281@findex -no-reboot
blueswir15824d652009-03-28 06:44:27 +00003282Exit instead of rebooting.
3283ETEXI
3284
3285DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
Blue Swirlad960902010-03-29 19:23:52 +00003286 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003287STEXI
3288@item -no-shutdown
Stefan Weil6616b2a2010-02-05 23:52:05 +01003289@findex -no-shutdown
blueswir15824d652009-03-28 06:44:27 +00003290Don't exit QEMU on guest shutdown, but instead only stop the emulation.
3291This allows for instance switching to monitor to commit changes to the
3292disk image.
3293ETEXI
3294
3295DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
3296 "-loadvm [tag|id]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003297 " start right away with a saved state (loadvm in monitor)\n",
3298 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003299STEXI
3300@item -loadvm @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003301@findex -loadvm
blueswir15824d652009-03-28 06:44:27 +00003302Start right away with a saved state (@code{loadvm} in monitor)
3303ETEXI
3304
3305#ifndef _WIN32
3306DEF("daemonize", 0, QEMU_OPTION_daemonize, \
Blue Swirlad960902010-03-29 19:23:52 +00003307 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003308#endif
3309STEXI
3310@item -daemonize
Stefan Weil6616b2a2010-02-05 23:52:05 +01003311@findex -daemonize
blueswir15824d652009-03-28 06:44:27 +00003312Daemonize the QEMU process after initialization. QEMU will not detach from
3313standard IO until it is ready to receive connections on any of its devices.
3314This option is a useful way for external programs to launch QEMU without having
3315to cope with initialization race conditions.
3316ETEXI
3317
3318DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
Blue Swirlad960902010-03-29 19:23:52 +00003319 "-option-rom rom load a file, rom, into the option ROM space\n",
3320 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003321STEXI
3322@item -option-rom @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003323@findex -option-rom
blueswir15824d652009-03-28 06:44:27 +00003324Load the contents of @var{file} as an option ROM.
3325This option is useful to load things like EtherBoot.
3326ETEXI
3327
Markus Armbrustere2180522014-10-06 16:19:07 +02003328HXCOMM Silently ignored for compatibility
3329DEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003330
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003331HXCOMM Options deprecated by -rtc
Blue Swirlad960902010-03-29 19:23:52 +00003332DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
3333DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003334
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003335DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
Paolo Bonzini78808142012-03-30 10:31:21 +00003336 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003337 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
3338 QEMU_ARCH_ALL)
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003339
blueswir15824d652009-03-28 06:44:27 +00003340STEXI
3341
Jan Kiszka68752042009-09-15 13:36:04 +02003342@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003343@findex -rtc
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003344Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
3345UTC or local time, respectively. @code{localtime} is required for correct date in
3346MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
3347format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
3348
Michael Tokarev9d85d552014-04-07 13:34:58 +04003349By default the RTC is driven by the host system time. This allows using of the
Jan Kiszka68752042009-09-15 13:36:04 +02003350RTC as accurate reference clock inside the guest, specifically if the host
3351time is smoothly following an accurate external reference clock, e.g. via NTP.
Paolo Bonzini78808142012-03-30 10:31:21 +00003352If you want to isolate the guest time from the host, you can set @option{clock}
3353to @code{rt} instead. To even prevent it from progressing during suspension,
3354you can set it to @code{vm}.
Jan Kiszka68752042009-09-15 13:36:04 +02003355
Jan Kiszka1ed2fc12009-09-15 13:36:04 +02003356Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
3357specifically with Windows' ACPI HAL. This option will try to figure out how
3358many timer interrupts were not processed by the Windows guest and will
3359re-inject them.
blueswir15824d652009-03-28 06:44:27 +00003360ETEXI
3361
3362DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
Pranith Kumar778d9f92016-02-26 10:16:51 -05003363 "-icount [shift=N|auto][,align=on|off][,sleep=on|off,rr=record|replay,rrfile=<filename>]\n" \
aliguoribc14ca22009-04-05 18:43:37 +00003364 " enable virtual instruction counter with 2^N clock ticks per\n" \
Victor CLEMENTf1f4b572015-05-29 17:14:05 +02003365 " instruction, enable aligning the host and virtual clocks\n" \
3366 " or disable real time cpu sleeping\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003367STEXI
Pavel Dovgalyuk4c27b852015-09-17 19:25:18 +03003368@item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename}]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003369@findex -icount
blueswir15824d652009-03-28 06:44:27 +00003370Enable virtual instruction counter. The virtual cpu will execute one
Kevin Wolf4e257e52009-10-09 10:58:36 +02003371instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
blueswir15824d652009-03-28 06:44:27 +00003372then the virtual cpu speed will be automatically adjusted to keep virtual
3373time within a few seconds of real time.
3374
Victor CLEMENTf1f4b572015-05-29 17:14:05 +02003375When the virtual cpu is sleeping, the virtual time will advance at default
Pranith Kumar778d9f92016-02-26 10:16:51 -05003376speed unless @option{sleep=on|off} is specified.
3377With @option{sleep=on|off}, the virtual time will jump to the next timer deadline
Victor CLEMENTf1f4b572015-05-29 17:14:05 +02003378instantly whenever the virtual cpu goes to sleep mode and will not advance
3379if no timer is enabled. This behavior give deterministic execution times from
3380the guest point of view.
3381
blueswir15824d652009-03-28 06:44:27 +00003382Note that while this option can give deterministic behavior, it does not
3383provide cycle accurate emulation. Modern CPUs contain superscalar out of
3384order cores with complex cache hierarchies. The number of instructions
3385executed often has little or no correlation with actual performance.
Sebastian Tanasea8bfac32014-07-25 11:56:29 +02003386
Daniel P. Berrangeb6af0972015-08-26 12:17:13 +01003387@option{align=on} will activate the delay algorithm which will try
Sebastian Tanasea8bfac32014-07-25 11:56:29 +02003388to synchronise the host clock and the virtual clock. The goal is to
3389have a guest running at the real frequency imposed by the shift option.
3390Whenever the guest clock is behind the host clock and if
Michael Tokarev82597612015-04-27 11:12:49 +03003391@option{align=on} is specified then we print a message to the user
Sebastian Tanasea8bfac32014-07-25 11:56:29 +02003392to inform about the delay.
3393Currently this option does not work when @option{shift} is @code{auto}.
3394Note: The sync algorithm will work for those shift values for which
3395the guest clock runs ahead of the host clock. Typically this happens
3396when the shift value is high (how high depends on the host machine).
Pavel Dovgalyuk4c27b852015-09-17 19:25:18 +03003397
3398When @option{rr} option is specified deterministic record/replay is enabled.
3399Replay log is written into @var{filename} file in record mode and
3400read from this file in replay mode.
blueswir15824d652009-03-28 06:44:27 +00003401ETEXI
3402
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003403DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
Xu Wangd7933ef2015-06-11 17:32:05 +02003404 "-watchdog model\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003405 " enable virtual hardware watchdog [default=none]\n",
3406 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003407STEXI
3408@item -watchdog @var{model}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003409@findex -watchdog
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003410Create a virtual hardware watchdog device. Once enabled (by a guest
3411action), the watchdog must be periodically polled by an agent inside
Xu Wangd7933ef2015-06-11 17:32:05 +02003412the guest or else the guest will be restarted. Choose a model for
3413which your guest has drivers.
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003414
Xu Wangd7933ef2015-06-11 17:32:05 +02003415The @var{model} is the model of hardware watchdog to emulate. Use
3416@code{-watchdog help} to list available hardware models. Only one
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003417watchdog can be enabled for a guest.
Xu Wangd7933ef2015-06-11 17:32:05 +02003418
3419The following models may be available:
3420@table @option
3421@item ib700
3422iBASE 700 is a very simple ISA watchdog with a single timer.
3423@item i6300esb
3424Intel 6300ESB I/O controller hub is a much more featureful PCI-based
3425dual-timer watchdog.
Xu Wang188f24c2015-02-05 18:28:32 +08003426@item diag288
3427A virtual watchdog for s390x backed by the diagnose 288 hypercall
3428(currently KVM only).
Xu Wangd7933ef2015-06-11 17:32:05 +02003429@end table
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003430ETEXI
3431
3432DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
3433 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003434 " action when watchdog fires [default=reset]\n",
3435 QEMU_ARCH_ALL)
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003436STEXI
3437@item -watchdog-action @var{action}
Markus Armbrusterb8f490e2013-02-13 19:49:38 +01003438@findex -watchdog-action
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003439
3440The @var{action} controls what QEMU will do when the watchdog timer
3441expires.
3442The default is
3443@code{reset} (forcefully reset the guest).
3444Other possible actions are:
3445@code{shutdown} (attempt to gracefully shutdown the guest),
3446@code{poweroff} (forcefully poweroff the guest),
3447@code{pause} (pause the guest),
3448@code{debug} (print a debug message and continue), or
3449@code{none} (do nothing).
3450
3451Note that the @code{shutdown} action requires that the guest responds
3452to ACPI signals, which it may not be able to do in the sort of
3453situations where the watchdog would have expired, and thus
3454@code{-watchdog-action shutdown} is not recommended for production use.
3455
3456Examples:
3457
3458@table @code
3459@item -watchdog i6300esb -watchdog-action pause
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02003460@itemx -watchdog ib700
Richard W.M. Jones9dd986c2009-04-25 13:56:19 +01003461@end table
3462ETEXI
3463
blueswir15824d652009-03-28 06:44:27 +00003464DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
Blue Swirlad960902010-03-29 19:23:52 +00003465 "-echr chr set terminal escape character instead of ctrl-a\n",
3466 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003467STEXI
3468
Kevin Wolf4e257e52009-10-09 10:58:36 +02003469@item -echr @var{numeric_ascii_value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003470@findex -echr
blueswir15824d652009-03-28 06:44:27 +00003471Change the escape character used for switching to the monitor when using
3472monitor and serial sharing. The default is @code{0x01} when using the
3473@code{-nographic} option. @code{0x01} is equal to pressing
3474@code{Control-a}. You can select a different character from the ascii
3475control keys where 1 through 26 map to Control-a through Control-z. For
3476instance you could use the either of the following to change the escape
3477character to Control-t.
3478@table @code
3479@item -echr 0x14
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02003480@itemx -echr 20
blueswir15824d652009-03-28 06:44:27 +00003481@end table
3482ETEXI
3483
3484DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
3485 "-virtioconsole c\n" \
Blue Swirlad960902010-03-29 19:23:52 +00003486 " set virtio console\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003487STEXI
3488@item -virtioconsole @var{c}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003489@findex -virtioconsole
blueswir15824d652009-03-28 06:44:27 +00003490Set virtio console.
Amit Shah98b19252010-01-20 00:36:52 +05303491
3492This option is maintained for backward compatibility.
3493
3494Please use @code{-device virtconsole} for the new way of invocation.
blueswir15824d652009-03-28 06:44:27 +00003495ETEXI
3496
3497DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
Blue Swirlad960902010-03-29 19:23:52 +00003498 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003499STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01003500@item -show-cursor
Stefan Weil6616b2a2010-02-05 23:52:05 +01003501@findex -show-cursor
Stefan Weil95d5f082010-01-20 22:25:27 +01003502Show cursor.
blueswir15824d652009-03-28 06:44:27 +00003503ETEXI
3504
3505DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
Blue Swirlad960902010-03-29 19:23:52 +00003506 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003507STEXI
Stefan Weil95d5f082010-01-20 22:25:27 +01003508@item -tb-size @var{n}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003509@findex -tb-size
Stefan Weil95d5f082010-01-20 22:25:27 +01003510Set TB size.
blueswir15824d652009-03-28 06:44:27 +00003511ETEXI
3512
3513DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
Michael Tokarev7c601802015-02-10 22:40:47 +03003514 "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \
3515 "-incoming rdma:host:port[,ipv4][,ipv6]\n" \
3516 "-incoming unix:socketpath\n" \
3517 " prepare for incoming migration, listen on\n" \
3518 " specified protocol and socket address\n" \
3519 "-incoming fd:fd\n" \
3520 "-incoming exec:cmdline\n" \
3521 " accept incoming migration on given file descriptor\n" \
Dr. David Alan Gilbert15970512015-05-29 19:52:52 +01003522 " or from given external command\n" \
3523 "-incoming defer\n" \
3524 " wait for the URI to be specified via migrate_incoming\n",
Blue Swirlad960902010-03-29 19:23:52 +00003525 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003526STEXI
Michael Tokarev7c601802015-02-10 22:40:47 +03003527@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]
Markus Armbrusterf9cfd652015-06-15 14:35:59 +02003528@itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6]
Stefan Weil6616b2a2010-02-05 23:52:05 +01003529@findex -incoming
Michael Tokarev7c601802015-02-10 22:40:47 +03003530Prepare for incoming migration, listen on a given tcp port.
3531
3532@item -incoming unix:@var{socketpath}
3533Prepare for incoming migration, listen on a given unix socket.
3534
3535@item -incoming fd:@var{fd}
3536Accept incoming migration from a given filedescriptor.
3537
3538@item -incoming exec:@var{cmdline}
3539Accept incoming migration as an output from specified external command.
Dr. David Alan Gilbert15970512015-05-29 19:52:52 +01003540
3541@item -incoming defer
3542Wait for the URI to be specified via migrate_incoming. The monitor can
3543be used to change settings (such as migration parameters) prior to issuing
3544the migrate_incoming to allow the migration to begin.
blueswir15824d652009-03-28 06:44:27 +00003545ETEXI
3546
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01003547DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
Blue Swirlad960902010-03-29 19:23:52 +00003548 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01003549STEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003550@item -nodefaults
Stefan Weil6616b2a2010-02-05 23:52:05 +01003551@findex -nodefaults
Michal Novotny66c19bf2012-07-16 14:35:10 +02003552Don't create default devices. Normally, QEMU sets the default devices like serial
3553port, parallel port, virtual console, monitor device, VGA adapter, floppy and
3554CD-ROM drive and others. The @code{-nodefaults} option will disable all those
3555default devices.
Gerd Hoffmannd8c208d2009-12-08 13:11:46 +01003556ETEXI
3557
blueswir15824d652009-03-28 06:44:27 +00003558#ifndef _WIN32
3559DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
Blue Swirlad960902010-03-29 19:23:52 +00003560 "-chroot dir chroot to dir just before starting the VM\n",
3561 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003562#endif
3563STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02003564@item -chroot @var{dir}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003565@findex -chroot
blueswir15824d652009-03-28 06:44:27 +00003566Immediately before starting guest execution, chroot to the specified
3567directory. Especially useful in combination with -runas.
3568ETEXI
3569
3570#ifndef _WIN32
3571DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
Blue Swirlad960902010-03-29 19:23:52 +00003572 "-runas user change to user id user just before starting the VM\n",
3573 QEMU_ARCH_ALL)
blueswir15824d652009-03-28 06:44:27 +00003574#endif
3575STEXI
Kevin Wolf4e257e52009-10-09 10:58:36 +02003576@item -runas @var{user}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003577@findex -runas
blueswir15824d652009-03-28 06:44:27 +00003578Immediately before starting guest execution, drop root privileges, switching
3579to the specified user.
3580ETEXI
3581
blueswir15824d652009-03-28 06:44:27 +00003582DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
3583 "-prom-env variable=value\n"
Blue Swirlad960902010-03-29 19:23:52 +00003584 " set OpenBIOS nvram variables\n",
3585 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
Stefan Weil95d5f082010-01-20 22:25:27 +01003586STEXI
3587@item -prom-env @var{variable}=@var{value}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003588@findex -prom-env
Stefan Weil95d5f082010-01-20 22:25:27 +01003589Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
3590ETEXI
blueswir15824d652009-03-28 06:44:27 +00003591DEF("semihosting", 0, QEMU_OPTION_semihosting,
Michael Wallef7bbcfb2014-04-22 20:18:42 +02003592 "-semihosting semihosting mode\n",
Leon Alrae3b3c1692015-06-19 11:08:43 +01003593 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
3594 QEMU_ARCH_MIPS)
Stefan Weil95d5f082010-01-20 22:25:27 +01003595STEXI
3596@item -semihosting
Stefan Weil6616b2a2010-02-05 23:52:05 +01003597@findex -semihosting
Leon Alrae3b3c1692015-06-19 11:08:43 +01003598Enable semihosting mode (ARM, M68K, Xtensa, MIPS only).
Liviu Ionescua38bb072014-12-11 12:07:48 +00003599ETEXI
3600DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config,
Leon Alraea59d31a2015-06-19 14:17:45 +01003601 "-semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]]\n" \
3602 " semihosting configuration\n",
Leon Alrae3b3c1692015-06-19 11:08:43 +01003603QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
3604QEMU_ARCH_MIPS)
Liviu Ionescua38bb072014-12-11 12:07:48 +00003605STEXI
Leon Alraea59d31a2015-06-19 14:17:45 +01003606@item -semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]]
Liviu Ionescua38bb072014-12-11 12:07:48 +00003607@findex -semihosting-config
Leon Alrae3b3c1692015-06-19 11:08:43 +01003608Enable and configure semihosting (ARM, M68K, Xtensa, MIPS only).
Leon Alraea59d31a2015-06-19 14:17:45 +01003609@table @option
3610@item target=@code{native|gdb|auto}
3611Defines where the semihosting calls will be addressed, to QEMU (@code{native})
3612or to GDB (@code{gdb}). The default is @code{auto}, which means @code{gdb}
3613during debug sessions and @code{native} otherwise.
3614@item arg=@var{str1},arg=@var{str2},...
3615Allows the user to pass input arguments, and can be used multiple times to build
3616up a list. The old-style @code{-kernel}/@code{-append} method of passing a
3617command line is still supported for backward compatibility. If both the
3618@code{--semihosting-config arg} and the @code{-kernel}/@code{-append} are
3619specified, the former is passed to semihosting as it always takes precedence.
3620@end table
Stefan Weil95d5f082010-01-20 22:25:27 +01003621ETEXI
blueswir15824d652009-03-28 06:44:27 +00003622DEF("old-param", 0, QEMU_OPTION_old_param,
Blue Swirlad960902010-03-29 19:23:52 +00003623 "-old-param old param mode\n", QEMU_ARCH_ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01003624STEXI
3625@item -old-param
Stefan Weil6616b2a2010-02-05 23:52:05 +01003626@findex -old-param (ARM)
Stefan Weil95d5f082010-01-20 22:25:27 +01003627Old param mode (ARM only).
3628ETEXI
3629
Eduardo Otubo7d76ad42012-08-14 18:44:08 -03003630DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \
3631 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n",
3632 QEMU_ARCH_ALL)
3633STEXI
Markus Armbruster6265c432013-02-13 19:49:39 +01003634@item -sandbox @var{arg}
Eduardo Otubo7d76ad42012-08-14 18:44:08 -03003635@findex -sandbox
3636Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will
3637disable it. The default is 'off'.
3638ETEXI
3639
Gerd Hoffmann715a6642009-10-14 10:39:28 +02003640DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
Blue Swirlad960902010-03-29 19:23:52 +00003641 "-readconfig <file>\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003642STEXI
3643@item -readconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003644@findex -readconfig
Michal Novotnyed24cfa2012-07-16 14:28:32 +02003645Read device configuration from @var{file}. This approach is useful when you want to spawn
3646QEMU process with many command line options but you don't want to exceed the command line
3647character limit.
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003648ETEXI
Gerd Hoffmann715a6642009-10-14 10:39:28 +02003649DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
3650 "-writeconfig <file>\n"
Blue Swirlad960902010-03-29 19:23:52 +00003651 " read/write config file\n", QEMU_ARCH_ALL)
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003652STEXI
3653@item -writeconfig @var{file}
Stefan Weil6616b2a2010-02-05 23:52:05 +01003654@findex -writeconfig
Michal Novotnyed24cfa2012-07-16 14:28:32 +02003655Write device configuration to @var{file}. The @var{file} can be either filename to save
3656command line and device configuration into file or dash @code{-}) character to print the
3657output to stdout. This can be later used as input file for @code{-readconfig} option.
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003658ETEXI
Anthony Liguori292444c2010-01-21 10:57:58 -06003659DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
3660 "-nodefconfig\n"
Blue Swirlad960902010-03-29 19:23:52 +00003661 " do not load default config files at startup\n",
3662 QEMU_ARCH_ALL)
Anthony Liguori292444c2010-01-21 10:57:58 -06003663STEXI
3664@item -nodefconfig
Stefan Weil6616b2a2010-02-05 23:52:05 +01003665@findex -nodefconfig
Eduardo Habkostf29a5612012-05-02 13:07:29 -03003666Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
3667The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
3668ETEXI
3669DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
3670 "-no-user-config\n"
3671 " do not load user-provided config files at startup\n",
3672 QEMU_ARCH_ALL)
3673STEXI
3674@item -no-user-config
3675@findex -no-user-config
3676The @code{-no-user-config} option makes QEMU not load any of the user-provided
3677config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config
3678files from @var{datadir}.
Anthony Liguori292444c2010-01-21 10:57:58 -06003679ETEXI
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003680DEF("trace", HAS_ARG, QEMU_OPTION_trace,
Paolo Bonzini10578a22016-01-07 16:55:26 +03003681 "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
Lluís23d15e82011-08-31 20:31:31 +02003682 " specify tracing options\n",
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003683 QEMU_ARCH_ALL)
3684STEXI
Lluís23d15e82011-08-31 20:31:31 +02003685HXCOMM This line is not accurate, as some sub-options are backend-specific but
3686HXCOMM HX does not support conditional compilation of text.
Denis V. Luneve370ad92016-06-17 17:44:08 +03003687@item -trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}]
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003688@findex -trace
Denis V. Luneveeb2b8f2016-06-17 17:44:09 +03003689@include qemu-option-trace.texi
Prerna Saxenaab6540d2010-08-09 11:48:32 +01003690ETEXI
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003691
Markus Armbruster31e70d62013-02-13 19:49:37 +01003692HXCOMM Internal use
3693DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL)
3694DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL)
Anthony Liguoric7f0f3b2012-03-28 15:42:02 +02003695
Paul Moore0f669982012-08-03 14:39:21 -04003696#ifdef __linux__
3697DEF("enable-fips", 0, QEMU_OPTION_enablefips,
3698 "-enable-fips enable FIPS 140-2 compliance\n",
3699 QEMU_ARCH_ALL)
3700#endif
3701STEXI
3702@item -enable-fips
3703@findex -enable-fips
3704Enable FIPS 140-2 compliance mode.
3705ETEXI
3706
Jan Kiszkaa0dac022012-10-05 14:51:45 -03003707HXCOMM Deprecated by -machine accel=tcg property
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003708DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386)
Jan Kiszkaa0dac022012-10-05 14:51:45 -03003709
Jan Kiszkac21fb4f2012-10-05 14:51:42 -03003710HXCOMM Deprecated by kvm-pit driver properties
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003711DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection,
Jan Kiszkac21fb4f2012-10-05 14:51:42 -03003712 "", QEMU_ARCH_I386)
3713
Jan Kiszka4086bde2012-10-05 14:51:41 -03003714HXCOMM Deprecated (ignored)
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003715DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386)
Jan Kiszka4086bde2012-10-05 14:51:41 -03003716
Jan Kiszkae43d5942012-10-05 14:51:40 -03003717HXCOMM Deprecated by -machine kernel_irqchip=on|off property
Bruce Rogersc6e88b32012-11-20 07:11:21 -07003718DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386)
Jan Kiszkae43d5942012-10-05 14:51:40 -03003719
Jan Kiszka88eed342012-10-05 14:51:44 -03003720HXCOMM Deprecated (ignored)
3721DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL)
3722
Seiji Aguchi5e2ac512013-07-03 23:02:46 -04003723DEF("msg", HAS_ARG, QEMU_OPTION_msg,
3724 "-msg timestamp[=on|off]\n"
3725 " change the format of messages\n"
3726 " on|off controls leading timestamps (default:on)\n",
3727 QEMU_ARCH_ALL)
3728STEXI
3729@item -msg timestamp[=on|off]
3730@findex -msg
3731prepend a timestamp to each log message.(default:on)
3732ETEXI
3733
Amit Shahabfd9ce2014-06-20 18:56:08 +05303734DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate,
3735 "-dump-vmstate <file>\n"
3736 " Output vmstate information in JSON format to file.\n"
3737 " Use the scripts/vmstate-static-checker.py file to\n"
3738 " check for possible regressions in migration code\n"
Laurent Vivier23820532015-09-04 21:30:04 +02003739 " by comparing two such vmstate dumps.\n",
Amit Shahabfd9ce2014-06-20 18:56:08 +05303740 QEMU_ARCH_ALL)
3741STEXI
3742@item -dump-vmstate @var{file}
3743@findex -dump-vmstate
3744Dump json-encoded vmstate information for current machine type to file
3745in @var{file}
3746ETEXI
3747
Daniel P. Berrangeb9174d42015-05-13 17:14:03 +01003748DEFHEADING(Generic object creation)
3749
3750DEF("object", HAS_ARG, QEMU_OPTION_object,
3751 "-object TYPENAME[,PROP1=VALUE1,...]\n"
3752 " create a new object of type TYPENAME setting properties\n"
3753 " in the order they are specified. Note that the 'id'\n"
3754 " property must be set. These objects are placed in the\n"
3755 " '/objects' path.\n",
3756 QEMU_ARCH_ALL)
3757STEXI
3758@item -object @var{typename}[,@var{prop1}=@var{value1},...]
3759@findex -object
3760Create a new object of type @var{typename} setting properties
3761in the order they are specified. Note that the 'id'
3762property must be set. These objects are placed in the
3763'/objects' path.
3764
3765@table @option
3766
3767@item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off}
3768
3769Creates a memory file backend object, which can be used to back
3770the guest RAM with huge pages. The @option{id} parameter is a
3771unique ID that will be used to reference this memory region
3772when configuring the @option{-numa} argument. The @option{size}
3773option provides the size of the memory region, and accepts
3774common suffixes, eg @option{500M}. The @option{mem-path} provides
3775the path to either a shared memory or huge page filesystem mount.
3776The @option{share} boolean option determines whether the memory
3777region is marked as private to QEMU, or shared. The latter allows
3778a co-operating external process to access the QEMU memory region.
3779
3780@item -object rng-random,id=@var{id},filename=@var{/dev/random}
3781
3782Creates a random number generator backend which obtains entropy from
3783a device on the host. The @option{id} parameter is a unique ID that
3784will be used to reference this entropy backend from the @option{virtio-rng}
3785device. The @option{filename} parameter specifies which file to obtain
3786entropy from and if omitted defaults to @option{/dev/random}.
3787
3788@item -object rng-egd,id=@var{id},chardev=@var{chardevid}
3789
3790Creates a random number generator backend which obtains entropy from
3791an external daemon running on the host. The @option{id} parameter is
3792a unique ID that will be used to reference this entropy backend from
3793the @option{virtio-rng} device. The @option{chardev} parameter is
3794the unique ID of a character device backend that provides the connection
3795to the RNG daemon.
3796
Daniel P. Berrangee00adf62015-03-13 17:39:26 +00003797@item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off}
3798
3799Creates a TLS anonymous credentials object, which can be used to provide
3800TLS support on network backends. The @option{id} parameter is a unique
3801ID which network backends will use to access the credentials. The
3802@option{endpoint} is either @option{server} or @option{client} depending
3803on whether the QEMU network backend that uses the credentials will be
3804acting as a client or as a server. If @option{verify-peer} is enabled
3805(the default) then once the handshake is completed, the peer credentials
3806will be verified, though this is a no-op for anonymous credentials.
3807
3808The @var{dir} parameter tells QEMU where to find the credential
3809files. For server endpoints, this directory may contain a file
3810@var{dh-params.pem} providing diffie-hellman parameters to use
3811for the TLS server. If the file is missing, QEMU will generate
3812a set of DH parameters at startup. This is a computationally
3813expensive operation that consumes random pool entropy, so it is
3814recommended that a persistent set of parameters be generated
3815upfront and saved.
3816
Daniel P. Berrange1d7b5b42015-10-15 16:14:42 +01003817@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 +00003818
3819Creates a TLS anonymous credentials object, which can be used to provide
3820TLS support on network backends. The @option{id} parameter is a unique
3821ID which network backends will use to access the credentials. The
3822@option{endpoint} is either @option{server} or @option{client} depending
3823on whether the QEMU network backend that uses the credentials will be
3824acting as a client or as a server. If @option{verify-peer} is enabled
3825(the default) then once the handshake is completed, the peer credentials
3826will be verified. With x509 certificates, this implies that the clients
3827must be provided with valid client certificates too.
3828
3829The @var{dir} parameter tells QEMU where to find the credential
3830files. For server endpoints, this directory may contain a file
3831@var{dh-params.pem} providing diffie-hellman parameters to use
3832for the TLS server. If the file is missing, QEMU will generate
3833a set of DH parameters at startup. This is a computationally
3834expensive operation that consumes random pool entropy, so it is
3835recommended that a persistent set of parameters be generated
3836upfront and saved.
3837
3838For x509 certificate credentials the directory will contain further files
3839providing the x509 certificates. The certificates must be stored
3840in PEM format, in filenames @var{ca-cert.pem}, @var{ca-crl.pem} (optional),
3841@var{server-cert.pem} (only servers), @var{server-key.pem} (only servers),
3842@var{client-cert.pem} (only clients), and @var{client-key.pem} (only clients).
3843
Daniel P. Berrange1d7b5b42015-10-15 16:14:42 +01003844For the @var{server-key.pem} and @var{client-key.pem} files which
3845contain sensitive private keys, it is possible to use an encrypted
3846version by providing the @var{passwordid} parameter. This provides
3847the ID of a previously created @code{secret} object containing the
3848password for decryption.
3849
zhanghailiang338d3f42016-03-01 13:37:02 +08003850@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 +08003851
3852Interval @var{t} can't be 0, this filter batches the packet delivery: all
3853packets arriving in a given interval on netdev @var{netdevid} are delayed
3854until the end of the interval. Interval is in microseconds.
zhanghailiang338d3f42016-03-01 13:37:02 +08003855@option{status} is optional that indicate whether the netfilter is
3856on (enabled) or off (disabled), the default status for netfilter will be 'on'.
Yang Hongyang7dbb11c2015-10-07 11:52:21 +08003857
3858queue @var{all|rx|tx} is an option that can be applied to any netfilter.
3859
3860@option{all}: the filter is attached both to the receive and the transmit
3861 queue of the netdev (default).
3862
3863@option{rx}: the filter is attached to the receive queue of the netdev,
3864 where it will receive packets sent to the netdev.
3865
3866@option{tx}: the filter is attached to the transmit queue of the netdev,
3867 where it will receive packets sent by the netdev.
3868
Zhang Chenf6d3afb2016-03-15 15:41:33 +08003869@item -object filter-mirror,id=@var{id},netdev=@var{netdevid},outdev=@var{chardevid}[,queue=@var{all|rx|tx}]
3870
3871filter-mirror on netdev @var{netdevid},mirror net packet to chardev
3872@var{chardevid}
3873
Zhang Chend46f75b2016-03-17 16:16:26 +08003874@item -object filter-redirector,id=@var{id},netdev=@var{netdevid},indev=@var{chardevid},
3875outdev=@var{chardevid}[,queue=@var{all|rx|tx}]
3876
3877filter-redirector on netdev @var{netdevid},redirect filter's net packet to chardev
3878@var{chardevid},and redirect indev's packet to filter.
3879Create a filter-redirector we need to differ outdev id from indev id, id can not
3880be the same. we can just use indev or outdev, but at least one of indev or outdev
3881need to be specified.
3882
Thomas Huthd3e0c032015-10-13 12:40:02 +02003883@item -object filter-dump,id=@var{id},netdev=@var{dev},file=@var{filename}][,maxlen=@var{len}]
3884
3885Dump the network traffic on netdev @var{dev} to the file specified by
3886@var{filename}. At most @var{len} bytes (64k by default) per packet are stored.
3887The file format is libpcap, so it can be analyzed with tools such as tcpdump
3888or Wireshark.
3889
Daniel P. Berrangeac1d8872015-10-14 09:58:38 +01003890@item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
3891@item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
3892
3893Defines a secret to store a password, encryption key, or some other sensitive
3894data. The sensitive data can either be passed directly via the @var{data}
3895parameter, or indirectly via the @var{file} parameter. Using the @var{data}
3896parameter is insecure unless the sensitive data is encrypted.
3897
3898The sensitive data can be provided in raw format (the default), or base64.
3899When encoded as JSON, the raw format only supports valid UTF-8 characters,
3900so base64 is recommended for sending binary data. QEMU will convert from
3901which ever format is provided to the format it needs internally. eg, an
3902RBD password can be provided in raw format, even though it will be base64
3903encoded when passed onto the RBD sever.
3904
3905For added protection, it is possible to encrypt the data associated with
3906a secret using the AES-256-CBC cipher. Use of encryption is indicated
3907by providing the @var{keyid} and @var{iv} parameters. The @var{keyid}
3908parameter provides the ID of a previously defined secret that contains
3909the AES-256 decryption key. This key should be 32-bytes long and be
3910base64 encoded. The @var{iv} parameter provides the random initialization
3911vector used for encryption of this particular secret and should be a
Daniel P. Berrange69c0b272016-04-04 10:33:55 +01003912base64 encrypted string of the 16-byte IV.
Daniel P. Berrangeac1d8872015-10-14 09:58:38 +01003913
3914The simplest (insecure) usage is to provide the secret inline
3915
3916@example
3917
3918 # $QEMU -object secret,id=sec0,data=letmein,format=raw
3919
3920@end example
3921
3922The simplest secure usage is to provide the secret via a file
3923
3924 # echo -n "letmein" > mypasswd.txt
3925 # $QEMU -object secret,id=sec0,file=mypasswd.txt,format=raw
3926
3927For greater security, AES-256-CBC should be used. To illustrate usage,
3928consider the openssl command line tool which can encrypt the data. Note
3929that when encrypting, the plaintext must be padded to the cipher block
3930size (32 bytes) using the standard PKCS#5/6 compatible padding algorithm.
3931
3932First a master key needs to be created in base64 encoding:
3933
3934@example
3935 # openssl rand -base64 32 > key.b64
3936 # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"')
3937@end example
3938
3939Each secret to be encrypted needs to have a random initialization vector
3940generated. These do not need to be kept secret
3941
3942@example
3943 # openssl rand -base64 16 > iv.b64
3944 # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"')
3945@end example
3946
3947The secret to be defined can now be encrypted, in this case we're
3948telling openssl to base64 encode the result, but it could be left
3949as raw bytes if desired.
3950
3951@example
3952 # SECRET=$(echo -n "letmein" |
3953 openssl enc -aes-256-cbc -a -K $KEY -iv $IV)
3954@end example
3955
3956When launching QEMU, create a master secret pointing to @code{key.b64}
3957and specify that to be used to decrypt the user password. Pass the
3958contents of @code{iv.b64} to the second secret
3959
3960@example
3961 # $QEMU \
3962 -object secret,id=secmaster0,format=base64,file=key.b64 \
3963 -object secret,id=sec0,keyid=secmaster0,format=base64,\
3964 data=$SECRET,iv=$(<iv.b64)
3965@end example
3966
Daniel P. Berrangeb9174d42015-05-13 17:14:03 +01003967@end table
3968
3969ETEXI
3970
3971
Stefan Weil3dbf2c72010-01-16 18:19:44 +01003972HXCOMM This is the last statement. Insert new options before this line!
3973STEXI
3974@end table
3975ETEXI