| blob | 44c658fd4e0eae5aec5b8a8a0f3ada98cf513ec0 |
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
48 QEMU_ARCH_ALL)
49 STEXI
51 @findex -machine
54 @table @option
59 to initialize.
60 @item kernel_irqchip=on|off
62 @item gfx_passthru=on|off
64 @item vmport=on|off|auto
67 is on.
68 @item kvm_shadow_mem=size
69 Defines the size of the KVM shadow MMU.
76 @item iommu=on|off
80 controls whether AES wrapping keys will be created to allow
84 controls whether DEA wrapping keys will be created to allow
86 @item nvdimm=on|off
88 @end table
89 ETEXI
91 HXCOMM Deprecated by -machine
96 STEXI
98 @findex -cpu
100 ETEXI
110 QEMU_ARCH_ALL)
111 STEXI
112 @item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
113 @findex -smp
121 specifies the maximum number of hotpluggable CPUs.
122 ETEXI
127 STEXI
130 @findex -numa
134 resources. That is, it just assigns existing resources to NUMA nodes. This
135 means that one still has to use the @option{-m}, @option{-smp} options
136 to allocate RAM and VCPUs respectively, and possibly @option{-object}
137 to specify the memory backend for the @samp{memdev} suboption.
139 @samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one
140 node uses @samp{memdev}, all of them have to use it.
141 ETEXI
143 DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
146 STEXI
147 @item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
148 @findex -add-fd
150 Add a file descriptor to an fd set. Valid options are:
152 @table @option
153 @item fd=@var{fd}
154 This option defines the file descriptor of which a duplicate is added to fd set.
155 The file descriptor cannot be stdin, stdout, or stderr.
156 @item set=@var{set}
157 This option defines the ID of the fd set to add the file descriptor to.
158 @item opaque=@var{opaque}
159 This option defines a free-form string that can be used to describe @var{fd}.
160 @end table
162 You can open an image using pre-opened file descriptors from an fd set:
163 @example
164 qemu-system-i386
165 -add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
166 -add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
167 -drive file=/dev/fdset/2,index=0,media=disk
168 @end example
169 ETEXI
171 DEF("set", HAS_ARG, QEMU_OPTION_set,
175 STEXI
176 @item -set @var{group}.@var{id}.@var{arg}=@var{value}
177 @findex -set
179 ETEXI
181 DEF("global", HAS_ARG, QEMU_OPTION_global,
185 QEMU_ARCH_ALL)
186 STEXI
187 @item -global @var{driver}.@var{prop}=@var{value}
188 @itemx -global driver=@var{driver},property=@var{property},value=@var{value}
189 @findex -global
192 @example
193 qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
194 @end example
197 created automatically by the machine model. To create a device which is not
203 ETEXI
212 QEMU_ARCH_ALL)
213 STEXI
214 @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]
215 @findex -boot
220 particular boot order only on the first startup, specify it via
236 system support it.
239 supports it. This only effects when boot priority is changed by
242 @example
249 @end example
252 use is discouraged as it may be removed from future versions.
253 ETEXI
262 QEMU_ARCH_ALL)
263 STEXI
265 @findex -m
269 could be used to set amount of hotpluggable memory slots and maximum amount of
276 @example
278 @end example
281 be enabled and the guest startup RAM will never increase.
282 ETEXI
284 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
286 STEXI
287 @item -mem-path @var{path}
288 @findex -mem-path
289 Allocate guest RAM from a temporarily created file in @var{path}.
290 ETEXI
292 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
294 QEMU_ARCH_ALL)
295 STEXI
296 @item -mem-prealloc
297 @findex -mem-prealloc
298 Preallocate memory when using -mem-path.
299 ETEXI
301 DEF("k", HAS_ARG, QEMU_OPTION_k,
303 QEMU_ARCH_ALL)
304 STEXI
305 @item -k @var{language}
306 @findex -k
307 Use keyboard layout @var{language} (for example @code{fr} for
308 French). This option is only needed where it is not easy to get raw PC
309 keycodes (e.g. on Macs, with some X11 servers or with a VNC
311 hosts.
313 The available layouts are:
314 @example
318 @end example
321 ETEXI
326 QEMU_ARCH_ALL)
327 STEXI
331 parameters.
332 ETEXI
339 STEXI
341 @findex -soundhw
343 available sound hardware.
345 @example
352 @end example
354 Note that Linux's i810_audio OSS kernel (for AC97) module might
355 require manually specifying clocking.
357 @example
358 modprobe i810_audio clocking=48000
359 @end example
360 ETEXI
362 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
366 STEXI
367 @item -balloon none
368 @findex -balloon
369 Disable balloon device.
370 @item -balloon virtio[,addr=@var{addr}]
371 Enable virtio balloon device (default), optionally with PCI address
372 @var{addr}.
373 ETEXI
375 DEF("device", HAS_ARG, QEMU_OPTION_device,
381 QEMU_ARCH_ALL)
382 STEXI
383 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
384 @findex -device
385 Add device @var{driver}. @var{prop}=@var{value} sets driver
386 properties. Valid properties depend on the driver. To get help on
387 possible drivers and properties, use @code{-device help} and
388 @code{-device @var{driver},help}.
390 Some drivers are:
391 @item -device ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}]
393 Add an IPMI BMC. This is a simulation of a hardware management
394 interface processor that normally sits on a system. It provides
395 a watchdog and the ability to reset and power control the system.
396 You need to connect this to an IPMI interface to make it useful
398 The IPMI slave address to use for the BMC. The default is 0x20.
399 This address is the BMC's address on the I2C network of management
401 it.
403 @item -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}]
405 Add a connection to an external IPMI BMC simulator. Instead of
406 locally emulating the BMC like the above item, instead connect
407 to an external entity that provides the IPMI services.
409 A connection is made to an external BMC simulator. If you do this, it
410 is strongly recommended that you use the "reconnect=" chardev option
411 to reconnect to the simulator if the connection is lost. Note that if
412 this is not used carefully, it can be a security issue, as the
413 interface has the ability to send resets, NMIs, and power off the VM.
415 on a secure port on localhost, so neither the simulator nor QEMU is
416 exposed to any outside network.
423 Add a KCS IPMI interafce on the ISA bus. This also adds a
426 @table @option
434 @end table
441 ETEXI
449 QEMU_ARCH_ALL)
450 STEXI
452 @findex -name
457 Naming of individual threads can also be enabled on Linux to aid debugging.
458 ETEXI
463 STEXI
465 @findex -uuid
466 Set system UUID.
467 ETEXI
469 STEXI
470 @end table
471 ETEXI
475 STEXI
476 @table @option
477 ETEXI
482 STEXI
485 @findex -fda
486 @findex -fdb
488 ETEXI
496 STEXI
501 @findex -hda
502 @findex -hdb
503 @findex -hdc
504 @findex -hdd
506 ETEXI
510 QEMU_ARCH_ALL)
511 STEXI
513 @findex -cdrom
517 ETEXI
534 STEXI
536 @findex -drive
540 @table @option
546 Special files such as iSCSI devices can be specified using protocol
552 These options define where is connected the drive by defining the bus number and
553 the unit id.
565 @var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data.
567 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
569 @var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) requests are ignored or passed to the filesystem. Some machine types may not support discard requests.
573 an untrusted format header.
575 This option specifies the serial number to assign to the device.
577 Specify the controller's PCI address (if=virtio only).
578 @item werror=@var{action},rerror=@var{action}
579 Specify which @var{action} to take on write and read errors. Valid actions are:
580 "ignore" (ignore the error and try to continue), "stop" (pause QEMU),
581 "report" (report the error to the guest), "enospc" (pause QEMU only if the
582 host disk is full; report the error to the guest otherwise).
583 The default setting is @option{werror=enospc} and @option{rerror=report}.
584 @item readonly
585 Open drive @option{file} as read-only. Guest write attempts will fail.
586 @item copy-on-read=@var{copy-on-read}
587 @var{copy-on-read} is "on" or "off" and enables whether to copy read backing
588 file sectors into the image file.
589 @item detect-zeroes=@var{detect-zeroes}
590 @var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic
591 conversion of plain zero writes by the OS to driver specific optimized
592 zero write commands. You may even choose "unmap" if @var{discard} is set
593 to "unmap" to allow a zero write to be converted to an UNMAP operation.
594 @end table
596 By default, the @option{cache=writeback} mode is used. It will report data
597 writes as completed as soon as the data is present in the host page cache.
598 This is safe as long as your guest OS makes sure to correctly flush disk caches
599 where needed. If your guest OS does not handle volatile disk write caches
600 correctly and your host crashes or loses power, then the guest may experience
601 data corruption.
603 For such guests, you should consider using @option{cache=writethrough}. This
604 means that the host page cache will be used to read and write data, but write
605 notification will be sent to the guest only after QEMU has made sure to flush
606 each write to the disk. Be aware that this has a major impact on performance.
608 The host page cache can be avoided entirely with @option{cache=none}. This will
611 the guest OS must handle the disk write cache correctly in order to avoid data
612 corruption on host crashes.
614 The host page cache can be avoided while only sending write notifications to
615 the guest when the data has been flushed to the disk using
619 @option{cache=unsafe}. This option tells QEMU that it never needs to write any
620 data to the disk but can instead keep things in cache. If anything goes wrong,
621 like your host losing power, the disk storage getting disconnected accidentally,
622 etc. your image will most probably be rendered unusable. When using
623 the @option{-snapshot} option, unsafe caching is always used.
625 Copy-on-read avoids accessing the same backing file sectors repeatedly and is
626 useful when the backing file is over a slow network. By default copy-on-read
627 is off.
629 Instead of @option{-cdrom} you can use:
630 @example
631 qemu-system-i386 -drive file=file,index=2,media=cdrom
632 @end example
634 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
635 use:
636 @example
637 qemu-system-i386 -drive file=file,index=0,media=disk
638 qemu-system-i386 -drive file=file,index=1,media=disk
639 qemu-system-i386 -drive file=file,index=2,media=disk
640 qemu-system-i386 -drive file=file,index=3,media=disk
641 @end example
643 You can open an image using pre-opened file descriptors from an fd set:
644 @example
645 qemu-system-i386
646 -add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
647 -add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
648 -drive file=/dev/fdset/2,index=0,media=disk
649 @end example
651 You can connect a CDROM to the slave of ide0:
652 @example
653 qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom
654 @end example
657 @example
659 @end example
662 @example
664 @end example
667 @example
670 @end example
673 incremented:
674 @example
676 @end example
677 is interpreted like:
678 @example
679 qemu-system-i386 -hda a -hdb b
680 @end example
681 ETEXI
685 QEMU_ARCH_ALL)
686 STEXI
687 @item -mtdblock @var{file}
688 @findex -mtdblock
689 Use @var{file} as on-board Flash memory image.
690 ETEXI
694 STEXI
695 @item -sd @var{file}
696 @findex -sd
697 Use @var{file} as SecureDigital card image.
698 ETEXI
702 STEXI
703 @item -pflash @var{file}
704 @findex -pflash
705 Use @var{file} as a parallel flash image.
706 ETEXI
710 QEMU_ARCH_ALL)
711 STEXI
712 @item -snapshot
713 @findex -snapshot
714 Write to temporary files instead of disk image files. In this case,
715 the raw disk image you use is not written back. You can however force
716 the write back by pressing @key{C-a s} (@pxref{disk_images}).
717 ETEXI
723 QEMU_ARCH_ALL)
724 STEXI
725 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
726 @findex -hdachs
727 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
728 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
729 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
730 all those parameters. This option is useful for old MS-DOS disk
731 images.
732 ETEXI
735 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
737 QEMU_ARCH_ALL)
739 STEXI
741 @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}]
742 @findex -fsdev
743 Define a new file system device. Valid options are:
744 @table @option
745 @item @var{fsdriver}
746 This option specifies the fs driver backend to use.
748 @item id=@var{id}
749 Specifies identifier for this device
750 @item path=@var{path}
751 Specifies the export path for the file system device. Files under
752 this path will be available to the 9p client on the guest.
753 @item security_model=@var{security_model}
754 Specifies the security model to be used for this export path.
757 credentials as they are created on the guest. This requires QEMU
759 attributes like uid, gid, mode bits and link target are stored as
761 hidden .virtfs_metadata directory. Directories exported by this security model cannot
763 passthrough except the sever won't report failures if it fails to
764 set file attributes like ownership. Security model is mandatory
765 only for local fsdriver. Other fsdrivers (like handle, proxy) don't take
766 security model as a parameter.
767 @item writeout=@var{writeout}
769 This means that host page cache will be used to read and write data but
770 write notification will be sent to the guest only when the data has been
771 reported as written by the storage subsystem.
772 @item readonly
773 Enables exporting 9p share as a readonly mount for guests. By default
774 read-write access is given.
775 @item socket=@var{socket}
776 Enables proxy filesystem driver to use passed socket file for communicating
777 with virtfs-proxy-helper
778 @item sock_fd=@var{sock_fd}
779 Enables proxy filesystem driver to use passed socket descriptor for
780 communicating with virtfs-proxy-helper. Usually a helper like libvirt
781 will create socketpair and pass one of the fds as sock_fd
782 @end table
785 @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
786 Options for virtio-9p-pci driver are:
787 @table @option
788 @item fsdev=@var{id}
789 Specifies the id value specified along with -fsdev option
790 @item mount_tag=@var{mount_tag}
791 Specifies the tag name to be used by the guest to mount this export point
792 @end table
794 ETEXI
797 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
799 QEMU_ARCH_ALL)
801 STEXI
803 @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}]
804 @findex -virtfs
806 The general form of a Virtual File system pass-through options are:
807 @table @option
808 @item @var{fsdriver}
809 This option specifies the fs driver backend to use.
811 @item id=@var{id}
812 Specifies identifier for this device
813 @item path=@var{path}
814 Specifies the export path for the file system device. Files under
815 this path will be available to the 9p client on the guest.
816 @item security_model=@var{security_model}
817 Specifies the security model to be used for this export path.
820 credentials as they are created on the guest. This requires QEMU
822 attributes like uid, gid, mode bits and link target are stored as
824 hidden .virtfs_metadata directory. Directories exported by this security model cannot
826 passthrough except the sever won't report failures if it fails to
827 set file attributes like ownership. Security model is mandatory only
828 for local fsdriver. Other fsdrivers (like handle, proxy) don't take security
829 model as a parameter.
830 @item writeout=@var{writeout}
832 This means that host page cache will be used to read and write data but
833 write notification will be sent to the guest only when the data has been
834 reported as written by the storage subsystem.
835 @item readonly
836 Enables exporting 9p share as a readonly mount for guests. By default
837 read-write access is given.
838 @item socket=@var{socket}
839 Enables proxy filesystem driver to use passed socket file for
840 communicating with virtfs-proxy-helper. Usually a helper like libvirt
841 will create socketpair and pass one of the fds as sock_fd
842 @item sock_fd
843 Enables proxy filesystem driver to use passed 'sock_fd' as the socket
844 descriptor for interfacing with virtfs-proxy-helper
845 @end table
846 ETEXI
850 QEMU_ARCH_ALL)
851 STEXI
852 @item -virtfs_synth
853 @findex -virtfs_synth
854 Create synthetic file system image
855 ETEXI
857 STEXI
858 @end table
859 ETEXI
860 DEFHEADING()
862 DEFHEADING(USB options:)
863 STEXI
864 @table @option
865 ETEXI
869 QEMU_ARCH_ALL)
870 STEXI
871 @item -usb
872 @findex -usb
873 Enable the USB driver (will be the default soon)
874 ETEXI
878 QEMU_ARCH_ALL)
879 STEXI
881 @item -usbdevice @var{devname}
882 @findex -usbdevice
883 Add the USB device @var{devname}. @xref{usb_devices}.
885 @table @option
887 @item mouse
888 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
890 @item tablet
891 Pointer device that uses absolute coordinates (like a touchscreen). This
892 means QEMU is able to report the mouse position without having to grab the
893 mouse. Also overrides the PS/2 mouse emulation when activated.
895 @item disk:[format=@var{format}]:@var{file}
896 Mass storage device based on file. The optional @var{format} argument
897 will be used rather than detecting the format. Can be used to specify
898 @code{format=raw} to avoid interpreting an untrusted format header.
900 @item host:@var{bus}.@var{addr}
901 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
903 @item host:@var{vendor_id}:@var{product_id}
904 Pass through the host device identified by @var{vendor_id}:@var{product_id}
905 (Linux only).
907 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
908 Serial converter to host character device @var{dev}, see @code{-serial} for the
909 available devices.
911 @item braille
912 Braille device. This will use BrlAPI to display the braille output on a real
913 or fake device.
915 @item net:@var{options}
916 Network adapter that supports CDC ethernet and RNDIS protocols.
918 @end table
919 ETEXI
921 STEXI
922 @end table
923 ETEXI
924 DEFHEADING()
926 DEFHEADING(Display options:)
927 STEXI
928 @table @option
929 ETEXI
937 STEXI
938 @item -display @var{type}
939 @findex -display
940 Select type of display to use. This option is a replacement for the
941 old style -sdl/-curses/... options. Valid values for @var{type} are
942 @table @option
943 @item sdl
944 Display video output via SDL (usually in a separate graphics
945 window; see the SDL documentation for other possibilities).
946 @item curses
947 Display video output via curses. For graphics device models which
948 support a text mode, QEMU can display this output using a
949 curses/ncurses interface. Nothing is displayed when the graphics
950 device is in graphical mode or if the graphics device does not support
951 a text mode. Generally only the VGA device models support text mode.
952 @item none
953 Do not display video output. The guest will still see an emulated
954 graphics card, but its output will not be displayed to the QEMU
955 user. This option differs from the -nographic option in that it
956 only affects what is done with video output; -nographic also changes
957 the destination of the serial and parallel port data.
958 @item gtk
959 Display video output in a GTK window. This interface provides drop-down
960 menus and other UI elements to configure and control the VM during
961 runtime.
962 @item vnc
963 Start a VNC server on display <arg>
964 @end table
965 ETEXI
969 QEMU_ARCH_ALL)
970 STEXI
971 @item -nographic
972 @findex -nographic
973 Normally, QEMU uses SDL to display the VGA output. With this option,
974 you can totally disable graphical output so that QEMU is a simple
975 command line application. The emulated serial port is redirected on
976 the console and muxed with the monitor (unless redirected elsewhere
977 explicitly). Therefore, you can still use QEMU to debug a Linux kernel
978 with a serial console. Use @key{C-a h} for help on switching between
979 the console and monitor.
980 ETEXI
984 QEMU_ARCH_ALL)
985 STEXI
986 @item -curses
987 @findex -curses
988 Normally, QEMU uses SDL to display the VGA output. With this option,
989 QEMU can display the VGA output when in text mode using a
990 curses/ncurses interface. Nothing is displayed in graphical mode.
991 ETEXI
995 QEMU_ARCH_ALL)
996 STEXI
997 @item -no-frame
998 @findex -no-frame
999 Do not use decorations for SDL windows and start them using the whole
1000 available screen space. This makes the using QEMU in a dedicated desktop
1001 workspace more convenient.
1002 ETEXI
1006 QEMU_ARCH_ALL)
1007 STEXI
1008 @item -alt-grab
1009 @findex -alt-grab
1010 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
1011 affects the special keys (for fullscreen, monitor-mode switching, etc).
1012 ETEXI
1016 QEMU_ARCH_ALL)
1017 STEXI
1018 @item -ctrl-grab
1019 @findex -ctrl-grab
1020 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
1021 affects the special keys (for fullscreen, monitor-mode switching, etc).
1022 ETEXI
1026 STEXI
1027 @item -no-quit
1028 @findex -no-quit
1029 Disable SDL window close capability.
1030 ETEXI
1034 STEXI
1035 @item -sdl
1036 @findex -sdl
1037 Enable SDL.
1038 ETEXI
1058 QEMU_ARCH_ALL)
1059 STEXI
1060 @item -spice @var{option}[,@var{option}[,...]]
1061 @findex -spice
1062 Enable the spice remote desktop protocol. Valid options are
1064 @table @option
1066 @item port=<nr>
1067 Set the TCP port spice is listening on for plaintext channels.
1069 @item addr=<addr>
1070 Set the IP address spice is listening on. Default is any address.
1072 @item ipv4
1073 @itemx ipv6
1074 @itemx unix
1075 Force using the specified IP version.
1077 @item password=<secret>
1078 Set the password you need to authenticate.
1080 @item sasl
1081 Require that the client use SASL to authenticate with the spice.
1082 The exact choice of authentication method used is controlled from the
1083 system / user's SASL configuration file for the 'qemu' service. This
1084 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1085 unprivileged user, an environment variable SASL_CONF_PATH can be used
1086 to make it search alternate locations for the service config.
1087 While some SASL auth methods can also provide data encryption (eg GSSAPI),
1088 it is recommended that SASL always be combined with the 'tls' and
1089 'x509' settings to enable use of SSL and server certificates. This
1090 ensures a data encryption preventing compromise of authentication
1091 credentials.
1093 @item disable-ticketing
1094 Allow client connects without authentication.
1096 @item disable-copy-paste
1097 Disable copy paste between the client and the guest.
1099 @item disable-agent-file-xfer
1100 Disable spice-vdagent based file-xfer between the client and the guest.
1102 @item tls-port=<nr>
1103 Set the TCP port spice is listening on for encrypted channels.
1105 @item x509-dir=<dir>
1106 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
1108 @item x509-key-file=<file>
1109 @itemx x509-key-password=<file>
1110 @itemx x509-cert-file=<file>
1111 @itemx x509-cacert-file=<file>
1112 @itemx x509-dh-key-file=<file>
1113 The x509 file names can also be configured individually.
1115 @item tls-ciphers=<list>
1116 Specify which ciphers to use.
1118 @item tls-channel=[main|display|cursor|inputs|record|playback]
1119 @itemx plaintext-channel=[main|display|cursor|inputs|record|playback]
1120 Force specific channel to be used with or without TLS encryption. The
1121 options can be specified multiple times to configure multiple
1123 mode. For channels which are not explicitly forced into one mode the
1124 spice client is allowed to pick tls/plaintext as he pleases.
1126 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
1127 Configure image compression (lossless).
1128 Default is auto_glz.
1130 @item jpeg-wan-compression=[auto|never|always]
1131 @itemx zlib-glz-wan-compression=[auto|never|always]
1132 Configure wan image compression (lossy for slow links).
1133 Default is auto.
1135 @item streaming-video=[off|all|filter]
1136 Configure video stream detection. Default is filter.
1138 @item agent-mouse=[on|off]
1139 Enable/disable passing mouse events via vdagent. Default is on.
1141 @item playback-compression=[on|off]
1142 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
1144 @item seamless-migration=[on|off]
1145 Enable/disable spice seamless migration. Default is off.
1147 @item gl=[on|off]
1148 Enable/disable OpenGL context. Default is off.
1150 @end table
1151 ETEXI
1155 QEMU_ARCH_ALL)
1156 STEXI
1157 @item -portrait
1158 @findex -portrait
1159 Rotate graphical output 90 deg left (only PXA LCD).
1160 ETEXI
1164 QEMU_ARCH_ALL)
1165 STEXI
1166 @item -rotate @var{deg}
1167 @findex -rotate
1168 Rotate graphical output some deg left (only PXA LCD).
1169 ETEXI
1174 STEXI
1175 @item -vga @var{type}
1176 @findex -vga
1177 Select type of VGA card to emulate. Valid values for @var{type} are
1178 @table @option
1179 @item cirrus
1180 Cirrus Logic GD5446 Video card. All Windows versions starting from
1181 Windows 95 should recognize and use this graphic card. For optimal
1182 performances, use 16 bit color depth in the guest and the host OS.
1183 (This one is the default)
1184 @item std
1185 Standard VGA card with Bochs VBE extensions. If your guest OS
1186 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
1187 to use high resolution modes (>= 1280x1024x16) then you should use
1188 this option.
1189 @item vmware
1190 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
1191 recent XFree86/XOrg server or Windows guest with a driver for this
1192 card.
1193 @item qxl
1194 QXL paravirtual graphic card. It is VGA compatible (including VESA
1195 2.0 VBE support). Works best with qxl guest drivers installed though.
1196 Recommended choice when using the spice protocol.
1197 @item tcx
1198 (sun4m only) Sun TCX framebuffer. This is the default framebuffer for
1199 sun4m machines and offers both 8-bit and 24-bit colour depths at a
1200 fixed resolution of 1024x768.
1201 @item cg3
1202 (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer
1203 for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP)
1204 resolutions aimed at people wishing to run older Solaris versions.
1205 @item virtio
1206 Virtio VGA card.
1207 @item none
1208 Disable VGA card.
1209 @end table
1210 ETEXI
1214 STEXI
1215 @item -full-screen
1216 @findex -full-screen
1217 Start in full screen.
1218 ETEXI
1222 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
1223 STEXI
1224 @item -g @var{width}x@var{height}[x@var{depth}]
1225 @findex -g
1226 Set the initial graphical resolution and depth (PPC, SPARC only).
1227 ETEXI
1231 STEXI
1232 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
1233 @findex -vnc
1234 Normally, QEMU uses SDL to display the VGA output. With this option,
1235 you can have QEMU listen on VNC display @var{display} and redirect the VGA
1236 display over the VNC session. It is very useful to enable the usb
1237 tablet device when using this option (option @option{-usbdevice
1238 tablet}). When using the VNC display, you must use the @option{-k}
1239 parameter to set the keyboard layout if you are not using en-us. Valid
1240 syntax for the @var{display} is
1242 @table @option
1244 @item to=@var{L}
1246 With this option, QEMU will try next available VNC @var{display}s, until the
1248 available, e.g. port 5900+@var{display} is already used by another
1249 application. By default, to=0.
1251 @item @var{host}:@var{d}
1253 TCP connections will only be allowed from @var{host} on display @var{d}.
1254 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
1255 be omitted in which case the server will accept connections from any host.
1257 @item unix:@var{path}
1259 Connections will be allowed over UNIX domain sockets where @var{path} is the
1260 location of a unix socket to listen for connections on.
1262 @item none
1264 VNC is initialized but not started. The monitor @code{change} command
1265 can be used to later start the VNC server.
1267 @end table
1269 Following the @var{display} value there may be one or more @var{option} flags
1270 separated by commas. Valid options are
1272 @table @option
1274 @item reverse
1276 Connect to a listening VNC client via a ``reverse'' connection. The
1277 client is specified by the @var{display}. For reverse network
1278 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
1279 is a TCP port number, not a display number.
1281 @item websocket
1283 Opens an additional TCP listening port dedicated to VNC Websocket connections.
1284 By definition the Websocket port is 5700+@var{display}. If @var{host} is
1285 specified connections will only be allowed from this host.
1286 As an alternative the Websocket port could be specified by using
1287 @code{websocket}=@var{port}.
1288 If no TLS credentials are provided, the websocket connection runs in
1289 unencrypted mode. If TLS credentials are provided, the websocket connection
1290 requires encrypted client connections.
1292 @item password
1294 Require that password based authentication is used for client connections.
1296 The password must be set separately using the @code{set_password} command in
1297 the @ref{pcsys_monitor}. The syntax to change your password is:
1298 @code{set_password <protocol> <password>} where <protocol> could be either
1301 If you would like to change <protocol> password expiration, you should use
1302 @code{expire_password <protocol> <expiration-time>} where expiration time could
1303 be one of the following options: now, never, +seconds or UNIX time of
1304 expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800
1306 date and time).
1309 allow <protocol> password to expire immediately or never expire.
1311 @item tls-creds=@var{ID}
1313 Provides the ID of a set of TLS credentials to use to secure the
1314 VNC server. They will apply to both the normal VNC server socket
1315 and the websocket socket (if enabled). Setting TLS credentials
1316 will cause the VNC server socket to enable the VeNCrypt auth
1317 mechanism. The credentials should have been previously created
1318 using the @option{-object tls-creds} argument.
1320 The @option{tls-creds} parameter obsoletes the @option{tls},
1321 @option{x509}, and @option{x509verify} options, and as such
1322 it is not permitted to set both new and old type options at
1323 the same time.
1325 @item tls
1327 Require that client use TLS when communicating with the VNC server. This
1328 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
1329 attack. It is recommended that this option be combined with either the
1330 @option{x509} or @option{x509verify} options.
1332 This option is now deprecated in favor of using the @option{tls-creds}
1333 argument.
1335 @item x509=@var{/path/to/certificate/dir}
1337 Valid if @option{tls} is specified. Require that x509 credentials are used
1338 for negotiating the TLS session. The server will send its x509 certificate
1339 to the client. It is recommended that a password be set on the VNC server
1340 to provide authentication of the client when this is used. The path following
1341 this option specifies where the x509 certificates are to be loaded from.
1342 See the @ref{vnc_security} section for details on generating certificates.
1344 This option is now deprecated in favour of using the @option{tls-creds}
1345 argument.
1347 @item x509verify=@var{/path/to/certificate/dir}
1349 Valid if @option{tls} is specified. Require that x509 credentials are used
1350 for negotiating the TLS session. The server will send its x509 certificate
1351 to the client, and request that the client send its own x509 certificate.
1352 The server will validate the client's certificate against the CA certificate,
1353 and reject clients when validation fails. If the certificate authority is
1354 trusted, this is a sufficient authentication mechanism. You may still wish
1355 to set a password on the VNC server as a second authentication layer. The
1356 path following this option specifies where the x509 certificates are to
1357 be loaded from. See the @ref{vnc_security} section for details on generating
1358 certificates.
1360 This option is now deprecated in favour of using the @option{tls-creds}
1361 argument.
1363 @item sasl
1365 Require that the client use SASL to authenticate with the VNC server.
1366 The exact choice of authentication method used is controlled from the
1367 system / user's SASL configuration file for the 'qemu' service. This
1368 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1369 unprivileged user, an environment variable SASL_CONF_PATH can be used
1370 to make it search alternate locations for the service config.
1371 While some SASL auth methods can also provide data encryption (eg GSSAPI),
1372 it is recommended that SASL always be combined with the 'tls' and
1373 'x509' settings to enable use of SSL and server certificates. This
1374 ensures a data encryption preventing compromise of authentication
1375 credentials. See the @ref{vnc_security} section for details on using
1376 SASL authentication.
1378 @item acl
1380 Turn on access control lists for checking of the x509 client certificate
1381 and SASL party. For x509 certs, the ACL check is made against the
1382 certificate's distinguished name. This is something that looks like
1383 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1384 made against the username, which depending on the SASL plugin, may
1385 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1386 When the @option{acl} flag is set, the initial access list will be
1387 empty, with a @code{deny} policy. Thus no one will be allowed to
1388 use the VNC server until the ACLs have been loaded. This can be
1389 achieved using the @code{acl} monitor command.
1391 @item lossy
1393 Enable lossy compression methods (gradient, JPEG, ...). If this
1394 option is set, VNC client may receive lossy framebuffer updates
1395 depending on its encoding settings. Enabling this option can save
1396 a lot of bandwidth at the expense of quality.
1398 @item non-adaptive
1400 Disable adaptive encodings. Adaptive encodings are enabled by default.
1401 An adaptive encoding will try to detect frequently updated screen regions,
1402 and send updates in these regions using a lossy encoding (like JPEG).
1403 This can be really helpful to save bandwidth when playing videos. Disabling
1404 adaptive encodings restores the original static behavior of encodings
1405 like Tight.
1407 @item share=[allow-exclusive|force-shared|ignore]
1409 Set display sharing policy. 'allow-exclusive' allows clients to ask
1410 for exclusive access. As suggested by the rfb spec this is
1411 implemented by dropping other connections. Connecting multiple
1412 clients in parallel requires all clients asking for a shared session
1413 (vncviewer: -shared switch). This is the default. 'force-shared'
1414 disables exclusive client access. Useful for shared desktop sessions,
1415 where you don't want someone forgetting specify -shared disconnect
1416 everybody else. 'ignore' completely ignores the shared flag and
1417 allows everybody connect unconditionally. Doesn't conform to the rfb
1418 spec but is traditional QEMU behavior.
1420 @item key-delay-ms
1422 Set keyboard delay, for key down and key up events, in milliseconds.
1423 Default is 1. Keyboards are low-bandwidth devices, so this slowdown
1424 can help the device and guest to keep up and not lose events in case
1425 events are arriving in bulk. Possible causes for the latter are flaky
1426 network connections, or scripts for automated testing.
1428 @end table
1429 ETEXI
1431 STEXI
1432 @end table
1433 ETEXI
1434 ARCHHEADING(, QEMU_ARCH_I386)
1436 ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
1437 STEXI
1438 @table @option
1439 ETEXI
1443 QEMU_ARCH_I386)
1444 STEXI
1445 @item -win2k-hack
1446 @findex -win2k-hack
1447 Use it when installing Windows 2000 to avoid a disk full bug. After
1448 Windows 2000 is installed, you no longer need this option (this option
1449 slows down the IDE transfers).
1450 ETEXI
1452 HXCOMM Deprecated by -rtc
1457 QEMU_ARCH_I386)
1458 STEXI
1459 @item -no-fd-bootchk
1460 @findex -no-fd-bootchk
1461 Disable boot signature checking for floppy disks in BIOS. May
1462 be needed to boot from old floppy disks.
1463 ETEXI
1467 STEXI
1468 @item -no-acpi
1469 @findex -no-acpi
1470 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1471 it if your guest OS complains about ACPI problems (PC target machine
1472 only).
1473 ETEXI
1477 STEXI
1478 @item -no-hpet
1479 @findex -no-hpet
1480 Disable HPET support.
1481 ETEXI
1484 "-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"
1486 STEXI
1487 @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}]...]
1488 @findex -acpitable
1489 Add ACPI table with specified header fields and context from specified files.
1490 For file=, take whole ACPI table from the specified files, including all
1491 ACPI headers (possible overridden by other options).
1492 For data=, only data
1493 portion of the table is used, all header information is specified in the
1494 command line.
1495 If a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id
1496 fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order
1497 to ensure the field matches required by the Microsoft SLIC spec and the ACPI
1498 spec.
1499 ETEXI
1522 QEMU_ARCH_I386 | QEMU_ARCH_ARM)
1523 STEXI
1524 @item -smbios file=@var{binary}
1525 @findex -smbios
1526 Load SMBIOS entry from binary file.
1528 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off]
1529 Specify SMBIOS type 0 fields
1531 @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}]
1532 Specify SMBIOS type 1 fields
1534 @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}]
1535 Specify SMBIOS type 2 fields
1537 @item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}]
1538 Specify SMBIOS type 3 fields
1540 @item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}]
1541 Specify SMBIOS type 4 fields
1543 @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}]
1544 Specify SMBIOS type 17 fields
1545 ETEXI
1547 STEXI
1548 @end table
1549 ETEXI
1550 DEFHEADING()
1552 DEFHEADING(Network options:)
1553 STEXI
1554 @table @option
1555 ETEXI
1557 HXCOMM Legacy slirp options (now moved to -net user):
1558 #ifdef CONFIG_SLIRP
1562 #ifndef _WIN32
1564 #endif
1565 #endif
1568 #ifdef CONFIG_SLIRP
1574 #ifndef _WIN32
1576 #endif
1579 #endif
1580 #ifdef _WIN32
1583 #else
1610 #endif
1611 #ifdef __linux__
1637 #endif
1647 #ifdef CONFIG_VDE
1653 #endif
1654 #ifdef CONFIG_NETMAP
1659 #endif
1673 #ifdef CONFIG_SLIRP
1675 #endif
1678 #ifdef CONFIG_VDE
1680 #endif
1681 #ifdef CONFIG_NETMAP
1683 #endif
1687 STEXI
1688 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1689 @findex -net
1690 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1691 = 0 is the default). The NIC is an e1000 by default on the PC
1692 target. Optionally, the MAC address can be changed to @var{mac}, the
1693 device address set to @var{addr} (PCI cards only),
1694 and a @var{name} can be assigned for use in monitor commands.
1695 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1696 that the card should have; this option currently only affects virtio cards; set
1697 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1698 NIC is created. QEMU can emulate several different models of network card.
1699 Valid values for @var{type} are
1700 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1701 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1702 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1703 Not all devices are supported on all targets. Use @code{-net nic,model=help}
1704 for a list of available devices for your target.
1706 @item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
1707 @findex -netdev
1708 @item -net user[,@var{option}][,@var{option}][,...]
1709 Use the user mode network stack which requires no administrator
1710 privilege to run. Valid options are:
1712 @table @option
1713 @item vlan=@var{n}
1714 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1716 @item id=@var{id}
1717 @itemx name=@var{name}
1718 Assign symbolic name for use in monitor commands.
1720 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must
1721 be enabled. If neither is specified both protocols are enabled.
1723 @item net=@var{addr}[/@var{mask}]
1724 Set IP network address the guest will see. Optionally specify the netmask,
1725 either in the form a.b.c.d or as number of valid top-most bits. Default is
1726 10.0.2.0/24.
1728 @item host=@var{addr}
1729 Specify the guest-visible address of the host. Default is the 2nd IP in the
1730 guest network, i.e. x.x.x.2.
1732 @item ipv6-net=@var{addr}[/@var{int}]
1733 Set IPv6 network address the guest will see (default is fec0::/64). The
1734 network prefix is given in the usual hexadecimal IPv6 address
1735 notation. The prefix size is optional, and is given as the number of
1736 valid top-most bits (default is 64).
1738 @item ipv6-host=@var{addr}
1739 Specify the guest-visible IPv6 address of the host. Default is the 2nd IPv6 in
1740 the guest network, i.e. xxxx::2.
1742 @item restrict=on|off
1743 If this option is enabled, the guest will be isolated, i.e. it will not be
1744 able to contact the host and no guest IP packets will be routed over the host
1745 to the outside. This option does not affect any explicitly set forwarding rules.
1747 @item hostname=@var{name}
1748 Specifies the client hostname reported by the built-in DHCP server.
1750 @item dhcpstart=@var{addr}
1751 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1752 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1754 @item dns=@var{addr}
1755 Specify the guest-visible address of the virtual nameserver. The address must
1756 be different from the host address. Default is the 3rd IP in the guest network,
1757 i.e. x.x.x.3.
1759 @item ipv6-dns=@var{addr}
1760 Specify the guest-visible address of the IPv6 virtual nameserver. The address
1761 must be different from the host address. Default is the 3rd IP in the guest
1762 network, i.e. xxxx::3.
1764 @item dnssearch=@var{domain}
1765 Provides an entry for the domain-search list sent by the built-in
1766 DHCP server. More than one domain suffix can be transmitted by specifying
1767 this option multiple times. If supported, this will cause the guest to
1768 automatically try to append the given domain suffix(es) in case a domain name
1769 can not be resolved.
1771 Example:
1772 @example
1773 qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...]
1774 @end example
1776 @item tftp=@var{dir}
1777 When using the user mode network stack, activate a built-in TFTP
1778 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1779 The TFTP client on the guest must be configured in binary mode (use the command
1780 @code{bin} of the Unix TFTP client).
1782 @item bootfile=@var{file}
1783 When using the user mode network stack, broadcast @var{file} as the BOOTP
1784 filename. In conjunction with @option{tftp}, this can be used to network boot
1785 a guest from a local directory.
1787 Example (using pxelinux):
1788 @example
1789 qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1790 @end example
1792 @item smb=@var{dir}[,smbserver=@var{addr}]
1793 When using the user mode network stack, activate a built-in SMB
1794 server so that Windows OSes can access to the host files in @file{@var{dir}}
1795 transparently. The IP address of the SMB server can be set to @var{addr}. By
1796 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1798 In the guest Windows OS, the line:
1799 @example
1800 10.0.2.4 smbserver
1801 @end example
1802 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1803 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1807 Note that a SAMBA server must be installed on the host OS.
1808 QEMU was tested successfully with smbd versions from Red Hat 9,
1809 Fedora Core 3 and OpenSUSE 11.x.
1811 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1812 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1813 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1814 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1815 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1816 be bound to a specific host interface. If no connection type is set, TCP is
1817 used. This option can be given multiple times.
1819 For example, to redirect host X11 connection from screen 1 to guest
1820 screen 0, use the following:
1822 @example
1823 # on the host
1824 qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1825 # this host xterm should open in the guest X11 server
1826 xterm -display :1
1827 @end example
1829 To redirect telnet connections from host port 5555 to telnet port on
1830 the guest, use the following:
1832 @example
1833 # on the host
1834 qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
1835 telnet localhost 5555
1836 @end example
1838 Then when you use on the host @code{telnet localhost 5555}, you
1839 connect to the guest telnet server.
1841 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1842 @itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
1843 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1844 to the character device @var{dev} or to a program executed by @var{cmd:command}
1845 which gets spawned for each connection. This option can be given multiple times.
1847 You can either use a chardev directly and have that one used throughout QEMU's
1848 lifetime, like in the following example:
1850 @example
1851 # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
1852 # the guest accesses it
1853 qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...]
1854 @end example
1856 Or you can execute a command on every TCP connection established by the guest,
1857 so that QEMU behaves similar to an inetd process for that virtual server:
1859 @example
1861 # and connect the TCP stream to its stdin/stdout
1862 qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
1863 @end example
1865 @end table
1867 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1868 processed and applied to -net user. Mixing them with the new configuration
1869 syntax gives undefined results. Their use for new applications is discouraged
1870 as they will be removed from future versions.
1872 @item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1873 @itemx -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1874 Connect the host TAP network interface @var{name} to VLAN @var{n}.
1876 Use the network script @var{file} to configure it and the network script
1877 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1878 automatically provides one. The default network configure script is
1879 @file{/etc/qemu-ifup} and the default network deconfigure script is
1880 @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1881 to disable script execution.
1883 If running QEMU as an unprivileged user, use the network helper
1884 @var{helper} to configure the TAP interface. The default network
1885 helper executable is @file{/path/to/qemu-bridge-helper}.
1887 @option{fd}=@var{h} can be used to specify the handle of an already
1888 opened host TAP interface.
1890 Examples:
1892 @example
1893 #launch a QEMU instance with the default network script
1894 qemu-system-i386 linux.img -net nic -net tap
1895 @end example
1897 @example
1898 #launch a QEMU instance with two NICs, each one connected
1899 #to a TAP device
1900 qemu-system-i386 linux.img \
1901 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1902 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1903 @end example
1905 @example
1906 #launch a QEMU instance with the default network helper to
1907 #connect a TAP device to bridge br0
1908 qemu-system-i386 linux.img \
1910 @end example
1912 @item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
1913 @itemx -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
1914 Connect a host TAP network interface to a host bridge device.
1916 Use the network helper @var{helper} to configure the TAP interface and
1917 attach it to the bridge. The default network helper executable is
1918 @file{/path/to/qemu-bridge-helper} and the default bridge
1919 device is @file{br0}.
1921 Examples:
1923 @example
1924 #launch a QEMU instance with the default network helper to
1925 #connect a TAP device to bridge br0
1926 qemu-system-i386 linux.img -net bridge -net nic,model=virtio
1927 @end example
1929 @example
1930 #launch a QEMU instance with the default network helper to
1931 #connect a TAP device to bridge qemubr0
1932 qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
1933 @end example
1935 @item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1936 @itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1938 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1939 machine using a TCP socket connection. If @option{listen} is
1940 specified, QEMU waits for incoming connections on @var{port}
1941 (@var{host} is optional). @option{connect} is used to connect to
1942 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1943 specifies an already opened TCP socket.
1945 Example:
1946 @example
1947 # launch a first QEMU instance
1948 qemu-system-i386 linux.img \
1949 -net nic,macaddr=52:54:00:12:34:56 \
1950 -net socket,listen=:1234
1951 # connect the VLAN 0 of this instance to the VLAN 0
1952 # of the first instance
1953 qemu-system-i386 linux.img \
1954 -net nic,macaddr=52:54:00:12:34:57 \
1955 -net socket,connect=127.0.0.1:1234
1956 @end example
1958 @item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1959 @itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1961 Create a VLAN @var{n} shared with another QEMU virtual
1962 machines using a UDP multicast socket, effectively making a bus for
1963 every QEMU with same multicast address @var{maddr} and @var{port}.
1964 NOTES:
1965 @enumerate
1966 @item
1967 Several QEMU can be running on different hosts and share same bus (assuming
1968 correct multicast setup for these hosts).
1969 @item
1970 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1971 @url{http://user-mode-linux.sf.net}.
1972 @item
1973 Use @option{fd=h} to specify an already opened UDP multicast socket.
1974 @end enumerate
1976 Example:
1977 @example
1978 # launch one QEMU instance
1979 qemu-system-i386 linux.img \
1980 -net nic,macaddr=52:54:00:12:34:56 \
1981 -net socket,mcast=230.0.0.1:1234
1983 qemu-system-i386 linux.img \
1984 -net nic,macaddr=52:54:00:12:34:57 \
1985 -net socket,mcast=230.0.0.1:1234
1987 qemu-system-i386 linux.img \
1988 -net nic,macaddr=52:54:00:12:34:58 \
1989 -net socket,mcast=230.0.0.1:1234
1990 @end example
1992 Example (User Mode Linux compat.):
1993 @example
1994 # launch QEMU instance (note mcast address selected
1995 # is UML's default)
1996 qemu-system-i386 linux.img \
1997 -net nic,macaddr=52:54:00:12:34:56 \
1998 -net socket,mcast=239.192.168.1:1102
1999 # launch UML
2000 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
2001 @end example
2003 Example (send packets from host's 1.2.3.4):
2004 @example
2005 qemu-system-i386 linux.img \
2006 -net nic,macaddr=52:54:00:12:34:56 \
2007 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
2008 @end example
2010 @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}]
2011 @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}]
2012 Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular
2013 protocol to transport Ethernet (and other Layer 2) data frames between
2014 two systems. It is present in routers, firewalls and the Linux kernel
2015 (from version 3.3 onwards).
2017 This transport allows a VM to communicate to another VM, router or firewall directly.
2019 @item src=@var{srcaddr}
2020 source address (mandatory)
2021 @item dst=@var{dstaddr}
2022 destination address (mandatory)
2023 @item udp
2024 select udp encapsulation (default is ip).
2025 @item srcport=@var{srcport}
2026 source udp port.
2027 @item dstport=@var{dstport}
2028 destination udp port.
2029 @item ipv6
2030 force v6, otherwise defaults to v4.
2031 @item rxcookie=@var{rxcookie}
2032 @itemx txcookie=@var{txcookie}
2033 Cookies are a weak form of security in the l2tpv3 specification.
2034 Their function is mostly to prevent misconfiguration. By default they are 32
2035 bit.
2036 @item cookie64
2037 Set cookie size to 64 bit instead of the default 32
2038 @item counter=off
2039 Force a 'cut-down' L2TPv3 with no counter as in
2040 draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
2041 @item pincounter=on
2042 Work around broken counter handling in peer. This may also help on
2043 networks which have packet reorder.
2044 @item offset=@var{offset}
2045 Add an extra offset between header and data
2047 For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan
2048 on the remote Linux host 1.2.3.4:
2049 @example
2050 # Setup tunnel on linux host using raw ip as encapsulation
2051 # on 1.2.3.4
2052 ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \
2053 encap udp udp_sport 16384 udp_dport 16384
2054 ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \
2055 0xFFFFFFFF peer_session_id 0xFFFFFFFF
2056 ifconfig vmtunnel0 mtu 1500
2057 ifconfig vmtunnel0 up
2058 brctl addif br-lan vmtunnel0
2061 # on 4.3.2.1
2062 # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
2064 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
2067 @end example
2069 @item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
2070 @itemx -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
2071 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
2072 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
2073 and MODE @var{octalmode} to change default ownership and permissions for
2074 communication port. This option is only available if QEMU has been compiled
2075 with vde support enabled.
2077 Example:
2078 @example
2079 # launch vde switch
2080 vde_switch -F -sock /tmp/myswitch
2081 # launch QEMU instance
2082 qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
2083 @end example
2085 @item -netdev hubport,id=@var{id},hubid=@var{hubid}
2090 netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the
2091 required hub automatically.
2093 @item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n]
2095 Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should
2096 be a unix domain socket backed one. The vhost-user uses a specifically defined
2097 protocol to pass vhost ioctl replacement messages to an application on the other
2098 end of the socket. On non-MSIX guests, the feature can be forced with
2099 @var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to
2100 be created for multiqueue vhost-user.
2102 Example:
2103 @example
2104 qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
2105 -numa node,memdev=mem \
2106 -chardev socket,path=/path/to/socket \
2107 -netdev type=vhost-user,id=net0,chardev=chr0 \
2108 -device virtio-net-pci,netdev=net0
2109 @end example
2111 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
2112 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
2113 At most @var{len} bytes (64k by default) per packet are stored. The file format is
2114 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
2115 Note: For devices created with '-netdev', use '-object filter-dump,...' instead.
2117 @item -net none
2118 Indicate that no network devices should be configured. It is used to
2119 override the default configuration (@option{-net nic -net user}) which
2120 is activated if no @option{-net} options are provided.
2121 ETEXI
2123 STEXI
2124 @end table
2125 ETEXI
2126 DEFHEADING()
2128 DEFHEADING(Character device options:)
2129 STEXI
2131 The general form of a character device option is:
2132 @table @option
2133 ETEXI
2137 "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n"
2151 #ifdef _WIN32
2154 #else
2157 #endif
2158 #ifdef CONFIG_BRLAPI
2160 #endif
2161 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
2162 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
2165 #endif
2166 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
2169 #endif
2170 #if defined(CONFIG_SPICE)
2173 #endif
2174 , QEMU_ARCH_ALL
2175 )
2177 STEXI
2178 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
2179 @findex -chardev
2180 Backend is one of:
2181 @option{null},
2182 @option{socket},
2183 @option{udp},
2184 @option{msmouse},
2185 @option{vc},
2186 @option{ringbuf},
2187 @option{file},
2188 @option{pipe},
2189 @option{console},
2190 @option{serial},
2191 @option{pty},
2192 @option{stdio},
2193 @option{braille},
2194 @option{tty},
2195 @option{parallel},
2196 @option{parport},
2197 @option{spicevmc}.
2198 @option{spiceport}.
2199 The specific backend will determine the applicable options.
2201 All devices must have an id, which can be any string up to 127 characters long.
2202 It is used to uniquely identify this device in other command line directives.
2204 A character device may be used in multiplexing mode by multiple front-ends.
2205 Specify @option{mux=on} to enable this mode.
2208 If you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will
2209 create a multiplexer with your specified ID, and you can then configure multiple
2210 front ends to use that chardev ID for their input/output. Up to four different
2211 front ends can be connected to a single multiplexed chardev. (Without
2212 multiplexing enabled, a chardev can only be used by a single front end.)
2213 For instance you could use this to allow a single stdio chardev to be used by
2214 two serial ports and the QEMU monitor:
2216 @example
2217 -chardev stdio,mux=on,id=char0 \
2218 -mon chardev=char0,mode=readline,default \
2219 -serial chardev:char0 \
2220 -serial chardev:char0
2221 @end example
2223 You can have more than one multiplexer in a system configuration; for instance
2224 you could have a TCP port multiplexed between UART 0 and UART 1, and stdio
2225 multiplexed between the QEMU monitor and a parallel port:
2227 @example
2228 -chardev stdio,mux=on,id=char0 \
2229 -mon chardev=char0,mode=readline,default \
2230 -parallel chardev:char0 \
2231 -chardev tcp,...,mux=on,id=char1 \
2232 -serial chardev:char1 \
2233 -serial chardev:char1
2234 @end example
2236 When you're using a multiplexed character device, some escape sequences are
2237 interpreted in the input. @xref{mux_keys, Keys in the character backend
2238 multiplexer}.
2240 Note that some other command line options may implicitly create multiplexed
2241 character backends; for instance @option{-serial mon:stdio} creates a
2242 multiplexed stdio backend connected to the serial port and the QEMU monitor,
2243 and @option{-nographic} also multiplexes the console and the monitor to
2244 stdio.
2246 There is currently no support for multiplexing in the other direction
2247 (where a single QEMU front end takes input and output from multiple chardevs).
2249 Every backend supports the @option{logfile} option, which supplies the path
2250 to a file to record all data transmitted via the backend. The @option{logappend}
2251 option controls whether the log file will be truncated or appended to when
2252 opened.
2254 Further options to each backend are described below.
2256 @item -chardev null ,id=@var{id}
2257 A void device. This device will not emit any data, and will drop any data it
2258 receives. The null backend does not take any options.
2260 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] [,tls-creds=@var{id}]
2262 Create a two-way stream socket, which can be either a TCP or a unix socket. A
2263 unix socket will be created if @option{path} is specified. Behaviour is
2264 undefined if TCP options are specified for a unix socket.
2266 @option{server} specifies that the socket shall be a listening socket.
2268 @option{nowait} specifies that QEMU should not block waiting for a client to
2269 connect to a listening socket.
2271 @option{telnet} specifies that traffic on the socket should interpret telnet
2272 escape sequences.
2274 @option{reconnect} sets the timeout for reconnecting on non-server sockets when
2275 the remote end goes away. qemu will delay this many seconds and then attempt
2276 to reconnect. Zero disables reconnecting, and is the default.
2278 @option{tls-creds} requests enablement of the TLS protocol for encryption,
2279 and specifies the id of the TLS credentials to use for the handshake. The
2280 credentials must be previously created with the @option{-object tls-creds}
2281 argument.
2283 TCP and unix socket options are given below:
2285 @table @option
2287 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
2289 @option{host} for a listening socket specifies the local address to be bound.
2290 For a connecting socket species the remote host to connect to. @option{host} is
2291 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
2293 @option{port} for a listening socket specifies the local port to be bound. For a
2294 connecting socket specifies the port on the remote host to connect to.
2295 @option{port} can be given as either a port number or a service name.
2296 @option{port} is required.
2298 @option{to} is only relevant to listening sockets. If it is specified, and
2299 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
2300 to and including @option{to} until it succeeds. @option{to} must be specified
2301 as a port number.
2303 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2304 If neither is specified the socket may use either protocol.
2306 @option{nodelay} disables the Nagle algorithm.
2308 @item unix options: path=@var{path}
2310 @option{path} specifies the local path of the unix socket. @option{path} is
2311 required.
2313 @end table
2315 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
2317 Sends all traffic from the guest to a remote host over UDP.
2319 @option{host} specifies the remote host to connect to. If not specified it
2320 defaults to @code{localhost}.
2322 @option{port} specifies the port on the remote host to connect to. @option{port}
2323 is required.
2325 @option{localaddr} specifies the local address to bind to. If not specified it
2326 defaults to @code{0.0.0.0}.
2328 @option{localport} specifies the local port to bind to. If not specified any
2329 available local port will be used.
2331 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2332 If neither is specified the device may use either protocol.
2334 @item -chardev msmouse ,id=@var{id}
2336 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
2337 take any options.
2339 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
2341 Connect to a QEMU text console. @option{vc} may optionally be given a specific
2342 size.
2344 @option{width} and @option{height} specify the width and height respectively of
2345 the console, in pixels.
2347 @option{cols} and @option{rows} specify that the console be sized to fit a text
2348 console with the given dimensions.
2350 @item -chardev ringbuf ,id=@var{id} [,size=@var{size}]
2352 Create a ring buffer with fixed size @option{size}.
2353 @var{size} must be a power of two, and defaults to @code{64K}).
2355 @item -chardev file ,id=@var{id} ,path=@var{path}
2357 Log all traffic received from the guest to a file.
2359 @option{path} specifies the path of the file to be opened. This file will be
2360 created if it does not already exist, and overwritten if it does. @option{path}
2361 is required.
2363 @item -chardev pipe ,id=@var{id} ,path=@var{path}
2365 Create a two-way connection to the guest. The behaviour differs slightly between
2366 Windows hosts and other hosts:
2368 On Windows, a single duplex pipe will be created at
2371 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
2372 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
2373 received by the guest. Data written by the guest can be read from
2374 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
2375 be present.
2377 @option{path} forms part of the pipe path as described above. @option{path} is
2378 required.
2380 @item -chardev console ,id=@var{id}
2382 Send traffic from the guest to QEMU's standard output. @option{console} does not
2383 take any options.
2385 @option{console} is only available on Windows hosts.
2387 @item -chardev serial ,id=@var{id} ,path=@option{path}
2389 Send traffic from the guest to a serial device on the host.
2391 On Unix hosts serial will actually accept any tty device,
2392 not only serial lines.
2394 @option{path} specifies the name of the serial device to open.
2396 @item -chardev pty ,id=@var{id}
2398 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
2399 not take any options.
2401 @option{pty} is not available on Windows hosts.
2403 @item -chardev stdio ,id=@var{id} [,signal=on|off]
2404 Connect to standard input and standard output of the QEMU process.
2406 @option{signal} controls if signals are enabled on the terminal, that includes
2407 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
2408 default, use @option{signal=off} to disable it.
2410 @option{stdio} is not available on Windows hosts.
2412 @item -chardev braille ,id=@var{id}
2414 Connect to a local BrlAPI server. @option{braille} does not take any options.
2416 @item -chardev tty ,id=@var{id} ,path=@var{path}
2418 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
2419 DragonFlyBSD hosts. It is an alias for @option{serial}.
2421 @option{path} specifies the path to the tty. @option{path} is required.
2423 @item -chardev parallel ,id=@var{id} ,path=@var{path}
2424 @itemx -chardev parport ,id=@var{id} ,path=@var{path}
2426 @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
2428 Connect to a local parallel port.
2430 @option{path} specifies the path to the parallel port device. @option{path} is
2431 required.
2433 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2435 @option{spicevmc} is only available when spice support is built in.
2437 @option{debug} debug level for spicevmc
2439 @option{name} name of spice channel to connect to
2441 Connect to a spice virtual machine channel, such as vdiport.
2443 @item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2445 @option{spiceport} is only available when spice support is built in.
2447 @option{debug} debug level for spicevmc
2449 @option{name} name of spice port to connect to
2451 Connect to a spice port, allowing a Spice client to handle the traffic
2452 identified by a name (preferably a fqdn).
2453 ETEXI
2455 STEXI
2456 @end table
2457 ETEXI
2458 DEFHEADING()
2460 DEFHEADING(Device URL Syntax:)
2461 STEXI
2463 In addition to using normal file images for the emulated storage devices,
2464 QEMU can also use networked resources such as iSCSI devices. These are
2465 specified using a special URL syntax.
2467 @table @option
2468 @item iSCSI
2469 iSCSI support allows QEMU to access iSCSI resources directly and use as
2470 images for the guest storage. Both disk and cdrom images are supported.
2472 Syntax for specifying iSCSI LUNs is
2473 ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
2475 By default qemu will use the iSCSI initiator-name
2476 'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
2477 line or a configuration file.
2479 Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect
2480 stalled requests and force a reestablishment of the session. The timeout
2481 is specified in seconds. The default is 0 which means no timeout. Libiscsi
2482 1.15.0 or greater is required for this feature.
2484 Example (without authentication):
2485 @example
2486 qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
2487 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
2488 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2489 @end example
2491 Example (CHAP username/password via URL):
2492 @example
2493 qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
2494 @end example
2496 Example (CHAP username/password via environment variables):
2497 @example
2500 qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2501 @end example
2503 iSCSI support is an optional feature of QEMU and only available when
2504 compiled and linked against libiscsi.
2505 ETEXI
2512 STEXI
2514 iSCSI parameters such as username and password can also be specified via
2515 a configuration file. See qemu-doc for more information and examples.
2517 @item NBD
2518 QEMU supports NBD (Network Block Devices) both using TCP protocol as well
2519 as Unix Domain Sockets.
2521 Syntax for specifying a NBD device using TCP
2522 ``nbd:<server-ip>:<port>[:exportname=<export>]''
2524 Syntax for specifying a NBD device using Unix Domain Sockets
2525 ``nbd:unix:<domain-socket>[:exportname=<export>]''
2528 Example for TCP
2529 @example
2530 qemu-system-i386 --drive file=nbd:192.0.2.1:30000
2531 @end example
2533 Example for Unix Domain Sockets
2534 @example
2535 qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
2536 @end example
2538 @item SSH
2539 QEMU supports SSH (Secure Shell) access to remote disks.
2541 Examples:
2542 @example
2543 qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img
2544 qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
2545 @end example
2547 Currently authentication must be done using ssh-agent. Other
2548 authentication methods may be supported in future.
2550 @item Sheepdog
2551 Sheepdog is a distributed storage system for QEMU.
2552 QEMU supports using either local sheepdog devices or remote networked
2553 devices.
2555 Syntax for specifying a sheepdog device
2556 @example
2557 sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
2558 @end example
2560 Example
2561 @example
2562 qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
2563 @end example
2565 See also @url{http://http://www.osrg.net/sheepdog/}.
2567 @item GlusterFS
2568 GlusterFS is an user space distributed file system.
2569 QEMU supports the use of GlusterFS volumes for hosting VM disk images using
2570 TCP, Unix Domain Sockets and RDMA transport protocols.
2572 Syntax for specifying a VM disk image on GlusterFS volume is
2573 @example
2574 gluster[+transport]://[server[:port]]/volname/image[?socket=...]
2575 @end example
2578 Example
2579 @example
2580 qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img
2581 @end example
2583 See also @url{http://www.gluster.org}.
2585 @item HTTP/HTTPS/FTP/FTPS/TFTP
2586 QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp.
2588 Syntax using a single filename:
2589 @example
2590 <protocol>://[<username>[:<password>]@@]<host>/<path>
2591 @end example
2593 where:
2594 @table @option
2595 @item protocol
2596 'http', 'https', 'ftp', 'ftps', or 'tftp'.
2598 @item username
2599 Optional username for authentication to the remote server.
2601 @item password
2602 Optional password for authentication to the remote server.
2604 @item host
2605 Address of the remote server.
2607 @item path
2608 Path on the remote server, including any query string.
2609 @end table
2611 The following options are also supported:
2612 @table @option
2613 @item url
2614 The full URL when passing options to the driver explicitly.
2616 @item readahead
2617 The amount of data to read ahead with each range request to the remote server.
2618 This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it
2619 does not have a suffix, it will be assumed to be in bytes. The value must be a
2620 multiple of 512 bytes. It defaults to 256k.
2622 @item sslverify
2623 Whether to verify the remote server's certificate when connecting over SSL. It
2624 can have the value 'on' or 'off'. It defaults to 'on'.
2626 @item cookie
2627 Send this cookie (it can also be a list of cookies separated by ';') with
2628 each outgoing request. Only supported when using protocols such as HTTP
2629 which support cookies, otherwise ignored.
2631 @item timeout
2632 Set the timeout in seconds of the CURL connection. This timeout is the time
2633 that CURL waits for a response from the remote server to get the size of the
2634 image to be downloaded. If not set, the default timeout of 5 seconds is used.
2635 @end table
2637 Note that when passing options to qemu explicitly, @option{driver} is the value
2638 of <protocol>.
2640 Example: boot from a remote Fedora 20 live ISO image
2641 @example
2642 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
2644 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
2645 @end example
2647 Example: boot from a remote Fedora 20 cloud image using a local overlay for
2648 writes, copy-on-read, and a readahead of 64k
2649 @example
2650 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
2653 @end example
2658 @example
2659 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
2662 @end example
2663 ETEXI
2665 STEXI
2666 @end table
2667 ETEXI
2670 STEXI
2671 @table @option
2672 ETEXI
2684 QEMU_ARCH_ALL)
2685 STEXI
2687 @findex -bt
2690 example when emulating a machine with only one HCI built into it, only
2692 logic. The Transport Layer is decided by the machine type. Currently
2693 the machines @code{n800} and @code{n810} have one HCI and all other
2694 machines have none.
2696 @anchor{bt-hcis}
2697 The following three types are recognized:
2699 @table @option
2700 @item -bt hci,null
2701 (default) The corresponding Bluetooth HCI assumes no internal logic
2702 and will not respond to any HCI commands or emit events.
2704 @item -bt hci,host[:@var{id}]
2705 (@code{bluez} only) The corresponding HCI passes commands / events
2706 to / from the physical HCI identified by the name @var{id} (default:
2707 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
2708 capable systems like Linux.
2710 @item -bt hci[,vlan=@var{n}]
2711 Add a virtual, standard HCI that will participate in the Bluetooth
2712 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
2713 VLANs, devices inside a bluetooth network @var{n} can only communicate
2714 with other devices in the same network (scatternet).
2715 @end table
2717 @item -bt vhci[,vlan=@var{n}]
2718 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
2719 to the host bluetooth stack instead of to the emulated target. This
2720 allows the host and target machines to participate in a common scatternet
2721 and communicate. Requires the Linux @code{vhci} driver installed. Can
2722 be used as following:
2724 @example
2725 qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
2726 @end example
2728 @item -bt device:@var{dev}[,vlan=@var{n}]
2729 Emulate a bluetooth device @var{dev} and place it in network @var{n}
2730 (default @code{0}). QEMU can only emulate one type of bluetooth devices
2731 currently:
2733 @table @option
2734 @item keyboard
2735 Virtual wireless keyboard implementing the HIDP bluetooth profile.
2736 @end table
2737 ETEXI
2739 STEXI
2740 @end table
2741 ETEXI
2742 DEFHEADING()
2744 #ifdef CONFIG_TPM
2745 DEFHEADING(TPM device options:)
2747 DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
2752 QEMU_ARCH_ALL)
2753 STEXI
2755 The general form of a TPM device option is:
2756 @table @option
2758 @item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
2759 @findex -tpmdev
2760 Backend type must be:
2761 @option{passthrough}.
2763 The specific backend type will determine the applicable options.
2764 The @code{-tpmdev} option creates the TPM backend and requires a
2765 @code{-device} option that specifies the TPM frontend interface model.
2767 Options to each backend are described below.
2769 Use 'help' to print all available TPM backend types.
2770 @example
2771 qemu -tpmdev help
2772 @end example
2774 @item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
2776 (Linux-host only) Enable access to the host's TPM using the passthrough
2777 driver.
2779 @option{path} specifies the path to the host's TPM device, i.e., on
2780 a Linux host this would be @code{/dev/tpm0}.
2781 @option{path} is optional and by default @code{/dev/tpm0} is used.
2783 @option{cancel-path} specifies the path to the host TPM device's sysfs
2784 entry allowing for cancellation of an ongoing TPM command.
2785 @option{cancel-path} is optional and by default QEMU will search for the
2786 sysfs entry to use.
2788 Some notes about using the host's TPM with the passthrough driver:
2790 The TPM device accessed by the passthrough driver must not be
2791 used by any other application on the host.
2793 Since the host's firmware (BIOS/UEFI) has already initialized the TPM,
2794 the VM's firmware (BIOS/UEFI) will not be able to initialize the
2795 TPM again and may therefore not show a TPM-specific menu that would
2796 otherwise allow the user to configure the TPM, e.g., allow the user to
2797 enable/disable or activate/deactivate the TPM.
2798 Further, if TPM ownership is released from within a VM then the host's TPM
2799 will get disabled and deactivated. To enable and activate the
2800 TPM again afterwards, the host has to be rebooted and the user is
2801 required to enter the firmware's menu to enable and activate the TPM.
2802 If the TPM is left disabled and/or deactivated most TPM commands will fail.
2804 To create a passthrough TPM use the following two options:
2805 @example
2806 -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
2807 @end example
2808 Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
2809 @code{tpmdev=tpm0} in the device option.
2811 @end table
2813 ETEXI
2815 DEFHEADING()
2817 #endif
2819 DEFHEADING(Linux/Multiboot boot specific:)
2820 STEXI
2822 When using these options, you can use a given Linux or Multiboot
2823 kernel without installing it in the disk image. It can be useful
2824 for easier testing of various kernels.
2826 @table @option
2827 ETEXI
2831 STEXI
2832 @item -kernel @var{bzImage}
2833 @findex -kernel
2834 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2835 or in multiboot format.
2836 ETEXI
2840 STEXI
2841 @item -append @var{cmdline}
2842 @findex -append
2843 Use @var{cmdline} as kernel command line
2844 ETEXI
2848 STEXI
2849 @item -initrd @var{file}
2850 @findex -initrd
2851 Use @var{file} as initial ram disk.
2855 This syntax is only available with multiboot.
2857 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2858 first module.
2859 ETEXI
2863 STEXI
2864 @item -dtb @var{file}
2865 @findex -dtb
2866 Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
2867 on boot.
2868 ETEXI
2870 STEXI
2871 @end table
2872 ETEXI
2873 DEFHEADING()
2875 DEFHEADING(Debug/Expert options:)
2876 STEXI
2877 @table @option
2878 ETEXI
2885 QEMU_ARCH_ALL)
2886 STEXI
2888 @item -fw_cfg [name=]@var{name},file=@var{file}
2889 @findex -fw_cfg
2890 Add named fw_cfg entry with contents from file @var{file}.
2892 @item -fw_cfg [name=]@var{name},string=@var{str}
2893 Add named fw_cfg entry with contents from string @var{str}.
2895 The terminating NUL character of the contents of @var{str} will not be
2896 included as part of the fw_cfg item data. To insert contents with
2897 embedded NUL characters, you have to use the @var{file} parameter.
2899 The fw_cfg entries are passed by QEMU through to the guest.
2901 Example:
2902 @example
2903 -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin
2904 @end example
2905 creates an fw_cfg entry named opt/com.mycompany/blob with contents
2906 from ./my_blob.bin.
2908 ETEXI
2912 QEMU_ARCH_ALL)
2913 STEXI
2914 @item -serial @var{dev}
2915 @findex -serial
2916 Redirect the virtual serial port to host character device
2917 @var{dev}. The default device is @code{vc} in graphical mode and
2918 @code{stdio} in non graphical mode.
2920 This option can be used several times to simulate up to 4 serial
2921 ports.
2923 Use @code{-serial none} to disable all serial ports.
2925 Available character devices are:
2926 @table @option
2927 @item vc[:@var{W}x@var{H}]
2928 Virtual console. Optionally, a width and height can be given in pixel with
2929 @example
2930 vc:800x600
2931 @end example
2932 It is also possible to specify width or height in characters:
2933 @example
2934 vc:80Cx24C
2935 @end example
2936 @item pty
2937 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
2938 @item none
2939 No device is allocated.
2940 @item null
2941 void device
2942 @item chardev:@var{id}
2943 Use a named character device defined with the @code{-chardev} option.
2944 @item /dev/XXX
2945 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2946 parameters are set according to the emulated ones.
2947 @item /dev/parport@var{N}
2948 [Linux only, parallel port only] Use host parallel port
2949 @var{N}. Currently SPP and EPP parallel port features can be used.
2950 @item file:@var{filename}
2951 Write output to @var{filename}. No character can be read.
2952 @item stdio
2953 [Unix only] standard input/output
2954 @item pipe:@var{filename}
2955 name pipe @var{filename}
2956 @item COM@var{n}
2957 [Windows only] Use host serial port @var{n}
2958 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2959 This implements UDP Net Console.
2960 When @var{remote_host} or @var{src_ip} are not specified
2961 they default to @code{0.0.0.0}.
2962 When not using a specified @var{src_port} a random port is automatically chosen.
2964 If you just want a simple readonly console you can use @code{netcat} or
2965 @code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
2966 @code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
2967 will appear in the netconsole session.
2969 If you plan to send characters back via netconsole or you want to stop
2970 and start QEMU a lot of times, you should have QEMU use the same
2971 source port each time by using something like @code{-serial
2972 udp::4555@@:4556} to QEMU. Another approach is to use a patched
2973 version of netcat which can listen to a TCP port and send and receive
2974 characters via udp. If you have a patched version of netcat which
2975 activates telnet remote echo and single char transfer, then you can
2976 use the following options to step up a netcat redirector to allow
2977 telnet on port 5555 to access the QEMU port.
2978 @table @code
2979 @item QEMU Options:
2980 -serial udp::4555@@:4556
2981 @item netcat options:
2982 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2983 @item telnet options:
2984 localhost 5555
2985 @end table
2987 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}]
2988 The TCP Net Console has two modes of operation. It can send the serial
2989 I/O to a location or wait for a connection from a location. By default
2990 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
2991 the @var{server} option QEMU will wait for a client socket application
2992 to connect to the port before continuing, unless the @code{nowait}
2993 option was specified. The @code{nodelay} option disables the Nagle buffering
2994 algorithm. The @code{reconnect} option only applies if @var{noserver} is
2995 set, if the connection goes down it will attempt to reconnect at the
2996 given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only
2997 one TCP connection at a time is accepted. You can use @code{telnet} to
2998 connect to the corresponding character device.
2999 @table @code
3000 @item Example to send tcp console to 192.168.0.2 port 4444
3001 -serial tcp:192.168.0.2:4444
3002 @item Example to listen and wait on port 4444 for connection
3003 -serial tcp::4444,server
3004 @item Example to not wait and listen on ip 192.168.0.100 port 4444
3005 -serial tcp:192.168.0.100:4444,server,nowait
3006 @end table
3008 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
3009 The telnet protocol is used instead of raw tcp sockets. The options
3010 work the same as if you had specified @code{-serial tcp}. The
3011 difference is that the port acts like a telnet server or client using
3012 telnet option negotiation. This will also allow you to send the
3013 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
3014 sequence. Typically in unix telnet you do it with Control-] and then
3017 @item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}]
3018 A unix domain socket is used instead of a tcp socket. The option works the
3019 same as if you had specified @code{-serial tcp} except the unix domain socket
3020 @var{path} is used for connections.
3022 @item mon:@var{dev_string}
3023 This is a special option to allow the monitor to be multiplexed onto
3024 another serial port. The monitor is accessed with key sequence of
3025 @key{Control-a} and then pressing @key{c}.
3026 @var{dev_string} should be any one of the serial devices specified
3027 above. An example to multiplex the monitor onto a telnet server
3028 listening on port 4444 would be:
3029 @table @code
3030 @item -serial mon:telnet::4444,server,nowait
3031 @end table
3032 When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate
3033 QEMU any more but will be passed to the guest instead.
3035 @item braille
3036 Braille device. This will use BrlAPI to display the braille output on a real
3037 or fake device.
3039 @item msmouse
3040 Three button serial mouse. Configure the guest to use Microsoft protocol.
3041 @end table
3042 ETEXI
3046 QEMU_ARCH_ALL)
3047 STEXI
3048 @item -parallel @var{dev}
3049 @findex -parallel
3050 Redirect the virtual parallel port to host device @var{dev} (same
3051 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
3052 be used to use hardware devices connected on the corresponding host
3053 parallel port.
3055 This option can be used several times to simulate up to 3 parallel
3056 ports.
3058 Use @code{-parallel none} to disable all parallel ports.
3059 ETEXI
3063 QEMU_ARCH_ALL)
3064 STEXI
3065 @item -monitor @var{dev}
3066 @findex -monitor
3067 Redirect the monitor to host device @var{dev} (same devices as the
3068 serial port).
3069 The default device is @code{vc} in graphical mode and @code{stdio} in
3070 non graphical mode.
3071 Use @code{-monitor none} to disable the default monitor.
3072 ETEXI
3075 QEMU_ARCH_ALL)
3076 STEXI
3077 @item -qmp @var{dev}
3078 @findex -qmp
3079 Like -monitor but opens in 'control' mode.
3080 ETEXI
3083 QEMU_ARCH_ALL)
3084 STEXI
3085 @item -qmp-pretty @var{dev}
3086 @findex -qmp-pretty
3087 Like -qmp but uses pretty JSON formatting.
3088 ETEXI
3092 STEXI
3093 @item -mon [chardev=]name[,mode=readline|control][,default]
3094 @findex -mon
3095 Setup monitor on chardev @var{name}.
3096 ETEXI
3100 QEMU_ARCH_ALL)
3101 STEXI
3102 @item -debugcon @var{dev}
3103 @findex -debugcon
3104 Redirect the debug console to host device @var{dev} (same devices as the
3105 serial port). The debug console is an I/O port which is typically port
3106 0xe9; writing to that I/O port sends output to this device.
3107 The default device is @code{vc} in graphical mode and @code{stdio} in
3108 non graphical mode.
3109 ETEXI
3113 STEXI
3114 @item -pidfile @var{file}
3115 @findex -pidfile
3116 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
3117 from a script.
3118 ETEXI
3122 STEXI
3123 @item -singlestep
3124 @findex -singlestep
3125 Run the emulation in single step mode.
3126 ETEXI
3130 QEMU_ARCH_ALL)
3131 STEXI
3132 @item -S
3133 @findex -S
3134 Do not start CPU at startup (you must type 'c' in the monitor).
3135 ETEXI
3141 QEMU_ARCH_ALL)
3142 STEXI
3143 @item -realtime mlock=on|off
3144 @findex -realtime
3145 Run qemu with realtime features.
3146 mlocking qemu and guest memory can be enabled via @option{mlock=on}
3147 (enabled by default).
3148 ETEXI
3152 STEXI
3153 @item -gdb @var{dev}
3154 @findex -gdb
3155 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
3156 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
3157 stdio are reasonable use case. The latter is allowing to start QEMU from
3158 within gdb and establish the connection via a pipe:
3159 @example
3160 (gdb) target remote | exec qemu-system-i386 -gdb stdio ...
3161 @end example
3162 ETEXI
3166 QEMU_ARCH_ALL)
3167 STEXI
3168 @item -s
3169 @findex -s
3170 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
3171 (@pxref{gdb_usage}).
3172 ETEXI
3176 QEMU_ARCH_ALL)
3177 STEXI
3178 @item -d @var{item1}[,...]
3179 @findex -d
3180 Enable logging of specified items. Use '-d help' for a list of log items.
3181 ETEXI
3185 QEMU_ARCH_ALL)
3186 STEXI
3187 @item -D @var{logfile}
3188 @findex -D
3189 Output log in @var{logfile} instead of to stderr
3190 ETEXI
3193 "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n",
3194 QEMU_ARCH_ALL)
3195 STEXI
3196 @item -dfilter @var{range1}[,...]
3197 @findex -dfilter
3198 Filter debug output to that relevant to a range of target addresses. The filter
3199 spec can be either @var{start}+@var{size}, @var{start}-@var{size} or
3200 @var{start}..@var{end} where @var{start} @var{end} and @var{size} are the
3201 addresses and sizes required. For example:
3202 @example
3203 -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000
3204 @end example
3205 Will dump output for any code in the 0x1000 sized block starting at 0x8000 and
3206 the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized
3207 block starting at 0xffffffc00005f000.
3208 ETEXI
3212 QEMU_ARCH_ALL)
3213 STEXI
3214 @item -L @var{path}
3215 @findex -L
3216 Set the directory for the BIOS, VGA BIOS and keymaps.
3218 To list all the data directories, use @code{-L help}.
3219 ETEXI
3223 STEXI
3224 @item -bios @var{file}
3225 @findex -bios
3226 Set the filename for the BIOS.
3227 ETEXI
3231 STEXI
3232 @item -enable-kvm
3233 @findex -enable-kvm
3234 Enable KVM full virtualization support. This option is only available
3235 if KVM support is enabled when compiling.
3236 ETEXI
3243 QEMU_ARCH_ALL)
3247 QEMU_ARCH_ALL)
3248 STEXI
3249 @item -xen-domid @var{id}
3250 @findex -xen-domid
3251 Specify xen guest domain @var{id} (XEN only).
3252 @item -xen-create
3253 @findex -xen-create
3254 Create domain using xen hypercalls, bypassing xend.
3255 Warning: should not be used when xend is in use (XEN only).
3256 @item -xen-attach
3257 @findex -xen-attach
3258 Attach to existing xen domain.
3259 xend will use this when starting QEMU (XEN only).
3260 ETEXI
3264 STEXI
3265 @item -no-reboot
3266 @findex -no-reboot
3267 Exit instead of rebooting.
3268 ETEXI
3272 STEXI
3273 @item -no-shutdown
3274 @findex -no-shutdown
3275 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
3276 This allows for instance switching to monitor to commit changes to the
3277 disk image.
3278 ETEXI
3283 QEMU_ARCH_ALL)
3284 STEXI
3285 @item -loadvm @var{file}
3286 @findex -loadvm
3287 Start right away with a saved state (@code{loadvm} in monitor)
3288 ETEXI
3290 #ifndef _WIN32
3293 #endif
3294 STEXI
3295 @item -daemonize
3296 @findex -daemonize
3297 Daemonize the QEMU process after initialization. QEMU will not detach from
3298 standard IO until it is ready to receive connections on any of its devices.
3299 This option is a useful way for external programs to launch QEMU without having
3300 to cope with initialization race conditions.
3301 ETEXI
3305 QEMU_ARCH_ALL)
3306 STEXI
3307 @item -option-rom @var{file}
3308 @findex -option-rom
3309 Load the contents of @var{file} as an option ROM.
3310 This option is useful to load things like EtherBoot.
3311 ETEXI
3313 HXCOMM Silently ignored for compatibility
3316 HXCOMM Options deprecated by -rtc
3323 QEMU_ARCH_ALL)
3325 STEXI
3327 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
3328 @findex -rtc
3329 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
3330 UTC or local time, respectively. @code{localtime} is required for correct date in
3331 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
3332 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
3334 By default the RTC is driven by the host system time. This allows using of the
3335 RTC as accurate reference clock inside the guest, specifically if the host
3336 time is smoothly following an accurate external reference clock, e.g. via NTP.
3337 If you want to isolate the guest time from the host, you can set @option{clock}
3338 to @code{rt} instead. To even prevent it from progressing during suspension,
3339 you can set it to @code{vm}.
3341 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
3342 specifically with Windows' ACPI HAL. This option will try to figure out how
3343 many timer interrupts were not processed by the Windows guest and will
3344 re-inject them.
3345 ETEXI
3352 STEXI
3353 @item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename}]
3354 @findex -icount
3355 Enable virtual instruction counter. The virtual cpu will execute one
3356 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
3357 then the virtual cpu speed will be automatically adjusted to keep virtual
3358 time within a few seconds of real time.
3360 When the virtual cpu is sleeping, the virtual time will advance at default
3361 speed unless @option{sleep=on|off} is specified.
3362 With @option{sleep=on|off}, the virtual time will jump to the next timer deadline
3363 instantly whenever the virtual cpu goes to sleep mode and will not advance
3364 if no timer is enabled. This behavior give deterministic execution times from
3365 the guest point of view.
3367 Note that while this option can give deterministic behavior, it does not
3368 provide cycle accurate emulation. Modern CPUs contain superscalar out of
3369 order cores with complex cache hierarchies. The number of instructions
3370 executed often has little or no correlation with actual performance.
3372 @option{align=on} will activate the delay algorithm which will try
3373 to synchronise the host clock and the virtual clock. The goal is to
3374 have a guest running at the real frequency imposed by the shift option.
3375 Whenever the guest clock is behind the host clock and if
3376 @option{align=on} is specified then we print a message to the user
3377 to inform about the delay.
3378 Currently this option does not work when @option{shift} is @code{auto}.
3379 Note: The sync algorithm will work for those shift values for which
3380 the guest clock runs ahead of the host clock. Typically this happens
3381 when the shift value is high (how high depends on the host machine).
3383 When @option{rr} option is specified deterministic record/replay is enabled.
3384 Replay log is written into @var{filename} file in record mode and
3385 read from this file in replay mode.
3386 ETEXI
3391 QEMU_ARCH_ALL)
3392 STEXI
3393 @item -watchdog @var{model}
3394 @findex -watchdog
3395 Create a virtual hardware watchdog device. Once enabled (by a guest
3396 action), the watchdog must be periodically polled by an agent inside
3397 the guest or else the guest will be restarted. Choose a model for
3398 which your guest has drivers.
3400 The @var{model} is the model of hardware watchdog to emulate. Use
3401 @code{-watchdog help} to list available hardware models. Only one
3402 watchdog can be enabled for a guest.
3404 The following models may be available:
3405 @table @option
3406 @item ib700
3407 iBASE 700 is a very simple ISA watchdog with a single timer.
3408 @item i6300esb
3409 Intel 6300ESB I/O controller hub is a much more featureful PCI-based
3410 dual-timer watchdog.
3411 @item diag288
3412 A virtual watchdog for s390x backed by the diagnose 288 hypercall
3413 (currently KVM only).
3414 @end table
3415 ETEXI
3420 QEMU_ARCH_ALL)
3421 STEXI
3422 @item -watchdog-action @var{action}
3423 @findex -watchdog-action
3425 The @var{action} controls what QEMU will do when the watchdog timer
3426 expires.
3427 The default is
3428 @code{reset} (forcefully reset the guest).
3429 Other possible actions are:
3430 @code{shutdown} (attempt to gracefully shutdown the guest),
3431 @code{poweroff} (forcefully poweroff the guest),
3432 @code{pause} (pause the guest),
3433 @code{debug} (print a debug message and continue), or
3434 @code{none} (do nothing).
3436 Note that the @code{shutdown} action requires that the guest responds
3437 to ACPI signals, which it may not be able to do in the sort of
3438 situations where the watchdog would have expired, and thus
3439 @code{-watchdog-action shutdown} is not recommended for production use.
3441 Examples:
3443 @table @code
3444 @item -watchdog i6300esb -watchdog-action pause
3445 @itemx -watchdog ib700
3446 @end table
3447 ETEXI
3451 QEMU_ARCH_ALL)
3452 STEXI
3454 @item -echr @var{numeric_ascii_value}
3455 @findex -echr
3456 Change the escape character used for switching to the monitor when using
3457 monitor and serial sharing. The default is @code{0x01} when using the
3458 @code{-nographic} option. @code{0x01} is equal to pressing
3459 @code{Control-a}. You can select a different character from the ascii
3460 control keys where 1 through 26 map to Control-a through Control-z. For
3461 instance you could use the either of the following to change the escape
3462 character to Control-t.
3463 @table @code
3464 @item -echr 0x14
3465 @itemx -echr 20
3466 @end table
3467 ETEXI
3472 STEXI
3473 @item -virtioconsole @var{c}
3474 @findex -virtioconsole
3475 Set virtio console.
3477 This option is maintained for backward compatibility.
3479 Please use @code{-device virtconsole} for the new way of invocation.
3480 ETEXI
3484 STEXI
3485 @item -show-cursor
3486 @findex -show-cursor
3487 Show cursor.
3488 ETEXI
3492 STEXI
3493 @item -tb-size @var{n}
3494 @findex -tb-size
3495 Set TB size.
3496 ETEXI
3510 QEMU_ARCH_ALL)
3511 STEXI
3512 @item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]
3513 @itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6]
3514 @findex -incoming
3515 Prepare for incoming migration, listen on a given tcp port.
3517 @item -incoming unix:@var{socketpath}
3518 Prepare for incoming migration, listen on a given unix socket.
3520 @item -incoming fd:@var{fd}
3521 Accept incoming migration from a given filedescriptor.
3523 @item -incoming exec:@var{cmdline}
3524 Accept incoming migration as an output from specified external command.
3526 @item -incoming defer
3527 Wait for the URI to be specified via migrate_incoming. The monitor can
3528 be used to change settings (such as migration parameters) prior to issuing
3529 the migrate_incoming to allow the migration to begin.
3530 ETEXI
3534 STEXI
3535 @item -nodefaults
3536 @findex -nodefaults
3541 ETEXI
3543 #ifndef _WIN32
3546 QEMU_ARCH_ALL)
3547 #endif
3548 STEXI
3550 @findex -chroot
3551 Immediately before starting guest execution, chroot to the specified
3553 ETEXI
3555 #ifndef _WIN32
3558 QEMU_ARCH_ALL)
3559 #endif
3560 STEXI
3562 @findex -runas
3564 to the specified user.
3565 ETEXI
3570 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
3571 STEXI
3575 ETEXI
3578 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
3579 QEMU_ARCH_MIPS)
3580 STEXI
3581 @item -semihosting
3582 @findex -semihosting
3584 ETEXI
3588 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 |
3589 QEMU_ARCH_MIPS)
3590 STEXI
3594 @table @option
3600 Allows the user to pass input arguments, and can be used multiple times to build
3605 @end table
3606 ETEXI
3609 STEXI
3613 ETEXI
3617 QEMU_ARCH_ALL)
3618 STEXI
3620 @findex -sandbox
3623 ETEXI
3627 STEXI
3629 @findex -readconfig
3631 QEMU process with many command line options but you don't want to exceed the command line
3632 character limit.
3633 ETEXI
3634 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
3637 STEXI
3638 @item -writeconfig @var{file}
3639 @findex -writeconfig
3640 Write device configuration to @var{file}. The @var{file} can be either filename to save
3641 command line and device configuration into file or dash @code{-}) character to print the
3642 output to stdout. This can be later used as input file for @code{-readconfig} option.
3643 ETEXI
3644 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
3647 QEMU_ARCH_ALL)
3648 STEXI
3649 @item -nodefconfig
3650 @findex -nodefconfig
3651 Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
3652 The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
3653 ETEXI
3654 DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
3657 QEMU_ARCH_ALL)
3658 STEXI
3659 @item -no-user-config
3660 @findex -no-user-config
3661 The @code{-no-user-config} option makes QEMU not load any of the user-provided
3664 ETEXI
3668 QEMU_ARCH_ALL)
3669 STEXI
3671 HXCOMM HX does not support conditional compilation of text.
3675 Specify tracing options.
3677 @table @option
3697 This option is only available if QEMU has been compiled with
3699 @end table
3700 ETEXI
3702 HXCOMM Internal use
3706 #ifdef __linux__
3709 QEMU_ARCH_ALL)
3710 #endif
3711 STEXI
3715 ETEXI
3720 HXCOMM Deprecated by kvm-pit driver properties
3737 QEMU_ARCH_ALL)
3738 STEXI
3740 @findex -msg
3742 ETEXI
3750 QEMU_ARCH_ALL)
3751 STEXI
3756 ETEXI
3766 QEMU_ARCH_ALL)
3767 STEXI
3769 @findex -object
3775 @table @option
3777 @item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off}
3779 Creates a memory file backend object, which can be used to back
3781 unique ID that will be used to reference this memory region
3783 option provides the size of the memory region, and accepts
3785 the path to either a shared memory or huge page filesystem mount.
3792 Creates a random number generator backend which obtains entropy from
3800 Creates a random number generator backend which obtains entropy from
3802 a unique ID that will be used to reference this entropy backend from
3804 the unique ID of a character device backend that provides the connection
3805 to the RNG daemon.
3807 @item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off}
3809 Creates a TLS anonymous credentials object, which can be used to provide
3811 ID which network backends will use to access the credentials. The
3813 on whether the QEMU network backend that uses the credentials will be
3822 a set of DH parameters at startup. This is a computationally
3823 expensive operation that consumes random pool entropy, so it is
3824 recommended that a persistent set of parameters be generated
3825 upfront and saved.
3827 @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}
3829 Creates a TLS anonymous credentials object, which can be used to provide
3831 ID which network backends will use to access the credentials. The
3833 on whether the QEMU network backend that uses the credentials will be
3837 must be provided with valid client certificates too.
3843 a set of DH parameters at startup. This is a computationally
3844 expensive operation that consumes random pool entropy, so it is
3845 recommended that a persistent set of parameters be generated
3846 upfront and saved.
3848 For x509 certificate credentials the directory will contain further files
3849 providing the x509 certificates. The certificates must be stored
3860 @item -object filter-buffer,id=@var{id},netdev=@var{netdevid},interval=@var{t}[,queue=@var{all|rx|tx}][,status=@var{on|off}]
3863 packets arriving in a given interval on netdev @var{netdevid} are delayed
3864 until the end of the interval. Interval is in microseconds.
3865 @option{status} is optional that indicate whether the netfilter is
3868 queue @var{all|rx|tx} is an option that can be applied to any netfilter.
3870 @option{all}: the filter is attached both to the receive and the transmit
3871 queue of the netdev (default).
3873 @option{rx}: the filter is attached to the receive queue of the netdev,
3874 where it will receive packets sent to the netdev.
3876 @option{tx}: the filter is attached to the transmit queue of the netdev,
3877 where it will receive packets sent by the netdev.
3879 @item -object filter-mirror,id=@var{id},netdev=@var{netdevid},outdev=@var{chardevid}[,queue=@var{all|rx|tx}]
3881 filter-mirror on netdev @var{netdevid},mirror net packet to chardev
3882 @var{chardevid}
3884 @item -object filter-redirector,id=@var{id},netdev=@var{netdevid},indev=@var{chardevid},
3885 outdev=@var{chardevid}[,queue=@var{all|rx|tx}]
3887 filter-redirector on netdev @var{netdevid},redirect filter's net packet to chardev
3889 Create a filter-redirector we need to differ outdev id from indev id, id can not
3890 be the same. we can just use indev or outdev, but at least one of indev or outdev
3891 need to be specified.
3893 @item -object filter-dump,id=@var{id},netdev=@var{dev},file=@var{filename}][,maxlen=@var{len}]
3895 Dump the network traffic on netdev @var{dev} to the file specified by
3896 @var{filename}. At most @var{len} bytes (64k by default) per packet are stored.
3897 The file format is libpcap, so it can be analyzed with tools such as tcpdump
3898 or Wireshark.
3900 @item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
3901 @item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}]
3903 Defines a secret to store a password, encryption key, or some other sensitive
3904 data. The sensitive data can either be passed directly via the @var{data}
3905 parameter, or indirectly via the @var{file} parameter. Using the @var{data}
3906 parameter is insecure unless the sensitive data is encrypted.
3908 The sensitive data can be provided in raw format (the default), or base64.
3909 When encoded as JSON, the raw format only supports valid UTF-8 characters,
3910 so base64 is recommended for sending binary data. QEMU will convert from
3911 which ever format is provided to the format it needs internally. eg, an
3912 RBD password can be provided in raw format, even though it will be base64
3913 encoded when passed onto the RBD sever.
3915 For added protection, it is possible to encrypt the data associated with
3916 a secret using the AES-256-CBC cipher. Use of encryption is indicated
3917 by providing the @var{keyid} and @var{iv} parameters. The @var{keyid}
3918 parameter provides the ID of a previously defined secret that contains
3919 the AES-256 decryption key. This key should be 32-bytes long and be
3920 base64 encoded. The @var{iv} parameter provides the random initialization
3921 vector used for encryption of this particular secret and should be a
3922 base64 encrypted string of the 16-byte IV.
3924 The simplest (insecure) usage is to provide the secret inline
3926 @example
3928 # $QEMU -object secret,id=sec0,data=letmein,format=raw
3930 @end example
3932 The simplest secure usage is to provide the secret via a file
3934 # echo -n "letmein" > mypasswd.txt
3935 # $QEMU -object secret,id=sec0,file=mypasswd.txt,format=raw
3937 For greater security, AES-256-CBC should be used. To illustrate usage,
3938 consider the openssl command line tool which can encrypt the data. Note
3939 that when encrypting, the plaintext must be padded to the cipher block
3940 size (32 bytes) using the standard PKCS#5/6 compatible padding algorithm.
3942 First a master key needs to be created in base64 encoding:
3944 @example
3945 # openssl rand -base64 32 > key.b64
3947 @end example
3949 Each secret to be encrypted needs to have a random initialization vector
3950 generated. These do not need to be kept secret
3952 @example
3953 # openssl rand -base64 16 > iv.b64
3955 @end example
3957 The secret to be defined can now be encrypted, in this case we're
3958 telling openssl to base64 encode the result, but it could be left
3961 @example
3964 @end example
3967 and specify that to be used to decrypt the user password. Pass the
3970 @example
3971 # $QEMU \
3975 @end example
3977 @end table
3979 ETEXI
3983 STEXI
3984 @end table
3985 ETEXI