Lines Matching full:on

32     "                vmport=on|off|auto controls emulation of vmport (default: auto)\n"
33 " dump-guest-core=on|off include guest memory in a core dump (default=on)\n"
34 " mem-merge=on|off controls memory merge support (default: on)\n"
35 " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n"
36 " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n"
37 " suppress-vmdesc=on|off disables self-describing migration (default=off)\n"
38 " nvdimm=on|off controls NVDIMM support (default=off)\n"
40 " hmat=on|off controls ACPI HMAT support (default=off)\n"
42 " aux-ram-share=on|off allocate auxiliary guest RAM as shared (default: off)\n"
67 This is used to enable an accelerator. Depending on the target
73 ``vmport=on|off|auto``
75 to select the value based on accel and i8042. For accel=xen or
76 i8042=off the default is off otherwise the default is on.
78 ``dump-guest-core=on|off``
79 Include guest memory in a core dump. The default is on.
81 ``mem-merge=on|off``
86 ``aes-key-wrap=on|off``
87 Enables or disables AES key wrapping support on s390-ccw hosts.
90 is on.
92 ``dea-key-wrap=on|off``
93 Enables or disables DEA key wrapping support on s390-ccw hosts.
96 is on.
98 ``nvdimm=on|off``
104 ``hmat=on|off``
108 ``aux-ram-share=on|off``
113 specified on the command line, or implicitly created by the -m
116 To use the cpr-transfer migration mode, you must set aux-ram-share=on.
125 -object memory-backend-file,id=pc.ram,size=512M,mem-path=/hugetlbfs,prealloc=on,share=on
150 They are regions of Host Physical Addresses (HPA) on a system which
181 applied on. This field is the combination of cache level and cache
225 …" igd-passthru=on|off (enable Xen integrated Intel graphics passthrough, default=of…
226 … " kernel-irqchip=on|off|split controls accelerated irqchip support (default=on)\n"
228 " one-insn-per-tb=on|off (one guest instruction per TCG translation block)\n"
229 " split-wx=on|off (enable TCG split w^x mapping)\n"
238 This is used to enable an accelerator. Depending on the target
244 ``igd-passthru=on|off``
249 ``kernel-irqchip=on|off|split``
251 acceleration of the interrupt controllers. On x86, split irqchip
259 ``one-insn-per-tb=on|off``
265 ``split-wx=on|off``
268 such a case this will default on. On other operating systems, this
294 enabling dirty-logging on a huge-page requires breaking it into
295 PAGE_SIZE pages in the first place. KVM on ARM does this splitting
303 impact on the memory. By default, this feature is disabled
307 Enables or disables notify VM exit support on x86 host and specify
330 " drawers= number of drawers on the machine board\n"
343 " sockets means the number of sockets on the machine board\n"
353 Simulate a SMP system with '\ ``n``\ ' CPUs initially present on
354 the machine type board. On boards supporting CPU hotplug, the optional
369 which vary depending on capacity of the corresponding CPU targets. So
381 (2 sockets totally on the machine, 2 cores per socket, 2 threads per
391 totally on the machine, 2 dies per socket, 2 modules per die, 2 cores per
401 totally on the machine, 2 clusters per socket, 2 cores per cluster,
456 omitted on all nodes, VCPUs are automatically split between them.
468 CPU. The set of properties is machine specific, and depends on used
504 set only when the machine property 'hmat' is set to 'on'.
513 -machine hmat=on \
560 value are NUM byte per second (or MB/s, GB/s or TB/s depending on
583 -machine hmat=on \
657 device which is not created automatically and set properties on it,
666 "-boot [order=drives][,once=drives][,menu=on|off]\n"
667 " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n"
669 … 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
670 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n"
674 …order=drives][,once=drives][,menu=on|off][,splash=sp_name][,splash-time=sp_time][,reboot-timeout=r…
676 letters depend on the target architecture. The x86 PC uses: a, b
679 To apply a particular boot order only on the first startup, specify
685 Interactive boot menus/prompts can be enabled via ``menu=on`` as far
689 as logo, when option splash=sp\_name is given and menu=on, If
701 Do strict boot via ``strict=on`` as far as firmware/BIOS supports
712 |qemu_system_x86| -boot menu=on,splash=/root/boot.bmp,splash-time=5000
768 (e.g. on Macs, with some X11 servers or with a VNC or curses
769 display). You don't normally need to use it on PC/Linux or
812 ``audiodev`` property is not set on a device or machine. In
916 ``in|out.mixing-engine=on|off``
924 engine only supports mono and stereo audio. Default is on.
926 ``in|out.fixed-settings=on|off``
928 based on how the guest opens the sound card. In this case you
929 must not specify frequency, channels or format. Default is on.
955 Creates backend using the ALSA. This backend is only available on
967 ``in|out.try-poll=on|off``
975 available on Mac OS and only supports playback.
984 only available on Windows and only supports playback.
993 Creates a backend using OSS. This backend is available on most
1005 ``in|out.try-poll=on|off``
1006 Attempt to use poll mode with the device. Default is on.
1008 ``try-mmap=on|off``
1011 ``exclusive=on|off``
1022 Creates a backend using PulseAudio. This backend is available on
1038 Creates a backend using PipeWire. This backend is available on
1053 Creates a backend using SDL. This backend is available on most
1063 Creates a backend using SNDIO. This backend is available on
1093 " add device (based on driver)\n"
1101 properties depend on the driver. To get help on possible drivers and
1108 interface processor that normally sits on a system. It provides a
1113 address is the BMC's address on the I2C network of management
1151 simulator running on a secure port on localhost, so neither the
1155 details on the external interface.
1158 Add a KCS IPMI interface on the ISA bus. This also adds a
1178 Add a KCS IPMI interface on the PCI bus.
1184 Like the KCS interface, but defines a BT interface on the PCI bus.
1190 ``intremap=on|off`` (default: auto)
1197 ``caching-mode=on|off`` (default: off)
1203 the DMA mapping on the host before guest DMA starts.
1205 ``device-iotlb=on|off`` (default: off)
1208 paired with ats=on configured for the device.
1226 ``aw-bits=val`` (val between 32 and 64, default depends on machine)
1232 "-name string1[,process=string2][,debug-threads=on|off]\n"
1243 individual threads can also be enabled on Linux to aid debugging.
1308 Use file as hard disk 0, 1, 2 or 3 image on the default bus of the
1309 emulated machine (this is for example the IDE bus on most x86 machines,
1310 but it can also be SCSI, virtio or something else on other target
1320 Use file as CD-ROM image on the default bus of the emulated machine
1321 (which is IDE1 master on x86, so you cannot use ``-hdc`` and ``-cdrom``
1322 at the same time there). On systems that support it, you can use the
1328 " [,cache.direct=on|off][,cache.no-flush=on|off]\n"
1329 " [,read-only=on|off][,auto-read-only=on|off]\n"
1330 " [,force-share=on|off][,detect-zeroes=on|off|unmap]\n"
1374 If ``auto-read-only=on`` is set, QEMU may fall back to
1376 even switch between modes as needed, e.g. depending on
1389 Enabling ``force-share=on`` requires ``read-only=on``.
1392 The host page cache can be avoided with ``cache.direct=on``.
1398 failures, you can use ``cache.no-flush=on``. This option
1406 discard is one of "ignore" (or "off") or "unmap" (or "on")
1412 detect-zeroes is "off", "on" or "unmap" and enables the
1433 (auto/on/off, default: auto)
1443 usually stacked on top of a protocol level block driver such as
1465 usually stacked on top of a protocol level block driver such as
1479 Whether to enable the lazy refcounts feature (on/off;
1489 cache-size is not specified - 32M on Linux platforms, and 8M
1490 on non-Linux platforms; otherwise, as large as possible
1502 interval is in seconds. The default value is 600 on
1503 supporting platforms, and 0 on other platforms. Setting it
1508 forwarded to the data source (on/off; default: on if
1514 frees clusters in the qcow2 file (on/off; default: on)
1518 issued on other occasions where a cluster gets freed
1519 (on/off; default: off)
1525 on the protocol level (i.e. in the image file) depends on the
1534 images directly on block devices), you should consider enabling
1564 " [,snapshot=on|off][,rerror=ignore|stop|report]\n"
1567 " [,readonly=on|off][,copy-on-read=on|off]\n"
1568 " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n"
1596 This option defines on which type on interface the drive is
1613 snapshot is "on" or "off" and controls snapshot mode for the
1628 writeback on off off
1629 none on on off
1631 directsync off on off
1632 unsafe on off on
1647 Specify which action to take on write and read errors. Valid
1654 ``copy-on-read=copy-on-read``
1655 copy-on-read is "on" or "off" and enables whether to copy read
1690 By default, the ``cache.writeback=on`` mode is used. It will report
1701 this has a major impact on performance.
1705 Copy-on-read avoids accessing the same backing file sectors
1707 network. By default copy-on-read is off.
1769 "-mtdblock file use 'file' as on-board Flash memory image\n",
1773 Use file as on-board Flash memory image.
1797 can use the 'snapshot' property on your drive declarations
1804 " [,writeout=immediate][,readonly=on][,fmode=fmode][,dmode=dmode]\n"
1814 ``-fsdev local,id=id,path=path,security_model=security_model [,writeout=writeout][,readonly=on][,fm…
1816 ``-fsdev synth,id=id[,readonly=on]``
1830 under this path will be available to the 9p client on the guest.
1836 are stored using the same credentials as they are created on the
1854 ``readonly=on``
1859 Specifies the default mode for newly created files on the host.
1864 Specifies the default mode for newly created directories on the
1897 "ccw" or "device", depending on the machine type.
1909 …" [,id=id][,writeout=immediate][,readonly=on][,fmode=fmode][,dmode=dmode][,multidevs=remap|…
1910 "-virtfs synth,mount_tag=tag[,id=id][,readonly=on]\n",
1914 …tag=mount_tag ,security_model=security_model[,writeout=writeout][,readonly=on] [,fmode=fmode][,dmo…
1919 directory on host is made directly accessible by guest as a pass-through
1940 under this path will be available to the 9p client on the guest.
1946 are stored using the same credentials as they are created on the
1964 ``readonly=on``
1969 Specifies the default mode for newly created files on the host.
1974 Specifies the default mode for newly created directories on the
1984 the same 9p export in order to avoid file ID collisions on guest.
1991 collisions on guest. Remapping inodes in such cases is required
1993 exposed on guest. Instead all files of an export shared with
1994 virtfs always share the same device ID on guest. So two files
1996 on host would otherwise cause a file ID collision and hence
1997 potential severe misbehaviours on guest.
2002 logged (once) by qemu on host side. No further action is performed
2003 in this case that would prevent file ID collisions on guest. This
2005 files being accessed and data corruption on the exported tree.
2009 message but also deny access to additional devices on guest. Note
2032 "-usb enable on-board USB host controller (if not enabled by default)\n",
2036 Enable USB emulation on machine types with an on-board USB host
2037 controller (if not enabled by default). Note that on-board USB host
2039 ``-device qemu-xhci`` can be used instead on machines with PCI.
2047 Add the USB device devname, and enable an on-board USB controller
2049 ``-machine usb=on``). Note that this option is mainly intended for
2055 to a USB 3.0 controller instead (at least on machines that support
2063 output on a real or fake device (i.e. it also creates a
2092 "-display spice-app[,gl=on|off]\n"
2095 "-display sdl[,gl=on|core|es|off][,grab-mod=<mod>][,show-cursor=on|off]\n"
2096 " [,window-close=on|off]\n"
2099 "-display gtk[,full-screen=on|off][,gl=on|off][,grab-on-hover=on|off]\n"
2100 " [,show-tabs=on|off][,show-cursor=on|off][,window-close=on|off]\n"
2101 " [,show-menubar=on|off][,zoom-to-fit=on|off]\n"
2110 "-display cocoa[,full-grab=on|off][,swap-opt-cmd=on|off]\n"
2111 " [,show-cursor=on|off][,left-command-key=on|off]\n"
2112 " [,full-screen=on|off][,zoom-to-fit=on|off]\n"
2119 " [,gl=on|core|es|off][,rendernode=<file>]\n"
2141 ``spice-app[,gl=on|off]``
2156 ``gl=on|off|core|es`` : Use OpenGL for rendering (the D-Bus interface
2168 ``gl=on|off|core|es`` : Use OpenGL for displaying
2170 ``show-cursor=on|off`` : Force showing the mouse cursor
2172 ``window-close=on|off`` : Allow to quit qemu with window close button
2179 ``full-screen=on|off`` : Start in fullscreen mode
2181 ``gl=on|off`` : Use OpenGL for displaying
2183 ``grab-on-hover=on|off`` : Grab keyboard input on mouse hover
2185 ``show-tabs=on|off`` : Display the tab bar for switching between the
2189 ``show-cursor=on|off`` : Force showing the mouse cursor
2191 ``window-close=on|off`` : Allow to quit qemu with window close button
2193 ``show-menubar=on|off`` : Display the main window menubar, defaults to "on"
2195 ``zoom-to-fit=on|off`` : Expand video output to the window size,
2214 ``full-grab=on|off`` : Capture all key presses, including system combos.
2216 performs a global grab on key events.
2220 ``swap-opt-cmd=on|off`` : Swap the Option and Command keys so that their
2221 key codes match their position on non-Mac
2225 ``show-cursor=on|off`` : Force showing the mouse cursor
2227 ``left-command-key=on|off`` : Disable forwarding left command key to host
2229 ``full-screen=on|off`` : Start in fullscreen mode
2231 ``zoom-to-fit=on|off`` : Expand video output to the window size,
2240 Start a VNC server on display <display>
2260 The emulated serial port is redirected on the console and muxed with
2263 Use C-a h for help on switching between the console and monitor.
2272 " [,ipv4=on|off][,ipv6=on|off][,unix=on|off]\n"
2276 " [,sasl=on|off][,disable-ticketing=on|off]\n"
2281 " [,streaming-video=[off|all|filter]][,disable-copy-paste=on|off]\n"
2282 " [,disable-agent-file-xfer=on|off][,agent-mouse=[on|off]]\n"
2283 " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n"
2284 " [,gl=[on|off]][,rendernode=<file>]\n"
2294 Set the TCP port spice is listening on for plaintext channels.
2297 Set the IP address spice is listening on. Default is any
2300 ``ipv4=on|off``; \ ``ipv6=on|off``; \ ``unix=on|off``
2307 ``sasl=on|off``
2321 ``disable-ticketing=on|off``
2324 ``disable-copy-paste=on|off``
2327 ``disable-agent-file-xfer=on|off``
2332 Set the TCP port spice is listening on for encrypted channels.
2362 ``agent-mouse=[on|off]``
2363 Enable/disable passing mouse events via vdagent. Default is on.
2365 ``playback-compression=[on|off]``
2367 Default is on.
2369 ``seamless-migration=[on|off]``
2372 ``gl=[on|off]``
2459 monitor in a window. With this option, you can have QEMU listen on
2473 TCP connections will only be allowed from host on display d. By
2480 is the location of a unix socket to listen for connections on.
2489 ``reverse=on|off``
2495 ``websocket=on|off``
2507 to listen for connections on.
2513 ``password=on|off``
2528 password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for
2552 on the fly while the VNC server is active. If missing, it will
2555 ``sasl=on|off``
2569 for details on using SASL authentication.
2574 resolved at time of use, so can be deleted and recreated on the
2578 ``acl=on|off``
2588 ``lossy=on|off``
2591 depending on its encoding settings. Enabling this option can
2594 ``non-adaptive=on|off``
2629 ``power-control=on|off``
2646 ide-device.win2k-install-hack=on``.
2678 " [,uefi=on|off]\n"
2707 ``-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d][,uefi=on|off]``
2734 loads data from a file on disk. Note that the file is not permitted to contain any NUL bytes.
2739 Note that on the x86 architecture, the total size of all SMBIOS tables is limited to 65535
2771 …as ``enoX`` on Linux, with X being the instance number, instead of the name depending on the inter…
2772 position on the PCI bus.
2800 "-netdev user,id=str[,ipv4=on|off][,net=addr[/mask]][,host=addr]\n"
2801 " [,ipv6=on|off][,ipv6-net=addr[/int]][,ipv6-host=addr]\n"
2802 " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n"
2816 " [,br=bridge][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n"
2817 " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n"
2832 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
2833 " use vhost=on to enable experimental in kernel accelerator\n"
2835 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
2840 " spent on busy polling for vhost net\n"
2848 " [,rxsession=rxsession],txsession=txsession[,ipv6=on|off][,udp=on|off]\n"
2849 " [,cookie64=on|off][,counter][,pincounter][,txcookie=txcookie]\n"
2860 " use 'udp=on' to specify udp encapsulation\n"
2863 " use 'ipv6=on' to force v6\n"
2868 " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n"
2870 " use 'pincounter=on' to work around broken counter handling in peer\n"
2882 …=on|off],addr.type=inet,addr.host=host,addr.port=port[,to=maxport][,numeric=on|off][,keep-alive=on
2883 …"-netdev stream,id=str[,server=on|off],addr.type=unix,addr.path=path[,abstract=on|off][,tight=on|o…
2884 …"-netdev stream,id=str[,server=on|off],addr.type=fd,addr.str=file-descriptor[,reconnect-ms=millise…
2899 " running on host and listening for incoming connections on 'socketpath'.\n"
2906 " VALE port (created on the fly) called 'name' ('nmname' is name of the \n"
2910 "-netdev af-xdp,id=str,ifname=name[,mode=native|skb][,force-copy=on|off]\n"
2911 " [,queues=n][,start-queue=m][,inhibit=on|off][,sock-fds=x:y:...:z]\n"
2914 …" use 'force-copy=on|off' to force XDP copy mode even if device supports zero-copy …
2915 …" use 'inhibit=on|off' to inhibit loading of a default XDP program (default: off)\n"
2916 " with inhibit=on,\n"
2923 "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n"
2933 "-netdev vmnet-host,id=str[,isolated=on|off][,net-uuid=uuid]\n"
2940 "-netdev vmnet-shared,id=str[,isolated=on|off][,nat66-prefix=addr]\n"
2946 "-netdev vmnet-bridged,id=str,ifname=name[,isolated=on|off]\n"
2952 " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL)
2977 " initialize an on-board / default host NIC (using MAC address\n"
2984 " configure or create an on-board (or machine default) NIC and\n"
3009 This option is a shortcut for configuring both the on-board
3037 ``ipv4=on|off and ipv6=on|off``
3060 ``restrict=on|off``
3106 server. The TFTP client on the guest must be configured in
3148 Note that a SAMBA server must be installed on the host OS.
3152 hostport to the guest IP address guestaddr on guest port
3164 # on the host
3170 port on the guest, use the following:
3174 # on the host
3178 Then when you use on the host ``telnet localhost 5555``, you
3182 Forward guest TCP connections to the IP address server on port
3192 # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
3196 Or you can execute a command on every TCP connection established
3202 # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234
3272 ``listen`` is specified, QEMU waits for incoming connections on port
3296 1. Several QEMU can be running on different hosts and share same bus
3312 # launch another QEMU instance on same "bus"
3316 # launch yet another QEMU instance on same "bus"
3340 …=on|off],addr.type=inet,addr.host=host,addr.port=port[,to=maxport][,numeric=on|off][,keep-alive=on
3343 ``server=on|off``
3344 if ``on`` create a server socket
3347 socket address to listen on (server=on) or connect to (server=off)
3352 ``numeric=on|off``
3353 …if ``on`` ``host`` and ``port`` are guaranteed to be numeric, otherwise a name resolution should b…
3355 ``keep-alive=on|off``
3358 ``mptcp=on|off``
3361 ``ipv4=on|off``
3364 ``ipv6=on|off``
3378 … -netdev stream,id=net0,server=on,addr.type=inet,addr.host=localhost,addr.port=1234
3384 ``-netdev stream,id=str[,server=on|off],addr.type=unix,addr.path=path[,abstract=on|off][,tight=on|o…
3387 ``server=on|off``
3388 if ``on`` create a server socket
3393 ``abstract=on|off``
3394 if ``on``, this is a Linux abstract socket address.
3396 ``tight=on|off``
3422 netdev stream,id=net0,server=on,addr.type=unix,addr.path=/tmp/qemu0
3428 ``-netdev stream,id=str[,server=on|off],addr.type=fd,addr.str=file-descriptor[,reconnect-ms=millise…
3431 ``server=on|off``
3432 if ``on`` create a server socket
3458 # launch another QEMU instance on same "bus"
3462 # launch yet another QEMU instance on same "bus"
3529 …on=txsession[,rxsession=rxsession][,ipv6=on|off][,udp=on|off][,cookie64=on|off][,counter=on|off][,…
3544 ``udp=on``
3553 ``ipv6=on``
3561 ``cookie64=on``
3568 ``pincounter=on``
3570 on networks which have packet reorder.
3575 For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to
3576 the bridge br-lan on the remote Linux host 1.2.3.4:
3580 # Setup tunnel on linux host using raw ip as encapsulation
3581 # on 1.2.3.4
3591 # on 4.3.2.1
3595 …,id=n1,src=4.2.3.1,dst=1.2.3.4,udp=on,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0…
3599 on host and listening for incoming connections on socketpath. Use
3613 …xdp,id=str,ifname=name[,mode=native|skb][,force-copy=on|off][,queues=n][,start-queue=m][,inhibit=o…
3619 defaults to 1. Traffic arriving on non-configured device queues will
3633 create a separate set of XDP queues on top of regular ones, and only
3653 should be set to 'on' and 'sock-fds' provided with file descriptors for
3660 -netdev af-xdp,id=n1,ifname=eth0,queues=3,inhibit=on,sock-fds=15:16:17
3662 ``-netdev vhost-user,chardev=id[,vhostforce=on|off][,queues=n]``
3666 messages to an application on the other end of the socket. On
3675 qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
3686 vDPA devices can be both physically located on the hardware or
3690 Create a hub port on the emulated hub with ID hubid.
3698 Legacy option to configure or create an on-board (or machine
3726 "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
3727 …"-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4=on|off][,ipv6=on|off][,nodelay=on|off]\…
3728 …" [,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][,reconnect-ms=millisec…
3729 " [,logfile=PATH][,logappend=on|off][,tls-creds=ID][,tls-authz=ID] (tcp)\n"
3730 …"-chardev socket,id=id,path=path[,server=on|off][,wait=on|off][,telnet=on|off][,websocket=on|off][…
3731 …" [,mux=on|off][,logfile=PATH][,logappend=on|off][,abstract=on|off][,tight=on|off] (unix)\…
3733 " [,localport=localport][,ipv4=on|off][,ipv6=on|off][,mux=on|off]\n"
3734 " [,logfile=PATH][,logappend=on|off]\n"
3735 "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
3737 " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
3738 "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n"
3739 …chardev file,id=id,path=path[,input-path=input-file][,mux=on|off][,logfile=PATH][,logappend=on|off…
3740 "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
3742 "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
3743 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
3745 "-chardev pty,id=id[,path=path][,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
3746 "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n"
3749 "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
3753 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
3756 "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
3759 "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
3760 "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
3768 ``-chardev backend,id=id[,mux=on|off][,options]``
3782 front-ends. Specify ``mux=on`` to enable this mode. A multiplexer is
3786 ``mux=on``, QEMU will create a multiplexer with your specified ID,
3796 -chardev stdio,mux=on,id=char0 \
3808 -chardev stdio,mux=on,id=char0 \
3811 -chardev tcp,...,mux=on,id=char1 \
3842 …socket,id=id[,TCP options or unix options][,server=on|off][,wait=on|off][,telnet=on|off][,websocke…
3848 ``server=on|off`` specifies that the socket shall be a listening socket.
3850 ``wait=on|off`` specifies that QEMU should not block waiting for a client
3853 ``telnet=on|off`` specifies that traffic on the socket should interpret
3856 ``websocket=on|off`` specifies that the socket uses WebSocket protocol for
3859 ``reconnect-ms`` sets the timeout for reconnecting on non-server
3872 deleted and recreated on the fly while the chardev server is active.
3877 ``TCP options: port=port[,host=host][,to=to][,ipv4=on|off][,ipv6=on|off][,nodelay=on|off]``
3884 bound. For a connecting socket specifies the port on the remote
3893 ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4
3897 ``nodelay=on|off`` disables the Nagle algorithm.
3899 ``unix options: path=path[,abstract=on|off][,tight=on|off]``
3902 ``abstract=on|off`` specifies the use of the abstract socket namespace,
3904 ``tight=on|off`` sets the socket length of abstract sockets to their minimum,
3907 …=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4=on|off][,ipv6=on|off]``
3913 ``port`` specifies the port on the remote host to connect to.
3922 ``ipv4=on|off`` and ``ipv6=on|off`` specify that either IPv4 or IPv6 must be used.
3994 Note that ``input-path`` is not supported on Windows hosts.
4000 On Windows, a single duplex pipe will be created at
4003 On other hosts, 2 pipes will be created called ``path.in`` and
4015 ``console`` is only available on Windows hosts.
4018 Send traffic from the guest to a serial device on the host.
4020 On Unix hosts serial will actually accept any tty device, not only
4026 Create a new pseudo-terminal on the host and connect to it.
4028 ``pty`` is not available on Windows hosts.
4037 gracefully, it will not do so in case of crashes or on certain
4041 ``-chardev stdio,id=id[,signal=on|off]``
4044 ``signal`` controls if signals are enabled on the terminal, that
4054 ``parallel`` is only available on Linux, FreeBSD and DragonFlyBSD
4111 ``path`` specifies the path to the host's TPM device, i.e., on a
4123 by any other application on the host.
4221 of the hardware when it is started, and so on) is also architecture
4261 them on the command line to escape them:
4275 kernel on boot.
4316 Crash on deprecated commands and arguments
4332 Crash on unstable commands and arguments
4415 gracefully, it will not do so in case of crashes or on certain
4475 netcat redirector to allow telnet on port 5555 to access the
4487 ``tcp:[host]:port[,server=on|off][,wait=on|off][,nodelay=on|off][,reconnect-ms=milliseconds]``
4491 port. If you use the ``server=on`` option QEMU will wait for a client
4493 unless the ``wait=on|off`` option was specified. The ``nodelay=on|off``
4498 time is accepted. You can use ``telnet=on`` to connect to the
4504 ``Example to listen and wait on port 4444 for connection``
4505 -serial tcp::4444,server=on
4507 ``Example to not wait and listen on ip 192.168.0.100 port 4444``
4508 -serial tcp:192.168.0.100:4444,server=on,wait=off
4510 ``telnet:host:port[,server=on|off][,wait=on|off][,nodelay=on|off]``
4520 ``websocket:host:port,server=on[,wait=on|off][,nodelay=on|off]``
4524 ``unix:path[,server=on|off][,wait=on|off][,reconnect-ms=milliseconds]``
4534 multiplex the monitor onto a telnet server listening on port
4537 ``-serial mon:telnet::4444,server=on,wait=off``
4545 output on a real or fake device.
4558 as the serial port). On Linux hosts, ``/dev/parportN`` can be used
4559 to use hardware devices connected on the corresponding host parallel
4584 QMP available on localhost port 4444::
4586 -qmp tcp:localhost:4444,server=on,wait=off
4601 "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL)
4603 ``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]``
4610 turning on JSON pretty printing to ease
4615 -chardev socket,id=mon1,host=localhost,port=4444,server=on,wait=off \
4616 -mon chardev=mon1,mode=control,pretty=on
4618 enables the QMP monitor on localhost port 4444 with pretty-printing.
4663 "-overcommit [mem-lock=on|off|on-fault][cpu-pm=on|off]\n"
4665 " mem-lock=on|off|on-fault controls memory lock support (default: off)\n"
4666 " cpu-pm=on|off controls cpu power management (default: off)\n",
4669 ``-overcommit mem-lock=on|off|on-fault``
4671 ``-overcommit cpu-pm=on|off``
4675 Locking qemu and guest memory can be enabled via ``mem-lock=on``
4676 or ``mem-lock=on-fault`` (disabled by default). This works when
4678 guest. The on-fault option is better for reducing the memory footprint
4684 for other processes on the same host cpu, but decreasing latency for
4685 guest) can be enabled via ``cpu-pm=on`` (disabled by default). This
4692 "-gdb dev accept gdb connection on 'dev'. (QEMU defaults to starting\n"
4698 Accept a gdb connection on device dev (see the :ref:`GDB usage` chapter
4704 The most usual configuration is to listen on a local TCP socket::
4723 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
4826 Don't exit QEMU on guest shutdown, but instead only stop the
4872 detach from standard IO until it is ready to receive connections on
4920 …"-icount [shift=N|auto][,align=on|off][,sleep=on|off][,rr=record|replay,rrfile=<filename>[,rrsnaps…
4926 ``-icount [shift=N|auto][,align=on|off][,sleep=on|off][,rr=record|replay,rrfile=filename[,rrsnapsho…
4944 The default if icount is enabled is ``sleep=on``.
4946 or ``align=on``.
4948 ``align=on`` will activate the delay algorithm which will try to
4952 ``align=on`` is specified then we print a message to the user to
4957 depends on the host machine). The default if icount is enabled
5013 "-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]\n" \
5014 "-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]\n" \
5016 " prepare for incoming migration, listen on\n" \
5021 " accept incoming migration on given file descriptor\n" \
5024 " accept incoming migration on the migration channel\n" \
5035 ``-incoming tcp:[host]:port[,to=maxport][,ipv4=on|off][,ipv6=on|off]``
5037 ``-incoming rdma:host:port[,ipv4=on|off][,ipv6=on|off]``
5038 Prepare for incoming migration, listen on a given tcp port.
5041 Prepare for incoming migration, listen on a given unix socket.
5055 Accept incoming migration on the migration channel. For the syntax
5126 …"-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,userspace=on|off][,arg…
5131 ``-semihosting-config [enable=on|off][,target=native|gdb|auto][,chardev=id][,userspace=on|off][,arg…
5148 ``userspace=on|off``
5151 make semihosting calls. Note that setting ``userspace=on`` should
5172 "-sandbox on[,obsolete=allow|deny][,elevateprivileges=allow|deny|children]\n" \
5188 Enable Seccomp mode 2 system call filter. 'on' will enable syscall
5221 user-provided config files on sysconfdir.
5254 "-run-with [async-teardown=on|off][,chroot=dir][user=username|uid:gid]\n"
5256 " async-teardown=on enables asynchronous teardown (Linux only)\n"
5262 ``-run-with [async-teardown=on|off][,chroot=dir][user=username|uid:gid]``
5265 ``async-teardown=on`` enables asynchronous teardown. A new process called
5290 "-msg [timestamp[=on|off]][,guest-name=[on|off]]\n"
5292 " timestamp=on enables timestamps (default: off)\n"
5293 " guest-name=on enables guest name prefix but only if\n"
5297 ``-msg [timestamp[=on|off]][,guest-name[=on|off]]``
5300 ``timestamp=on|off``
5303 ``guest-name=on|off``
5367on|off,discard-data=on|off,merge=on|off,dump=on|off,prealloc=on|off,host-nodes=host-nodes,policy=d…
5386 Setting share=on might affect the ability to configure NUMA
5388 Documentation/vm/numa\_memory\_policy.txt on the Linux kernel
5391 Setting the ``discard-data`` boolean option to on indicates that
5441 NVDIMM). If ``pmem`` is set to 'on', QEMU will take necessary
5458 ROM. If set to ``on``, create ROM; if set to ``off``, create
5464 (``readonly=on``) and mark the memory to be private for QEMU
5468 …``-object memory-backend-ram,id=id,merge=on|off,dump=on|off,share=on|off,prealloc=on|off,size=size…
5475 …erge=on|off,dump=on|off,share=on|off,prealloc=on|off,size=size,host-nodes=host-nodes,policy=defaul…
5482 further resizing the memory ('on' by default).
5487 the hugetlb page size on systems that support multiple hugetlb
5498 The ``share`` boolean option is on by default with memfd.
5500 …``-object memory-backend-shm,id=id,merge=on|off,dump=on|off,share=on|off,prealloc=on|off,size=size…
5512 The ``share`` boolean option is on by default with shm. Setting it to
5537 from a device on the host. The ``id`` parameter is a unique ID
5545 from an external daemon running on the host. The ``id``
5551 ``-object tls-creds-anon,id=id,endpoint=endpoint,dir=/path/to/cred/dir,verify-peer=on|off``
5553 provide TLS support on network backends. The ``id`` parameter is
5556 depending on whether the QEMU network backend that uses the
5573 can be used to provide TLS support on network backends. The
5576 or ``client`` depending on whether the QEMU network backend that
5594 …,id=id,endpoint=endpoint,dir=/path/to/cred/dir,priority=priority,verify-peer=on|off,passwordid=id``
5596 provide TLS support on network backends. The ``id`` parameter is
5599 depending on whether the QEMU network backend that uses the
5675 …``-object filter-buffer,id=id,netdev=netdevid,interval=t[,queue=all|rx|tx][,status=on|off][,positi…
5677 all packets arriving in a given interval on netdev netdevid are
5680 netfilter is on (enabled) or off (disabled), the default status
5681 for netfilter will be 'on'.
5717 filter-mirror on netdev netdevid,mirror net packet to
5722 filter-redirector on netdev netdevid,redirect filter's net
5743 Dump the network traffic on netdev dev to the file specified by
5761 size depend on user environment.
5775 -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off
5776 -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off
5777 -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off
5779 -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off
5801 -chardev socket,id=mirror0,host=3.3.3.3,port=9003,server=on,wait=off
5802 -chardev socket,id=compare1,host=3.3.3.3,port=9004,server=on,wait=off
5803 -chardev socket,id=compare0,host=3.3.3.3,port=9001,server=on,wait=off
5805 -chardev socket,id=compare_out,host=3.3.3.3,port=9005,server=on,wait=off
5807 -chardev socket,id=notify_way,host=3.3.3.3,port=9009,server=on,wait=off
5847 vhost ioctl replacement messages to an application on the other
5941 …vice=string,policy=policy,handle=handle,dh-cert-file=file,session-file=file,kernel-hashes=on|off]``
5944 on AMD processors.
5950 must provide this value. On EPYC, the value should be 47.
5955 Similar to C-bit, the value is Host family dependent. On EPYC,
5966 commands can be performed on this guest by the hypervisor. The
6000 depends on the network service that authorization object is
6001 associated with. For authorizing based on TLS x509 certificates,
6018 ``-object authz-listfile,id=id,filename=path,refresh=on|off``
6053 strings being matched depends on the network service, but is
6063 -object authz-simple,id=auth0,filename=/etc/qemu/vnc-sasl.acl,refresh=on \\
6105 emulation and I/O to run on other host CPUs.
6121 for many cases but can be adjusted based on knowledge of the