| blob | 0b621bb99e8d3a42b37854a622caf2f69cf9fb35 |
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
6 HXCOMM architectures.
10 STEXI
11 @table @option
12 ETEXI
16 STEXI
17 @item -h
18 @findex -h
19 Display help and exit
20 ETEXI
24 STEXI
25 @item -version
26 @findex -version
27 Display version information and exit
28 ETEXI
47 QEMU_ARCH_ALL)
48 STEXI
50 @findex -machine
53 @table @option
58 to initialize.
59 @item kernel_irqchip=on|off
61 @item gfx_passthru=on|off
63 @item vmport=on|off|auto
66 is on.
67 @item kvm_shadow_mem=size
68 Defines the size of the KVM shadow MMU.
77 controls whether AES wrapping keys will be created to allow
81 controls whether DEA wrapping keys will be created to allow
83 @item nvdimm=on|off
85 @end table
86 ETEXI
88 HXCOMM Deprecated by -machine
93 STEXI
95 @findex -cpu
97 ETEXI
107 QEMU_ARCH_ALL)
108 STEXI
109 @item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
110 @findex -smp
118 specifies the maximum number of hotpluggable CPUs.
119 ETEXI
124 STEXI
127 @findex -numa
131 resources. That is, it just assigns existing resources to NUMA nodes. This
132 means that one still has to use the @option{-m}, @option{-smp} options
133 to allocate RAM and VCPUs respectively, and possibly @option{-object}
134 to specify the memory backend for the @samp{memdev} suboption.
136 @samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one
137 node uses @samp{memdev}, all of them have to use it.
138 ETEXI
140 DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
143 STEXI
144 @item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
145 @findex -add-fd
147 Add a file descriptor to an fd set. Valid options are:
149 @table @option
150 @item fd=@var{fd}
151 This option defines the file descriptor of which a duplicate is added to fd set.
152 The file descriptor cannot be stdin, stdout, or stderr.
153 @item set=@var{set}
154 This option defines the ID of the fd set to add the file descriptor to.
155 @item opaque=@var{opaque}
156 This option defines a free-form string that can be used to describe @var{fd}.
157 @end table
159 You can open an image using pre-opened file descriptors from an fd set:
160 @example
161 qemu-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
166 ETEXI
168 DEF("set", HAS_ARG, QEMU_OPTION_set,
172 STEXI
173 @item -set @var{group}.@var{id}.@var{arg}=@var{value}
174 @findex -set
176 ETEXI
178 DEF("global", HAS_ARG, QEMU_OPTION_global,
182 QEMU_ARCH_ALL)
183 STEXI
184 @item -global @var{driver}.@var{prop}=@var{value}
185 @itemx -global driver=@var{driver},property=@var{property},value=@var{value}
186 @findex -global
189 @example
190 qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
191 @end example
194 created automatically by the machine model. To create a device which is not
200 ETEXI
209 QEMU_ARCH_ALL)
210 STEXI
211 @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]
212 @findex -boot
217 particular boot order only on the first startup, specify it via
233 system support it.
236 supports it. This only effects when boot priority is changed by
239 @example
246 @end example
249 use is discouraged as it may be removed from future versions.
250 ETEXI
259 QEMU_ARCH_ALL)
260 STEXI
262 @findex -m
266 could be used to set amount of hotpluggable memory slots and maximum amount of
273 @example
275 @end example
278 be enabled and the guest startup RAM will never increase.
279 ETEXI
281 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
283 STEXI
284 @item -mem-path @var{path}
285 @findex -mem-path
286 Allocate guest RAM from a temporarily created file in @var{path}.
287 ETEXI
289 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
291 QEMU_ARCH_ALL)
292 STEXI
293 @item -mem-prealloc
294 @findex -mem-prealloc
295 Preallocate memory when using -mem-path.
296 ETEXI
298 DEF("k", HAS_ARG, QEMU_OPTION_k,
300 QEMU_ARCH_ALL)
301 STEXI
302 @item -k @var{language}
303 @findex -k
304 Use keyboard layout @var{language} (for example @code{fr} for
305 French). This option is only needed where it is not easy to get raw PC
306 keycodes (e.g. on Macs, with some X11 servers or with a VNC or curses
308 hosts.
310 The available layouts are:
311 @example
315 @end example
318 ETEXI
323 QEMU_ARCH_ALL)
324 STEXI
328 parameters.
329 ETEXI
336 STEXI
338 @findex -soundhw
340 available sound hardware.
342 @example
349 @end example
351 Note that Linux's i810_audio OSS kernel (for AC97) module might
352 require manually specifying clocking.
354 @example
355 modprobe i810_audio clocking=48000
356 @end example
357 ETEXI
359 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
363 STEXI
364 @item -balloon none
365 @findex -balloon
366 Disable balloon device.
367 @item -balloon virtio[,addr=@var{addr}]
368 Enable virtio balloon device (default), optionally with PCI address
369 @var{addr}.
370 ETEXI
372 DEF("device", HAS_ARG, QEMU_OPTION_device,
378 QEMU_ARCH_ALL)
379 STEXI
380 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
381 @findex -device
382 Add device @var{driver}. @var{prop}=@var{value} sets driver
383 properties. Valid properties depend on the driver. To get help on
384 possible drivers and properties, use @code{-device help} and
385 @code{-device @var{driver},help}.
387 Some drivers are:
388 @item -device ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}]
390 Add an IPMI BMC. This is a simulation of a hardware management
391 interface processor that normally sits on a system. It provides
392 a watchdog and the ability to reset and power control the system.
393 You need to connect this to an IPMI interface to make it useful
395 The IPMI slave address to use for the BMC. The default is 0x20.
396 This address is the BMC's address on the I2C network of management
398 it.
400 @item -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}]
402 Add a connection to an external IPMI BMC simulator. Instead of
403 locally emulating the BMC like the above item, instead connect
404 to an external entity that provides the IPMI services.
406 A connection is made to an external BMC simulator. If you do this, it
407 is strongly recommended that you use the "reconnect=" chardev option
408 to reconnect to the simulator if the connection is lost. Note that if
409 this is not used carefully, it can be a security issue, as the
410 interface has the ability to send resets, NMIs, and power off the VM.
412 on a secure port on localhost, so neither the simulator nor QEMU is
413 exposed to any outside network.
420 Add a KCS IPMI interafce on the ISA bus. This also adds a
423 @table @option
431 @end table
438 ETEXI
446 QEMU_ARCH_ALL)
447 STEXI
449 @findex -name
454 Naming of individual threads can also be enabled on Linux to aid debugging.
455 ETEXI
460 STEXI
462 @findex -uuid
463 Set system UUID.
464 ETEXI
466 STEXI
467 @end table
468 ETEXI
472 STEXI
473 @table @option
474 ETEXI
479 STEXI
482 @findex -fda
483 @findex -fdb
485 ETEXI
493 STEXI
498 @findex -hda
499 @findex -hdb
500 @findex -hdc
501 @findex -hdd
503 ETEXI
507 QEMU_ARCH_ALL)
508 STEXI
510 @findex -cdrom
514 ETEXI
531 STEXI
533 @findex -drive
537 @table @option
543 Special files such as iSCSI devices can be specified using protocol
549 These options define where is connected the drive by defining the bus number and
550 the unit id.
562 @var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data.
564 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
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.
570 an untrusted format header.
572 This option specifies the serial number to assign to the device.
574 Specify the controller's PCI address (if=virtio only).
575 @item werror=@var{action},rerror=@var{action}
576 Specify 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
579 host disk is full; report the error to the guest otherwise).
580 The default setting is @option{werror=enospc} and @option{rerror=report}.
581 @item readonly
582 Open drive @option{file} as read-only. Guest write attempts will fail.
583 @item copy-on-read=@var{copy-on-read}
584 @var{copy-on-read} is "on" or "off" and enables whether to copy read backing
585 file sectors into the image file.
586 @item detect-zeroes=@var{detect-zeroes}
587 @var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic
588 conversion of plain zero writes by the OS to driver specific optimized
589 zero write commands. You may even choose "unmap" if @var{discard} is set
590 to "unmap" to allow a zero write to be converted to an UNMAP operation.
591 @end table
593 By default, the @option{cache=writeback} mode is used. It will report data
594 writes as completed as soon as the data is present in the host page cache.
595 This is safe as long as your guest OS makes sure to correctly flush disk caches
596 where needed. If your guest OS does not handle volatile disk write caches
597 correctly and your host crashes or loses power, then the guest may experience
598 data corruption.
600 For such guests, you should consider using @option{cache=writethrough}. This
601 means that the host page cache will be used to read and write data, but write
602 notification will be sent to the guest only after QEMU has made sure to flush
603 each write to the disk. Be aware that this has a major impact on performance.
605 The host page cache can be avoided entirely with @option{cache=none}. This will
608 the guest OS must handle the disk write cache correctly in order to avoid data
609 corruption on host crashes.
611 The host page cache can be avoided while only sending write notifications to
612 the guest when the data has been flushed to the disk using
616 @option{cache=unsafe}. This option tells QEMU that it never needs to write any
617 data to the disk but can instead keep things in cache. If anything goes wrong,
618 like your host losing power, the disk storage getting disconnected accidentally,
619 etc. your image will most probably be rendered unusable. When using
620 the @option{-snapshot} option, unsafe caching is always used.
622 Copy-on-read avoids accessing the same backing file sectors repeatedly and is
623 useful when the backing file is over a slow network. By default copy-on-read
624 is off.
626 Instead of @option{-cdrom} you can use:
627 @example
628 qemu-system-i386 -drive file=file,index=2,media=cdrom
629 @end example
631 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
632 use:
633 @example
634 qemu-system-i386 -drive file=file,index=0,media=disk
635 qemu-system-i386 -drive file=file,index=1,media=disk
636 qemu-system-i386 -drive file=file,index=2,media=disk
637 qemu-system-i386 -drive file=file,index=3,media=disk
638 @end example
640 You can open an image using pre-opened file descriptors from an fd set:
641 @example
642 qemu-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
648 You can connect a CDROM to the slave of ide0:
649 @example
650 qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom
651 @end example
654 @example
656 @end example
659 @example
661 @end example
664 @example
667 @end example
670 incremented:
671 @example
673 @end example
674 is interpreted like:
675 @example
676 qemu-system-i386 -hda a -hdb b
677 @end example
678 ETEXI
682 QEMU_ARCH_ALL)
683 STEXI
684 @item -mtdblock @var{file}
685 @findex -mtdblock
686 Use @var{file} as on-board Flash memory image.
687 ETEXI
691 STEXI
692 @item -sd @var{file}
693 @findex -sd
694 Use @var{file} as SecureDigital card image.
695 ETEXI
699 STEXI
700 @item -pflash @var{file}
701 @findex -pflash
702 Use @var{file} as a parallel flash image.
703 ETEXI
707 QEMU_ARCH_ALL)
708 STEXI
709 @item -snapshot
710 @findex -snapshot
711 Write to temporary files instead of disk image files. In this case,
712 the raw disk image you use is not written back. You can however force
713 the write back by pressing @key{C-a s} (@pxref{disk_images}).
714 ETEXI
720 QEMU_ARCH_ALL)
721 STEXI
722 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
723 @findex -hdachs
724 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
725 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
726 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
727 all those parameters. This option is useful for old MS-DOS disk
728 images.
729 ETEXI
732 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
734 QEMU_ARCH_ALL)
736 STEXI
738 @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}]
739 @findex -fsdev
740 Define a new file system device. Valid options are:
741 @table @option
742 @item @var{fsdriver}
743 This option specifies the fs driver backend to use.
745 @item id=@var{id}
746 Specifies identifier for this device
747 @item path=@var{path}
748 Specifies the export path for the file system device. Files under
749 this path will be available to the 9p client on the guest.
750 @item security_model=@var{security_model}
751 Specifies the security model to be used for this export path.
754 credentials as they are created on the guest. This requires QEMU
756 attributes like uid, gid, mode bits and link target are stored as
758 hidden .virtfs_metadata directory. Directories exported by this security model cannot
760 passthrough except the sever won't report failures if it fails to
761 set file attributes like ownership. Security model is mandatory
762 only for local fsdriver. Other fsdrivers (like handle, proxy) don't take
763 security model as a parameter.
764 @item writeout=@var{writeout}
766 This means that host page cache will be used to read and write data but
767 write notification will be sent to the guest only when the data has been
768 reported as written by the storage subsystem.
769 @item readonly
770 Enables exporting 9p share as a readonly mount for guests. By default
771 read-write access is given.
772 @item socket=@var{socket}
773 Enables proxy filesystem driver to use passed socket file for communicating
774 with virtfs-proxy-helper
775 @item sock_fd=@var{sock_fd}
776 Enables proxy filesystem driver to use passed socket descriptor for
777 communicating with virtfs-proxy-helper. Usually a helper like libvirt
778 will create socketpair and pass one of the fds as sock_fd
779 @end table
782 @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
783 Options for virtio-9p-pci driver are:
784 @table @option
785 @item fsdev=@var{id}
786 Specifies the id value specified along with -fsdev option
787 @item mount_tag=@var{mount_tag}
788 Specifies the tag name to be used by the guest to mount this export point
789 @end table
791 ETEXI
794 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
796 QEMU_ARCH_ALL)
798 STEXI
800 @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}]
801 @findex -virtfs
803 The general form of a Virtual File system pass-through options are:
804 @table @option
805 @item @var{fsdriver}
806 This option specifies the fs driver backend to use.
808 @item id=@var{id}
809 Specifies identifier for this device
810 @item path=@var{path}
811 Specifies the export path for the file system device. Files under
812 this path will be available to the 9p client on the guest.
813 @item security_model=@var{security_model}
814 Specifies the security model to be used for this export path.
817 credentials as they are created on the guest. This requires QEMU
819 attributes like uid, gid, mode bits and link target are stored as
821 hidden .virtfs_metadata directory. Directories exported by this security model cannot
823 passthrough except the sever won't report failures if it fails to
824 set file attributes like ownership. Security model is mandatory only
825 for local fsdriver. Other fsdrivers (like handle, proxy) don't take security
826 model as a parameter.
827 @item writeout=@var{writeout}
829 This means that host page cache will be used to read and write data but
830 write notification will be sent to the guest only when the data has been
831 reported as written by the storage subsystem.
832 @item readonly
833 Enables exporting 9p share as a readonly mount for guests. By default
834 read-write access is given.
835 @item socket=@var{socket}
836 Enables proxy filesystem driver to use passed socket file for
837 communicating with virtfs-proxy-helper. Usually a helper like libvirt
838 will create socketpair and pass one of the fds as sock_fd
839 @item sock_fd
840 Enables proxy filesystem driver to use passed 'sock_fd' as the socket
841 descriptor for interfacing with virtfs-proxy-helper
842 @end table
843 ETEXI
847 QEMU_ARCH_ALL)
848 STEXI
849 @item -virtfs_synth
850 @findex -virtfs_synth
851 Create synthetic file system image
852 ETEXI
854 STEXI
855 @end table
856 ETEXI
857 DEFHEADING()
859 DEFHEADING(USB options:)
860 STEXI
861 @table @option
862 ETEXI
866 QEMU_ARCH_ALL)
867 STEXI
868 @item -usb
869 @findex -usb
870 Enable the USB driver (will be the default soon)
871 ETEXI
875 QEMU_ARCH_ALL)
876 STEXI
878 @item -usbdevice @var{devname}
879 @findex -usbdevice
880 Add the USB device @var{devname}. @xref{usb_devices}.
882 @table @option
884 @item mouse
885 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
887 @item tablet
888 Pointer device that uses absolute coordinates (like a touchscreen). This
889 means QEMU is able to report the mouse position without having to grab the
890 mouse. Also overrides the PS/2 mouse emulation when activated.
892 @item disk:[format=@var{format}]:@var{file}
893 Mass storage device based on file. The optional @var{format} argument
894 will be used rather than detecting the format. Can be used to specify
895 @code{format=raw} to avoid interpreting an untrusted format header.
897 @item host:@var{bus}.@var{addr}
898 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
900 @item host:@var{vendor_id}:@var{product_id}
901 Pass through the host device identified by @var{vendor_id}:@var{product_id}
902 (Linux only).
904 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
905 Serial converter to host character device @var{dev}, see @code{-serial} for the
906 available devices.
908 @item braille
909 Braille device. This will use BrlAPI to display the braille output on a real
910 or fake device.
912 @item net:@var{options}
913 Network adapter that supports CDC ethernet and RNDIS protocols.
915 @end table
916 ETEXI
918 STEXI
919 @end table
920 ETEXI
921 DEFHEADING()
923 DEFHEADING(Display options:)
924 STEXI
925 @table @option
926 ETEXI
937 #if defined(CONFIG_GTK)
939 #elif defined(CONFIG_SDL)
941 #elif defined(CONFIG_COCOA)
943 #elif defined(CONFIG_VNC)
945 #else
947 #endif
948 , QEMU_ARCH_ALL)
949 STEXI
950 @item -display @var{type}
951 @findex -display
952 Select type of display to use. This option is a replacement for the
953 old style -sdl/-curses/... options. Valid values for @var{type} are
954 @table @option
955 @item sdl
956 Display video output via SDL (usually in a separate graphics
957 window; see the SDL documentation for other possibilities).
958 @item curses
959 Display video output via curses. For graphics device models which
960 support a text mode, QEMU can display this output using a
961 curses/ncurses interface. Nothing is displayed when the graphics
962 device is in graphical mode or if the graphics device does not support
963 a text mode. Generally only the VGA device models support text mode.
964 @item none
965 Do not display video output. The guest will still see an emulated
966 graphics card, but its output will not be displayed to the QEMU
967 user. This option differs from the -nographic option in that it
968 only affects what is done with video output; -nographic also changes
969 the destination of the serial and parallel port data.
970 @item gtk
971 Display video output in a GTK window. This interface provides drop-down
972 menus and other UI elements to configure and control the VM during
973 runtime.
974 @item vnc
975 Start a VNC server on display <arg>
976 @end table
977 ETEXI
981 QEMU_ARCH_ALL)
982 STEXI
983 @item -nographic
984 @findex -nographic
985 Normally, if QEMU is compiled with graphical window support, it displays
986 output such as guest graphics, guest console, and the QEMU monitor in a
987 window. With this option, you can totally disable graphical output so
988 that QEMU is a simple command line application. The emulated serial port
989 is redirected on the console and muxed with the monitor (unless
990 redirected elsewhere explicitly). Therefore, you can still use QEMU to
991 debug a Linux kernel with a serial console. Use @key{C-a h} for help on
992 switching between the console and monitor.
993 ETEXI
997 QEMU_ARCH_ALL)
998 STEXI
999 @item -curses
1000 @findex -curses
1001 Normally, if QEMU is compiled with graphical window support, it displays
1002 output such as guest graphics, guest console, and the QEMU monitor in a
1003 window. With this option, QEMU can display the VGA output when in text
1004 mode using a curses/ncurses interface. Nothing is displayed in graphical
1005 mode.
1006 ETEXI
1010 QEMU_ARCH_ALL)
1011 STEXI
1012 @item -no-frame
1013 @findex -no-frame
1014 Do not use decorations for SDL windows and start them using the whole
1015 available screen space. This makes the using QEMU in a dedicated desktop
1016 workspace more convenient.
1017 ETEXI
1021 QEMU_ARCH_ALL)
1022 STEXI
1023 @item -alt-grab
1024 @findex -alt-grab
1025 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
1026 affects the special keys (for fullscreen, monitor-mode switching, etc).
1027 ETEXI
1031 QEMU_ARCH_ALL)
1032 STEXI
1033 @item -ctrl-grab
1034 @findex -ctrl-grab
1035 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
1036 affects the special keys (for fullscreen, monitor-mode switching, etc).
1037 ETEXI
1041 STEXI
1042 @item -no-quit
1043 @findex -no-quit
1044 Disable SDL window close capability.
1045 ETEXI
1049 STEXI
1050 @item -sdl
1051 @findex -sdl
1052 Enable SDL.
1053 ETEXI
1073 QEMU_ARCH_ALL)
1074 STEXI
1075 @item -spice @var{option}[,@var{option}[,...]]
1076 @findex -spice
1077 Enable the spice remote desktop protocol. Valid options are
1079 @table @option
1081 @item port=<nr>
1082 Set the TCP port spice is listening on for plaintext channels.
1084 @item addr=<addr>
1085 Set the IP address spice is listening on. Default is any address.
1087 @item ipv4
1088 @itemx ipv6
1089 @itemx unix
1090 Force using the specified IP version.
1092 @item password=<secret>
1093 Set the password you need to authenticate.
1095 @item sasl
1096 Require that the client use SASL to authenticate with the spice.
1097 The exact choice of authentication method used is controlled from the
1098 system / user's SASL configuration file for the 'qemu' service. This
1099 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1100 unprivileged user, an environment variable SASL_CONF_PATH can be used
1101 to make it search alternate locations for the service config.
1102 While some SASL auth methods can also provide data encryption (eg GSSAPI),
1103 it is recommended that SASL always be combined with the 'tls' and
1104 'x509' settings to enable use of SSL and server certificates. This
1105 ensures a data encryption preventing compromise of authentication
1106 credentials.
1108 @item disable-ticketing
1109 Allow client connects without authentication.
1111 @item disable-copy-paste
1112 Disable copy paste between the client and the guest.
1114 @item disable-agent-file-xfer
1115 Disable spice-vdagent based file-xfer between the client and the guest.
1117 @item tls-port=<nr>
1118 Set the TCP port spice is listening on for encrypted channels.
1120 @item x509-dir=<dir>
1121 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
1123 @item x509-key-file=<file>
1124 @itemx x509-key-password=<file>
1125 @itemx x509-cert-file=<file>
1126 @itemx x509-cacert-file=<file>
1127 @itemx x509-dh-key-file=<file>
1128 The x509 file names can also be configured individually.
1130 @item tls-ciphers=<list>
1131 Specify which ciphers to use.
1133 @item tls-channel=[main|display|cursor|inputs|record|playback]
1134 @itemx plaintext-channel=[main|display|cursor|inputs|record|playback]
1135 Force specific channel to be used with or without TLS encryption. The
1136 options can be specified multiple times to configure multiple
1138 mode. For channels which are not explicitly forced into one mode the
1139 spice client is allowed to pick tls/plaintext as he pleases.
1141 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
1142 Configure image compression (lossless).
1143 Default is auto_glz.
1145 @item jpeg-wan-compression=[auto|never|always]
1146 @itemx zlib-glz-wan-compression=[auto|never|always]
1147 Configure wan image compression (lossy for slow links).
1148 Default is auto.
1150 @item streaming-video=[off|all|filter]
1151 Configure video stream detection. Default is off.
1153 @item agent-mouse=[on|off]
1154 Enable/disable passing mouse events via vdagent. Default is on.
1156 @item playback-compression=[on|off]
1157 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
1159 @item seamless-migration=[on|off]
1160 Enable/disable spice seamless migration. Default is off.
1162 @item gl=[on|off]
1163 Enable/disable OpenGL context. Default is off.
1165 @end table
1166 ETEXI
1170 QEMU_ARCH_ALL)
1171 STEXI
1172 @item -portrait
1173 @findex -portrait
1174 Rotate graphical output 90 deg left (only PXA LCD).
1175 ETEXI
1179 QEMU_ARCH_ALL)
1180 STEXI
1181 @item -rotate @var{deg}
1182 @findex -rotate
1183 Rotate graphical output some deg left (only PXA LCD).
1184 ETEXI
1189 STEXI
1190 @item -vga @var{type}
1191 @findex -vga
1192 Select type of VGA card to emulate. Valid values for @var{type} are
1193 @table @option
1194 @item cirrus
1195 Cirrus Logic GD5446 Video card. All Windows versions starting from
1196 Windows 95 should recognize and use this graphic card. For optimal
1197 performances, use 16 bit color depth in the guest and the host OS.
1198 (This one is the default)
1199 @item std
1200 Standard VGA card with Bochs VBE extensions. If your guest OS
1201 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
1202 to use high resolution modes (>= 1280x1024x16) then you should use
1203 this option.
1204 @item vmware
1205 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
1206 recent XFree86/XOrg server or Windows guest with a driver for this
1207 card.
1208 @item qxl
1209 QXL paravirtual graphic card. It is VGA compatible (including VESA
1210 2.0 VBE support). Works best with qxl guest drivers installed though.
1211 Recommended choice when using the spice protocol.
1212 @item tcx
1213 (sun4m only) Sun TCX framebuffer. This is the default framebuffer for
1214 sun4m machines and offers both 8-bit and 24-bit colour depths at a
1215 fixed resolution of 1024x768.
1216 @item cg3
1217 (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer
1218 for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP)
1219 resolutions aimed at people wishing to run older Solaris versions.
1220 @item virtio
1221 Virtio VGA card.
1222 @item none
1223 Disable VGA card.
1224 @end table
1225 ETEXI
1229 STEXI
1230 @item -full-screen
1231 @findex -full-screen
1232 Start in full screen.
1233 ETEXI
1237 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
1238 STEXI
1239 @item -g @var{width}x@var{height}[x@var{depth}]
1240 @findex -g
1241 Set the initial graphical resolution and depth (PPC, SPARC only).
1242 ETEXI
1246 STEXI
1247 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
1248 @findex -vnc
1249 Normally, if QEMU is compiled with graphical window support, it displays
1250 output such as guest graphics, guest console, and the QEMU monitor in a
1251 window. With this option, you can have QEMU listen on VNC display
1252 @var{display} and redirect the VGA display over the VNC session. It is
1253 very useful to enable the usb tablet device when using this option
1254 (option @option{-usbdevice tablet}). When using the VNC display, you
1255 must use the @option{-k} parameter to set the keyboard layout if you are
1256 not using en-us. Valid syntax for the @var{display} is
1258 @table @option
1260 @item to=@var{L}
1262 With this option, QEMU will try next available VNC @var{display}s, until the
1264 available, e.g. port 5900+@var{display} is already used by another
1265 application. By default, to=0.
1267 @item @var{host}:@var{d}
1269 TCP connections will only be allowed from @var{host} on display @var{d}.
1270 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
1271 be omitted in which case the server will accept connections from any host.
1273 @item unix:@var{path}
1275 Connections will be allowed over UNIX domain sockets where @var{path} is the
1276 location of a unix socket to listen for connections on.
1278 @item none
1280 VNC is initialized but not started. The monitor @code{change} command
1281 can be used to later start the VNC server.
1283 @end table
1285 Following the @var{display} value there may be one or more @var{option} flags
1286 separated by commas. Valid options are
1288 @table @option
1290 @item reverse
1292 Connect to a listening VNC client via a ``reverse'' connection. The
1293 client is specified by the @var{display}. For reverse network
1294 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
1295 is a TCP port number, not a display number.
1297 @item websocket
1299 Opens an additional TCP listening port dedicated to VNC Websocket connections.
1300 By definition the Websocket port is 5700+@var{display}. If @var{host} is
1301 specified connections will only be allowed from this host.
1302 As an alternative the Websocket port could be specified by using
1303 @code{websocket}=@var{port}.
1304 If no TLS credentials are provided, the websocket connection runs in
1305 unencrypted mode. If TLS credentials are provided, the websocket connection
1306 requires encrypted client connections.
1308 @item password
1310 Require that password based authentication is used for client connections.
1312 The password must be set separately using the @code{set_password} command in
1313 the @ref{pcsys_monitor}. The syntax to change your password is:
1314 @code{set_password <protocol> <password>} where <protocol> could be either
1317 If you would like to change <protocol> password expiration, you should use
1318 @code{expire_password <protocol> <expiration-time>} where expiration time could
1319 be one of the following options: now, never, +seconds or UNIX time of
1320 expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800
1322 date and time).
1325 allow <protocol> password to expire immediately or never expire.
1327 @item tls-creds=@var{ID}
1329 Provides the ID of a set of TLS credentials to use to secure the
1330 VNC server. They will apply to both the normal VNC server socket
1331 and the websocket socket (if enabled). Setting TLS credentials
1332 will cause the VNC server socket to enable the VeNCrypt auth
1333 mechanism. The credentials should have been previously created
1334 using the @option{-object tls-creds} argument.
1336 The @option{tls-creds} parameter obsoletes the @option{tls},
1337 @option{x509}, and @option{x509verify} options, and as such
1338 it is not permitted to set both new and old type options at
1339 the same time.
1341 @item tls
1343 Require that client use TLS when communicating with the VNC server. This
1344 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
1345 attack. It is recommended that this option be combined with either the
1346 @option{x509} or @option{x509verify} options.
1348 This option is now deprecated in favor of using the @option{tls-creds}
1349 argument.
1351 @item x509=@var{/path/to/certificate/dir}
1353 Valid if @option{tls} is specified. Require that x509 credentials are used
1354 for negotiating the TLS session. The server will send its x509 certificate
1355 to the client. It is recommended that a password be set on the VNC server
1356 to provide authentication of the client when this is used. The path following
1357 this option specifies where the x509 certificates are to be loaded from.
1358 See the @ref{vnc_security} section for details on generating certificates.
1360 This option is now deprecated in favour of using the @option{tls-creds}
1361 argument.
1363 @item x509verify=@var{/path/to/certificate/dir}
1365 Valid if @option{tls} is specified. Require that x509 credentials are used
1366 for negotiating the TLS session. The server will send its x509 certificate
1367 to the client, and request that the client send its own x509 certificate.
1368 The server will validate the client's certificate against the CA certificate,
1369 and reject clients when validation fails. If the certificate authority is
1370 trusted, this is a sufficient authentication mechanism. You may still wish
1371 to set a password on the VNC server as a second authentication layer. The
1372 path following this option specifies where the x509 certificates are to
1373 be loaded from. See the @ref{vnc_security} section for details on generating
1374 certificates.
1376 This option is now deprecated in favour of using the @option{tls-creds}
1377 argument.
1379 @item sasl
1381 Require that the client use SASL to authenticate with the VNC server.
1382 The exact choice of authentication method used is controlled from the
1383 system / user's SASL configuration file for the 'qemu' service. This
1384 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1385 unprivileged user, an environment variable SASL_CONF_PATH can be used
1386 to make it search alternate locations for the service config.
1387 While some SASL auth methods can also provide data encryption (eg GSSAPI),
1388 it is recommended that SASL always be combined with the 'tls' and
1389 'x509' settings to enable use of SSL and server certificates. This
1390 ensures a data encryption preventing compromise of authentication
1391 credentials. See the @ref{vnc_security} section for details on using
1392 SASL authentication.
1394 @item acl
1396 Turn on access control lists for checking of the x509 client certificate
1397 and SASL party. For x509 certs, the ACL check is made against the
1398 certificate's distinguished name. This is something that looks like
1399 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1400 made against the username, which depending on the SASL plugin, may
1401 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1402 When the @option{acl} flag is set, the initial access list will be
1403 empty, with a @code{deny} policy. Thus no one will be allowed to
1404 use the VNC server until the ACLs have been loaded. This can be
1405 achieved using the @code{acl} monitor command.
1407 @item lossy
1409 Enable lossy compression methods (gradient, JPEG, ...). If this
1410 option is set, VNC client may receive lossy framebuffer updates
1411 depending on its encoding settings. Enabling this option can save
1412 a lot of bandwidth at the expense of quality.
1414 @item non-adaptive
1416 Disable adaptive encodings. Adaptive encodings are enabled by default.
1417 An adaptive encoding will try to detect frequently updated screen regions,
1418 and send updates in these regions using a lossy encoding (like JPEG).
1419 This can be really helpful to save bandwidth when playing videos. Disabling
1420 adaptive encodings restores the original static behavior of encodings
1421 like Tight.
1423 @item share=[allow-exclusive|force-shared|ignore]
1425 Set display sharing policy. 'allow-exclusive' allows clients to ask
1426 for exclusive access. As suggested by the rfb spec this is
1427 implemented by dropping other connections. Connecting multiple
1428 clients in parallel requires all clients asking for a shared session
1429 (vncviewer: -shared switch). This is the default. 'force-shared'
1430 disables exclusive client access. Useful for shared desktop sessions,
1431 where you don't want someone forgetting specify -shared disconnect
1432 everybody else. 'ignore' completely ignores the shared flag and
1433 allows everybody connect unconditionally. Doesn't conform to the rfb
1434 spec but is traditional QEMU behavior.
1436 @item key-delay-ms
1438 Set keyboard delay, for key down and key up events, in milliseconds.
1439 Default is 1. Keyboards are low-bandwidth devices, so this slowdown
1440 can help the device and guest to keep up and not lose events in case
1441 events are arriving in bulk. Possible causes for the latter are flaky
1442 network connections, or scripts for automated testing.
1444 @end table
1445 ETEXI
1447 STEXI
1448 @end table
1449 ETEXI
1450 ARCHHEADING(, QEMU_ARCH_I386)
1452 ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
1453 STEXI
1454 @table @option
1455 ETEXI
1459 QEMU_ARCH_I386)
1460 STEXI
1461 @item -win2k-hack
1462 @findex -win2k-hack
1463 Use it when installing Windows 2000 to avoid a disk full bug. After
1464 Windows 2000 is installed, you no longer need this option (this option
1465 slows down the IDE transfers).
1466 ETEXI
1468 HXCOMM Deprecated by -rtc
1473 QEMU_ARCH_I386)
1474 STEXI
1475 @item -no-fd-bootchk
1476 @findex -no-fd-bootchk
1477 Disable boot signature checking for floppy disks in BIOS. May
1478 be needed to boot from old floppy disks.
1479 ETEXI
1483 STEXI
1484 @item -no-acpi
1485 @findex -no-acpi
1486 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1487 it if your guest OS complains about ACPI problems (PC target machine
1488 only).
1489 ETEXI
1493 STEXI
1494 @item -no-hpet
1495 @findex -no-hpet
1496 Disable HPET support.
1497 ETEXI
1500 "-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"
1502 STEXI
1503 @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}]...]
1504 @findex -acpitable
1505 Add ACPI table with specified header fields and context from specified files.
1506 For file=, take whole ACPI table from the specified files, including all
1507 ACPI headers (possible overridden by other options).
1508 For data=, only data
1509 portion of the table is used, all header information is specified in the
1510 command line.
1511 If a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id
1512 fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order
1513 to ensure the field matches required by the Microsoft SLIC spec and the ACPI
1514 spec.
1515 ETEXI
1538 QEMU_ARCH_I386 | QEMU_ARCH_ARM)
1539 STEXI
1540 @item -smbios file=@var{binary}
1541 @findex -smbios
1542 Load SMBIOS entry from binary file.
1544 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off]
1545 Specify SMBIOS type 0 fields
1547 @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}]
1548 Specify SMBIOS type 1 fields
1550 @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}]
1551 Specify SMBIOS type 2 fields
1553 @item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}]
1554 Specify SMBIOS type 3 fields
1556 @item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}]
1557 Specify SMBIOS type 4 fields
1559 @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}]
1560 Specify SMBIOS type 17 fields
1561 ETEXI
1563 STEXI
1564 @end table
1565 ETEXI
1566 DEFHEADING()
1568 DEFHEADING(Network options:)
1569 STEXI
1570 @table @option
1571 ETEXI
1573 HXCOMM Legacy slirp options (now moved to -net user):
1574 #ifdef CONFIG_SLIRP
1578 #ifndef _WIN32
1580 #endif
1581 #endif
1584 #ifdef CONFIG_SLIRP
1590 #ifndef _WIN32
1592 #endif
1595 #endif
1596 #ifdef _WIN32
1599 #else
1629 #endif
1630 #ifdef __linux__
1656 #endif
1666 #ifdef CONFIG_VDE
1672 #endif
1673 #ifdef CONFIG_NETMAP
1678 #endif
1692 #ifdef CONFIG_SLIRP
1694 #endif
1697 #ifdef CONFIG_VDE
1699 #endif
1700 #ifdef CONFIG_NETMAP
1702 #endif
1706 STEXI
1707 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1708 @findex -net
1709 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1710 = 0 is the default). The NIC is an e1000 by default on the PC
1711 target. Optionally, the MAC address can be changed to @var{mac}, the
1712 device address set to @var{addr} (PCI cards only),
1713 and a @var{name} can be assigned for use in monitor commands.
1714 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1715 that the card should have; this option currently only affects virtio cards; set
1716 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1717 NIC is created. QEMU can emulate several different models of network card.
1718 Valid values for @var{type} are
1719 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1720 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1721 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1722 Not all devices are supported on all targets. Use @code{-net nic,model=help}
1723 for a list of available devices for your target.
1725 @item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
1726 @findex -netdev
1727 @item -net user[,@var{option}][,@var{option}][,...]
1728 Use the user mode network stack which requires no administrator
1729 privilege to run. Valid options are:
1731 @table @option
1732 @item vlan=@var{n}
1733 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1735 @item id=@var{id}
1736 @itemx name=@var{name}
1737 Assign symbolic name for use in monitor commands.
1739 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must
1740 be enabled. If neither is specified both protocols are enabled.
1742 @item net=@var{addr}[/@var{mask}]
1743 Set IP network address the guest will see. Optionally specify the netmask,
1744 either in the form a.b.c.d or as number of valid top-most bits. Default is
1745 10.0.2.0/24.
1747 @item host=@var{addr}
1748 Specify the guest-visible address of the host. Default is the 2nd IP in the
1749 guest network, i.e. x.x.x.2.
1751 @item ipv6-net=@var{addr}[/@var{int}]
1752 Set IPv6 network address the guest will see (default is fec0::/64). The
1753 network prefix is given in the usual hexadecimal IPv6 address
1754 notation. The prefix size is optional, and is given as the number of
1755 valid top-most bits (default is 64).
1757 @item ipv6-host=@var{addr}
1758 Specify the guest-visible IPv6 address of the host. Default is the 2nd IPv6 in
1759 the guest network, i.e. xxxx::2.
1761 @item restrict=on|off
1762 If this option is enabled, the guest will be isolated, i.e. it will not be
1763 able to contact the host and no guest IP packets will be routed over the host
1764 to the outside. This option does not affect any explicitly set forwarding rules.
1766 @item hostname=@var{name}
1767 Specifies the client hostname reported by the built-in DHCP server.
1769 @item dhcpstart=@var{addr}
1770 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1771 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1773 @item dns=@var{addr}
1774 Specify the guest-visible address of the virtual nameserver. The address must
1775 be different from the host address. Default is the 3rd IP in the guest network,
1776 i.e. x.x.x.3.
1778 @item ipv6-dns=@var{addr}
1779 Specify the guest-visible address of the IPv6 virtual nameserver. The address
1780 must be different from the host address. Default is the 3rd IP in the guest
1781 network, i.e. xxxx::3.
1783 @item dnssearch=@var{domain}
1784 Provides an entry for the domain-search list sent by the built-in
1785 DHCP server. More than one domain suffix can be transmitted by specifying
1786 this option multiple times. If supported, this will cause the guest to
1787 automatically try to append the given domain suffix(es) in case a domain name
1788 can not be resolved.
1790 Example:
1791 @example
1792 qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...]
1793 @end example
1795 @item tftp=@var{dir}
1796 When using the user mode network stack, activate a built-in TFTP
1797 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1798 The TFTP client on the guest must be configured in binary mode (use the command
1799 @code{bin} of the Unix TFTP client).
1801 @item bootfile=@var{file}
1802 When using the user mode network stack, broadcast @var{file} as the BOOTP
1803 filename. In conjunction with @option{tftp}, this can be used to network boot
1804 a guest from a local directory.
1806 Example (using pxelinux):
1807 @example
1808 qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1809 @end example
1811 @item smb=@var{dir}[,smbserver=@var{addr}]
1812 When using the user mode network stack, activate a built-in SMB
1813 server so that Windows OSes can access to the host files in @file{@var{dir}}
1814 transparently. The IP address of the SMB server can be set to @var{addr}. By
1815 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1817 In the guest Windows OS, the line:
1818 @example
1819 10.0.2.4 smbserver
1820 @end example
1821 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1822 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1826 Note that a SAMBA server must be installed on the host OS.
1827 QEMU was tested successfully with smbd versions from Red Hat 9,
1828 Fedora Core 3 and OpenSUSE 11.x.
1830 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1831 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1832 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1833 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1834 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1835 be bound to a specific host interface. If no connection type is set, TCP is
1836 used. This option can be given multiple times.
1838 For example, to redirect host X11 connection from screen 1 to guest
1839 screen 0, use the following:
1841 @example
1842 # on the host
1843 qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1844 # this host xterm should open in the guest X11 server
1845 xterm -display :1
1846 @end example
1848 To redirect telnet connections from host port 5555 to telnet port on
1849 the guest, use the following:
1851 @example
1852 # on the host
1853 qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
1854 telnet localhost 5555
1855 @end example
1857 Then when you use on the host @code{telnet localhost 5555}, you
1858 connect to the guest telnet server.
1860 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1861 @itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
1862 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1863 to the character device @var{dev} or to a program executed by @var{cmd:command}
1864 which gets spawned for each connection. This option can be given multiple times.
1866 You can either use a chardev directly and have that one used throughout QEMU's
1867 lifetime, like in the following example:
1869 @example
1870 # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
1871 # the guest accesses it
1872 qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...]
1873 @end example
1875 Or you can execute a command on every TCP connection established by the guest,
1876 so that QEMU behaves similar to an inetd process for that virtual server:
1878 @example
1880 # and connect the TCP stream to its stdin/stdout
1881 qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
1882 @end example
1884 @end table
1886 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1887 processed and applied to -net user. Mixing them with the new configuration
1888 syntax gives undefined results. Their use for new applications is discouraged
1889 as they will be removed from future versions.
1891 @item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1892 @itemx -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1893 Connect the host TAP network interface @var{name} to VLAN @var{n}.
1895 Use the network script @var{file} to configure it and the network script
1896 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1897 automatically provides one. The default network configure script is
1898 @file{/etc/qemu-ifup} and the default network deconfigure script is
1899 @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1900 to disable script execution.
1902 If running QEMU as an unprivileged user, use the network helper
1903 @var{helper} to configure the TAP interface. The default network
1904 helper executable is @file{/path/to/qemu-bridge-helper}.
1906 @option{fd}=@var{h} can be used to specify the handle of an already
1907 opened host TAP interface.
1909 Examples:
1911 @example
1912 #launch a QEMU instance with the default network script
1913 qemu-system-i386 linux.img -net nic -net tap
1914 @end example
1916 @example
1917 #launch a QEMU instance with two NICs, each one connected
1918 #to a TAP device
1919 qemu-system-i386 linux.img \
1920 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1921 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1922 @end example
1924 @example
1925 #launch a QEMU instance with the default network helper to
1926 #connect a TAP device to bridge br0
1927 qemu-system-i386 linux.img \
1929 @end example
1931 @item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
1932 @itemx -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
1933 Connect a host TAP network interface to a host bridge device.
1935 Use the network helper @var{helper} to configure the TAP interface and
1936 attach it to the bridge. The default network helper executable is
1937 @file{/path/to/qemu-bridge-helper} and the default bridge
1938 device is @file{br0}.
1940 Examples:
1942 @example
1943 #launch a QEMU instance with the default network helper to
1944 #connect a TAP device to bridge br0
1945 qemu-system-i386 linux.img -net bridge -net nic,model=virtio
1946 @end example
1948 @example
1949 #launch a QEMU instance with the default network helper to
1950 #connect a TAP device to bridge qemubr0
1951 qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
1952 @end example
1954 @item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1955 @itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1957 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1958 machine using a TCP socket connection. If @option{listen} is
1959 specified, QEMU waits for incoming connections on @var{port}
1960 (@var{host} is optional). @option{connect} is used to connect to
1961 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1962 specifies an already opened TCP socket.
1964 Example:
1965 @example
1966 # launch a first QEMU instance
1967 qemu-system-i386 linux.img \
1968 -net nic,macaddr=52:54:00:12:34:56 \
1969 -net socket,listen=:1234
1970 # connect the VLAN 0 of this instance to the VLAN 0
1971 # of the first instance
1972 qemu-system-i386 linux.img \
1973 -net nic,macaddr=52:54:00:12:34:57 \
1974 -net socket,connect=127.0.0.1:1234
1975 @end example
1977 @item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1978 @itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1980 Create a VLAN @var{n} shared with another QEMU virtual
1981 machines using a UDP multicast socket, effectively making a bus for
1982 every QEMU with same multicast address @var{maddr} and @var{port}.
1983 NOTES:
1984 @enumerate
1985 @item
1986 Several QEMU can be running on different hosts and share same bus (assuming
1987 correct multicast setup for these hosts).
1988 @item
1989 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1990 @url{http://user-mode-linux.sf.net}.
1991 @item
1992 Use @option{fd=h} to specify an already opened UDP multicast socket.
1993 @end enumerate
1995 Example:
1996 @example
1997 # launch one QEMU instance
1998 qemu-system-i386 linux.img \
1999 -net nic,macaddr=52:54:00:12:34:56 \
2000 -net socket,mcast=230.0.0.1:1234
2002 qemu-system-i386 linux.img \
2003 -net nic,macaddr=52:54:00:12:34:57 \
2004 -net socket,mcast=230.0.0.1:1234
2006 qemu-system-i386 linux.img \
2007 -net nic,macaddr=52:54:00:12:34:58 \
2008 -net socket,mcast=230.0.0.1:1234
2009 @end example
2011 Example (User Mode Linux compat.):
2012 @example
2013 # launch QEMU instance (note mcast address selected
2014 # is UML's default)
2015 qemu-system-i386 linux.img \
2016 -net nic,macaddr=52:54:00:12:34:56 \
2017 -net socket,mcast=239.192.168.1:1102
2018 # launch UML
2019 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
2020 @end example
2022 Example (send packets from host's 1.2.3.4):
2023 @example
2024 qemu-system-i386 linux.img \
2025 -net nic,macaddr=52:54:00:12:34:56 \
2026 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
2027 @end example
2029 @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}]
2030 @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}]
2031 Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular
2032 protocol to transport Ethernet (and other Layer 2) data frames between
2033 two systems. It is present in routers, firewalls and the Linux kernel
2034 (from version 3.3 onwards).
2036 This transport allows a VM to communicate to another VM, router or firewall directly.
2038 @item src=@var{srcaddr}
2039 source address (mandatory)
2040 @item dst=@var{dstaddr}
2041 destination address (mandatory)
2042 @item udp
2043 select udp encapsulation (default is ip).
2044 @item srcport=@var{srcport}
2045 source udp port.
2046 @item dstport=@var{dstport}
2047 destination udp port.
2048 @item ipv6
2049 force v6, otherwise defaults to v4.
2050 @item rxcookie=@var{rxcookie}
2051 @itemx txcookie=@var{txcookie}
2052 Cookies are a weak form of security in the l2tpv3 specification.
2053 Their function is mostly to prevent misconfiguration. By default they are 32
2054 bit.
2055 @item cookie64
2056 Set cookie size to 64 bit instead of the default 32
2057 @item counter=off
2058 Force a 'cut-down' L2TPv3 with no counter as in
2059 draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
2060 @item pincounter=on
2061 Work around broken counter handling in peer. This may also help on
2062 networks which have packet reorder.
2063 @item offset=@var{offset}
2064 Add an extra offset between header and data
2066 For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan
2067 on the remote Linux host 1.2.3.4:
2068 @example
2069 # Setup tunnel on linux host using raw ip as encapsulation
2070 # on 1.2.3.4
2071 ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \
2072 encap udp udp_sport 16384 udp_dport 16384
2073 ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \
2074 0xFFFFFFFF peer_session_id 0xFFFFFFFF
2075 ifconfig vmtunnel0 mtu 1500
2076 ifconfig vmtunnel0 up
2077 brctl addif br-lan vmtunnel0
2080 # on 4.3.2.1
2081 # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
2083 qemu-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
2086 @end example
2088 @item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
2089 @itemx -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
2090 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
2091 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
2092 and MODE @var{octalmode} to change default ownership and permissions for
2093 communication port. This option is only available if QEMU has been compiled
2094 with vde support enabled.
2096 Example:
2097 @example
2098 # launch vde switch
2099 vde_switch -F -sock /tmp/myswitch
2100 # launch QEMU instance
2101 qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
2102 @end example
2104 @item -netdev hubport,id=@var{id},hubid=@var{hubid}
2109 netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the
2110 required hub automatically.
2112 @item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n]
2114 Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should
2115 be a unix domain socket backed one. The vhost-user uses a specifically defined
2116 protocol to pass vhost ioctl replacement messages to an application on the other
2117 end of the socket. On non-MSIX guests, the feature can be forced with
2118 @var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to
2119 be created for multiqueue vhost-user.
2121 Example:
2122 @example
2123 qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
2124 -numa node,memdev=mem \
2125 -chardev socket,path=/path/to/socket \
2126 -netdev type=vhost-user,id=net0,chardev=chr0 \
2127 -device virtio-net-pci,netdev=net0
2128 @end example
2130 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
2131 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
2132 At most @var{len} bytes (64k by default) per packet are stored. The file format is
2133 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
2134 Note: For devices created with '-netdev', use '-object filter-dump,...' instead.
2136 @item -net none
2137 Indicate that no network devices should be configured. It is used to
2138 override the default configuration (@option{-net nic -net user}) which
2139 is activated if no @option{-net} options are provided.
2140 ETEXI
2142 STEXI
2143 @end table
2144 ETEXI
2145 DEFHEADING()
2147 DEFHEADING(Character device options:)
2148 STEXI
2150 The general form of a character device option is:
2151 @table @option
2152 ETEXI
2157 "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n"
2171 #ifdef _WIN32
2174 #else
2177 #endif
2178 #ifdef CONFIG_BRLAPI
2180 #endif
2181 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
2182 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
2185 #endif
2186 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
2189 #endif
2190 #if defined(CONFIG_SPICE)
2193 #endif
2194 , QEMU_ARCH_ALL
2195 )
2197 STEXI
2198 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
2199 @findex -chardev
2200 Backend is one of:
2201 @option{null},
2202 @option{socket},
2203 @option{udp},
2204 @option{msmouse},
2205 @option{vc},
2206 @option{ringbuf},
2207 @option{file},
2208 @option{pipe},
2209 @option{console},
2210 @option{serial},
2211 @option{pty},
2212 @option{stdio},
2213 @option{braille},
2214 @option{tty},
2215 @option{parallel},
2216 @option{parport},
2217 @option{spicevmc}.
2218 @option{spiceport}.
2219 The specific backend will determine the applicable options.
2223 All devices must have an id, which can be any string up to 127 characters long.
2224 It is used to uniquely identify this device in other command line directives.
2226 A character device may be used in multiplexing mode by multiple front-ends.
2227 Specify @option{mux=on} to enable this mode.
2230 If you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will
2231 create a multiplexer with your specified ID, and you can then configure multiple
2232 front ends to use that chardev ID for their input/output. Up to four different
2233 front ends can be connected to a single multiplexed chardev. (Without
2234 multiplexing enabled, a chardev can only be used by a single front end.)
2235 For instance you could use this to allow a single stdio chardev to be used by
2236 two serial ports and the QEMU monitor:
2238 @example
2239 -chardev stdio,mux=on,id=char0 \
2240 -mon chardev=char0,mode=readline,default \
2241 -serial chardev:char0 \
2242 -serial chardev:char0
2243 @end example
2245 You can have more than one multiplexer in a system configuration; for instance
2246 you could have a TCP port multiplexed between UART 0 and UART 1, and stdio
2247 multiplexed between the QEMU monitor and a parallel port:
2249 @example
2250 -chardev stdio,mux=on,id=char0 \
2251 -mon chardev=char0,mode=readline,default \
2252 -parallel chardev:char0 \
2253 -chardev tcp,...,mux=on,id=char1 \
2254 -serial chardev:char1 \
2255 -serial chardev:char1
2256 @end example
2258 When you're using a multiplexed character device, some escape sequences are
2259 interpreted in the input. @xref{mux_keys, Keys in the character backend
2260 multiplexer}.
2262 Note that some other command line options may implicitly create multiplexed
2263 character backends; for instance @option{-serial mon:stdio} creates a
2264 multiplexed stdio backend connected to the serial port and the QEMU monitor,
2265 and @option{-nographic} also multiplexes the console and the monitor to
2266 stdio.
2268 There is currently no support for multiplexing in the other direction
2269 (where a single QEMU front end takes input and output from multiple chardevs).
2271 Every backend supports the @option{logfile} option, which supplies the path
2272 to a file to record all data transmitted via the backend. The @option{logappend}
2273 option controls whether the log file will be truncated or appended to when
2274 opened.
2276 Further options to each backend are described below.
2278 @item -chardev null ,id=@var{id}
2279 A void device. This device will not emit any data, and will drop any data it
2280 receives. The null backend does not take any options.
2282 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] [,tls-creds=@var{id}]
2284 Create a two-way stream socket, which can be either a TCP or a unix socket. A
2285 unix socket will be created if @option{path} is specified. Behaviour is
2286 undefined if TCP options are specified for a unix socket.
2288 @option{server} specifies that the socket shall be a listening socket.
2290 @option{nowait} specifies that QEMU should not block waiting for a client to
2291 connect to a listening socket.
2293 @option{telnet} specifies that traffic on the socket should interpret telnet
2294 escape sequences.
2296 @option{reconnect} sets the timeout for reconnecting on non-server sockets when
2297 the remote end goes away. qemu will delay this many seconds and then attempt
2298 to reconnect. Zero disables reconnecting, and is the default.
2300 @option{tls-creds} requests enablement of the TLS protocol for encryption,
2301 and specifies the id of the TLS credentials to use for the handshake. The
2302 credentials must be previously created with the @option{-object tls-creds}
2303 argument.
2305 TCP and unix socket options are given below:
2307 @table @option
2309 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
2311 @option{host} for a listening socket specifies the local address to be bound.
2312 For a connecting socket species the remote host to connect to. @option{host} is
2313 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
2315 @option{port} for a listening socket specifies the local port to be bound. For a
2316 connecting socket specifies the port on the remote host to connect to.
2317 @option{port} can be given as either a port number or a service name.
2318 @option{port} is required.
2320 @option{to} is only relevant to listening sockets. If it is specified, and
2321 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
2322 to and including @option{to} until it succeeds. @option{to} must be specified
2323 as a port number.
2325 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2326 If neither is specified the socket may use either protocol.
2328 @option{nodelay} disables the Nagle algorithm.
2330 @item unix options: path=@var{path}
2332 @option{path} specifies the local path of the unix socket. @option{path} is
2333 required.
2335 @end table
2337 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
2339 Sends all traffic from the guest to a remote host over UDP.
2341 @option{host} specifies the remote host to connect to. If not specified it
2342 defaults to @code{localhost}.
2344 @option{port} specifies the port on the remote host to connect to. @option{port}
2345 is required.
2347 @option{localaddr} specifies the local address to bind to. If not specified it
2348 defaults to @code{0.0.0.0}.
2350 @option{localport} specifies the local port to bind to. If not specified any
2351 available local port will be used.
2353 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2354 If neither is specified the device may use either protocol.
2356 @item -chardev msmouse ,id=@var{id}
2358 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
2359 take any options.
2361 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
2363 Connect to a QEMU text console. @option{vc} may optionally be given a specific
2364 size.
2366 @option{width} and @option{height} specify the width and height respectively of
2367 the console, in pixels.
2369 @option{cols} and @option{rows} specify that the console be sized to fit a text
2370 console with the given dimensions.
2372 @item -chardev ringbuf ,id=@var{id} [,size=@var{size}]
2374 Create a ring buffer with fixed size @option{size}.
2375 @var{size} must be a power of two, and defaults to @code{64K}).
2377 @item -chardev file ,id=@var{id} ,path=@var{path}
2379 Log all traffic received from the guest to a file.
2381 @option{path} specifies the path of the file to be opened. This file will be
2382 created if it does not already exist, and overwritten if it does. @option{path}
2383 is required.
2385 @item -chardev pipe ,id=@var{id} ,path=@var{path}
2387 Create a two-way connection to the guest. The behaviour differs slightly between
2388 Windows hosts and other hosts:
2390 On Windows, a single duplex pipe will be created at
2393 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
2394 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
2395 received by the guest. Data written by the guest can be read from
2396 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
2397 be present.
2399 @option{path} forms part of the pipe path as described above. @option{path} is
2400 required.
2402 @item -chardev console ,id=@var{id}
2404 Send traffic from the guest to QEMU's standard output. @option{console} does not
2405 take any options.
2407 @option{console} is only available on Windows hosts.
2409 @item -chardev serial ,id=@var{id} ,path=@option{path}
2411 Send traffic from the guest to a serial device on the host.
2413 On Unix hosts serial will actually accept any tty device,
2414 not only serial lines.
2416 @option{path} specifies the name of the serial device to open.
2418 @item -chardev pty ,id=@var{id}
2420 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
2421 not take any options.
2423 @option{pty} is not available on Windows hosts.
2425 @item -chardev stdio ,id=@var{id} [,signal=on|off]
2426 Connect to standard input and standard output of the QEMU process.
2428 @option{signal} controls if signals are enabled on the terminal, that includes
2429 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
2430 default, use @option{signal=off} to disable it.
2432 @option{stdio} is not available on Windows hosts.
2434 @item -chardev braille ,id=@var{id}
2436 Connect to a local BrlAPI server. @option{braille} does not take any options.
2438 @item -chardev tty ,id=@var{id} ,path=@var{path}
2440 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
2441 DragonFlyBSD hosts. It is an alias for @option{serial}.
2443 @option{path} specifies the path to the tty. @option{path} is required.
2445 @item -chardev parallel ,id=@var{id} ,path=@var{path}
2446 @itemx -chardev parport ,id=@var{id} ,path=@var{path}
2448 @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
2450 Connect to a local parallel port.
2452 @option{path} specifies the path to the parallel port device. @option{path} is
2453 required.
2455 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2457 @option{spicevmc} is only available when spice support is built in.
2459 @option{debug} debug level for spicevmc
2461 @option{name} name of spice channel to connect to
2463 Connect to a spice virtual machine channel, such as vdiport.
2465 @item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2467 @option{spiceport} is only available when spice support is built in.
2469 @option{debug} debug level for spicevmc
2471 @option{name} name of spice port to connect to
2473 Connect to a spice port, allowing a Spice client to handle the traffic
2474 identified by a name (preferably a fqdn).
2475 ETEXI
2477 STEXI
2478 @end table
2479 ETEXI
2480 DEFHEADING()
2482 DEFHEADING(Device URL Syntax:)
2483 STEXI
2485 In addition to using normal file images for the emulated storage devices,
2486 QEMU can also use networked resources such as iSCSI devices. These are
2487 specified using a special URL syntax.
2489 @table @option
2490 @item iSCSI
2491 iSCSI support allows QEMU to access iSCSI resources directly and use as
2492 images for the guest storage. Both disk and cdrom images are supported.
2494 Syntax for specifying iSCSI LUNs is
2495 ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
2497 By default qemu will use the iSCSI initiator-name
2498 'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
2499 line or a configuration file.
2501 Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect
2502 stalled requests and force a reestablishment of the session. The timeout
2503 is specified in seconds. The default is 0 which means no timeout. Libiscsi
2504 1.15.0 or greater is required for this feature.
2506 Example (without authentication):
2507 @example
2508 qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
2509 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
2510 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2511 @end example
2513 Example (CHAP username/password via URL):
2514 @example
2515 qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
2516 @end example
2518 Example (CHAP username/password via environment variables):
2519 @example
2522 qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2523 @end example
2525 iSCSI support is an optional feature of QEMU and only available when
2526 compiled and linked against libiscsi.
2527 ETEXI
2534 STEXI
2536 iSCSI parameters such as username and password can also be specified via
2537 a configuration file. See qemu-doc for more information and examples.
2539 @item NBD
2540 QEMU supports NBD (Network Block Devices) both using TCP protocol as well
2541 as Unix Domain Sockets.
2543 Syntax for specifying a NBD device using TCP
2544 ``nbd:<server-ip>:<port>[:exportname=<export>]''
2546 Syntax for specifying a NBD device using Unix Domain Sockets
2547 ``nbd:unix:<domain-socket>[:exportname=<export>]''
2550 Example for TCP
2551 @example
2552 qemu-system-i386 --drive file=nbd:192.0.2.1:30000
2553 @end example
2555 Example for Unix Domain Sockets
2556 @example
2557 qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
2558 @end example
2560 @item SSH
2561 QEMU supports SSH (Secure Shell) access to remote disks.
2563 Examples:
2564 @example
2565 qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img
2566 qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
2567 @end example
2569 Currently authentication must be done using ssh-agent. Other
2570 authentication methods may be supported in future.
2572 @item Sheepdog
2573 Sheepdog is a distributed storage system for QEMU.
2574 QEMU supports using either local sheepdog devices or remote networked
2575 devices.
2577 Syntax for specifying a sheepdog device
2578 @example
2579 sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
2580 @end example
2582 Example
2583 @example
2584 qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
2585 @end example
2587 See also @url{http://http://www.osrg.net/sheepdog/}.
2589 @item GlusterFS
2590 GlusterFS is an user space distributed file system.
2591 QEMU supports the use of GlusterFS volumes for hosting VM disk images using
2592 TCP, Unix Domain Sockets and RDMA transport protocols.
2594 Syntax for specifying a VM disk image on GlusterFS volume is
2595 @example
2596 gluster[+transport]://[server[:port]]/volname/image[?socket=...]
2597 @end example
2600 Example
2601 @example
2602 qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img
2603 @end example
2605 See also @url{http://www.gluster.org}.
2607 @item HTTP/HTTPS/FTP/FTPS/TFTP
2608 QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp.
2610 Syntax using a single filename:
2611 @example
2612 <protocol>://[<username>[:<password>]@@]<host>/<path>
2613 @end example
2615 where:
2616 @table @option
2617 @item protocol
2618 'http', 'https', 'ftp', 'ftps', or 'tftp'.
2620 @item username
2621 Optional username for authentication to the remote server.
2623 @item password
2624 Optional password for authentication to the remote server.
2626 @item host
2627 Address of the remote server.
2629 @item path
2630 Path on the remote server, including any query string.
2631 @end table
2633 The following options are also supported:
2634 @table @option
2635 @item url
2636 The full URL when passing options to the driver explicitly.
2638 @item readahead
2639 The amount of data to read ahead with each range request to the remote server.
2640 This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it
2641 does not have a suffix, it will be assumed to be in bytes. The value must be a
2642 multiple of 512 bytes. It defaults to 256k.
2644 @item sslverify
2645 Whether to verify the remote server's certificate when connecting over SSL. It
2646 can have the value 'on' or 'off'. It defaults to 'on'.
2648 @item cookie
2649 Send this cookie (it can also be a list of cookies separated by ';') with
2650 each outgoing request. Only supported when using protocols such as HTTP
2651 which support cookies, otherwise ignored.
2653 @item timeout
2654 Set the timeout in seconds of the CURL connection. This timeout is the time
2655 that CURL waits for a response from the remote server to get the size of the
2656 image to be downloaded. If not set, the default timeout of 5 seconds is used.
2657 @end table
2659 Note that when passing options to qemu explicitly, @option{driver} is the value
2660 of <protocol>.
2662 Example: boot from a remote Fedora 20 live ISO image
2663 @example
2664 qemu-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
2666 qemu-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
2667 @end example
2669 Example: boot from a remote Fedora 20 cloud image using a local overlay for
2670 writes, copy-on-read, and a readahead of 64k
2671 @example
2672 qemu-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
2675 @end example
2680 @example
2681 qemu-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
2684 @end example
2685 ETEXI
2687 STEXI
2688 @end table
2689 ETEXI
2692 STEXI
2693 @table @option
2694 ETEXI
2706 QEMU_ARCH_ALL)
2707 STEXI
2709 @findex -bt
2712 example when emulating a machine with only one HCI built into it, only
2714 logic. The Transport Layer is decided by the machine type. Currently
2715 the machines @code{n800} and @code{n810} have one HCI and all other
2716 machines have none.
2718 @anchor{bt-hcis}
2719 The following three types are recognized:
2721 @table @option
2722 @item -bt hci,null
2723 (default) The corresponding Bluetooth HCI assumes no internal logic
2724 and will not respond to any HCI commands or emit events.
2726 @item -bt hci,host[:@var{id}]
2727 (@code{bluez} only) The corresponding HCI passes commands / events
2728 to / from the physical HCI identified by the name @var{id} (default:
2729 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
2730 capable systems like Linux.
2732 @item -bt hci[,vlan=@var{n}]
2733 Add a virtual, standard HCI that will participate in the Bluetooth
2734 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
2735 VLANs, devices inside a bluetooth network @var{n} can only communicate
2736 with other devices in the same network (scatternet).
2737 @end table
2739 @item -bt vhci[,vlan=@var{n}]
2740 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
2741 to the host bluetooth stack instead of to the emulated target. This
2742 allows the host and target machines to participate in a common scatternet
2743 and communicate. Requires the Linux @code{vhci} driver installed. Can
2744 be used as following:
2746 @example
2747 qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
2748 @end example
2750 @item -bt device:@var{dev}[,vlan=@var{n}]
2751 Emulate a bluetooth device @var{dev} and place it in network @var{n}
2752 (default @code{0}). QEMU can only emulate one type of bluetooth devices
2753 currently:
2755 @table @option
2756 @item keyboard
2757 Virtual wireless keyboard implementing the HIDP bluetooth profile.
2758 @end table
2759 ETEXI
2761 STEXI
2762 @end table
2763 ETEXI
2764 DEFHEADING()
2766 #ifdef CONFIG_TPM
2767 DEFHEADING(TPM device options:)
2769 DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
2774 QEMU_ARCH_ALL)
2775 STEXI
2777 The general form of a TPM device option is:
2778 @table @option
2780 @item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
2781 @findex -tpmdev
2782 Backend type must be:
2783 @option{passthrough}.
2785 The specific backend type will determine the applicable options.
2786 The @code{-tpmdev} option creates the TPM backend and requires a
2787 @code{-device} option that specifies the TPM frontend interface model.
2789 Options to each backend are described below.
2791 Use 'help' to print all available TPM backend types.
2792 @example
2793 qemu -tpmdev help
2794 @end example
2796 @item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
2798 (Linux-host only) Enable access to the host's TPM using the passthrough
2799 driver.
2801 @option{path} specifies the path to the host's TPM device, i.e., on
2802 a Linux host this would be @code{/dev/tpm0}.
2803 @option{path} is optional and by default @code{/dev/tpm0} is used.
2805 @option{cancel-path} specifies the path to the host TPM device's sysfs
2806 entry allowing for cancellation of an ongoing TPM command.
2807 @option{cancel-path} is optional and by default QEMU will search for the
2808 sysfs entry to use.
2810 Some notes about using the host's TPM with the passthrough driver:
2812 The TPM device accessed by the passthrough driver must not be
2813 used by any other application on the host.
2815 Since the host's firmware (BIOS/UEFI) has already initialized the TPM,
2816 the VM's firmware (BIOS/UEFI) will not be able to initialize the
2817 TPM again and may therefore not show a TPM-specific menu that would
2818 otherwise allow the user to configure the TPM, e.g., allow the user to
2819 enable/disable or activate/deactivate the TPM.
2820 Further, if TPM ownership is released from within a VM then the host's TPM
2821 will get disabled and deactivated. To enable and activate the
2822 TPM again afterwards, the host has to be rebooted and the user is
2823 required to enter the firmware's menu to enable and activate the TPM.
2824 If the TPM is left disabled and/or deactivated most TPM commands will fail.
2826 To create a passthrough TPM use the following two options:
2827 @example
2828 -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
2829 @end example
2830 Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
2831 @code{tpmdev=tpm0} in the device option.
2833 @end table
2835 ETEXI
2837 DEFHEADING()
2839 #endif
2841 DEFHEADING(Linux/Multiboot boot specific:)
2842 STEXI
2844 When using these options, you can use a given Linux or Multiboot
2845 kernel without installing it in the disk image. It can be useful
2846 for easier testing of various kernels.
2848 @table @option
2849 ETEXI
2853 STEXI
2854 @item -kernel @var{bzImage}
2855 @findex -kernel
2856 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2857 or in multiboot format.
2858 ETEXI
2862 STEXI
2863 @item -append @var{cmdline}
2864 @findex -append
2865 Use @var{cmdline} as kernel command line
2866 ETEXI
2870 STEXI
2871 @item -initrd @var{file}
2872 @findex -initrd
2873 Use @var{file} as initial ram disk.
2877 This syntax is only available with multiboot.
2879 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2880 first module.
2881 ETEXI
2885 STEXI
2886 @item -dtb @var{file}
2887 @findex -dtb
2888 Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
2889 on boot.
2890 ETEXI
2892 STEXI
2893 @end table
2894 ETEXI
2895 DEFHEADING()
2897 DEFHEADING(Debug/Expert options:)
2898 STEXI
2899 @table @option
2900 ETEXI
2907 QEMU_ARCH_ALL)
2908 STEXI
2910 @item -fw_cfg [name=]@var{name},file=@var{file}
2911 @findex -fw_cfg
2912 Add named fw_cfg entry with contents from file @var{file}.
2914 @item -fw_cfg [name=]@var{name},string=@var{str}
2915 Add named fw_cfg entry with contents from string @var{str}.
2917 The terminating NUL character of the contents of @var{str} will not be
2918 included as part of the fw_cfg item data. To insert contents with
2919 embedded NUL characters, you have to use the @var{file} parameter.
2921 The fw_cfg entries are passed by QEMU through to the guest.
2923 Example:
2924 @example
2925 -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin
2926 @end example
2927 creates an fw_cfg entry named opt/com.mycompany/blob with contents
2928 from ./my_blob.bin.
2930 ETEXI
2934 QEMU_ARCH_ALL)
2935 STEXI
2936 @item -serial @var{dev}
2937 @findex -serial
2938 Redirect the virtual serial port to host character device
2939 @var{dev}. The default device is @code{vc} in graphical mode and
2940 @code{stdio} in non graphical mode.
2942 This option can be used several times to simulate up to 4 serial
2943 ports.
2945 Use @code{-serial none} to disable all serial ports.
2947 Available character devices are:
2948 @table @option
2949 @item vc[:@var{W}x@var{H}]
2950 Virtual console. Optionally, a width and height can be given in pixel with
2951 @example
2952 vc:800x600
2953 @end example
2954 It is also possible to specify width or height in characters:
2955 @example
2956 vc:80Cx24C
2957 @end example
2958 @item pty
2959 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
2960 @item none
2961 No device is allocated.
2962 @item null
2963 void device
2964 @item chardev:@var{id}
2965 Use a named character device defined with the @code{-chardev} option.
2966 @item /dev/XXX
2967 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2968 parameters are set according to the emulated ones.
2969 @item /dev/parport@var{N}
2970 [Linux only, parallel port only] Use host parallel port
2971 @var{N}. Currently SPP and EPP parallel port features can be used.
2972 @item file:@var{filename}
2973 Write output to @var{filename}. No character can be read.
2974 @item stdio
2975 [Unix only] standard input/output
2976 @item pipe:@var{filename}
2977 name pipe @var{filename}
2978 @item COM@var{n}
2979 [Windows only] Use host serial port @var{n}
2980 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2981 This implements UDP Net Console.
2982 When @var{remote_host} or @var{src_ip} are not specified
2983 they default to @code{0.0.0.0}.
2984 When not using a specified @var{src_port} a random port is automatically chosen.
2986 If you just want a simple readonly console you can use @code{netcat} or
2987 @code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
2988 @code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
2989 will appear in the netconsole session.
2991 If you plan to send characters back via netconsole or you want to stop
2992 and start QEMU a lot of times, you should have QEMU use the same
2993 source port each time by using something like @code{-serial
2994 udp::4555@@:4556} to QEMU. Another approach is to use a patched
2995 version of netcat which can listen to a TCP port and send and receive
2996 characters via udp. If you have a patched version of netcat which
2997 activates telnet remote echo and single char transfer, then you can
2998 use the following options to step up a netcat redirector to allow
2999 telnet on port 5555 to access the QEMU port.
3000 @table @code
3001 @item QEMU Options:
3002 -serial udp::4555@@:4556
3003 @item netcat options:
3004 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
3005 @item telnet options:
3006 localhost 5555
3007 @end table
3009 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}]
3010 The TCP Net Console has two modes of operation. It can send the serial
3011 I/O to a location or wait for a connection from a location. By default
3012 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
3013 the @var{server} option QEMU will wait for a client socket application
3014 to connect to the port before continuing, unless the @code{nowait}
3015 option was specified. The @code{nodelay} option disables the Nagle buffering
3016 algorithm. The @code{reconnect} option only applies if @var{noserver} is
3017 set, if the connection goes down it will attempt to reconnect at the
3018 given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only
3019 one TCP connection at a time is accepted. You can use @code{telnet} to
3020 connect to the corresponding character device.
3021 @table @code
3022 @item Example to send tcp console to 192.168.0.2 port 4444
3023 -serial tcp:192.168.0.2:4444
3024 @item Example to listen and wait on port 4444 for connection
3025 -serial tcp::4444,server
3026 @item Example to not wait and listen on ip 192.168.0.100 port 4444
3027 -serial tcp:192.168.0.100:4444,server,nowait
3028 @end table
3030 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
3031 The telnet protocol is used instead of raw tcp sockets. The options
3032 work the same as if you had specified @code{-serial tcp}. The
3033 difference is that the port acts like a telnet server or client using
3034 telnet option negotiation. This will also allow you to send the
3035 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
3036 sequence. Typically in unix telnet you do it with Control-] and then
3039 @item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}]
3040 A unix domain socket is used instead of a tcp socket. The option works the
3041 same as if you had specified @code{-serial tcp} except the unix domain socket
3042 @var{path} is used for connections.
3044 @item mon:@var{dev_string}
3045 This is a special option to allow the monitor to be multiplexed onto
3046 another serial port. The monitor is accessed with key sequence of
3047 @key{Control-a} and then pressing @key{c}.
3048 @var{dev_string} should be any one of the serial devices specified
3049 above. An example to multiplex the monitor onto a telnet server
3050 listening on port 4444 would be:
3051 @table @code
3052 @item -serial mon:telnet::4444,server,nowait
3053 @end table
3054 When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate
3055 QEMU any more but will be passed to the guest instead.
3057 @item braille
3058 Braille device. This will use BrlAPI to display the braille output on a real
3059 or fake device.
3061 @item msmouse
3062 Three button serial mouse. Configure the guest to use Microsoft protocol.
3063 @end table
3064 ETEXI
3068 QEMU_ARCH_ALL)
3069 STEXI
3070 @item -parallel @var{dev}
3071 @findex -parallel
3072 Redirect the virtual parallel port to host device @var{dev} (same
3073 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
3074 be used to use hardware devices connected on the corresponding host
3075 parallel port.
3077 This option can be used several times to simulate up to 3 parallel
3078 ports.
3080 Use @code{-parallel none} to disable all parallel ports.
3081 ETEXI
3085 QEMU_ARCH_ALL)
3086 STEXI
3087 @item -monitor @var{dev}
3088 @findex -monitor
3089 Redirect the monitor to host device @var{dev} (same devices as the
3090 serial port).
3091 The default device is @code{vc} in graphical mode and @code{stdio} in
3092 non graphical mode.
3093 Use @code{-monitor none} to disable the default monitor.
3094 ETEXI
3097 QEMU_ARCH_ALL)
3098 STEXI
3099 @item -qmp @var{dev}
3100 @findex -qmp
3101 Like -monitor but opens in 'control' mode.
3102 ETEXI
3105 QEMU_ARCH_ALL)
3106 STEXI
3107 @item -qmp-pretty @var{dev}
3108 @findex -qmp-pretty
3109 Like -qmp but uses pretty JSON formatting.
3110 ETEXI
3114 STEXI
3115 @item -mon [chardev=]name[,mode=readline|control][,default]
3116 @findex -mon
3117 Setup monitor on chardev @var{name}.
3118 ETEXI
3122 QEMU_ARCH_ALL)
3123 STEXI
3124 @item -debugcon @var{dev}
3125 @findex -debugcon
3126 Redirect the debug console to host device @var{dev} (same devices as the
3127 serial port). The debug console is an I/O port which is typically port
3128 0xe9; writing to that I/O port sends output to this device.
3129 The default device is @code{vc} in graphical mode and @code{stdio} in
3130 non graphical mode.
3131 ETEXI
3135 STEXI
3136 @item -pidfile @var{file}
3137 @findex -pidfile
3138 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
3139 from a script.
3140 ETEXI
3144 STEXI
3145 @item -singlestep
3146 @findex -singlestep
3147 Run the emulation in single step mode.
3148 ETEXI
3152 QEMU_ARCH_ALL)
3153 STEXI
3154 @item -S
3155 @findex -S
3156 Do not start CPU at startup (you must type 'c' in the monitor).
3157 ETEXI
3163 QEMU_ARCH_ALL)
3164 STEXI
3165 @item -realtime mlock=on|off
3166 @findex -realtime
3167 Run qemu with realtime features.
3168 mlocking qemu and guest memory can be enabled via @option{mlock=on}
3169 (enabled by default).
3170 ETEXI
3174 STEXI
3175 @item -gdb @var{dev}
3176 @findex -gdb
3177 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
3178 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
3179 stdio are reasonable use case. The latter is allowing to start QEMU from
3180 within gdb and establish the connection via a pipe:
3181 @example
3182 (gdb) target remote | exec qemu-system-i386 -gdb stdio ...
3183 @end example
3184 ETEXI
3188 QEMU_ARCH_ALL)
3189 STEXI
3190 @item -s
3191 @findex -s
3192 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
3193 (@pxref{gdb_usage}).
3194 ETEXI
3198 QEMU_ARCH_ALL)
3199 STEXI
3200 @item -d @var{item1}[,...]
3201 @findex -d
3202 Enable logging of specified items. Use '-d help' for a list of log items.
3203 ETEXI
3207 QEMU_ARCH_ALL)
3208 STEXI
3209 @item -D @var{logfile}
3210 @findex -D
3211 Output log in @var{logfile} instead of to stderr
3212 ETEXI
3215 "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n",
3216 QEMU_ARCH_ALL)
3217 STEXI
3218 @item -dfilter @var{range1}[,...]
3219 @findex -dfilter
3220 Filter debug output to that relevant to a range of target addresses. The filter
3221 spec can be either @var{start}+@var{size}, @var{start}-@var{size} or
3222 @var{start}..@var{end} where @var{start} @var{end} and @var{size} are the
3223 addresses and sizes required. For example:
3224 @example
3225 -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000
3226 @end example
3227 Will dump output for any code in the 0x1000 sized block starting at 0x8000 and
3228 the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized
3229 block starting at 0xffffffc00005f000.
3230 ETEXI
3234 QEMU_ARCH_ALL)
3235 STEXI
3236 @item -L @var{path}
3237 @findex -L
3238 Set the directory for the BIOS, VGA BIOS and keymaps.
3240 To list all the data directories, use @code{-L help}.
3241 ETEXI
3245 STEXI
3246 @item -bios @var{file}
3247 @findex -bios
3248 Set the filename for the BIOS.
3249 ETEXI
3253 STEXI
3254 @item -enable-kvm
3255 @findex -enable-kvm
3256 Enable KVM full virtualization support. This option is only available
3257 if KVM support is enabled when compiling.
3258 ETEXI
3265 QEMU_ARCH_ALL)
3269 QEMU_ARCH_ALL)
3270 STEXI
3271 @item -xen-domid @var{id}
3272 @findex -xen-domid
3273 Specify xen guest domain @var{id} (XEN only).
3274 @item -xen-create
3275 @findex -xen-create
3276 Create domain using xen hypercalls, bypassing xend.
3277 Warning: should not be used when xend is in use (XEN only).
3278 @item -xen-attach
3279 @findex -xen-attach
3280 Attach to existing xen domain.
3281 xend will use this when starting QEMU (XEN only).
3282 ETEXI
3286 STEXI
3287 @item -no-reboot
3288 @findex -no-reboot
3289 Exit instead of rebooting.
3290 ETEXI
3294 STEXI
3295 @item -no-shutdown
3296 @findex -no-shutdown
3297 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
3298 This allows for instance switching to monitor to commit changes to the
3299 disk image.
3300 ETEXI
3305 QEMU_ARCH_ALL)
3306 STEXI
3307 @item -loadvm @var{file}
3308 @findex -loadvm
3309 Start right away with a saved state (@code{loadvm} in monitor)
3310 ETEXI
3312 #ifndef _WIN32
3315 #endif
3316 STEXI
3317 @item -daemonize
3318 @findex -daemonize
3319 Daemonize the QEMU process after initialization. QEMU will not detach from
3320 standard IO until it is ready to receive connections on any of its devices.
3321 This option is a useful way for external programs to launch QEMU without having
3322 to cope with initialization race conditions.
3323 ETEXI
3327 QEMU_ARCH_ALL)
3328 STEXI
3329 @item -option-rom @var{file}
3330 @findex -option-rom
3331 Load the contents of @var{file} as an option ROM.
3332 This option is useful to load things like EtherBoot.
3333 ETEXI
3335 HXCOMM Silently ignored for compatibility
3338 HXCOMM Options deprecated by -rtc
3345 QEMU_ARCH_ALL)
3347 STEXI
3349 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
3350 @findex -rtc
3351 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
3352 UTC or local time, respectively. @code{localtime} is required for correct date in
3353 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
3354 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
3356 By default the RTC is driven by the host system time. This allows using of the
3357 RTC as accurate reference clock inside the guest, specifically if the host
3358 time is smoothly following an accurate external reference clock, e.g. via NTP.
3359 If you want to isolate the guest time from the host, you can set @option{clock}
3360 to @code{rt} instead. To even prevent it from progressing during suspension,
3361 you can set it to @code{vm}.
3363 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
3364 specifically with Windows' ACPI HAL. This option will try to figure out how
3365 many timer interrupts were not processed by the Windows guest and will
3366 re-inject them.
3367 ETEXI
3374 STEXI
3375 @item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename}]
3376 @findex -icount
3377 Enable virtual instruction counter. The virtual cpu will execute one
3378 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
3379 then the virtual cpu speed will be automatically adjusted to keep virtual
3380 time within a few seconds of real time.
3382 When the virtual cpu is sleeping, the virtual time will advance at default
3383 speed unless @option{sleep=on|off} is specified.
3384 With @option{sleep=on|off}, the virtual time will jump to the next timer deadline
3385 instantly whenever the virtual cpu goes to sleep mode and will not advance
3386 if no timer is enabled. This behavior give deterministic execution times from
3387 the guest point of view.
3389 Note that while this option can give deterministic behavior, it does not
3390 provide cycle accurate emulation. Modern CPUs contain superscalar out of
3391 order cores with complex cache hierarchies. The number of instructions
3392 executed often has little or no correlation with actual performance.
3394 @option{align=on} will activate the delay algorithm which will try
3395 to synchronise the host clock and the virtual clock. The goal is to
3396 have a guest running at the real frequency imposed by the shift option.
3397 Whenever the guest clock is behind the host clock and if
3398 @option{align=on} is specified then we print a message to the user
3399 to inform about the delay.
3400 Currently this option does not work when @option{shift} is @code{auto}.
3401 Note: The sync algorithm will work for those shift values for which
3402 the guest clock runs ahead of the host clock. Typically this happens
3403 when the shift value is high (how high depends on the host machine).
3405 When @option{rr} option is specified deterministic record/replay is enabled.
3406 Replay log is written into @var{filename} file in record mode and
3407 read from this file in replay mode.
3408 ETEXI
3413 QEMU_ARCH_ALL)
3414 STEXI
3415 @item -watchdog @var{model}
3416 @findex -watchdog
3417 Create a virtual hardware watchdog device. Once enabled (by a guest
3418 action), the watchdog must be periodically polled by an agent inside
3419 the guest or else the guest will be restarted. Choose a model for
3420 which your guest has drivers.
3422 The @var{model} is the model of hardware watchdog to emulate. Use
3423 @code{-watchdog help} to list available hardware models. Only one
3424 watchdog can be enabled for a guest.
3426 The following models may be available:
3427 @table @option
3428 @item ib700
3429 iBASE 700 is a very simple ISA watchdog with a single timer.
3430 @item i6300esb
3431 Intel 6300ESB I/O controller hub is a much more featureful PCI-based
3432 dual-timer watchdog.
3433 @item diag288
3434 A virtual watchdog for s390x backed by the diagnose 288 hypercall
3435 (currently KVM only).
3436 @end table
3437 ETEXI
3442 QEMU_ARCH_ALL)
3443 STEXI
3444 @item -watchdog-action @var{action}
3445 @findex -watchdog-action
3447 The @var{action} controls what QEMU will do when the watchdog timer
3448 expires.
3449 The default is
3450 @code{reset} (forcefully reset the guest).
3451 Other possible actions are:
3452 @code{shutdown} (attempt to gracefully shutdown the guest),
3453 @code{poweroff} (forcefully poweroff the guest),
3454 @code{pause} (pause the guest),
3455 @code{debug} (print a debug message and continue), or
3456 @code{none} (do nothing).
3458 Note that the @code{shutdown} action requires that the guest responds
3459 to ACPI signals, which it may not be able to do in the sort of
3460 situations where the watchdog would have expired, and thus
3461 @code{-watchdog-action shutdown} is not recommended for production use.
3463 Examples:
3465 @table @code
3466 @item -watchdog i6300esb -watchdog-action pause
3467 @itemx -watchdog ib700
3468 @end table
3469 ETEXI
3473 QEMU_ARCH_ALL)
3474 STEXI
3476 @item -echr @var{numeric_ascii_value}
3477 @findex -echr
3478 Change the escape character used for switching to the monitor when using
3479 monitor and serial sharing. The default is @code{0x01} when using the
3480 @code{-nographic} option. @code{0x01} is equal to pressing
3481 @code{Control-a}. You can select a different character from the ascii
3482 control keys where 1 through 26 map to Control-a through Control-z. For
3483 instance you could use the either of the following to change the escape
3484 character to Control-t.
3485 @table @code
3486 @item -echr 0x14
3487 @itemx -echr 20
3488 @end table
3489 ETEXI
3494 STEXI
3495 @item -virtioconsole @var{c}
3496 @findex -virtioconsole
3497 Set virtio console.
3499 This option is maintained for backward compatibility.
3501 Please use @code{-device virtconsole} for the new way of invocation.
3502 ETEXI
3506 STEXI
3507 @item -show-cursor
3508 @findex -show-cursor
3509 Show cursor.
3510 ETEXI
3514 STEXI
3515 @item -tb-size @var{n}
3516 @findex -tb-size
3517 Set TB size.
3518 ETEXI
3532 QEMU_ARCH_ALL)
3533 STEXI
3534 @item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]
3535 @itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6]
3536 @findex -incoming
3537 Prepare for incoming migration, listen on a given tcp port.
3539 @item -incoming unix:@var{socketpath}
3540 Prepare for incoming migration, listen on a given unix socket.
3542 @item -incoming fd:@var{fd}
3543 Accept incoming migration from a given filedescriptor.
3545 @item -incoming exec:@var{cmdline}
3546 Accept incoming migration as an output from specified external command.
3548 @item -incoming defer
3549 Wait for the URI to be specified via migrate_incoming. The monitor can
3550 be used to change settings (such as migration parameters) prior to issuing
3551 the migrate_incoming to allow the migration to begin.
3552 ETEXI
3556 STEXI
3557 @item -nodefaults
3558 @findex -nodefaults
3563 ETEXI
3565 #ifndef _WIN32
3568 QEMU_ARCH_ALL)
3569 #endif
3570 STEXI
3572 @findex -chroot
3573 Immediately before starting guest execution, chroot to the specified
3575 ETEXI
3577 #ifndef _WIN32
3580 QEMU_ARCH_ALL)
3581 #endif
3582 STEXI
3584 @findex -runas
3586 to the specified user.
3587 ETEXI
3592 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
3593 STEXI
3597 ETEXI
3600 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
3601 QEMU_ARCH_MIPS)
3602 STEXI
3603 @item -semihosting
3604 @findex -semihosting
3606 ETEXI
3610 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
3611 QEMU_ARCH_MIPS)
3612 STEXI
3616 @table @option
3622 Allows the user to pass input arguments, and can be used multiple times to build
3627 @end table
3628 ETEXI
3631 STEXI
3635 ETEXI
3639 QEMU_ARCH_ALL)
3640 STEXI
3642 @findex -sandbox
3645 ETEXI
3649 STEXI
3651 @findex -readconfig
3653 QEMU process with many command line options but you don't want to exceed the command line
3654 character limit.
3655 ETEXI
3656 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
3659 STEXI
3660 @item -writeconfig @var{file}
3661 @findex -writeconfig
3662 Write device configuration to @var{file}. The @var{file} can be either filename to save
3663 command line and device configuration into file or dash @code{-}) character to print the
3664 output to stdout. This can be later used as input file for @code{-readconfig} option.
3665 ETEXI
3666 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
3669 QEMU_ARCH_ALL)
3670 STEXI
3671 @item -nodefconfig
3672 @findex -nodefconfig
3673 Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
3674 The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
3675 ETEXI
3676 DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
3679 QEMU_ARCH_ALL)
3680 STEXI
3681 @item -no-user-config
3682 @findex -no-user-config
3683 The @code{-no-user-config} option makes QEMU not load any of the user-provided
3686 ETEXI
3690 QEMU_ARCH_ALL)
3691 STEXI
3693 HXCOMM HX does not support conditional compilation of text.
3697 ETEXI
3699 HXCOMM Internal use
3703 #ifdef __linux__
3706 QEMU_ARCH_ALL)
3707 #endif
3708 STEXI
3712 ETEXI
3717 HXCOMM Deprecated by kvm-pit driver properties
3734 QEMU_ARCH_ALL)
3735 STEXI
3737 @findex -msg
3739 ETEXI
3747 QEMU_ARCH_ALL)
3748 STEXI
3753 ETEXI
3763 QEMU_ARCH_ALL)
3764 STEXI
3766 @findex -object
3772 @table @option
3774 @item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off}
3776 Creates a memory file backend object, which can be used to back
3778 unique ID that will be used to reference this memory region
3780 option provides the size of the memory region, and accepts
3782 the path to either a shared memory or huge page filesystem mount.
3789 Creates a random number generator backend which obtains entropy from
3797 Creates a random number generator backend which obtains entropy from
3799 a unique ID that will be used to reference this entropy backend from
3801 the unique ID of a character device backend that provides the connection
3802 to the RNG daemon.
3804 @item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off}
3806 Creates a TLS anonymous credentials object, which can be used to provide
3808 ID which network backends will use to access the credentials. The
3810 on whether the QEMU network backend that uses the credentials will be
3819 a set of DH parameters at startup. This is a computationally
3820 expensive operation that consumes random pool entropy, so it is
3821 recommended that a persistent set of parameters be generated
3822 upfront and saved.
3824 @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}
3826 Creates a TLS anonymous credentials object, which can be used to provide
3828 ID which network backends will use to access the credentials. The
3830 on whether the QEMU network backend that uses the credentials will be
3834 must be provided with valid client certificates too.
3840 a set of DH parameters at startup. This is a computationally
3841 expensive operation that consumes random pool entropy, so it is
3842 recommended that a persistent set of parameters be generated
3843 upfront and saved.
3845 For x509 certificate credentials the directory will contain further files
3846 providing the x509 certificates. The certificates must be stored
3857 @item -object filter-buffer,id=@var{id},netdev=@var{netdevid},interval=@var{t}[,queue=@var{all|rx|tx}][,status=@var{on|off}]
3860 packets arriving in a given interval on netdev @var{netdevid} are delayed
3861 until the end of the interval. Interval is in microseconds.
3862 @option{status} is optional that indicate whether the netfilter is
3865 queue @var{all|rx|tx} is an option that can be applied to any netfilter.
3867 @option{all}: the filter is attached both to the receive and the transmit
3868 queue of the netdev (default).
3870 @option{rx}: the filter is attached to the receive queue of the netdev,
3871 where it will receive packets sent to the netdev.
3873 @option{tx}: the filter is attached to the transmit queue of the netdev,
3874 where it will receive packets sent by the netdev.
3876 @item -object filter-mirror,id=@var{id},netdev=@var{netdevid},outdev=@var{chardevid}[,queue=@var{all|rx|tx}]
3878 filter-mirror on netdev @var{netdevid},mirror net packet to chardev
3879 @var{chardevid}
3881 @item -object filter-redirector,id=@var{id},netdev=@var{netdevid},indev=@var{chardevid},
3882 outdev=@var{chardevid}[,queue=@var{all|rx|tx}]
3884 filter-redirector on netdev @var{netdevid},redirect filter's net packet to chardev
3886 Create a filter-redirector we need to differ outdev id from indev id, id can not
3887 be the same. we can just use indev or outdev, but at least one of indev or outdev
3888 need to be specified.
3890 @item -object filter-dump,id=@var{id},netdev=@var{dev},file=@var{filename}][,maxlen=@var{len}]
3892 Dump the network traffic on netdev @var{dev} to the file specified by
3893 @var{filename}. At most @var{len} bytes (64k by default) per packet are stored.
3894 The file format is libpcap, so it can be analyzed with tools such as tcpdump
3895 or Wireshark.
3897 @item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
3898 @item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
3900 Defines a secret to store a password, encryption key, or some other sensitive
3901 data. The sensitive data can either be passed directly via the @var{data}
3902 parameter, or indirectly via the @var{file} parameter. Using the @var{data}
3903 parameter is insecure unless the sensitive data is encrypted.
3905 The sensitive data can be provided in raw format (the default), or base64.
3906 When encoded as JSON, the raw format only supports valid UTF-8 characters,
3907 so base64 is recommended for sending binary data. QEMU will convert from
3908 which ever format is provided to the format it needs internally. eg, an
3909 RBD password can be provided in raw format, even though it will be base64
3910 encoded when passed onto the RBD sever.
3912 For added protection, it is possible to encrypt the data associated with
3913 a secret using the AES-256-CBC cipher. Use of encryption is indicated
3914 by providing the @var{keyid} and @var{iv} parameters. The @var{keyid}
3915 parameter provides the ID of a previously defined secret that contains
3916 the AES-256 decryption key. This key should be 32-bytes long and be
3917 base64 encoded. The @var{iv} parameter provides the random initialization
3918 vector used for encryption of this particular secret and should be a
3919 base64 encrypted string of the 16-byte IV.
3921 The simplest (insecure) usage is to provide the secret inline
3923 @example
3925 # $QEMU -object secret,id=sec0,data=letmein,format=raw
3927 @end example
3929 The simplest secure usage is to provide the secret via a file
3931 # echo -n "letmein" > mypasswd.txt
3932 # $QEMU -object secret,id=sec0,file=mypasswd.txt,format=raw
3934 For greater security, AES-256-CBC should be used. To illustrate usage,
3935 consider the openssl command line tool which can encrypt the data. Note
3936 that when encrypting, the plaintext must be padded to the cipher block
3937 size (32 bytes) using the standard PKCS#5/6 compatible padding algorithm.
3939 First a master key needs to be created in base64 encoding:
3941 @example
3942 # openssl rand -base64 32 > key.b64
3944 @end example
3946 Each secret to be encrypted needs to have a random initialization vector
3947 generated. These do not need to be kept secret
3949 @example
3950 # openssl rand -base64 16 > iv.b64
3952 @end example
3954 The secret to be defined can now be encrypted, in this case we're
3955 telling openssl to base64 encode the result, but it could be left
3958 @example
3961 @end example
3964 and specify that to be used to decrypt the user password. Pass the
3967 @example
3968 # $QEMU \
3972 @end example
3974 @end table
3976 ETEXI
3980 STEXI
3981 @end table
3982 ETEXI