1HXCOMM Use DEFHEADING() to define headings in both help text and texi 2HXCOMM Text between STEXI and ETEXI are copied to texi version and 3HXCOMM discarded from C version 4HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to 5HXCOMM construct option structures, enums and help message for specified 6HXCOMM architectures. 7HXCOMM HXCOMM can be used for comments, discarded from both texi and C 8 9DEFHEADING(Standard options) 10STEXI 11@table @option 12ETEXI 13 14DEF("help", 0, QEMU_OPTION_h, 15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL) 16STEXI 17@item -h 18@findex -h 19Display help and exit 20ETEXI 21 22DEF("version", 0, QEMU_OPTION_version, 23 "-version display version information and exit\n", QEMU_ARCH_ALL) 24STEXI 25@item -version 26@findex -version 27Display version information and exit 28ETEXI 29 30DEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 31 "-machine [type=]name[,prop[=value][,...]]\n" 32 " selects emulated machine ('-machine help' for list)\n" 33 " property accel=accel1[:accel2[:...]] selects accelerator\n" 34 " supported accelerators are kvm, xen, tcg (default: tcg)\n" 35 " kernel_irqchip=on|off|split controls accelerated irqchip support (default=off)\n" 36 " vmport=on|off|auto controls emulation of vmport (default: auto)\n" 37 " kvm_shadow_mem=size of KVM shadow MMU in bytes\n" 38 " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 39 " mem-merge=on|off controls memory merge support (default: on)\n" 40 " igd-passthru=on|off controls IGD GFX passthrough support (default=off)\n" 41 " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n" 42 " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n" 43 " suppress-vmdesc=on|off disables self-describing migration (default=off)\n" 44 " nvdimm=on|off controls NVDIMM support (default=off)\n" 45 " enforce-config-section=on|off enforce configuration section migration (default=off)\n", 46 QEMU_ARCH_ALL) 47STEXI 48@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 49@findex -machine 50Select the emulated machine by @var{name}. Use @code{-machine help} to list 51available machines. Supported machine properties are: 52@table @option 53@item accel=@var{accels1}[:@var{accels2}[:...]] 54This is used to enable an accelerator. Depending on the target architecture, 55kvm, xen, or tcg can be available. By default, tcg is used. If there is more 56than one accelerator specified, the next one is used if the previous one fails 57to initialize. 58@item kernel_irqchip=on|off 59Controls in-kernel irqchip support for the chosen accelerator when available. 60@item gfx_passthru=on|off 61Enables IGD GFX passthrough support for the chosen machine when available. 62@item vmport=on|off|auto 63Enables emulation of VMWare IO port, for vmmouse etc. auto says to select the 64value based on accel. For accel=xen the default is off otherwise the default 65is on. 66@item kvm_shadow_mem=size 67Defines the size of the KVM shadow MMU. 68@item dump-guest-core=on|off 69Include guest memory in a core dump. The default is on. 70@item mem-merge=on|off 71Enables or disables memory merge support. This feature, when supported by 72the host, de-duplicates identical memory pages among VMs instances 73(enabled by default). 74@item aes-key-wrap=on|off 75Enables or disables AES key wrapping support on s390-ccw hosts. This feature 76controls whether AES wrapping keys will be created to allow 77execution of AES cryptographic functions. The default is on. 78@item dea-key-wrap=on|off 79Enables or disables DEA key wrapping support on s390-ccw hosts. This feature 80controls whether DEA wrapping keys will be created to allow 81execution of DEA cryptographic functions. The default is on. 82@item nvdimm=on|off 83Enables or disables NVDIMM support. The default is off. 84@end table 85ETEXI 86 87HXCOMM Deprecated by -machine 88DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 89 90DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 91 "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 92STEXI 93@item -cpu @var{model} 94@findex -cpu 95Select CPU model (@code{-cpu help} for list and additional feature selection) 96ETEXI 97 98DEF("accel", HAS_ARG, QEMU_OPTION_accel, 99 "-accel [accel=]accelerator[,thread=single|multi]\n" 100 " select accelerator ('-accel help for list')\n" 101 " thread=single|multi (enable multi-threaded TCG)", QEMU_ARCH_ALL) 102STEXI 103@item -accel @var{name}[,prop=@var{value}[,...]] 104@findex -accel 105This is used to enable an accelerator. Depending on the target architecture, 106kvm, xen, or tcg can be available. By default, tcg is used. If there is more 107than one accelerator specified, the next one is used if the previous one fails 108to initialize. 109@table @option 110@item thread=single|multi 111Controls number of TCG threads. When the TCG is multi-threaded there will be one 112thread per vCPU therefor taking advantage of additional host cores. The default 113is to enable multi-threading where both the back-end and front-ends support it and 114no incompatible TCG features have been enabled (e.g. icount/replay). 115@end table 116ETEXI 117 118DEF("smp", HAS_ARG, QEMU_OPTION_smp, 119 "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 120 " set the number of CPUs to 'n' [default=1]\n" 121 " maxcpus= maximum number of total cpus, including\n" 122 " offline CPUs for hotplug, etc\n" 123 " cores= number of CPU cores on one socket\n" 124 " threads= number of threads on one CPU core\n" 125 " sockets= number of discrete sockets in the system\n", 126 QEMU_ARCH_ALL) 127STEXI 128@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 129@findex -smp 130Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 131CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 132to 4. 133For the PC target, the number of @var{cores} per socket, the number 134of @var{threads} per cores and the total number of @var{sockets} can be 135specified. Missing values will be computed. If any on the three values is 136given, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 137specifies the maximum number of hotpluggable CPUs. 138ETEXI 139 140DEF("numa", HAS_ARG, QEMU_OPTION_numa, 141 "-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node]\n" 142 "-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 143STEXI 144@item -numa node[,mem=@var{size}][,cpus=@var{firstcpu}[-@var{lastcpu}]][,nodeid=@var{node}] 145@itemx -numa node[,memdev=@var{id}][,cpus=@var{firstcpu}[-@var{lastcpu}]][,nodeid=@var{node}] 146@findex -numa 147Define a NUMA node and assign RAM and VCPUs to it. 148 149@var{firstcpu} and @var{lastcpu} are CPU indexes. Each 150@samp{cpus} option represent a contiguous range of CPU indexes 151(or a single VCPU if @var{lastcpu} is omitted). A non-contiguous 152set of VCPUs can be represented by providing multiple @samp{cpus} 153options. If @samp{cpus} is omitted on all nodes, VCPUs are automatically 154split between them. 155 156For example, the following option assigns VCPUs 0, 1, 2 and 5 to 157a NUMA node: 158@example 159-numa node,cpus=0-2,cpus=5 160@end example 161 162@samp{mem} assigns a given RAM amount to a node. @samp{memdev} 163assigns RAM from a given memory backend device to a node. If 164@samp{mem} and @samp{memdev} are omitted in all nodes, RAM is 165split equally between them. 166 167@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, 168if one node uses @samp{memdev}, all of them have to use it. 169 170Note that the -@option{numa} option doesn't allocate any of the 171specified resources, it just assigns existing resources to NUMA 172nodes. This means that one still has to use the @option{-m}, 173@option{-smp} options to allocate RAM and VCPUs respectively. 174 175ETEXI 176 177DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 178 "-add-fd fd=fd,set=set[,opaque=opaque]\n" 179 " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 180STEXI 181@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 182@findex -add-fd 183 184Add a file descriptor to an fd set. Valid options are: 185 186@table @option 187@item fd=@var{fd} 188This option defines the file descriptor of which a duplicate is added to fd set. 189The file descriptor cannot be stdin, stdout, or stderr. 190@item set=@var{set} 191This option defines the ID of the fd set to add the file descriptor to. 192@item opaque=@var{opaque} 193This option defines a free-form string that can be used to describe @var{fd}. 194@end table 195 196You can open an image using pre-opened file descriptors from an fd set: 197@example 198qemu-system-i386 199-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 200-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 201-drive file=/dev/fdset/2,index=0,media=disk 202@end example 203ETEXI 204 205DEF("set", HAS_ARG, QEMU_OPTION_set, 206 "-set group.id.arg=value\n" 207 " set <arg> parameter for item <id> of type <group>\n" 208 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 209STEXI 210@item -set @var{group}.@var{id}.@var{arg}=@var{value} 211@findex -set 212Set parameter @var{arg} for item @var{id} of type @var{group} 213ETEXI 214 215DEF("global", HAS_ARG, QEMU_OPTION_global, 216 "-global driver.property=value\n" 217 "-global driver=driver,property=property,value=value\n" 218 " set a global default for a driver property\n", 219 QEMU_ARCH_ALL) 220STEXI 221@item -global @var{driver}.@var{prop}=@var{value} 222@itemx -global driver=@var{driver},property=@var{property},value=@var{value} 223@findex -global 224Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 225 226@example 227qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk 228@end example 229 230In particular, you can use this to set driver properties for devices which are 231created automatically by the machine model. To create a device which is not 232created automatically and set properties on it, use -@option{device}. 233 234-global @var{driver}.@var{prop}=@var{value} is shorthand for -global 235driver=@var{driver},property=@var{prop},value=@var{value}. The 236longhand syntax works even when @var{driver} contains a dot. 237ETEXI 238 239DEF("boot", HAS_ARG, QEMU_OPTION_boot, 240 "-boot [order=drives][,once=drives][,menu=on|off]\n" 241 " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 242 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 243 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 244 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 245 " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 246 QEMU_ARCH_ALL) 247STEXI 248@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] 249@findex -boot 250Specify boot order @var{drives} as a string of drive letters. Valid 251drive letters depend on the target architecture. The x86 PC uses: a, b 252(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 253from network adapter 1-4), hard disk boot is the default. To apply a 254particular boot order only on the first startup, specify it via 255@option{once}. Note that the @option{order} or @option{once} parameter 256should not be used together with the @option{bootindex} property of 257devices, since the firmware implementations normally do not support both 258at the same time. 259 260Interactive boot menus/prompts can be enabled via @option{menu=on} as far 261as firmware/BIOS supports them. The default is non-interactive boot. 262 263A splash picture could be passed to bios, enabling user to show it as logo, 264when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 265supports them. Currently Seabios for X86 system support it. 266limitation: The splash file could be a jpeg file or a BMP file in 24 BPP 267format(true color). The resolution should be supported by the SVGA mode, so 268the recommended is 320x240, 640x480, 800x640. 269 270A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 271when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not 272reboot, qemu passes '-1' to bios by default. Currently Seabios for X86 273system support it. 274 275Do strict boot via @option{strict=on} as far as firmware/BIOS 276supports it. This only effects when boot priority is changed by 277bootindex options. The default is non-strict boot. 278 279@example 280# try to boot from network first, then from hard disk 281qemu-system-i386 -boot order=nc 282# boot from CD-ROM first, switch back to default order after reboot 283qemu-system-i386 -boot once=d 284# boot with a splash picture for 5 seconds. 285qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 286@end example 287 288Note: The legacy format '-boot @var{drives}' is still supported but its 289use is discouraged as it may be removed from future versions. 290ETEXI 291 292DEF("m", HAS_ARG, QEMU_OPTION_m, 293 "-m [size=]megs[,slots=n,maxmem=size]\n" 294 " configure guest RAM\n" 295 " size: initial amount of guest memory\n" 296 " slots: number of hotplug slots (default: none)\n" 297 " maxmem: maximum amount of guest memory (default: none)\n" 298 "NOTE: Some architectures might enforce a specific granularity\n", 299 QEMU_ARCH_ALL) 300STEXI 301@item -m [size=]@var{megs}[,slots=n,maxmem=size] 302@findex -m 303Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB. 304Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in 305megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem} 306could be used to set amount of hotpluggable memory slots and maximum amount of 307memory. Note that @var{maxmem} must be aligned to the page size. 308 309For example, the following command-line sets the guest startup RAM size to 3101GB, creates 3 slots to hotplug additional memory and sets the maximum 311memory the guest can reach to 4GB: 312 313@example 314qemu-system-x86_64 -m 1G,slots=3,maxmem=4G 315@end example 316 317If @var{slots} and @var{maxmem} are not specified, memory hotplug won't 318be enabled and the guest startup RAM will never increase. 319ETEXI 320 321DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 322 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 323STEXI 324@item -mem-path @var{path} 325@findex -mem-path 326Allocate guest RAM from a temporarily created file in @var{path}. 327ETEXI 328 329DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 330 "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 331 QEMU_ARCH_ALL) 332STEXI 333@item -mem-prealloc 334@findex -mem-prealloc 335Preallocate memory when using -mem-path. 336ETEXI 337 338DEF("k", HAS_ARG, QEMU_OPTION_k, 339 "-k language use keyboard layout (for example 'fr' for French)\n", 340 QEMU_ARCH_ALL) 341STEXI 342@item -k @var{language} 343@findex -k 344Use keyboard layout @var{language} (for example @code{fr} for 345French). This option is only needed where it is not easy to get raw PC 346keycodes (e.g. on Macs, with some X11 servers or with a VNC or curses 347display). You don't normally need to use it on PC/Linux or PC/Windows 348hosts. 349 350The available layouts are: 351@example 352ar de-ch es fo fr-ca hu ja mk no pt-br sv 353da en-gb et fr fr-ch is lt nl pl ru th 354de en-us fi fr-be hr it lv nl-be pt sl tr 355@end example 356 357The default is @code{en-us}. 358ETEXI 359 360 361DEF("audio-help", 0, QEMU_OPTION_audio_help, 362 "-audio-help print list of audio drivers and their options\n", 363 QEMU_ARCH_ALL) 364STEXI 365@item -audio-help 366@findex -audio-help 367Will show the audio subsystem help: list of drivers, tunable 368parameters. 369ETEXI 370 371DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 372 "-soundhw c1,... enable audio support\n" 373 " and only specified sound cards (comma separated list)\n" 374 " use '-soundhw help' to get the list of supported cards\n" 375 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 376STEXI 377@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 378@findex -soundhw 379Enable audio and selected sound hardware. Use 'help' to print all 380available sound hardware. 381 382@example 383qemu-system-i386 -soundhw sb16,adlib disk.img 384qemu-system-i386 -soundhw es1370 disk.img 385qemu-system-i386 -soundhw ac97 disk.img 386qemu-system-i386 -soundhw hda disk.img 387qemu-system-i386 -soundhw all disk.img 388qemu-system-i386 -soundhw help 389@end example 390 391Note that Linux's i810_audio OSS kernel (for AC97) module might 392require manually specifying clocking. 393 394@example 395modprobe i810_audio clocking=48000 396@end example 397ETEXI 398 399DEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 400 "-balloon none disable balloon device\n" 401 "-balloon virtio[,addr=str]\n" 402 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 403STEXI 404@item -balloon none 405@findex -balloon 406Disable balloon device. 407@item -balloon virtio[,addr=@var{addr}] 408Enable virtio balloon device (default), optionally with PCI address 409@var{addr}. 410ETEXI 411 412DEF("device", HAS_ARG, QEMU_OPTION_device, 413 "-device driver[,prop[=value][,...]]\n" 414 " add device (based on driver)\n" 415 " prop=value,... sets driver properties\n" 416 " use '-device help' to print all possible drivers\n" 417 " use '-device driver,help' to print all possible properties\n", 418 QEMU_ARCH_ALL) 419STEXI 420@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 421@findex -device 422Add device @var{driver}. @var{prop}=@var{value} sets driver 423properties. Valid properties depend on the driver. To get help on 424possible drivers and properties, use @code{-device help} and 425@code{-device @var{driver},help}. 426 427Some drivers are: 428@item -device ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}] 429 430Add an IPMI BMC. This is a simulation of a hardware management 431interface processor that normally sits on a system. It provides 432a watchdog and the ability to reset and power control the system. 433You need to connect this to an IPMI interface to make it useful 434 435The IPMI slave address to use for the BMC. The default is 0x20. 436This address is the BMC's address on the I2C network of management 437controllers. If you don't know what this means, it is safe to ignore 438it. 439 440@item -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}] 441 442Add a connection to an external IPMI BMC simulator. Instead of 443locally emulating the BMC like the above item, instead connect 444to an external entity that provides the IPMI services. 445 446A connection is made to an external BMC simulator. If you do this, it 447is strongly recommended that you use the "reconnect=" chardev option 448to reconnect to the simulator if the connection is lost. Note that if 449this is not used carefully, it can be a security issue, as the 450interface has the ability to send resets, NMIs, and power off the VM. 451It's best if QEMU makes a connection to an external simulator running 452on a secure port on localhost, so neither the simulator nor QEMU is 453exposed to any outside network. 454 455See the "lanserv/README.vm" file in the OpenIPMI library for more 456details on the external interface. 457 458@item -device isa-ipmi-kcs,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}] 459 460Add a KCS IPMI interafce on the ISA bus. This also adds a 461corresponding ACPI and SMBIOS entries, if appropriate. 462 463@table @option 464@item bmc=@var{id} 465The BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above. 466@item ioport=@var{val} 467Define the I/O address of the interface. The default is 0xca0 for KCS. 468@item irq=@var{val} 469Define the interrupt to use. The default is 5. To disable interrupts, 470set this to 0. 471@end table 472 473@item -device isa-ipmi-bt,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}] 474 475Like the KCS interface, but defines a BT interface. The default port is 4760xe4 and the default interrupt is 5. 477 478ETEXI 479 480DEF("name", HAS_ARG, QEMU_OPTION_name, 481 "-name string1[,process=string2][,debug-threads=on|off]\n" 482 " set the name of the guest\n" 483 " string1 sets the window title and string2 the process name (on Linux)\n" 484 " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" 485 " NOTE: The thread names are for debugging and not a stable API.\n", 486 QEMU_ARCH_ALL) 487STEXI 488@item -name @var{name} 489@findex -name 490Sets the @var{name} of the guest. 491This name will be displayed in the SDL window caption. 492The @var{name} will also be used for the VNC server. 493Also optionally set the top visible process name in Linux. 494Naming of individual threads can also be enabled on Linux to aid debugging. 495ETEXI 496 497DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 498 "-uuid %08x-%04x-%04x-%04x-%012x\n" 499 " specify machine UUID\n", QEMU_ARCH_ALL) 500STEXI 501@item -uuid @var{uuid} 502@findex -uuid 503Set system UUID. 504ETEXI 505 506STEXI 507@end table 508ETEXI 509DEFHEADING() 510 511DEFHEADING(Block device options) 512STEXI 513@table @option 514ETEXI 515 516DEF("fda", HAS_ARG, QEMU_OPTION_fda, 517 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 518DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 519STEXI 520@item -fda @var{file} 521@itemx -fdb @var{file} 522@findex -fda 523@findex -fdb 524Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). 525ETEXI 526 527DEF("hda", HAS_ARG, QEMU_OPTION_hda, 528 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 529DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 530DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 531 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 532DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 533STEXI 534@item -hda @var{file} 535@itemx -hdb @var{file} 536@itemx -hdc @var{file} 537@itemx -hdd @var{file} 538@findex -hda 539@findex -hdb 540@findex -hdc 541@findex -hdd 542Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 543ETEXI 544 545DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 546 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 547 QEMU_ARCH_ALL) 548STEXI 549@item -cdrom @var{file} 550@findex -cdrom 551Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 552@option{-cdrom} at the same time). You can use the host CD-ROM by 553using @file{/dev/cdrom} as filename (@pxref{host_drives}). 554ETEXI 555 556DEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev, 557 "-blockdev [driver=]driver[,node-name=N][,discard=ignore|unmap]\n" 558 " [,cache.direct=on|off][,cache.no-flush=on|off]\n" 559 " [,read-only=on|off][,detect-zeroes=on|off|unmap]\n" 560 " [,driver specific parameters...]\n" 561 " configure a block backend\n", QEMU_ARCH_ALL) 562 563DEF("drive", HAS_ARG, QEMU_OPTION_drive, 564 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 565 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 566 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 567 " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" 568 " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 569 " [,readonly=on|off][,copy-on-read=on|off]\n" 570 " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 571 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 572 " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 573 " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 574 " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 575 " [[,iops_size=is]]\n" 576 " [[,group=g]]\n" 577 " use 'file' as a drive image\n", QEMU_ARCH_ALL) 578STEXI 579@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 580@findex -drive 581 582Define a new drive. Valid options are: 583 584@table @option 585@item file=@var{file} 586This option defines which disk image (@pxref{disk_images}) to use with 587this drive. If the filename contains comma, you must double it 588(for instance, "file=my,,file" to use file "my,file"). 589 590Special files such as iSCSI devices can be specified using protocol 591specific URLs. See the section for "Device URL Syntax" for more information. 592@item if=@var{interface} 593This option defines on which type on interface the drive is connected. 594Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 595@item bus=@var{bus},unit=@var{unit} 596These options define where is connected the drive by defining the bus number and 597the unit id. 598@item index=@var{index} 599This option defines where is connected the drive by using an index in the list 600of available connectors of a given interface type. 601@item media=@var{media} 602This option defines the type of the media: disk or cdrom. 603@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 604These options have the same definition as they have in @option{-hdachs}. 605@item snapshot=@var{snapshot} 606@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive 607(see @option{-snapshot}). 608@item cache=@var{cache} 609@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 610@item aio=@var{aio} 611@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 612@item discard=@var{discard} 613@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. 614@item format=@var{format} 615Specify which disk @var{format} will be used rather than detecting 616the format. Can be used to specify format=raw to avoid interpreting 617an untrusted format header. 618@item serial=@var{serial} 619This option specifies the serial number to assign to the device. 620@item addr=@var{addr} 621Specify the controller's PCI address (if=virtio only). 622@item werror=@var{action},rerror=@var{action} 623Specify which @var{action} to take on write and read errors. Valid actions are: 624"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 625"report" (report the error to the guest), "enospc" (pause QEMU only if the 626host disk is full; report the error to the guest otherwise). 627The default setting is @option{werror=enospc} and @option{rerror=report}. 628@item readonly 629Open drive @option{file} as read-only. Guest write attempts will fail. 630@item copy-on-read=@var{copy-on-read} 631@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 632file sectors into the image file. 633@item detect-zeroes=@var{detect-zeroes} 634@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic 635conversion of plain zero writes by the OS to driver specific optimized 636zero write commands. You may even choose "unmap" if @var{discard} is set 637to "unmap" to allow a zero write to be converted to an UNMAP operation. 638@end table 639 640By default, the @option{cache=writeback} mode is used. It will report data 641writes as completed as soon as the data is present in the host page cache. 642This is safe as long as your guest OS makes sure to correctly flush disk caches 643where needed. If your guest OS does not handle volatile disk write caches 644correctly and your host crashes or loses power, then the guest may experience 645data corruption. 646 647For such guests, you should consider using @option{cache=writethrough}. This 648means that the host page cache will be used to read and write data, but write 649notification will be sent to the guest only after QEMU has made sure to flush 650each write to the disk. Be aware that this has a major impact on performance. 651 652The host page cache can be avoided entirely with @option{cache=none}. This will 653attempt to do disk IO directly to the guest's memory. QEMU may still perform 654an internal copy of the data. Note that this is considered a writeback mode and 655the guest OS must handle the disk write cache correctly in order to avoid data 656corruption on host crashes. 657 658The host page cache can be avoided while only sending write notifications to 659the guest when the data has been flushed to the disk using 660@option{cache=directsync}. 661 662In case you don't care about data integrity over host failures, use 663@option{cache=unsafe}. This option tells QEMU that it never needs to write any 664data to the disk but can instead keep things in cache. If anything goes wrong, 665like your host losing power, the disk storage getting disconnected accidentally, 666etc. your image will most probably be rendered unusable. When using 667the @option{-snapshot} option, unsafe caching is always used. 668 669Copy-on-read avoids accessing the same backing file sectors repeatedly and is 670useful when the backing file is over a slow network. By default copy-on-read 671is off. 672 673Instead of @option{-cdrom} you can use: 674@example 675qemu-system-i386 -drive file=file,index=2,media=cdrom 676@end example 677 678Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 679use: 680@example 681qemu-system-i386 -drive file=file,index=0,media=disk 682qemu-system-i386 -drive file=file,index=1,media=disk 683qemu-system-i386 -drive file=file,index=2,media=disk 684qemu-system-i386 -drive file=file,index=3,media=disk 685@end example 686 687You can open an image using pre-opened file descriptors from an fd set: 688@example 689qemu-system-i386 690-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 691-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 692-drive file=/dev/fdset/2,index=0,media=disk 693@end example 694 695You can connect a CDROM to the slave of ide0: 696@example 697qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 698@end example 699 700If you don't specify the "file=" argument, you define an empty drive: 701@example 702qemu-system-i386 -drive if=ide,index=1,media=cdrom 703@end example 704 705Instead of @option{-fda}, @option{-fdb}, you can use: 706@example 707qemu-system-i386 -drive file=file,index=0,if=floppy 708qemu-system-i386 -drive file=file,index=1,if=floppy 709@end example 710 711By default, @var{interface} is "ide" and @var{index} is automatically 712incremented: 713@example 714qemu-system-i386 -drive file=a -drive file=b" 715@end example 716is interpreted like: 717@example 718qemu-system-i386 -hda a -hdb b 719@end example 720ETEXI 721 722DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 723 "-mtdblock file use 'file' as on-board Flash memory image\n", 724 QEMU_ARCH_ALL) 725STEXI 726@item -mtdblock @var{file} 727@findex -mtdblock 728Use @var{file} as on-board Flash memory image. 729ETEXI 730 731DEF("sd", HAS_ARG, QEMU_OPTION_sd, 732 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 733STEXI 734@item -sd @var{file} 735@findex -sd 736Use @var{file} as SecureDigital card image. 737ETEXI 738 739DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 740 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 741STEXI 742@item -pflash @var{file} 743@findex -pflash 744Use @var{file} as a parallel flash image. 745ETEXI 746 747DEF("snapshot", 0, QEMU_OPTION_snapshot, 748 "-snapshot write to temporary files instead of disk image files\n", 749 QEMU_ARCH_ALL) 750STEXI 751@item -snapshot 752@findex -snapshot 753Write to temporary files instead of disk image files. In this case, 754the raw disk image you use is not written back. You can however force 755the write back by pressing @key{C-a s} (@pxref{disk_images}). 756ETEXI 757 758DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 759 "-hdachs c,h,s[,t]\n" \ 760 " force hard disk 0 physical geometry and the optional BIOS\n" \ 761 " translation (t=none or lba) (usually QEMU can guess them)\n", 762 QEMU_ARCH_ALL) 763STEXI 764@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 765@findex -hdachs 766Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 767@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 768translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 769all those parameters. This option is useful for old MS-DOS disk 770images. 771ETEXI 772 773DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 774 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 775 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n" 776 " [[,throttling.bps-total=b]|[[,throttling.bps-read=r][,throttling.bps-write=w]]]\n" 777 " [[,throttling.iops-total=i]|[[,throttling.iops-read=r][,throttling.iops-write=w]]]\n" 778 " [[,throttling.bps-total-max=bm]|[[,throttling.bps-read-max=rm][,throttling.bps-write-max=wm]]]\n" 779 " [[,throttling.iops-total-max=im]|[[,throttling.iops-read-max=irm][,throttling.iops-write-max=iwm]]]\n" 780 " [[,throttling.iops-size=is]]\n", 781 QEMU_ARCH_ALL) 782 783STEXI 784 785@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}] 786@findex -fsdev 787Define a new file system device. Valid options are: 788@table @option 789@item @var{fsdriver} 790This option specifies the fs driver backend to use. 791Currently "local", "handle" and "proxy" file system drivers are supported. 792@item id=@var{id} 793Specifies identifier for this device 794@item path=@var{path} 795Specifies the export path for the file system device. Files under 796this path will be available to the 9p client on the guest. 797@item security_model=@var{security_model} 798Specifies the security model to be used for this export path. 799Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 800In "passthrough" security model, files are stored using the same 801credentials as they are created on the guest. This requires QEMU 802to run as root. In "mapped-xattr" security model, some of the file 803attributes like uid, gid, mode bits and link target are stored as 804file attributes. For "mapped-file" these attributes are stored in the 805hidden .virtfs_metadata directory. Directories exported by this security model cannot 806interact with other unix tools. "none" security model is same as 807passthrough except the sever won't report failures if it fails to 808set file attributes like ownership. Security model is mandatory 809only for local fsdriver. Other fsdrivers (like handle, proxy) don't take 810security model as a parameter. 811@item writeout=@var{writeout} 812This is an optional argument. The only supported value is "immediate". 813This means that host page cache will be used to read and write data but 814write notification will be sent to the guest only when the data has been 815reported as written by the storage subsystem. 816@item readonly 817Enables exporting 9p share as a readonly mount for guests. By default 818read-write access is given. 819@item socket=@var{socket} 820Enables proxy filesystem driver to use passed socket file for communicating 821with virtfs-proxy-helper 822@item sock_fd=@var{sock_fd} 823Enables proxy filesystem driver to use passed socket descriptor for 824communicating with virtfs-proxy-helper. Usually a helper like libvirt 825will create socketpair and pass one of the fds as sock_fd 826@end table 827 828-fsdev option is used along with -device driver "virtio-9p-pci". 829@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 830Options for virtio-9p-pci driver are: 831@table @option 832@item fsdev=@var{id} 833Specifies the id value specified along with -fsdev option 834@item mount_tag=@var{mount_tag} 835Specifies the tag name to be used by the guest to mount this export point 836@end table 837 838ETEXI 839 840DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 841 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 842 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 843 QEMU_ARCH_ALL) 844 845STEXI 846 847@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}] 848@findex -virtfs 849 850The general form of a Virtual File system pass-through options are: 851@table @option 852@item @var{fsdriver} 853This option specifies the fs driver backend to use. 854Currently "local", "handle" and "proxy" file system drivers are supported. 855@item id=@var{id} 856Specifies identifier for this device 857@item path=@var{path} 858Specifies the export path for the file system device. Files under 859this path will be available to the 9p client on the guest. 860@item security_model=@var{security_model} 861Specifies the security model to be used for this export path. 862Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 863In "passthrough" security model, files are stored using the same 864credentials as they are created on the guest. This requires QEMU 865to run as root. In "mapped-xattr" security model, some of the file 866attributes like uid, gid, mode bits and link target are stored as 867file attributes. For "mapped-file" these attributes are stored in the 868hidden .virtfs_metadata directory. Directories exported by this security model cannot 869interact with other unix tools. "none" security model is same as 870passthrough except the sever won't report failures if it fails to 871set file attributes like ownership. Security model is mandatory only 872for local fsdriver. Other fsdrivers (like handle, proxy) don't take security 873model as a parameter. 874@item writeout=@var{writeout} 875This is an optional argument. The only supported value is "immediate". 876This means that host page cache will be used to read and write data but 877write notification will be sent to the guest only when the data has been 878reported as written by the storage subsystem. 879@item readonly 880Enables exporting 9p share as a readonly mount for guests. By default 881read-write access is given. 882@item socket=@var{socket} 883Enables proxy filesystem driver to use passed socket file for 884communicating with virtfs-proxy-helper. Usually a helper like libvirt 885will create socketpair and pass one of the fds as sock_fd 886@item sock_fd 887Enables proxy filesystem driver to use passed 'sock_fd' as the socket 888descriptor for interfacing with virtfs-proxy-helper 889@end table 890ETEXI 891 892DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 893 "-virtfs_synth Create synthetic file system image\n", 894 QEMU_ARCH_ALL) 895STEXI 896@item -virtfs_synth 897@findex -virtfs_synth 898Create synthetic file system image 899ETEXI 900 901STEXI 902@end table 903ETEXI 904DEFHEADING() 905 906DEFHEADING(USB options) 907STEXI 908@table @option 909ETEXI 910 911DEF("usb", 0, QEMU_OPTION_usb, 912 "-usb enable the USB driver (will be the default soon)\n", 913 QEMU_ARCH_ALL) 914STEXI 915@item -usb 916@findex -usb 917Enable the USB driver (will be the default soon) 918ETEXI 919 920DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 921 "-usbdevice name add the host or guest USB device 'name'\n", 922 QEMU_ARCH_ALL) 923STEXI 924 925@item -usbdevice @var{devname} 926@findex -usbdevice 927Add the USB device @var{devname}. @xref{usb_devices}. 928 929@table @option 930 931@item mouse 932Virtual Mouse. This will override the PS/2 mouse emulation when activated. 933 934@item tablet 935Pointer device that uses absolute coordinates (like a touchscreen). This 936means QEMU is able to report the mouse position without having to grab the 937mouse. Also overrides the PS/2 mouse emulation when activated. 938 939@item disk:[format=@var{format}]:@var{file} 940Mass storage device based on file. The optional @var{format} argument 941will be used rather than detecting the format. Can be used to specify 942@code{format=raw} to avoid interpreting an untrusted format header. 943 944@item host:@var{bus}.@var{addr} 945Pass through the host device identified by @var{bus}.@var{addr} (Linux only). 946 947@item host:@var{vendor_id}:@var{product_id} 948Pass through the host device identified by @var{vendor_id}:@var{product_id} 949(Linux only). 950 951@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 952Serial converter to host character device @var{dev}, see @code{-serial} for the 953available devices. 954 955@item braille 956Braille device. This will use BrlAPI to display the braille output on a real 957or fake device. 958 959@item net:@var{options} 960Network adapter that supports CDC ethernet and RNDIS protocols. 961 962@end table 963ETEXI 964 965STEXI 966@end table 967ETEXI 968DEFHEADING() 969 970DEFHEADING(Display options) 971STEXI 972@table @option 973ETEXI 974 975DEF("display", HAS_ARG, QEMU_OPTION_display, 976 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 977 " [,window_close=on|off][,gl=on|off]\n" 978 "-display gtk[,grab_on_hover=on|off][,gl=on|off]|\n" 979 "-display vnc=<display>[,<optargs>]\n" 980 "-display curses\n" 981 "-display none" 982 " select display type\n" 983 "The default display is equivalent to\n" 984#if defined(CONFIG_GTK) 985 "\t\"-display gtk\"\n" 986#elif defined(CONFIG_SDL) 987 "\t\"-display sdl\"\n" 988#elif defined(CONFIG_COCOA) 989 "\t\"-display cocoa\"\n" 990#elif defined(CONFIG_VNC) 991 "\t\"-vnc localhost:0,to=99,id=default\"\n" 992#else 993 "\t\"-display none\"\n" 994#endif 995 , QEMU_ARCH_ALL) 996STEXI 997@item -display @var{type} 998@findex -display 999Select type of display to use. This option is a replacement for the 1000old style -sdl/-curses/... options. Valid values for @var{type} are 1001@table @option 1002@item sdl 1003Display video output via SDL (usually in a separate graphics 1004window; see the SDL documentation for other possibilities). 1005@item curses 1006Display video output via curses. For graphics device models which 1007support a text mode, QEMU can display this output using a 1008curses/ncurses interface. Nothing is displayed when the graphics 1009device is in graphical mode or if the graphics device does not support 1010a text mode. Generally only the VGA device models support text mode. 1011@item none 1012Do not display video output. The guest will still see an emulated 1013graphics card, but its output will not be displayed to the QEMU 1014user. This option differs from the -nographic option in that it 1015only affects what is done with video output; -nographic also changes 1016the destination of the serial and parallel port data. 1017@item gtk 1018Display video output in a GTK window. This interface provides drop-down 1019menus and other UI elements to configure and control the VM during 1020runtime. 1021@item vnc 1022Start a VNC server on display <arg> 1023@end table 1024ETEXI 1025 1026DEF("nographic", 0, QEMU_OPTION_nographic, 1027 "-nographic disable graphical output and redirect serial I/Os to console\n", 1028 QEMU_ARCH_ALL) 1029STEXI 1030@item -nographic 1031@findex -nographic 1032Normally, if QEMU is compiled with graphical window support, it displays 1033output such as guest graphics, guest console, and the QEMU monitor in a 1034window. With this option, you can totally disable graphical output so 1035that QEMU is a simple command line application. The emulated serial port 1036is redirected on the console and muxed with the monitor (unless 1037redirected elsewhere explicitly). Therefore, you can still use QEMU to 1038debug a Linux kernel with a serial console. Use @key{C-a h} for help on 1039switching between the console and monitor. 1040ETEXI 1041 1042DEF("curses", 0, QEMU_OPTION_curses, 1043 "-curses shorthand for -display curses\n", 1044 QEMU_ARCH_ALL) 1045STEXI 1046@item -curses 1047@findex -curses 1048Normally, if QEMU is compiled with graphical window support, it displays 1049output such as guest graphics, guest console, and the QEMU monitor in a 1050window. With this option, QEMU can display the VGA output when in text 1051mode using a curses/ncurses interface. Nothing is displayed in graphical 1052mode. 1053ETEXI 1054 1055DEF("no-frame", 0, QEMU_OPTION_no_frame, 1056 "-no-frame open SDL window without a frame and window decorations\n", 1057 QEMU_ARCH_ALL) 1058STEXI 1059@item -no-frame 1060@findex -no-frame 1061Do not use decorations for SDL windows and start them using the whole 1062available screen space. This makes the using QEMU in a dedicated desktop 1063workspace more convenient. 1064ETEXI 1065 1066DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 1067 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 1068 QEMU_ARCH_ALL) 1069STEXI 1070@item -alt-grab 1071@findex -alt-grab 1072Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 1073affects the special keys (for fullscreen, monitor-mode switching, etc). 1074ETEXI 1075 1076DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 1077 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 1078 QEMU_ARCH_ALL) 1079STEXI 1080@item -ctrl-grab 1081@findex -ctrl-grab 1082Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 1083affects the special keys (for fullscreen, monitor-mode switching, etc). 1084ETEXI 1085 1086DEF("no-quit", 0, QEMU_OPTION_no_quit, 1087 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 1088STEXI 1089@item -no-quit 1090@findex -no-quit 1091Disable SDL window close capability. 1092ETEXI 1093 1094DEF("sdl", 0, QEMU_OPTION_sdl, 1095 "-sdl shorthand for -display sdl\n", QEMU_ARCH_ALL) 1096STEXI 1097@item -sdl 1098@findex -sdl 1099Enable SDL. 1100ETEXI 1101 1102DEF("spice", HAS_ARG, QEMU_OPTION_spice, 1103 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 1104 " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 1105 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 1106 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n" 1107 " [,tls-ciphers=<list>]\n" 1108 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 1109 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 1110 " [,sasl][,password=<secret>][,disable-ticketing]\n" 1111 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 1112 " [,jpeg-wan-compression=[auto|never|always]]\n" 1113 " [,zlib-glz-wan-compression=[auto|never|always]]\n" 1114 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 1115 " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" 1116 " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 1117 " [,gl=[on|off]][,rendernode=<file>]\n" 1118 " enable spice\n" 1119 " at least one of {port, tls-port} is mandatory\n", 1120 QEMU_ARCH_ALL) 1121STEXI 1122@item -spice @var{option}[,@var{option}[,...]] 1123@findex -spice 1124Enable the spice remote desktop protocol. Valid options are 1125 1126@table @option 1127 1128@item port=<nr> 1129Set the TCP port spice is listening on for plaintext channels. 1130 1131@item addr=<addr> 1132Set the IP address spice is listening on. Default is any address. 1133 1134@item ipv4 1135@itemx ipv6 1136@itemx unix 1137Force using the specified IP version. 1138 1139@item password=<secret> 1140Set the password you need to authenticate. 1141 1142@item sasl 1143Require that the client use SASL to authenticate with the spice. 1144The exact choice of authentication method used is controlled from the 1145system / user's SASL configuration file for the 'qemu' service. This 1146is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 1147unprivileged user, an environment variable SASL_CONF_PATH can be used 1148to make it search alternate locations for the service config. 1149While some SASL auth methods can also provide data encryption (eg GSSAPI), 1150it is recommended that SASL always be combined with the 'tls' and 1151'x509' settings to enable use of SSL and server certificates. This 1152ensures a data encryption preventing compromise of authentication 1153credentials. 1154 1155@item disable-ticketing 1156Allow client connects without authentication. 1157 1158@item disable-copy-paste 1159Disable copy paste between the client and the guest. 1160 1161@item disable-agent-file-xfer 1162Disable spice-vdagent based file-xfer between the client and the guest. 1163 1164@item tls-port=<nr> 1165Set the TCP port spice is listening on for encrypted channels. 1166 1167@item x509-dir=<dir> 1168Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 1169 1170@item x509-key-file=<file> 1171@itemx x509-key-password=<file> 1172@itemx x509-cert-file=<file> 1173@itemx x509-cacert-file=<file> 1174@itemx x509-dh-key-file=<file> 1175The x509 file names can also be configured individually. 1176 1177@item tls-ciphers=<list> 1178Specify which ciphers to use. 1179 1180@item tls-channel=[main|display|cursor|inputs|record|playback] 1181@itemx plaintext-channel=[main|display|cursor|inputs|record|playback] 1182Force specific channel to be used with or without TLS encryption. The 1183options can be specified multiple times to configure multiple 1184channels. The special name "default" can be used to set the default 1185mode. For channels which are not explicitly forced into one mode the 1186spice client is allowed to pick tls/plaintext as he pleases. 1187 1188@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 1189Configure image compression (lossless). 1190Default is auto_glz. 1191 1192@item jpeg-wan-compression=[auto|never|always] 1193@itemx zlib-glz-wan-compression=[auto|never|always] 1194Configure wan image compression (lossy for slow links). 1195Default is auto. 1196 1197@item streaming-video=[off|all|filter] 1198Configure video stream detection. Default is off. 1199 1200@item agent-mouse=[on|off] 1201Enable/disable passing mouse events via vdagent. Default is on. 1202 1203@item playback-compression=[on|off] 1204Enable/disable audio stream compression (using celt 0.5.1). Default is on. 1205 1206@item seamless-migration=[on|off] 1207Enable/disable spice seamless migration. Default is off. 1208 1209@item gl=[on|off] 1210Enable/disable OpenGL context. Default is off. 1211 1212@item rendernode=<file> 1213DRM render node for OpenGL rendering. If not specified, it will pick 1214the first available. (Since 2.9) 1215 1216@end table 1217ETEXI 1218 1219DEF("portrait", 0, QEMU_OPTION_portrait, 1220 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1221 QEMU_ARCH_ALL) 1222STEXI 1223@item -portrait 1224@findex -portrait 1225Rotate graphical output 90 deg left (only PXA LCD). 1226ETEXI 1227 1228DEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 1229 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 1230 QEMU_ARCH_ALL) 1231STEXI 1232@item -rotate @var{deg} 1233@findex -rotate 1234Rotate graphical output some deg left (only PXA LCD). 1235ETEXI 1236 1237DEF("vga", HAS_ARG, QEMU_OPTION_vga, 1238 "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n" 1239 " select video card type\n", QEMU_ARCH_ALL) 1240STEXI 1241@item -vga @var{type} 1242@findex -vga 1243Select type of VGA card to emulate. Valid values for @var{type} are 1244@table @option 1245@item cirrus 1246Cirrus Logic GD5446 Video card. All Windows versions starting from 1247Windows 95 should recognize and use this graphic card. For optimal 1248performances, use 16 bit color depth in the guest and the host OS. 1249(This card was the default before QEMU 2.2) 1250@item std 1251Standard VGA card with Bochs VBE extensions. If your guest OS 1252supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 1253to use high resolution modes (>= 1280x1024x16) then you should use 1254this option. (This card is the default since QEMU 2.2) 1255@item vmware 1256VMWare SVGA-II compatible adapter. Use it if you have sufficiently 1257recent XFree86/XOrg server or Windows guest with a driver for this 1258card. 1259@item qxl 1260QXL paravirtual graphic card. It is VGA compatible (including VESA 12612.0 VBE support). Works best with qxl guest drivers installed though. 1262Recommended choice when using the spice protocol. 1263@item tcx 1264(sun4m only) Sun TCX framebuffer. This is the default framebuffer for 1265sun4m machines and offers both 8-bit and 24-bit colour depths at a 1266fixed resolution of 1024x768. 1267@item cg3 1268(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer 1269for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) 1270resolutions aimed at people wishing to run older Solaris versions. 1271@item virtio 1272Virtio VGA card. 1273@item none 1274Disable VGA card. 1275@end table 1276ETEXI 1277 1278DEF("full-screen", 0, QEMU_OPTION_full_screen, 1279 "-full-screen start in full screen\n", QEMU_ARCH_ALL) 1280STEXI 1281@item -full-screen 1282@findex -full-screen 1283Start in full screen. 1284ETEXI 1285 1286DEF("g", 1, QEMU_OPTION_g , 1287 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1288 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 1289STEXI 1290@item -g @var{width}x@var{height}[x@var{depth}] 1291@findex -g 1292Set the initial graphical resolution and depth (PPC, SPARC only). 1293ETEXI 1294 1295DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1296 "-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL) 1297STEXI 1298@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 1299@findex -vnc 1300Normally, if QEMU is compiled with graphical window support, it displays 1301output such as guest graphics, guest console, and the QEMU monitor in a 1302window. With this option, you can have QEMU listen on VNC display 1303@var{display} and redirect the VGA display over the VNC session. It is 1304very useful to enable the usb tablet device when using this option 1305(option @option{-usbdevice tablet}). When using the VNC display, you 1306must use the @option{-k} parameter to set the keyboard layout if you are 1307not using en-us. Valid syntax for the @var{display} is 1308 1309@table @option 1310 1311@item to=@var{L} 1312 1313With this option, QEMU will try next available VNC @var{display}s, until the 1314number @var{L}, if the origianlly defined "-vnc @var{display}" is not 1315available, e.g. port 5900+@var{display} is already used by another 1316application. By default, to=0. 1317 1318@item @var{host}:@var{d} 1319 1320TCP connections will only be allowed from @var{host} on display @var{d}. 1321By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 1322be omitted in which case the server will accept connections from any host. 1323 1324@item unix:@var{path} 1325 1326Connections will be allowed over UNIX domain sockets where @var{path} is the 1327location of a unix socket to listen for connections on. 1328 1329@item none 1330 1331VNC is initialized but not started. The monitor @code{change} command 1332can be used to later start the VNC server. 1333 1334@end table 1335 1336Following the @var{display} value there may be one or more @var{option} flags 1337separated by commas. Valid options are 1338 1339@table @option 1340 1341@item reverse 1342 1343Connect to a listening VNC client via a ``reverse'' connection. The 1344client is specified by the @var{display}. For reverse network 1345connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 1346is a TCP port number, not a display number. 1347 1348@item websocket 1349 1350Opens an additional TCP listening port dedicated to VNC Websocket connections. 1351If a bare @var{websocket} option is given, the Websocket port is 13525700+@var{display}. An alternative port can be specified with the 1353syntax @code{websocket}=@var{port}. 1354 1355If @var{host} is specified connections will only be allowed from this host. 1356It is possible to control the websocket listen address independently, using 1357the syntax @code{websocket}=@var{host}:@var{port}. 1358 1359If no TLS credentials are provided, the websocket connection runs in 1360unencrypted mode. If TLS credentials are provided, the websocket connection 1361requires encrypted client connections. 1362 1363@item password 1364 1365Require that password based authentication is used for client connections. 1366 1367The password must be set separately using the @code{set_password} command in 1368the @ref{pcsys_monitor}. The syntax to change your password is: 1369@code{set_password <protocol> <password>} where <protocol> could be either 1370"vnc" or "spice". 1371 1372If you would like to change <protocol> password expiration, you should use 1373@code{expire_password <protocol> <expiration-time>} where expiration time could 1374be one of the following options: now, never, +seconds or UNIX time of 1375expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 1376to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 1377date and time). 1378 1379You can also use keywords "now" or "never" for the expiration time to 1380allow <protocol> password to expire immediately or never expire. 1381 1382@item tls-creds=@var{ID} 1383 1384Provides the ID of a set of TLS credentials to use to secure the 1385VNC server. They will apply to both the normal VNC server socket 1386and the websocket socket (if enabled). Setting TLS credentials 1387will cause the VNC server socket to enable the VeNCrypt auth 1388mechanism. The credentials should have been previously created 1389using the @option{-object tls-creds} argument. 1390 1391The @option{tls-creds} parameter obsoletes the @option{tls}, 1392@option{x509}, and @option{x509verify} options, and as such 1393it is not permitted to set both new and old type options at 1394the same time. 1395 1396@item tls 1397 1398Require that client use TLS when communicating with the VNC server. This 1399uses anonymous TLS credentials so is susceptible to a man-in-the-middle 1400attack. It is recommended that this option be combined with either the 1401@option{x509} or @option{x509verify} options. 1402 1403This option is now deprecated in favor of using the @option{tls-creds} 1404argument. 1405 1406@item x509=@var{/path/to/certificate/dir} 1407 1408Valid if @option{tls} is specified. Require that x509 credentials are used 1409for negotiating the TLS session. The server will send its x509 certificate 1410to the client. It is recommended that a password be set on the VNC server 1411to provide authentication of the client when this is used. The path following 1412this option specifies where the x509 certificates are to be loaded from. 1413See the @ref{vnc_security} section for details on generating certificates. 1414 1415This option is now deprecated in favour of using the @option{tls-creds} 1416argument. 1417 1418@item x509verify=@var{/path/to/certificate/dir} 1419 1420Valid if @option{tls} is specified. Require that x509 credentials are used 1421for negotiating the TLS session. The server will send its x509 certificate 1422to the client, and request that the client send its own x509 certificate. 1423The server will validate the client's certificate against the CA certificate, 1424and reject clients when validation fails. If the certificate authority is 1425trusted, this is a sufficient authentication mechanism. You may still wish 1426to set a password on the VNC server as a second authentication layer. The 1427path following this option specifies where the x509 certificates are to 1428be loaded from. See the @ref{vnc_security} section for details on generating 1429certificates. 1430 1431This option is now deprecated in favour of using the @option{tls-creds} 1432argument. 1433 1434@item sasl 1435 1436Require that the client use SASL to authenticate with the VNC server. 1437The exact choice of authentication method used is controlled from the 1438system / user's SASL configuration file for the 'qemu' service. This 1439is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 1440unprivileged user, an environment variable SASL_CONF_PATH can be used 1441to make it search alternate locations for the service config. 1442While some SASL auth methods can also provide data encryption (eg GSSAPI), 1443it is recommended that SASL always be combined with the 'tls' and 1444'x509' settings to enable use of SSL and server certificates. This 1445ensures a data encryption preventing compromise of authentication 1446credentials. See the @ref{vnc_security} section for details on using 1447SASL authentication. 1448 1449@item acl 1450 1451Turn on access control lists for checking of the x509 client certificate 1452and SASL party. For x509 certs, the ACL check is made against the 1453certificate's distinguished name. This is something that looks like 1454@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 1455made against the username, which depending on the SASL plugin, may 1456include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 1457When the @option{acl} flag is set, the initial access list will be 1458empty, with a @code{deny} policy. Thus no one will be allowed to 1459use the VNC server until the ACLs have been loaded. This can be 1460achieved using the @code{acl} monitor command. 1461 1462@item lossy 1463 1464Enable lossy compression methods (gradient, JPEG, ...). If this 1465option is set, VNC client may receive lossy framebuffer updates 1466depending on its encoding settings. Enabling this option can save 1467a lot of bandwidth at the expense of quality. 1468 1469@item non-adaptive 1470 1471Disable adaptive encodings. Adaptive encodings are enabled by default. 1472An adaptive encoding will try to detect frequently updated screen regions, 1473and send updates in these regions using a lossy encoding (like JPEG). 1474This can be really helpful to save bandwidth when playing videos. Disabling 1475adaptive encodings restores the original static behavior of encodings 1476like Tight. 1477 1478@item share=[allow-exclusive|force-shared|ignore] 1479 1480Set display sharing policy. 'allow-exclusive' allows clients to ask 1481for exclusive access. As suggested by the rfb spec this is 1482implemented by dropping other connections. Connecting multiple 1483clients in parallel requires all clients asking for a shared session 1484(vncviewer: -shared switch). This is the default. 'force-shared' 1485disables exclusive client access. Useful for shared desktop sessions, 1486where you don't want someone forgetting specify -shared disconnect 1487everybody else. 'ignore' completely ignores the shared flag and 1488allows everybody connect unconditionally. Doesn't conform to the rfb 1489spec but is traditional QEMU behavior. 1490 1491@item key-delay-ms 1492 1493Set keyboard delay, for key down and key up events, in milliseconds. 1494Default is 1. Keyboards are low-bandwidth devices, so this slowdown 1495can help the device and guest to keep up and not lose events in case 1496events are arriving in bulk. Possible causes for the latter are flaky 1497network connections, or scripts for automated testing. 1498 1499@end table 1500ETEXI 1501 1502STEXI 1503@end table 1504ETEXI 1505ARCHHEADING(, QEMU_ARCH_I386) 1506 1507ARCHHEADING(i386 target only, QEMU_ARCH_I386) 1508STEXI 1509@table @option 1510ETEXI 1511 1512DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1513 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1514 QEMU_ARCH_I386) 1515STEXI 1516@item -win2k-hack 1517@findex -win2k-hack 1518Use it when installing Windows 2000 to avoid a disk full bug. After 1519Windows 2000 is installed, you no longer need this option (this option 1520slows down the IDE transfers). 1521ETEXI 1522 1523HXCOMM Deprecated by -rtc 1524DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 1525 1526DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1527 "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1528 QEMU_ARCH_I386) 1529STEXI 1530@item -no-fd-bootchk 1531@findex -no-fd-bootchk 1532Disable boot signature checking for floppy disks in BIOS. May 1533be needed to boot from old floppy disks. 1534ETEXI 1535 1536DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1537 "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 1538STEXI 1539@item -no-acpi 1540@findex -no-acpi 1541Disable ACPI (Advanced Configuration and Power Interface) support. Use 1542it if your guest OS complains about ACPI problems (PC target machine 1543only). 1544ETEXI 1545 1546DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1547 "-no-hpet disable HPET\n", QEMU_ARCH_I386) 1548STEXI 1549@item -no-hpet 1550@findex -no-hpet 1551Disable HPET support. 1552ETEXI 1553 1554DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1555 "-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" 1556 " ACPI table description\n", QEMU_ARCH_I386) 1557STEXI 1558@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}]...] 1559@findex -acpitable 1560Add ACPI table with specified header fields and context from specified files. 1561For file=, take whole ACPI table from the specified files, including all 1562ACPI headers (possible overridden by other options). 1563For data=, only data 1564portion of the table is used, all header information is specified in the 1565command line. 1566If a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id 1567fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order 1568to ensure the field matches required by the Microsoft SLIC spec and the ACPI 1569spec. 1570ETEXI 1571 1572DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1573 "-smbios file=binary\n" 1574 " load SMBIOS entry from binary file\n" 1575 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1576 " [,uefi=on|off]\n" 1577 " specify SMBIOS type 0 fields\n" 1578 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1579 " [,uuid=uuid][,sku=str][,family=str]\n" 1580 " specify SMBIOS type 1 fields\n" 1581 "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1582 " [,asset=str][,location=str]\n" 1583 " specify SMBIOS type 2 fields\n" 1584 "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 1585 " [,sku=str]\n" 1586 " specify SMBIOS type 3 fields\n" 1587 "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 1588 " [,asset=str][,part=str]\n" 1589 " specify SMBIOS type 4 fields\n" 1590 "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 1591 " [,asset=str][,part=str][,speed=%d]\n" 1592 " specify SMBIOS type 17 fields\n", 1593 QEMU_ARCH_I386 | QEMU_ARCH_ARM) 1594STEXI 1595@item -smbios file=@var{binary} 1596@findex -smbios 1597Load SMBIOS entry from binary file. 1598 1599@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] 1600Specify SMBIOS type 0 fields 1601 1602@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}] 1603Specify SMBIOS type 1 fields 1604 1605@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}] 1606Specify SMBIOS type 2 fields 1607 1608@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}] 1609Specify SMBIOS type 3 fields 1610 1611@item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}] 1612Specify SMBIOS type 4 fields 1613 1614@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}] 1615Specify SMBIOS type 17 fields 1616ETEXI 1617 1618STEXI 1619@end table 1620ETEXI 1621DEFHEADING() 1622 1623DEFHEADING(Network options) 1624STEXI 1625@table @option 1626ETEXI 1627 1628HXCOMM Legacy slirp options (now moved to -net user): 1629#ifdef CONFIG_SLIRP 1630DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1631DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1632DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1633#ifndef _WIN32 1634DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1635#endif 1636#endif 1637 1638DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1639#ifdef CONFIG_SLIRP 1640 "-netdev user,id=str[,ipv4[=on|off]][,net=addr[/mask]][,host=addr]\n" 1641 " [,ipv6[=on|off]][,ipv6-net=addr[/int]][,ipv6-host=addr]\n" 1642 " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n" 1643 " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,tftp=dir]\n" 1644 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1645#ifndef _WIN32 1646 "[,smb=dir[,smbserver=addr]]\n" 1647#endif 1648 " configure a user mode network backend with ID 'str',\n" 1649 " its DHCP server and optional services\n" 1650#endif 1651#ifdef _WIN32 1652 "-netdev tap,id=str,ifname=name\n" 1653 " configure a host TAP network backend with ID 'str'\n" 1654#else 1655 "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 1656 " [,br=bridge][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 1657 " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 1658 " [,poll-us=n]\n" 1659 " configure a host TAP network backend with ID 'str'\n" 1660 " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 1661 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1662 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1663 " to deconfigure it\n" 1664 " use '[down]script=no' to disable script execution\n" 1665 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1666 " configure it\n" 1667 " use 'fd=h' to connect to an already opened TAP interface\n" 1668 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1669 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1670 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1671 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1672 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 1673 " use vhost=on to enable experimental in kernel accelerator\n" 1674 " (only has effect for virtio guests which use MSIX)\n" 1675 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 1676 " use 'vhostfd=h' to connect to an already opened vhost net device\n" 1677 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1678 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 1679 " use 'poll-us=n' to speciy the maximum number of microseconds that could be\n" 1680 " spent on busy polling for vhost net\n" 1681 "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 1682 " configure a host TAP network backend with ID 'str' that is\n" 1683 " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 1684 " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 1685#endif 1686#ifdef __linux__ 1687 "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 1688 " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n" 1689 " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n" 1690 " [,rxcookie=rxcookie][,offset=offset]\n" 1691 " configure a network backend with ID 'str' connected to\n" 1692 " an Ethernet over L2TPv3 pseudowire.\n" 1693 " Linux kernel 3.3+ as well as most routers can talk\n" 1694 " L2TPv3. This transport allows connecting a VM to a VM,\n" 1695 " VM to a router and even VM to Host. It is a nearly-universal\n" 1696 " standard (RFC3391). Note - this implementation uses static\n" 1697 " pre-configured tunnels (same as the Linux kernel).\n" 1698 " use 'src=' to specify source address\n" 1699 " use 'dst=' to specify destination address\n" 1700 " use 'udp=on' to specify udp encapsulation\n" 1701 " use 'srcport=' to specify source udp port\n" 1702 " use 'dstport=' to specify destination udp port\n" 1703 " use 'ipv6=on' to force v6\n" 1704 " L2TPv3 uses cookies to prevent misconfiguration as\n" 1705 " well as a weak security measure\n" 1706 " use 'rxcookie=0x012345678' to specify a rxcookie\n" 1707 " use 'txcookie=0x012345678' to specify a txcookie\n" 1708 " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 1709 " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 1710 " use 'pincounter=on' to work around broken counter handling in peer\n" 1711 " use 'offset=X' to add an extra offset between header and data\n" 1712#endif 1713 "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 1714 " configure a network backend to connect to another network\n" 1715 " using a socket connection\n" 1716 "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 1717 " configure a network backend to connect to a multicast maddr and port\n" 1718 " use 'localaddr=addr' to specify the host address to send packets from\n" 1719 "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 1720 " configure a network backend to connect to another network\n" 1721 " using an UDP tunnel\n" 1722#ifdef CONFIG_VDE 1723 "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 1724 " configure a network backend to connect to port 'n' of a vde switch\n" 1725 " running on host and listening for incoming connections on 'socketpath'.\n" 1726 " Use group 'groupname' and mode 'octalmode' to change default\n" 1727 " ownership and permissions for communication port.\n" 1728#endif 1729#ifdef CONFIG_NETMAP 1730 "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 1731 " attach to the existing netmap-enabled network interface 'name', or to a\n" 1732 " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 1733 " netmap device, defaults to '/dev/netmap')\n" 1734#endif 1735 "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 1736 " configure a vhost-user network, backed by a chardev 'dev'\n" 1737 "-netdev hubport,id=str,hubid=n\n" 1738 " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL) 1739DEF("net", HAS_ARG, QEMU_OPTION_net, 1740 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 1741 " old way to create a new NIC and connect it to VLAN 'n'\n" 1742 " (use the '-device devtype,netdev=str' option if possible instead)\n" 1743 "-net dump[,vlan=n][,file=f][,len=n]\n" 1744 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1745 "-net none use it alone to have zero network devices. If no -net option\n" 1746 " is provided, the default is '-net nic -net user'\n" 1747 "-net [" 1748#ifdef CONFIG_SLIRP 1749 "user|" 1750#endif 1751 "tap|" 1752 "bridge|" 1753#ifdef CONFIG_VDE 1754 "vde|" 1755#endif 1756#ifdef CONFIG_NETMAP 1757 "netmap|" 1758#endif 1759 "socket][,vlan=n][,option][,option][,...]\n" 1760 " old way to initialize a host network interface\n" 1761 " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 1762STEXI 1763@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 1764@findex -net 1765Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 1766= 0 is the default). The NIC is an e1000 by default on the PC 1767target. Optionally, the MAC address can be changed to @var{mac}, the 1768device address set to @var{addr} (PCI cards only), 1769and a @var{name} can be assigned for use in monitor commands. 1770Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1771that the card should have; this option currently only affects virtio cards; set 1772@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1773NIC is created. QEMU can emulate several different models of network card. 1774Valid values for @var{type} are 1775@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 1776@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 1777@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1778Not all devices are supported on all targets. Use @code{-net nic,model=help} 1779for a list of available devices for your target. 1780 1781@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1782@findex -netdev 1783@item -net user[,@var{option}][,@var{option}][,...] 1784Use the user mode network stack which requires no administrator 1785privilege to run. Valid options are: 1786 1787@table @option 1788@item vlan=@var{n} 1789Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1790 1791@item id=@var{id} 1792@itemx name=@var{name} 1793Assign symbolic name for use in monitor commands. 1794 1795@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must 1796be enabled. If neither is specified both protocols are enabled. 1797 1798@item net=@var{addr}[/@var{mask}] 1799Set IP network address the guest will see. Optionally specify the netmask, 1800either in the form a.b.c.d or as number of valid top-most bits. Default is 180110.0.2.0/24. 1802 1803@item host=@var{addr} 1804Specify the guest-visible address of the host. Default is the 2nd IP in the 1805guest network, i.e. x.x.x.2. 1806 1807@item ipv6-net=@var{addr}[/@var{int}] 1808Set IPv6 network address the guest will see (default is fec0::/64). The 1809network prefix is given in the usual hexadecimal IPv6 address 1810notation. The prefix size is optional, and is given as the number of 1811valid top-most bits (default is 64). 1812 1813@item ipv6-host=@var{addr} 1814Specify the guest-visible IPv6 address of the host. Default is the 2nd IPv6 in 1815the guest network, i.e. xxxx::2. 1816 1817@item restrict=on|off 1818If this option is enabled, the guest will be isolated, i.e. it will not be 1819able to contact the host and no guest IP packets will be routed over the host 1820to the outside. This option does not affect any explicitly set forwarding rules. 1821 1822@item hostname=@var{name} 1823Specifies the client hostname reported by the built-in DHCP server. 1824 1825@item dhcpstart=@var{addr} 1826Specify the first of the 16 IPs the built-in DHCP server can assign. Default 1827is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1828 1829@item dns=@var{addr} 1830Specify the guest-visible address of the virtual nameserver. The address must 1831be different from the host address. Default is the 3rd IP in the guest network, 1832i.e. x.x.x.3. 1833 1834@item ipv6-dns=@var{addr} 1835Specify the guest-visible address of the IPv6 virtual nameserver. The address 1836must be different from the host address. Default is the 3rd IP in the guest 1837network, i.e. xxxx::3. 1838 1839@item dnssearch=@var{domain} 1840Provides an entry for the domain-search list sent by the built-in 1841DHCP server. More than one domain suffix can be transmitted by specifying 1842this option multiple times. If supported, this will cause the guest to 1843automatically try to append the given domain suffix(es) in case a domain name 1844can not be resolved. 1845 1846Example: 1847@example 1848qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 1849@end example 1850 1851@item tftp=@var{dir} 1852When using the user mode network stack, activate a built-in TFTP 1853server. The files in @var{dir} will be exposed as the root of a TFTP server. 1854The TFTP client on the guest must be configured in binary mode (use the command 1855@code{bin} of the Unix TFTP client). 1856 1857@item bootfile=@var{file} 1858When using the user mode network stack, broadcast @var{file} as the BOOTP 1859filename. In conjunction with @option{tftp}, this can be used to network boot 1860a guest from a local directory. 1861 1862Example (using pxelinux): 1863@example 1864qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1865@end example 1866 1867@item smb=@var{dir}[,smbserver=@var{addr}] 1868When using the user mode network stack, activate a built-in SMB 1869server so that Windows OSes can access to the host files in @file{@var{dir}} 1870transparently. The IP address of the SMB server can be set to @var{addr}. By 1871default the 4th IP in the guest network is used, i.e. x.x.x.4. 1872 1873In the guest Windows OS, the line: 1874@example 187510.0.2.4 smbserver 1876@end example 1877must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1878or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1879 1880Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1881 1882Note that a SAMBA server must be installed on the host OS. 1883QEMU was tested successfully with smbd versions from Red Hat 9, 1884Fedora Core 3 and OpenSUSE 11.x. 1885 1886@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1887Redirect incoming TCP or UDP connections to the host port @var{hostport} to 1888the guest IP address @var{guestaddr} on guest port @var{guestport}. If 1889@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 1890given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 1891be bound to a specific host interface. If no connection type is set, TCP is 1892used. This option can be given multiple times. 1893 1894For example, to redirect host X11 connection from screen 1 to guest 1895screen 0, use the following: 1896 1897@example 1898# on the host 1899qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1900# this host xterm should open in the guest X11 server 1901xterm -display :1 1902@end example 1903 1904To redirect telnet connections from host port 5555 to telnet port on 1905the guest, use the following: 1906 1907@example 1908# on the host 1909qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1910telnet localhost 5555 1911@end example 1912 1913Then when you use on the host @code{telnet localhost 5555}, you 1914connect to the guest telnet server. 1915 1916@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1917@itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 1918Forward guest TCP connections to the IP address @var{server} on port @var{port} 1919to the character device @var{dev} or to a program executed by @var{cmd:command} 1920which gets spawned for each connection. This option can be given multiple times. 1921 1922You can either use a chardev directly and have that one used throughout QEMU's 1923lifetime, like in the following example: 1924 1925@example 1926# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1927# the guest accesses it 1928qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1929@end example 1930 1931Or you can execute a command on every TCP connection established by the guest, 1932so that QEMU behaves similar to an inetd process for that virtual server: 1933 1934@example 1935# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1936# and connect the TCP stream to its stdin/stdout 1937qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1938@end example 1939 1940@end table 1941 1942Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1943processed and applied to -net user. Mixing them with the new configuration 1944syntax gives undefined results. Their use for new applications is discouraged 1945as they will be removed from future versions. 1946 1947@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,br=@var{bridge}][,helper=@var{helper}] 1948@itemx -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,br=@var{bridge}][,helper=@var{helper}] 1949Connect the host TAP network interface @var{name} to VLAN @var{n}. 1950 1951Use the network script @var{file} to configure it and the network script 1952@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1953automatically provides one. The default network configure script is 1954@file{/etc/qemu-ifup} and the default network deconfigure script is 1955@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1956to disable script execution. 1957 1958If running QEMU as an unprivileged user, use the network helper 1959@var{helper} to configure the TAP interface and attach it to the bridge. 1960The default network helper executable is @file{/path/to/qemu-bridge-helper} 1961and the default bridge device is @file{br0}. 1962 1963@option{fd}=@var{h} can be used to specify the handle of an already 1964opened host TAP interface. 1965 1966Examples: 1967 1968@example 1969#launch a QEMU instance with the default network script 1970qemu-system-i386 linux.img -net nic -net tap 1971@end example 1972 1973@example 1974#launch a QEMU instance with two NICs, each one connected 1975#to a TAP device 1976qemu-system-i386 linux.img \ 1977 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 1978 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 1979@end example 1980 1981@example 1982#launch a QEMU instance with the default network helper to 1983#connect a TAP device to bridge br0 1984qemu-system-i386 linux.img \ 1985 -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1986@end example 1987 1988@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1989@itemx -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1990Connect a host TAP network interface to a host bridge device. 1991 1992Use the network helper @var{helper} to configure the TAP interface and 1993attach it to the bridge. The default network helper executable is 1994@file{/path/to/qemu-bridge-helper} and the default bridge 1995device is @file{br0}. 1996 1997Examples: 1998 1999@example 2000#launch a QEMU instance with the default network helper to 2001#connect a TAP device to bridge br0 2002qemu-system-i386 linux.img -net bridge -net nic,model=virtio 2003@end example 2004 2005@example 2006#launch a QEMU instance with the default network helper to 2007#connect a TAP device to bridge qemubr0 2008qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 2009@end example 2010 2011@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 2012@itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 2013 2014Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 2015machine using a TCP socket connection. If @option{listen} is 2016specified, QEMU waits for incoming connections on @var{port} 2017(@var{host} is optional). @option{connect} is used to connect to 2018another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 2019specifies an already opened TCP socket. 2020 2021Example: 2022@example 2023# launch a first QEMU instance 2024qemu-system-i386 linux.img \ 2025 -net nic,macaddr=52:54:00:12:34:56 \ 2026 -net socket,listen=:1234 2027# connect the VLAN 0 of this instance to the VLAN 0 2028# of the first instance 2029qemu-system-i386 linux.img \ 2030 -net nic,macaddr=52:54:00:12:34:57 \ 2031 -net socket,connect=127.0.0.1:1234 2032@end example 2033 2034@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 2035@itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 2036 2037Create a VLAN @var{n} shared with another QEMU virtual 2038machines using a UDP multicast socket, effectively making a bus for 2039every QEMU with same multicast address @var{maddr} and @var{port}. 2040NOTES: 2041@enumerate 2042@item 2043Several QEMU can be running on different hosts and share same bus (assuming 2044correct multicast setup for these hosts). 2045@item 2046mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 2047@url{http://user-mode-linux.sf.net}. 2048@item 2049Use @option{fd=h} to specify an already opened UDP multicast socket. 2050@end enumerate 2051 2052Example: 2053@example 2054# launch one QEMU instance 2055qemu-system-i386 linux.img \ 2056 -net nic,macaddr=52:54:00:12:34:56 \ 2057 -net socket,mcast=230.0.0.1:1234 2058# launch another QEMU instance on same "bus" 2059qemu-system-i386 linux.img \ 2060 -net nic,macaddr=52:54:00:12:34:57 \ 2061 -net socket,mcast=230.0.0.1:1234 2062# launch yet another QEMU instance on same "bus" 2063qemu-system-i386 linux.img \ 2064 -net nic,macaddr=52:54:00:12:34:58 \ 2065 -net socket,mcast=230.0.0.1:1234 2066@end example 2067 2068Example (User Mode Linux compat.): 2069@example 2070# launch QEMU instance (note mcast address selected 2071# is UML's default) 2072qemu-system-i386 linux.img \ 2073 -net nic,macaddr=52:54:00:12:34:56 \ 2074 -net socket,mcast=239.192.168.1:1102 2075# launch UML 2076/path/to/linux ubd0=/path/to/root_fs eth0=mcast 2077@end example 2078 2079Example (send packets from host's 1.2.3.4): 2080@example 2081qemu-system-i386 linux.img \ 2082 -net nic,macaddr=52:54:00:12:34:56 \ 2083 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 2084@end example 2085 2086@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}] 2087@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}] 2088Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular 2089protocol to transport Ethernet (and other Layer 2) data frames between 2090two systems. It is present in routers, firewalls and the Linux kernel 2091(from version 3.3 onwards). 2092 2093This transport allows a VM to communicate to another VM, router or firewall directly. 2094 2095@item src=@var{srcaddr} 2096 source address (mandatory) 2097@item dst=@var{dstaddr} 2098 destination address (mandatory) 2099@item udp 2100 select udp encapsulation (default is ip). 2101@item srcport=@var{srcport} 2102 source udp port. 2103@item dstport=@var{dstport} 2104 destination udp port. 2105@item ipv6 2106 force v6, otherwise defaults to v4. 2107@item rxcookie=@var{rxcookie} 2108@itemx txcookie=@var{txcookie} 2109 Cookies are a weak form of security in the l2tpv3 specification. 2110Their function is mostly to prevent misconfiguration. By default they are 32 2111bit. 2112@item cookie64 2113 Set cookie size to 64 bit instead of the default 32 2114@item counter=off 2115 Force a 'cut-down' L2TPv3 with no counter as in 2116draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 2117@item pincounter=on 2118 Work around broken counter handling in peer. This may also help on 2119networks which have packet reorder. 2120@item offset=@var{offset} 2121 Add an extra offset between header and data 2122 2123For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan 2124on the remote Linux host 1.2.3.4: 2125@example 2126# Setup tunnel on linux host using raw ip as encapsulation 2127# on 1.2.3.4 2128ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ 2129 encap udp udp_sport 16384 udp_dport 16384 2130ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ 2131 0xFFFFFFFF peer_session_id 0xFFFFFFFF 2132ifconfig vmtunnel0 mtu 1500 2133ifconfig vmtunnel0 up 2134brctl addif br-lan vmtunnel0 2135 2136 2137# on 4.3.2.1 2138# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 2139 2140qemu-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 2141 2142 2143@end example 2144 2145@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 2146@itemx -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 2147Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 2148listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 2149and MODE @var{octalmode} to change default ownership and permissions for 2150communication port. This option is only available if QEMU has been compiled 2151with vde support enabled. 2152 2153Example: 2154@example 2155# launch vde switch 2156vde_switch -F -sock /tmp/myswitch 2157# launch QEMU instance 2158qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 2159@end example 2160 2161@item -netdev hubport,id=@var{id},hubid=@var{hubid} 2162 2163Create a hub port on QEMU "vlan" @var{hubid}. 2164 2165The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 2166netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 2167required hub automatically. 2168 2169@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n] 2170 2171Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should 2172be a unix domain socket backed one. The vhost-user uses a specifically defined 2173protocol to pass vhost ioctl replacement messages to an application on the other 2174end of the socket. On non-MSIX guests, the feature can be forced with 2175@var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to 2176be created for multiqueue vhost-user. 2177 2178Example: 2179@example 2180qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 2181 -numa node,memdev=mem \ 2182 -chardev socket,id=chr0,path=/path/to/socket \ 2183 -netdev type=vhost-user,id=net0,chardev=chr0 \ 2184 -device virtio-net-pci,netdev=net0 2185@end example 2186 2187@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 2188Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 2189At most @var{len} bytes (64k by default) per packet are stored. The file format is 2190libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 2191Note: For devices created with '-netdev', use '-object filter-dump,...' instead. 2192 2193@item -net none 2194Indicate that no network devices should be configured. It is used to 2195override the default configuration (@option{-net nic -net user}) which 2196is activated if no @option{-net} options are provided. 2197ETEXI 2198 2199STEXI 2200@end table 2201ETEXI 2202DEFHEADING() 2203 2204DEFHEADING(Character device options) 2205STEXI 2206 2207The general form of a character device option is: 2208@table @option 2209ETEXI 2210 2211DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 2212 "-chardev help\n" 2213 "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2214 "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" 2215 " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off]\n" 2216 " [,logfile=PATH][,logappend=on|off][,tls-creds=ID] (tcp)\n" 2217 "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds]\n" 2218 " [,mux=on|off][,logfile=PATH][,logappend=on|off] (unix)\n" 2219 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 2220 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 2221 " [,logfile=PATH][,logappend=on|off]\n" 2222 "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2223 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 2224 " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2225 "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n" 2226 "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2227 "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2228#ifdef _WIN32 2229 "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2230 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2231#else 2232 "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2233 "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n" 2234#endif 2235#ifdef CONFIG_BRLAPI 2236 "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2237#endif 2238#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 2239 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 2240 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2241 "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2242#endif 2243#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 2244 "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2245 "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2246#endif 2247#if defined(CONFIG_SPICE) 2248 "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 2249 "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 2250#endif 2251 , QEMU_ARCH_ALL 2252) 2253 2254STEXI 2255@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 2256@findex -chardev 2257Backend is one of: 2258@option{null}, 2259@option{socket}, 2260@option{udp}, 2261@option{msmouse}, 2262@option{vc}, 2263@option{ringbuf}, 2264@option{file}, 2265@option{pipe}, 2266@option{console}, 2267@option{serial}, 2268@option{pty}, 2269@option{stdio}, 2270@option{braille}, 2271@option{tty}, 2272@option{parallel}, 2273@option{parport}, 2274@option{spicevmc}. 2275@option{spiceport}. 2276The specific backend will determine the applicable options. 2277 2278Use "-chardev help" to print all available chardev backend types. 2279 2280All devices must have an id, which can be any string up to 127 characters long. 2281It is used to uniquely identify this device in other command line directives. 2282 2283A character device may be used in multiplexing mode by multiple front-ends. 2284Specify @option{mux=on} to enable this mode. 2285A multiplexer is a "1:N" device, and here the "1" end is your specified chardev 2286backend, and the "N" end is the various parts of QEMU that can talk to a chardev. 2287If you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will 2288create a multiplexer with your specified ID, and you can then configure multiple 2289front ends to use that chardev ID for their input/output. Up to four different 2290front ends can be connected to a single multiplexed chardev. (Without 2291multiplexing enabled, a chardev can only be used by a single front end.) 2292For instance you could use this to allow a single stdio chardev to be used by 2293two serial ports and the QEMU monitor: 2294 2295@example 2296-chardev stdio,mux=on,id=char0 \ 2297-mon chardev=char0,mode=readline \ 2298-serial chardev:char0 \ 2299-serial chardev:char0 2300@end example 2301 2302You can have more than one multiplexer in a system configuration; for instance 2303you could have a TCP port multiplexed between UART 0 and UART 1, and stdio 2304multiplexed between the QEMU monitor and a parallel port: 2305 2306@example 2307-chardev stdio,mux=on,id=char0 \ 2308-mon chardev=char0,mode=readline \ 2309-parallel chardev:char0 \ 2310-chardev tcp,...,mux=on,id=char1 \ 2311-serial chardev:char1 \ 2312-serial chardev:char1 2313@end example 2314 2315When you're using a multiplexed character device, some escape sequences are 2316interpreted in the input. @xref{mux_keys, Keys in the character backend 2317multiplexer}. 2318 2319Note that some other command line options may implicitly create multiplexed 2320character backends; for instance @option{-serial mon:stdio} creates a 2321multiplexed stdio backend connected to the serial port and the QEMU monitor, 2322and @option{-nographic} also multiplexes the console and the monitor to 2323stdio. 2324 2325There is currently no support for multiplexing in the other direction 2326(where a single QEMU front end takes input and output from multiple chardevs). 2327 2328Every backend supports the @option{logfile} option, which supplies the path 2329to a file to record all data transmitted via the backend. The @option{logappend} 2330option controls whether the log file will be truncated or appended to when 2331opened. 2332 2333Further options to each backend are described below. 2334 2335@item -chardev null ,id=@var{id} 2336A void device. This device will not emit any data, and will drop any data it 2337receives. The null backend does not take any options. 2338 2339@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] [,tls-creds=@var{id}] 2340 2341Create a two-way stream socket, which can be either a TCP or a unix socket. A 2342unix socket will be created if @option{path} is specified. Behaviour is 2343undefined if TCP options are specified for a unix socket. 2344 2345@option{server} specifies that the socket shall be a listening socket. 2346 2347@option{nowait} specifies that QEMU should not block waiting for a client to 2348connect to a listening socket. 2349 2350@option{telnet} specifies that traffic on the socket should interpret telnet 2351escape sequences. 2352 2353@option{reconnect} sets the timeout for reconnecting on non-server sockets when 2354the remote end goes away. qemu will delay this many seconds and then attempt 2355to reconnect. Zero disables reconnecting, and is the default. 2356 2357@option{tls-creds} requests enablement of the TLS protocol for encryption, 2358and specifies the id of the TLS credentials to use for the handshake. The 2359credentials must be previously created with the @option{-object tls-creds} 2360argument. 2361 2362TCP and unix socket options are given below: 2363 2364@table @option 2365 2366@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 2367 2368@option{host} for a listening socket specifies the local address to be bound. 2369For a connecting socket species the remote host to connect to. @option{host} is 2370optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 2371 2372@option{port} for a listening socket specifies the local port to be bound. For a 2373connecting socket specifies the port on the remote host to connect to. 2374@option{port} can be given as either a port number or a service name. 2375@option{port} is required. 2376 2377@option{to} is only relevant to listening sockets. If it is specified, and 2378@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 2379to and including @option{to} until it succeeds. @option{to} must be specified 2380as a port number. 2381 2382@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 2383If neither is specified the socket may use either protocol. 2384 2385@option{nodelay} disables the Nagle algorithm. 2386 2387@item unix options: path=@var{path} 2388 2389@option{path} specifies the local path of the unix socket. @option{path} is 2390required. 2391 2392@end table 2393 2394@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 2395 2396Sends all traffic from the guest to a remote host over UDP. 2397 2398@option{host} specifies the remote host to connect to. If not specified it 2399defaults to @code{localhost}. 2400 2401@option{port} specifies the port on the remote host to connect to. @option{port} 2402is required. 2403 2404@option{localaddr} specifies the local address to bind to. If not specified it 2405defaults to @code{0.0.0.0}. 2406 2407@option{localport} specifies the local port to bind to. If not specified any 2408available local port will be used. 2409 2410@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 2411If neither is specified the device may use either protocol. 2412 2413@item -chardev msmouse ,id=@var{id} 2414 2415Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 2416take any options. 2417 2418@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 2419 2420Connect to a QEMU text console. @option{vc} may optionally be given a specific 2421size. 2422 2423@option{width} and @option{height} specify the width and height respectively of 2424the console, in pixels. 2425 2426@option{cols} and @option{rows} specify that the console be sized to fit a text 2427console with the given dimensions. 2428 2429@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 2430 2431Create a ring buffer with fixed size @option{size}. 2432@var{size} must be a power of two and defaults to @code{64K}. 2433 2434@item -chardev file ,id=@var{id} ,path=@var{path} 2435 2436Log all traffic received from the guest to a file. 2437 2438@option{path} specifies the path of the file to be opened. This file will be 2439created if it does not already exist, and overwritten if it does. @option{path} 2440is required. 2441 2442@item -chardev pipe ,id=@var{id} ,path=@var{path} 2443 2444Create a two-way connection to the guest. The behaviour differs slightly between 2445Windows hosts and other hosts: 2446 2447On Windows, a single duplex pipe will be created at 2448@file{\\.pipe\@option{path}}. 2449 2450On other hosts, 2 pipes will be created called @file{@option{path}.in} and 2451@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 2452received by the guest. Data written by the guest can be read from 2453@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 2454be present. 2455 2456@option{path} forms part of the pipe path as described above. @option{path} is 2457required. 2458 2459@item -chardev console ,id=@var{id} 2460 2461Send traffic from the guest to QEMU's standard output. @option{console} does not 2462take any options. 2463 2464@option{console} is only available on Windows hosts. 2465 2466@item -chardev serial ,id=@var{id} ,path=@option{path} 2467 2468Send traffic from the guest to a serial device on the host. 2469 2470On Unix hosts serial will actually accept any tty device, 2471not only serial lines. 2472 2473@option{path} specifies the name of the serial device to open. 2474 2475@item -chardev pty ,id=@var{id} 2476 2477Create a new pseudo-terminal on the host and connect to it. @option{pty} does 2478not take any options. 2479 2480@option{pty} is not available on Windows hosts. 2481 2482@item -chardev stdio ,id=@var{id} [,signal=on|off] 2483Connect to standard input and standard output of the QEMU process. 2484 2485@option{signal} controls if signals are enabled on the terminal, that includes 2486exiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2487default, use @option{signal=off} to disable it. 2488 2489@item -chardev braille ,id=@var{id} 2490 2491Connect to a local BrlAPI server. @option{braille} does not take any options. 2492 2493@item -chardev tty ,id=@var{id} ,path=@var{path} 2494 2495@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2496DragonFlyBSD hosts. It is an alias for @option{serial}. 2497 2498@option{path} specifies the path to the tty. @option{path} is required. 2499 2500@item -chardev parallel ,id=@var{id} ,path=@var{path} 2501@itemx -chardev parport ,id=@var{id} ,path=@var{path} 2502 2503@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 2504 2505Connect to a local parallel port. 2506 2507@option{path} specifies the path to the parallel port device. @option{path} is 2508required. 2509 2510@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2511 2512@option{spicevmc} is only available when spice support is built in. 2513 2514@option{debug} debug level for spicevmc 2515 2516@option{name} name of spice channel to connect to 2517 2518Connect to a spice virtual machine channel, such as vdiport. 2519 2520@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2521 2522@option{spiceport} is only available when spice support is built in. 2523 2524@option{debug} debug level for spicevmc 2525 2526@option{name} name of spice port to connect to 2527 2528Connect to a spice port, allowing a Spice client to handle the traffic 2529identified by a name (preferably a fqdn). 2530ETEXI 2531 2532STEXI 2533@end table 2534ETEXI 2535DEFHEADING() 2536 2537DEFHEADING(Device URL Syntax) 2538STEXI 2539 2540In addition to using normal file images for the emulated storage devices, 2541QEMU can also use networked resources such as iSCSI devices. These are 2542specified using a special URL syntax. 2543 2544@table @option 2545@item iSCSI 2546iSCSI support allows QEMU to access iSCSI resources directly and use as 2547images for the guest storage. Both disk and cdrom images are supported. 2548 2549Syntax for specifying iSCSI LUNs is 2550``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 2551 2552By default qemu will use the iSCSI initiator-name 2553'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 2554line or a configuration file. 2555 2556Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect 2557stalled requests and force a reestablishment of the session. The timeout 2558is specified in seconds. The default is 0 which means no timeout. Libiscsi 25591.15.0 or greater is required for this feature. 2560 2561Example (without authentication): 2562@example 2563qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2564 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2565 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2566@end example 2567 2568Example (CHAP username/password via URL): 2569@example 2570qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 2571@end example 2572 2573Example (CHAP username/password via environment variables): 2574@example 2575LIBISCSI_CHAP_USERNAME="user" \ 2576LIBISCSI_CHAP_PASSWORD="password" \ 2577qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2578@end example 2579 2580iSCSI support is an optional feature of QEMU and only available when 2581compiled and linked against libiscsi. 2582ETEXI 2583DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2584 "-iscsi [user=user][,password=password]\n" 2585 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 2586 " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 2587 " [,timeout=timeout]\n" 2588 " iSCSI session parameters\n", QEMU_ARCH_ALL) 2589STEXI 2590 2591iSCSI parameters such as username and password can also be specified via 2592a configuration file. See qemu-doc for more information and examples. 2593 2594@item NBD 2595QEMU supports NBD (Network Block Devices) both using TCP protocol as well 2596as Unix Domain Sockets. 2597 2598Syntax for specifying a NBD device using TCP 2599``nbd:<server-ip>:<port>[:exportname=<export>]'' 2600 2601Syntax for specifying a NBD device using Unix Domain Sockets 2602``nbd:unix:<domain-socket>[:exportname=<export>]'' 2603 2604 2605Example for TCP 2606@example 2607qemu-system-i386 --drive file=nbd:192.0.2.1:30000 2608@end example 2609 2610Example for Unix Domain Sockets 2611@example 2612qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 2613@end example 2614 2615@item SSH 2616QEMU supports SSH (Secure Shell) access to remote disks. 2617 2618Examples: 2619@example 2620qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 2621qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 2622@end example 2623 2624Currently authentication must be done using ssh-agent. Other 2625authentication methods may be supported in future. 2626 2627@item Sheepdog 2628Sheepdog is a distributed storage system for QEMU. 2629QEMU supports using either local sheepdog devices or remote networked 2630devices. 2631 2632Syntax for specifying a sheepdog device 2633@example 2634sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 2635@end example 2636 2637Example 2638@example 2639qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2640@end example 2641 2642See also @url{https://sheepdog.github.io/sheepdog/}. 2643 2644@item GlusterFS 2645GlusterFS is a user space distributed file system. 2646QEMU supports the use of GlusterFS volumes for hosting VM disk images using 2647TCP, Unix Domain Sockets and RDMA transport protocols. 2648 2649Syntax for specifying a VM disk image on GlusterFS volume is 2650@example 2651 2652URI: 2653gluster[+type]://[host[:port]]/volume/path[?socket=...][,debug=N][,logfile=...] 2654 2655JSON: 2656'json:@{"driver":"qcow2","file":@{"driver":"gluster","volume":"testvol","path":"a.img","debug":N,"logfile":"...", 2657@ "server":[@{"type":"tcp","host":"...","port":"..."@}, 2658@ @{"type":"unix","socket":"..."@}]@}@}' 2659@end example 2660 2661 2662Example 2663@example 2664URI: 2665qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img, 2666@ file.debug=9,file.logfile=/var/log/qemu-gluster.log 2667 2668JSON: 2669qemu-system-x86_64 'json:@{"driver":"qcow2", 2670@ "file":@{"driver":"gluster", 2671@ "volume":"testvol","path":"a.img", 2672@ "debug":9,"logfile":"/var/log/qemu-gluster.log", 2673@ "server":[@{"type":"tcp","host":"1.2.3.4","port":24007@}, 2674@ @{"type":"unix","socket":"/var/run/glusterd.socket"@}]@}@}' 2675qemu-system-x86_64 -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img, 2676@ file.debug=9,file.logfile=/var/log/qemu-gluster.log, 2677@ file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007, 2678@ file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket 2679@end example 2680 2681See also @url{http://www.gluster.org}. 2682 2683@item HTTP/HTTPS/FTP/FTPS 2684QEMU supports read-only access to files accessed over http(s) and ftp(s). 2685 2686Syntax using a single filename: 2687@example 2688<protocol>://[<username>[:<password>]@@]<host>/<path> 2689@end example 2690 2691where: 2692@table @option 2693@item protocol 2694'http', 'https', 'ftp', or 'ftps'. 2695 2696@item username 2697Optional username for authentication to the remote server. 2698 2699@item password 2700Optional password for authentication to the remote server. 2701 2702@item host 2703Address of the remote server. 2704 2705@item path 2706Path on the remote server, including any query string. 2707@end table 2708 2709The following options are also supported: 2710@table @option 2711@item url 2712The full URL when passing options to the driver explicitly. 2713 2714@item readahead 2715The amount of data to read ahead with each range request to the remote server. 2716This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it 2717does not have a suffix, it will be assumed to be in bytes. The value must be a 2718multiple of 512 bytes. It defaults to 256k. 2719 2720@item sslverify 2721Whether to verify the remote server's certificate when connecting over SSL. It 2722can have the value 'on' or 'off'. It defaults to 'on'. 2723 2724@item cookie 2725Send this cookie (it can also be a list of cookies separated by ';') with 2726each outgoing request. Only supported when using protocols such as HTTP 2727which support cookies, otherwise ignored. 2728 2729@item timeout 2730Set the timeout in seconds of the CURL connection. This timeout is the time 2731that CURL waits for a response from the remote server to get the size of the 2732image to be downloaded. If not set, the default timeout of 5 seconds is used. 2733@end table 2734 2735Note that when passing options to qemu explicitly, @option{driver} is the value 2736of <protocol>. 2737 2738Example: boot from a remote Fedora 20 live ISO image 2739@example 2740qemu-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 2741 2742qemu-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 2743@end example 2744 2745Example: boot from a remote Fedora 20 cloud image using a local overlay for 2746writes, copy-on-read, and a readahead of 64k 2747@example 2748qemu-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 2749 2750qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on 2751@end example 2752 2753Example: boot from an image stored on a VMware vSphere server with a self-signed 2754certificate using a local overlay for writes, a readahead of 64k and a timeout 2755of 10 seconds. 2756@example 2757qemu-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 2758 2759qemu-system-x86_64 -drive file=/tmp/test.qcow2 2760@end example 2761ETEXI 2762 2763STEXI 2764@end table 2765ETEXI 2766 2767DEFHEADING(Bluetooth(R) options) 2768STEXI 2769@table @option 2770ETEXI 2771 2772DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 2773 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 2774 "-bt hci,host[:id]\n" \ 2775 " use host's HCI with the given name\n" \ 2776 "-bt hci[,vlan=n]\n" \ 2777 " emulate a standard HCI in virtual scatternet 'n'\n" \ 2778 "-bt vhci[,vlan=n]\n" \ 2779 " add host computer to virtual scatternet 'n' using VHCI\n" \ 2780 "-bt device:dev[,vlan=n]\n" \ 2781 " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2782 QEMU_ARCH_ALL) 2783STEXI 2784@item -bt hci[...] 2785@findex -bt 2786Defines the function of the corresponding Bluetooth HCI. -bt options 2787are matched with the HCIs present in the chosen machine type. For 2788example when emulating a machine with only one HCI built into it, only 2789the first @code{-bt hci[...]} option is valid and defines the HCI's 2790logic. The Transport Layer is decided by the machine type. Currently 2791the machines @code{n800} and @code{n810} have one HCI and all other 2792machines have none. 2793 2794@anchor{bt-hcis} 2795The following three types are recognized: 2796 2797@table @option 2798@item -bt hci,null 2799(default) The corresponding Bluetooth HCI assumes no internal logic 2800and will not respond to any HCI commands or emit events. 2801 2802@item -bt hci,host[:@var{id}] 2803(@code{bluez} only) The corresponding HCI passes commands / events 2804to / from the physical HCI identified by the name @var{id} (default: 2805@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 2806capable systems like Linux. 2807 2808@item -bt hci[,vlan=@var{n}] 2809Add a virtual, standard HCI that will participate in the Bluetooth 2810scatternet @var{n} (default @code{0}). Similarly to @option{-net} 2811VLANs, devices inside a bluetooth network @var{n} can only communicate 2812with other devices in the same network (scatternet). 2813@end table 2814 2815@item -bt vhci[,vlan=@var{n}] 2816(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 2817to the host bluetooth stack instead of to the emulated target. This 2818allows the host and target machines to participate in a common scatternet 2819and communicate. Requires the Linux @code{vhci} driver installed. Can 2820be used as following: 2821 2822@example 2823qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 2824@end example 2825 2826@item -bt device:@var{dev}[,vlan=@var{n}] 2827Emulate a bluetooth device @var{dev} and place it in network @var{n} 2828(default @code{0}). QEMU can only emulate one type of bluetooth devices 2829currently: 2830 2831@table @option 2832@item keyboard 2833Virtual wireless keyboard implementing the HIDP bluetooth profile. 2834@end table 2835ETEXI 2836 2837STEXI 2838@end table 2839ETEXI 2840DEFHEADING() 2841 2842#ifdef CONFIG_TPM 2843DEFHEADING(TPM device options) 2844 2845DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 2846 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 2847 " use path to provide path to a character device; default is /dev/tpm0\n" 2848 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 2849 " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2850 QEMU_ARCH_ALL) 2851STEXI 2852 2853The general form of a TPM device option is: 2854@table @option 2855 2856@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2857@findex -tpmdev 2858Backend type must be: 2859@option{passthrough}. 2860 2861The specific backend type will determine the applicable options. 2862The @code{-tpmdev} option creates the TPM backend and requires a 2863@code{-device} option that specifies the TPM frontend interface model. 2864 2865Options to each backend are described below. 2866 2867Use 'help' to print all available TPM backend types. 2868@example 2869qemu -tpmdev help 2870@end example 2871 2872@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 2873 2874(Linux-host only) Enable access to the host's TPM using the passthrough 2875driver. 2876 2877@option{path} specifies the path to the host's TPM device, i.e., on 2878a Linux host this would be @code{/dev/tpm0}. 2879@option{path} is optional and by default @code{/dev/tpm0} is used. 2880 2881@option{cancel-path} specifies the path to the host TPM device's sysfs 2882entry allowing for cancellation of an ongoing TPM command. 2883@option{cancel-path} is optional and by default QEMU will search for the 2884sysfs entry to use. 2885 2886Some notes about using the host's TPM with the passthrough driver: 2887 2888The TPM device accessed by the passthrough driver must not be 2889used by any other application on the host. 2890 2891Since the host's firmware (BIOS/UEFI) has already initialized the TPM, 2892the VM's firmware (BIOS/UEFI) will not be able to initialize the 2893TPM again and may therefore not show a TPM-specific menu that would 2894otherwise allow the user to configure the TPM, e.g., allow the user to 2895enable/disable or activate/deactivate the TPM. 2896Further, if TPM ownership is released from within a VM then the host's TPM 2897will get disabled and deactivated. To enable and activate the 2898TPM again afterwards, the host has to be rebooted and the user is 2899required to enter the firmware's menu to enable and activate the TPM. 2900If the TPM is left disabled and/or deactivated most TPM commands will fail. 2901 2902To create a passthrough TPM use the following two options: 2903@example 2904-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 2905@end example 2906Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by 2907@code{tpmdev=tpm0} in the device option. 2908 2909@end table 2910 2911ETEXI 2912 2913DEFHEADING() 2914 2915#endif 2916 2917DEFHEADING(Linux/Multiboot boot specific) 2918STEXI 2919 2920When using these options, you can use a given Linux or Multiboot 2921kernel without installing it in the disk image. It can be useful 2922for easier testing of various kernels. 2923 2924@table @option 2925ETEXI 2926 2927DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2928 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 2929STEXI 2930@item -kernel @var{bzImage} 2931@findex -kernel 2932Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel 2933or in multiboot format. 2934ETEXI 2935 2936DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2937 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 2938STEXI 2939@item -append @var{cmdline} 2940@findex -append 2941Use @var{cmdline} as kernel command line 2942ETEXI 2943 2944DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2945 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 2946STEXI 2947@item -initrd @var{file} 2948@findex -initrd 2949Use @var{file} as initial ram disk. 2950 2951@item -initrd "@var{file1} arg=foo,@var{file2}" 2952 2953This syntax is only available with multiboot. 2954 2955Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 2956first module. 2957ETEXI 2958 2959DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2960 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2961STEXI 2962@item -dtb @var{file} 2963@findex -dtb 2964Use @var{file} as a device tree binary (dtb) image and pass it to the kernel 2965on boot. 2966ETEXI 2967 2968STEXI 2969@end table 2970ETEXI 2971DEFHEADING() 2972 2973DEFHEADING(Debug/Expert options) 2974STEXI 2975@table @option 2976ETEXI 2977 2978DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 2979 "-fw_cfg [name=]<name>,file=<file>\n" 2980 " add named fw_cfg entry with contents from file\n" 2981 "-fw_cfg [name=]<name>,string=<str>\n" 2982 " add named fw_cfg entry with contents from string\n", 2983 QEMU_ARCH_ALL) 2984STEXI 2985 2986@item -fw_cfg [name=]@var{name},file=@var{file} 2987@findex -fw_cfg 2988Add named fw_cfg entry with contents from file @var{file}. 2989 2990@item -fw_cfg [name=]@var{name},string=@var{str} 2991Add named fw_cfg entry with contents from string @var{str}. 2992 2993The terminating NUL character of the contents of @var{str} will not be 2994included as part of the fw_cfg item data. To insert contents with 2995embedded NUL characters, you have to use the @var{file} parameter. 2996 2997The fw_cfg entries are passed by QEMU through to the guest. 2998 2999Example: 3000@example 3001 -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin 3002@end example 3003creates an fw_cfg entry named opt/com.mycompany/blob with contents 3004from ./my_blob.bin. 3005 3006ETEXI 3007 3008DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 3009 "-serial dev redirect the serial port to char device 'dev'\n", 3010 QEMU_ARCH_ALL) 3011STEXI 3012@item -serial @var{dev} 3013@findex -serial 3014Redirect the virtual serial port to host character device 3015@var{dev}. The default device is @code{vc} in graphical mode and 3016@code{stdio} in non graphical mode. 3017 3018This option can be used several times to simulate up to 4 serial 3019ports. 3020 3021Use @code{-serial none} to disable all serial ports. 3022 3023Available character devices are: 3024@table @option 3025@item vc[:@var{W}x@var{H}] 3026Virtual console. Optionally, a width and height can be given in pixel with 3027@example 3028vc:800x600 3029@end example 3030It is also possible to specify width or height in characters: 3031@example 3032vc:80Cx24C 3033@end example 3034@item pty 3035[Linux only] Pseudo TTY (a new PTY is automatically allocated) 3036@item none 3037No device is allocated. 3038@item null 3039void device 3040@item chardev:@var{id} 3041Use a named character device defined with the @code{-chardev} option. 3042@item /dev/XXX 3043[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 3044parameters are set according to the emulated ones. 3045@item /dev/parport@var{N} 3046[Linux only, parallel port only] Use host parallel port 3047@var{N}. Currently SPP and EPP parallel port features can be used. 3048@item file:@var{filename} 3049Write output to @var{filename}. No character can be read. 3050@item stdio 3051[Unix only] standard input/output 3052@item pipe:@var{filename} 3053name pipe @var{filename} 3054@item COM@var{n} 3055[Windows only] Use host serial port @var{n} 3056@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 3057This implements UDP Net Console. 3058When @var{remote_host} or @var{src_ip} are not specified 3059they default to @code{0.0.0.0}. 3060When not using a specified @var{src_port} a random port is automatically chosen. 3061 3062If you just want a simple readonly console you can use @code{netcat} or 3063@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 3064@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 3065will appear in the netconsole session. 3066 3067If you plan to send characters back via netconsole or you want to stop 3068and start QEMU a lot of times, you should have QEMU use the same 3069source port each time by using something like @code{-serial 3070udp::4555@@:4556} to QEMU. Another approach is to use a patched 3071version of netcat which can listen to a TCP port and send and receive 3072characters via udp. If you have a patched version of netcat which 3073activates telnet remote echo and single char transfer, then you can 3074use the following options to set up a netcat redirector to allow 3075telnet on port 5555 to access the QEMU port. 3076@table @code 3077@item QEMU Options: 3078-serial udp::4555@@:4556 3079@item netcat options: 3080-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 3081@item telnet options: 3082localhost 5555 3083@end table 3084 3085@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] 3086The TCP Net Console has two modes of operation. It can send the serial 3087I/O to a location or wait for a connection from a location. By default 3088the TCP Net Console is sent to @var{host} at the @var{port}. If you use 3089the @var{server} option QEMU will wait for a client socket application 3090to connect to the port before continuing, unless the @code{nowait} 3091option was specified. The @code{nodelay} option disables the Nagle buffering 3092algorithm. The @code{reconnect} option only applies if @var{noserver} is 3093set, if the connection goes down it will attempt to reconnect at the 3094given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only 3095one TCP connection at a time is accepted. You can use @code{telnet} to 3096connect to the corresponding character device. 3097@table @code 3098@item Example to send tcp console to 192.168.0.2 port 4444 3099-serial tcp:192.168.0.2:4444 3100@item Example to listen and wait on port 4444 for connection 3101-serial tcp::4444,server 3102@item Example to not wait and listen on ip 192.168.0.100 port 4444 3103-serial tcp:192.168.0.100:4444,server,nowait 3104@end table 3105 3106@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 3107The telnet protocol is used instead of raw tcp sockets. The options 3108work the same as if you had specified @code{-serial tcp}. The 3109difference is that the port acts like a telnet server or client using 3110telnet option negotiation. This will also allow you to send the 3111MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 3112sequence. Typically in unix telnet you do it with Control-] and then 3113type "send break" followed by pressing the enter key. 3114 3115@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] 3116A unix domain socket is used instead of a tcp socket. The option works the 3117same as if you had specified @code{-serial tcp} except the unix domain socket 3118@var{path} is used for connections. 3119 3120@item mon:@var{dev_string} 3121This is a special option to allow the monitor to be multiplexed onto 3122another serial port. The monitor is accessed with key sequence of 3123@key{Control-a} and then pressing @key{c}. 3124@var{dev_string} should be any one of the serial devices specified 3125above. An example to multiplex the monitor onto a telnet server 3126listening on port 4444 would be: 3127@table @code 3128@item -serial mon:telnet::4444,server,nowait 3129@end table 3130When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 3131QEMU any more but will be passed to the guest instead. 3132 3133@item braille 3134Braille device. This will use BrlAPI to display the braille output on a real 3135or fake device. 3136 3137@item msmouse 3138Three button serial mouse. Configure the guest to use Microsoft protocol. 3139@end table 3140ETEXI 3141 3142DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 3143 "-parallel dev redirect the parallel port to char device 'dev'\n", 3144 QEMU_ARCH_ALL) 3145STEXI 3146@item -parallel @var{dev} 3147@findex -parallel 3148Redirect the virtual parallel port to host device @var{dev} (same 3149devices as the serial port). On Linux hosts, @file{/dev/parportN} can 3150be used to use hardware devices connected on the corresponding host 3151parallel port. 3152 3153This option can be used several times to simulate up to 3 parallel 3154ports. 3155 3156Use @code{-parallel none} to disable all parallel ports. 3157ETEXI 3158 3159DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 3160 "-monitor dev redirect the monitor to char device 'dev'\n", 3161 QEMU_ARCH_ALL) 3162STEXI 3163@item -monitor @var{dev} 3164@findex -monitor 3165Redirect the monitor to host device @var{dev} (same devices as the 3166serial port). 3167The default device is @code{vc} in graphical mode and @code{stdio} in 3168non graphical mode. 3169Use @code{-monitor none} to disable the default monitor. 3170ETEXI 3171DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 3172 "-qmp dev like -monitor but opens in 'control' mode\n", 3173 QEMU_ARCH_ALL) 3174STEXI 3175@item -qmp @var{dev} 3176@findex -qmp 3177Like -monitor but opens in 'control' mode. 3178ETEXI 3179DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 3180 "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 3181 QEMU_ARCH_ALL) 3182STEXI 3183@item -qmp-pretty @var{dev} 3184@findex -qmp-pretty 3185Like -qmp but uses pretty JSON formatting. 3186ETEXI 3187 3188DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 3189 "-mon [chardev=]name[,mode=readline|control]\n", QEMU_ARCH_ALL) 3190STEXI 3191@item -mon [chardev=]name[,mode=readline|control] 3192@findex -mon 3193Setup monitor on chardev @var{name}. 3194ETEXI 3195 3196DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 3197 "-debugcon dev redirect the debug console to char device 'dev'\n", 3198 QEMU_ARCH_ALL) 3199STEXI 3200@item -debugcon @var{dev} 3201@findex -debugcon 3202Redirect the debug console to host device @var{dev} (same devices as the 3203serial port). The debug console is an I/O port which is typically port 32040xe9; writing to that I/O port sends output to this device. 3205The default device is @code{vc} in graphical mode and @code{stdio} in 3206non graphical mode. 3207ETEXI 3208 3209DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 3210 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 3211STEXI 3212@item -pidfile @var{file} 3213@findex -pidfile 3214Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 3215from a script. 3216ETEXI 3217 3218DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 3219 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 3220STEXI 3221@item -singlestep 3222@findex -singlestep 3223Run the emulation in single step mode. 3224ETEXI 3225 3226DEF("S", 0, QEMU_OPTION_S, \ 3227 "-S freeze CPU at startup (use 'c' to start execution)\n", 3228 QEMU_ARCH_ALL) 3229STEXI 3230@item -S 3231@findex -S 3232Do not start CPU at startup (you must type 'c' in the monitor). 3233ETEXI 3234 3235DEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 3236 "-realtime [mlock=on|off]\n" 3237 " run qemu with realtime features\n" 3238 " mlock=on|off controls mlock support (default: on)\n", 3239 QEMU_ARCH_ALL) 3240STEXI 3241@item -realtime mlock=on|off 3242@findex -realtime 3243Run qemu with realtime features. 3244mlocking qemu and guest memory can be enabled via @option{mlock=on} 3245(enabled by default). 3246ETEXI 3247 3248DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 3249 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 3250STEXI 3251@item -gdb @var{dev} 3252@findex -gdb 3253Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 3254connections will likely be TCP-based, but also UDP, pseudo TTY, or even 3255stdio are reasonable use case. The latter is allowing to start QEMU from 3256within gdb and establish the connection via a pipe: 3257@example 3258(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 3259@end example 3260ETEXI 3261 3262DEF("s", 0, QEMU_OPTION_s, \ 3263 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 3264 QEMU_ARCH_ALL) 3265STEXI 3266@item -s 3267@findex -s 3268Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 3269(@pxref{gdb_usage}). 3270ETEXI 3271 3272DEF("d", HAS_ARG, QEMU_OPTION_d, \ 3273 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 3274 QEMU_ARCH_ALL) 3275STEXI 3276@item -d @var{item1}[,...] 3277@findex -d 3278Enable logging of specified items. Use '-d help' for a list of log items. 3279ETEXI 3280 3281DEF("D", HAS_ARG, QEMU_OPTION_D, \ 3282 "-D logfile output log to logfile (default stderr)\n", 3283 QEMU_ARCH_ALL) 3284STEXI 3285@item -D @var{logfile} 3286@findex -D 3287Output log in @var{logfile} instead of to stderr 3288ETEXI 3289 3290DEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \ 3291 "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n", 3292 QEMU_ARCH_ALL) 3293STEXI 3294@item -dfilter @var{range1}[,...] 3295@findex -dfilter 3296Filter debug output to that relevant to a range of target addresses. The filter 3297spec can be either @var{start}+@var{size}, @var{start}-@var{size} or 3298@var{start}..@var{end} where @var{start} @var{end} and @var{size} are the 3299addresses and sizes required. For example: 3300@example 3301 -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000 3302@end example 3303Will dump output for any code in the 0x1000 sized block starting at 0x8000 and 3304the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized 3305block starting at 0xffffffc00005f000. 3306ETEXI 3307 3308DEF("L", HAS_ARG, QEMU_OPTION_L, \ 3309 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 3310 QEMU_ARCH_ALL) 3311STEXI 3312@item -L @var{path} 3313@findex -L 3314Set the directory for the BIOS, VGA BIOS and keymaps. 3315 3316To list all the data directories, use @code{-L help}. 3317ETEXI 3318 3319DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 3320 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 3321STEXI 3322@item -bios @var{file} 3323@findex -bios 3324Set the filename for the BIOS. 3325ETEXI 3326 3327DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 3328 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 3329STEXI 3330@item -enable-kvm 3331@findex -enable-kvm 3332Enable KVM full virtualization support. This option is only available 3333if KVM support is enabled when compiling. 3334ETEXI 3335 3336DEF("enable-hax", 0, QEMU_OPTION_enable_hax, \ 3337 "-enable-hax enable HAX virtualization support\n", QEMU_ARCH_I386) 3338STEXI 3339@item -enable-hax 3340@findex -enable-hax 3341Enable HAX (Hardware-based Acceleration eXecution) support. This option 3342is only available if HAX support is enabled when compiling. HAX is only 3343applicable to MAC and Windows platform, and thus does not conflict with 3344KVM. 3345ETEXI 3346 3347DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 3348 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 3349DEF("xen-create", 0, QEMU_OPTION_xen_create, 3350 "-xen-create create domain using xen hypercalls, bypassing xend\n" 3351 " warning: should not be used when xend is in use\n", 3352 QEMU_ARCH_ALL) 3353DEF("xen-attach", 0, QEMU_OPTION_xen_attach, 3354 "-xen-attach attach to existing xen domain\n" 3355 " xend will use this when starting QEMU\n", 3356 QEMU_ARCH_ALL) 3357STEXI 3358@item -xen-domid @var{id} 3359@findex -xen-domid 3360Specify xen guest domain @var{id} (XEN only). 3361@item -xen-create 3362@findex -xen-create 3363Create domain using xen hypercalls, bypassing xend. 3364Warning: should not be used when xend is in use (XEN only). 3365@item -xen-attach 3366@findex -xen-attach 3367Attach to existing xen domain. 3368xend will use this when starting QEMU (XEN only). 3369ETEXI 3370 3371DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 3372 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 3373STEXI 3374@item -no-reboot 3375@findex -no-reboot 3376Exit instead of rebooting. 3377ETEXI 3378 3379DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 3380 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 3381STEXI 3382@item -no-shutdown 3383@findex -no-shutdown 3384Don't exit QEMU on guest shutdown, but instead only stop the emulation. 3385This allows for instance switching to monitor to commit changes to the 3386disk image. 3387ETEXI 3388 3389DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 3390 "-loadvm [tag|id]\n" \ 3391 " start right away with a saved state (loadvm in monitor)\n", 3392 QEMU_ARCH_ALL) 3393STEXI 3394@item -loadvm @var{file} 3395@findex -loadvm 3396Start right away with a saved state (@code{loadvm} in monitor) 3397ETEXI 3398 3399#ifndef _WIN32 3400DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 3401 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 3402#endif 3403STEXI 3404@item -daemonize 3405@findex -daemonize 3406Daemonize the QEMU process after initialization. QEMU will not detach from 3407standard IO until it is ready to receive connections on any of its devices. 3408This option is a useful way for external programs to launch QEMU without having 3409to cope with initialization race conditions. 3410ETEXI 3411 3412DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 3413 "-option-rom rom load a file, rom, into the option ROM space\n", 3414 QEMU_ARCH_ALL) 3415STEXI 3416@item -option-rom @var{file} 3417@findex -option-rom 3418Load the contents of @var{file} as an option ROM. 3419This option is useful to load things like EtherBoot. 3420ETEXI 3421 3422HXCOMM Silently ignored for compatibility 3423DEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL) 3424 3425HXCOMM Options deprecated by -rtc 3426DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 3427DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 3428 3429DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 3430 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 3431 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 3432 QEMU_ARCH_ALL) 3433 3434STEXI 3435 3436@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 3437@findex -rtc 3438Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 3439UTC or local time, respectively. @code{localtime} is required for correct date in 3440MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 3441format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 3442 3443By default the RTC is driven by the host system time. This allows using of the 3444RTC as accurate reference clock inside the guest, specifically if the host 3445time is smoothly following an accurate external reference clock, e.g. via NTP. 3446If you want to isolate the guest time from the host, you can set @option{clock} 3447to @code{rt} instead. To even prevent it from progressing during suspension, 3448you can set it to @code{vm}. 3449 3450Enable @option{driftfix} (i386 targets only) if you experience time drift problems, 3451specifically with Windows' ACPI HAL. This option will try to figure out how 3452many timer interrupts were not processed by the Windows guest and will 3453re-inject them. 3454ETEXI 3455 3456DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 3457 "-icount [shift=N|auto][,align=on|off][,sleep=on|off,rr=record|replay,rrfile=<filename>,rrsnapshot=<snapshot>]\n" \ 3458 " enable virtual instruction counter with 2^N clock ticks per\n" \ 3459 " instruction, enable aligning the host and virtual clocks\n" \ 3460 " or disable real time cpu sleeping\n", QEMU_ARCH_ALL) 3461STEXI 3462@item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename},rrsnapshot=@var{snapshot}] 3463@findex -icount 3464Enable virtual instruction counter. The virtual cpu will execute one 3465instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 3466then the virtual cpu speed will be automatically adjusted to keep virtual 3467time within a few seconds of real time. 3468 3469When the virtual cpu is sleeping, the virtual time will advance at default 3470speed unless @option{sleep=on|off} is specified. 3471With @option{sleep=on|off}, the virtual time will jump to the next timer deadline 3472instantly whenever the virtual cpu goes to sleep mode and will not advance 3473if no timer is enabled. This behavior give deterministic execution times from 3474the guest point of view. 3475 3476Note that while this option can give deterministic behavior, it does not 3477provide cycle accurate emulation. Modern CPUs contain superscalar out of 3478order cores with complex cache hierarchies. The number of instructions 3479executed often has little or no correlation with actual performance. 3480 3481@option{align=on} will activate the delay algorithm which will try 3482to synchronise the host clock and the virtual clock. The goal is to 3483have a guest running at the real frequency imposed by the shift option. 3484Whenever the guest clock is behind the host clock and if 3485@option{align=on} is specified then we print a message to the user 3486to inform about the delay. 3487Currently this option does not work when @option{shift} is @code{auto}. 3488Note: The sync algorithm will work for those shift values for which 3489the guest clock runs ahead of the host clock. Typically this happens 3490when the shift value is high (how high depends on the host machine). 3491 3492When @option{rr} option is specified deterministic record/replay is enabled. 3493Replay log is written into @var{filename} file in record mode and 3494read from this file in replay mode. 3495 3496Option rrsnapshot is used to create new vm snapshot named @var{snapshot} 3497at the start of execution recording. In replay mode this option is used 3498to load the initial VM state. 3499ETEXI 3500 3501DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 3502 "-watchdog model\n" \ 3503 " enable virtual hardware watchdog [default=none]\n", 3504 QEMU_ARCH_ALL) 3505STEXI 3506@item -watchdog @var{model} 3507@findex -watchdog 3508Create a virtual hardware watchdog device. Once enabled (by a guest 3509action), the watchdog must be periodically polled by an agent inside 3510the guest or else the guest will be restarted. Choose a model for 3511which your guest has drivers. 3512 3513The @var{model} is the model of hardware watchdog to emulate. Use 3514@code{-watchdog help} to list available hardware models. Only one 3515watchdog can be enabled for a guest. 3516 3517The following models may be available: 3518@table @option 3519@item ib700 3520iBASE 700 is a very simple ISA watchdog with a single timer. 3521@item i6300esb 3522Intel 6300ESB I/O controller hub is a much more featureful PCI-based 3523dual-timer watchdog. 3524@item diag288 3525A virtual watchdog for s390x backed by the diagnose 288 hypercall 3526(currently KVM only). 3527@end table 3528ETEXI 3529 3530DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 3531 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 3532 " action when watchdog fires [default=reset]\n", 3533 QEMU_ARCH_ALL) 3534STEXI 3535@item -watchdog-action @var{action} 3536@findex -watchdog-action 3537 3538The @var{action} controls what QEMU will do when the watchdog timer 3539expires. 3540The default is 3541@code{reset} (forcefully reset the guest). 3542Other possible actions are: 3543@code{shutdown} (attempt to gracefully shutdown the guest), 3544@code{poweroff} (forcefully poweroff the guest), 3545@code{pause} (pause the guest), 3546@code{debug} (print a debug message and continue), or 3547@code{none} (do nothing). 3548 3549Note that the @code{shutdown} action requires that the guest responds 3550to ACPI signals, which it may not be able to do in the sort of 3551situations where the watchdog would have expired, and thus 3552@code{-watchdog-action shutdown} is not recommended for production use. 3553 3554Examples: 3555 3556@table @code 3557@item -watchdog i6300esb -watchdog-action pause 3558@itemx -watchdog ib700 3559@end table 3560ETEXI 3561 3562DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 3563 "-echr chr set terminal escape character instead of ctrl-a\n", 3564 QEMU_ARCH_ALL) 3565STEXI 3566 3567@item -echr @var{numeric_ascii_value} 3568@findex -echr 3569Change the escape character used for switching to the monitor when using 3570monitor and serial sharing. The default is @code{0x01} when using the 3571@code{-nographic} option. @code{0x01} is equal to pressing 3572@code{Control-a}. You can select a different character from the ascii 3573control keys where 1 through 26 map to Control-a through Control-z. For 3574instance you could use the either of the following to change the escape 3575character to Control-t. 3576@table @code 3577@item -echr 0x14 3578@itemx -echr 20 3579@end table 3580ETEXI 3581 3582DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 3583 "-virtioconsole c\n" \ 3584 " set virtio console\n", QEMU_ARCH_ALL) 3585STEXI 3586@item -virtioconsole @var{c} 3587@findex -virtioconsole 3588Set virtio console. 3589 3590This option is maintained for backward compatibility. 3591 3592Please use @code{-device virtconsole} for the new way of invocation. 3593ETEXI 3594 3595DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3596 "-show-cursor show cursor\n", QEMU_ARCH_ALL) 3597STEXI 3598@item -show-cursor 3599@findex -show-cursor 3600Show cursor. 3601ETEXI 3602 3603DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3604 "-tb-size n set TB size\n", QEMU_ARCH_ALL) 3605STEXI 3606@item -tb-size @var{n} 3607@findex -tb-size 3608Set TB size. 3609ETEXI 3610 3611DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 3612 "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \ 3613 "-incoming rdma:host:port[,ipv4][,ipv6]\n" \ 3614 "-incoming unix:socketpath\n" \ 3615 " prepare for incoming migration, listen on\n" \ 3616 " specified protocol and socket address\n" \ 3617 "-incoming fd:fd\n" \ 3618 "-incoming exec:cmdline\n" \ 3619 " accept incoming migration on given file descriptor\n" \ 3620 " or from given external command\n" \ 3621 "-incoming defer\n" \ 3622 " wait for the URI to be specified via migrate_incoming\n", 3623 QEMU_ARCH_ALL) 3624STEXI 3625@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6] 3626@itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6] 3627@findex -incoming 3628Prepare for incoming migration, listen on a given tcp port. 3629 3630@item -incoming unix:@var{socketpath} 3631Prepare for incoming migration, listen on a given unix socket. 3632 3633@item -incoming fd:@var{fd} 3634Accept incoming migration from a given filedescriptor. 3635 3636@item -incoming exec:@var{cmdline} 3637Accept incoming migration as an output from specified external command. 3638 3639@item -incoming defer 3640Wait for the URI to be specified via migrate_incoming. The monitor can 3641be used to change settings (such as migration parameters) prior to issuing 3642the migrate_incoming to allow the migration to begin. 3643ETEXI 3644 3645DEF("only-migratable", 0, QEMU_OPTION_only_migratable, \ 3646 "-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL) 3647STEXI 3648@item -only-migratable 3649@findex -only-migratable 3650Only allow migratable devices. Devices will not be allowed to enter an 3651unmigratable state. 3652ETEXI 3653 3654DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3655 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3656STEXI 3657@item -nodefaults 3658@findex -nodefaults 3659Don't create default devices. Normally, QEMU sets the default devices like serial 3660port, parallel port, virtual console, monitor device, VGA adapter, floppy and 3661CD-ROM drive and others. The @code{-nodefaults} option will disable all those 3662default devices. 3663ETEXI 3664 3665#ifndef _WIN32 3666DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3667 "-chroot dir chroot to dir just before starting the VM\n", 3668 QEMU_ARCH_ALL) 3669#endif 3670STEXI 3671@item -chroot @var{dir} 3672@findex -chroot 3673Immediately before starting guest execution, chroot to the specified 3674directory. Especially useful in combination with -runas. 3675ETEXI 3676 3677#ifndef _WIN32 3678DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 3679 "-runas user change to user id user just before starting the VM\n", 3680 QEMU_ARCH_ALL) 3681#endif 3682STEXI 3683@item -runas @var{user} 3684@findex -runas 3685Immediately before starting guest execution, drop root privileges, switching 3686to the specified user. 3687ETEXI 3688 3689DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 3690 "-prom-env variable=value\n" 3691 " set OpenBIOS nvram variables\n", 3692 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 3693STEXI 3694@item -prom-env @var{variable}=@var{value} 3695@findex -prom-env 3696Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 3697ETEXI 3698DEF("semihosting", 0, QEMU_OPTION_semihosting, 3699 "-semihosting semihosting mode\n", 3700 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 3701 QEMU_ARCH_MIPS) 3702STEXI 3703@item -semihosting 3704@findex -semihosting 3705Enable semihosting mode (ARM, M68K, Xtensa, MIPS only). 3706ETEXI 3707DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 3708 "-semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]]\n" \ 3709 " semihosting configuration\n", 3710QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 3711QEMU_ARCH_MIPS) 3712STEXI 3713@item -semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]] 3714@findex -semihosting-config 3715Enable and configure semihosting (ARM, M68K, Xtensa, MIPS only). 3716@table @option 3717@item target=@code{native|gdb|auto} 3718Defines where the semihosting calls will be addressed, to QEMU (@code{native}) 3719or to GDB (@code{gdb}). The default is @code{auto}, which means @code{gdb} 3720during debug sessions and @code{native} otherwise. 3721@item arg=@var{str1},arg=@var{str2},... 3722Allows the user to pass input arguments, and can be used multiple times to build 3723up a list. The old-style @code{-kernel}/@code{-append} method of passing a 3724command line is still supported for backward compatibility. If both the 3725@code{--semihosting-config arg} and the @code{-kernel}/@code{-append} are 3726specified, the former is passed to semihosting as it always takes precedence. 3727@end table 3728ETEXI 3729DEF("old-param", 0, QEMU_OPTION_old_param, 3730 "-old-param old param mode\n", QEMU_ARCH_ARM) 3731STEXI 3732@item -old-param 3733@findex -old-param (ARM) 3734Old param mode (ARM only). 3735ETEXI 3736 3737DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 3738 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 3739 QEMU_ARCH_ALL) 3740STEXI 3741@item -sandbox @var{arg} 3742@findex -sandbox 3743Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 3744disable it. The default is 'off'. 3745ETEXI 3746 3747DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3748 "-readconfig <file>\n", QEMU_ARCH_ALL) 3749STEXI 3750@item -readconfig @var{file} 3751@findex -readconfig 3752Read device configuration from @var{file}. This approach is useful when you want to spawn 3753QEMU process with many command line options but you don't want to exceed the command line 3754character limit. 3755ETEXI 3756DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3757 "-writeconfig <file>\n" 3758 " read/write config file\n", QEMU_ARCH_ALL) 3759STEXI 3760@item -writeconfig @var{file} 3761@findex -writeconfig 3762Write device configuration to @var{file}. The @var{file} can be either filename to save 3763command line and device configuration into file or dash @code{-}) character to print the 3764output to stdout. This can be later used as input file for @code{-readconfig} option. 3765ETEXI 3766DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3767 "-nodefconfig\n" 3768 " do not load default config files at startup\n", 3769 QEMU_ARCH_ALL) 3770STEXI 3771@item -nodefconfig 3772@findex -nodefconfig 3773Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3774The @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3775ETEXI 3776DEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3777 "-no-user-config\n" 3778 " do not load user-provided config files at startup\n", 3779 QEMU_ARCH_ALL) 3780STEXI 3781@item -no-user-config 3782@findex -no-user-config 3783The @code{-no-user-config} option makes QEMU not load any of the user-provided 3784config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3785files from @var{datadir}. 3786ETEXI 3787DEF("trace", HAS_ARG, QEMU_OPTION_trace, 3788 "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 3789 " specify tracing options\n", 3790 QEMU_ARCH_ALL) 3791STEXI 3792HXCOMM This line is not accurate, as some sub-options are backend-specific but 3793HXCOMM HX does not support conditional compilation of text. 3794@item -trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}] 3795@findex -trace 3796@include qemu-option-trace.texi 3797ETEXI 3798 3799HXCOMM Internal use 3800DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 3801DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3802 3803#ifdef __linux__ 3804DEF("enable-fips", 0, QEMU_OPTION_enablefips, 3805 "-enable-fips enable FIPS 140-2 compliance\n", 3806 QEMU_ARCH_ALL) 3807#endif 3808STEXI 3809@item -enable-fips 3810@findex -enable-fips 3811Enable FIPS 140-2 compliance mode. 3812ETEXI 3813 3814HXCOMM Deprecated by -machine accel=tcg property 3815DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3816 3817HXCOMM Deprecated by kvm-pit driver properties 3818DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3819 "", QEMU_ARCH_I386) 3820 3821HXCOMM Deprecated (ignored) 3822DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 3823 3824HXCOMM Deprecated by -machine kernel_irqchip=on|off property 3825DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3826 3827HXCOMM Deprecated (ignored) 3828DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 3829 3830DEF("msg", HAS_ARG, QEMU_OPTION_msg, 3831 "-msg timestamp[=on|off]\n" 3832 " change the format of messages\n" 3833 " on|off controls leading timestamps (default:on)\n", 3834 QEMU_ARCH_ALL) 3835STEXI 3836@item -msg timestamp[=on|off] 3837@findex -msg 3838prepend a timestamp to each log message.(default:on) 3839ETEXI 3840 3841DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 3842 "-dump-vmstate <file>\n" 3843 " Output vmstate information in JSON format to file.\n" 3844 " Use the scripts/vmstate-static-checker.py file to\n" 3845 " check for possible regressions in migration code\n" 3846 " by comparing two such vmstate dumps.\n", 3847 QEMU_ARCH_ALL) 3848STEXI 3849@item -dump-vmstate @var{file} 3850@findex -dump-vmstate 3851Dump json-encoded vmstate information for current machine type to file 3852in @var{file} 3853ETEXI 3854 3855STEXI 3856@end table 3857ETEXI 3858DEFHEADING() 3859DEFHEADING(Generic object creation) 3860STEXI 3861@table @option 3862ETEXI 3863 3864DEF("object", HAS_ARG, QEMU_OPTION_object, 3865 "-object TYPENAME[,PROP1=VALUE1,...]\n" 3866 " create a new object of type TYPENAME setting properties\n" 3867 " in the order they are specified. Note that the 'id'\n" 3868 " property must be set. These objects are placed in the\n" 3869 " '/objects' path.\n", 3870 QEMU_ARCH_ALL) 3871STEXI 3872@item -object @var{typename}[,@var{prop1}=@var{value1},...] 3873@findex -object 3874Create a new object of type @var{typename} setting properties 3875in the order they are specified. Note that the 'id' 3876property must be set. These objects are placed in the 3877'/objects' path. 3878 3879@table @option 3880 3881@item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off} 3882 3883Creates a memory file backend object, which can be used to back 3884the guest RAM with huge pages. The @option{id} parameter is a 3885unique ID that will be used to reference this memory region 3886when configuring the @option{-numa} argument. The @option{size} 3887option provides the size of the memory region, and accepts 3888common suffixes, eg @option{500M}. The @option{mem-path} provides 3889the path to either a shared memory or huge page filesystem mount. 3890The @option{share} boolean option determines whether the memory 3891region is marked as private to QEMU, or shared. The latter allows 3892a co-operating external process to access the QEMU memory region. 3893 3894@item -object rng-random,id=@var{id},filename=@var{/dev/random} 3895 3896Creates a random number generator backend which obtains entropy from 3897a device on the host. The @option{id} parameter is a unique ID that 3898will be used to reference this entropy backend from the @option{virtio-rng} 3899device. The @option{filename} parameter specifies which file to obtain 3900entropy from and if omitted defaults to @option{/dev/random}. 3901 3902@item -object rng-egd,id=@var{id},chardev=@var{chardevid} 3903 3904Creates a random number generator backend which obtains entropy from 3905an external daemon running on the host. The @option{id} parameter is 3906a unique ID that will be used to reference this entropy backend from 3907the @option{virtio-rng} device. The @option{chardev} parameter is 3908the unique ID of a character device backend that provides the connection 3909to the RNG daemon. 3910 3911@item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off} 3912 3913Creates a TLS anonymous credentials object, which can be used to provide 3914TLS support on network backends. The @option{id} parameter is a unique 3915ID which network backends will use to access the credentials. The 3916@option{endpoint} is either @option{server} or @option{client} depending 3917on whether the QEMU network backend that uses the credentials will be 3918acting as a client or as a server. If @option{verify-peer} is enabled 3919(the default) then once the handshake is completed, the peer credentials 3920will be verified, though this is a no-op for anonymous credentials. 3921 3922The @var{dir} parameter tells QEMU where to find the credential 3923files. For server endpoints, this directory may contain a file 3924@var{dh-params.pem} providing diffie-hellman parameters to use 3925for the TLS server. If the file is missing, QEMU will generate 3926a set of DH parameters at startup. This is a computationally 3927expensive operation that consumes random pool entropy, so it is 3928recommended that a persistent set of parameters be generated 3929upfront and saved. 3930 3931@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} 3932 3933Creates a TLS anonymous credentials object, which can be used to provide 3934TLS support on network backends. The @option{id} parameter is a unique 3935ID which network backends will use to access the credentials. The 3936@option{endpoint} is either @option{server} or @option{client} depending 3937on whether the QEMU network backend that uses the credentials will be 3938acting as a client or as a server. If @option{verify-peer} is enabled 3939(the default) then once the handshake is completed, the peer credentials 3940will be verified. With x509 certificates, this implies that the clients 3941must be provided with valid client certificates too. 3942 3943The @var{dir} parameter tells QEMU where to find the credential 3944files. For server endpoints, this directory may contain a file 3945@var{dh-params.pem} providing diffie-hellman parameters to use 3946for the TLS server. If the file is missing, QEMU will generate 3947a set of DH parameters at startup. This is a computationally 3948expensive operation that consumes random pool entropy, so it is 3949recommended that a persistent set of parameters be generated 3950upfront and saved. 3951 3952For x509 certificate credentials the directory will contain further files 3953providing the x509 certificates. The certificates must be stored 3954in PEM format, in filenames @var{ca-cert.pem}, @var{ca-crl.pem} (optional), 3955@var{server-cert.pem} (only servers), @var{server-key.pem} (only servers), 3956@var{client-cert.pem} (only clients), and @var{client-key.pem} (only clients). 3957 3958For the @var{server-key.pem} and @var{client-key.pem} files which 3959contain sensitive private keys, it is possible to use an encrypted 3960version by providing the @var{passwordid} parameter. This provides 3961the ID of a previously created @code{secret} object containing the 3962password for decryption. 3963 3964@item -object filter-buffer,id=@var{id},netdev=@var{netdevid},interval=@var{t}[,queue=@var{all|rx|tx}][,status=@var{on|off}] 3965 3966Interval @var{t} can't be 0, this filter batches the packet delivery: all 3967packets arriving in a given interval on netdev @var{netdevid} are delayed 3968until the end of the interval. Interval is in microseconds. 3969@option{status} is optional that indicate whether the netfilter is 3970on (enabled) or off (disabled), the default status for netfilter will be 'on'. 3971 3972queue @var{all|rx|tx} is an option that can be applied to any netfilter. 3973 3974@option{all}: the filter is attached both to the receive and the transmit 3975 queue of the netdev (default). 3976 3977@option{rx}: the filter is attached to the receive queue of the netdev, 3978 where it will receive packets sent to the netdev. 3979 3980@option{tx}: the filter is attached to the transmit queue of the netdev, 3981 where it will receive packets sent by the netdev. 3982 3983@item -object filter-mirror,id=@var{id},netdev=@var{netdevid},outdev=@var{chardevid}[,queue=@var{all|rx|tx}] 3984 3985filter-mirror on netdev @var{netdevid},mirror net packet to chardev 3986@var{chardevid} 3987 3988@item -object filter-redirector,id=@var{id},netdev=@var{netdevid},indev=@var{chardevid}, 3989outdev=@var{chardevid}[,queue=@var{all|rx|tx}] 3990 3991filter-redirector on netdev @var{netdevid},redirect filter's net packet to chardev 3992@var{chardevid},and redirect indev's packet to filter. 3993Create a filter-redirector we need to differ outdev id from indev id, id can not 3994be the same. we can just use indev or outdev, but at least one of indev or outdev 3995need to be specified. 3996 3997@item -object filter-rewriter,id=@var{id},netdev=@var{netdevid},rewriter-mode=@var{mode}[,queue=@var{all|rx|tx}] 3998 3999Filter-rewriter is a part of COLO project.It will rewrite tcp packet to 4000secondary from primary to keep secondary tcp connection,and rewrite 4001tcp packet to primary from secondary make tcp packet can be handled by 4002client. 4003 4004usage: 4005colo secondary: 4006-object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 4007-object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 4008-object filter-rewriter,id=rew0,netdev=hn0,queue=all 4009 4010@item -object filter-dump,id=@var{id},netdev=@var{dev}[,file=@var{filename}][,maxlen=@var{len}] 4011 4012Dump the network traffic on netdev @var{dev} to the file specified by 4013@var{filename}. At most @var{len} bytes (64k by default) per packet are stored. 4014The file format is libpcap, so it can be analyzed with tools such as tcpdump 4015or Wireshark. 4016 4017@item -object colo-compare,id=@var{id},primary_in=@var{chardevid},secondary_in=@var{chardevid}, 4018outdev=@var{chardevid} 4019 4020Colo-compare gets packet from primary_in@var{chardevid} and secondary_in@var{chardevid}, than compare primary packet with 4021secondary packet. If the packets are same, we will output primary 4022packet to outdev@var{chardevid}, else we will notify colo-frame 4023do checkpoint and send primary packet to outdev@var{chardevid}. 4024 4025we must use it with the help of filter-mirror and filter-redirector. 4026 4027@example 4028 4029primary: 4030-netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 4031-device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 4032-chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait 4033-chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait 4034-chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait 4035-chardev socket,id=compare0-0,host=3.3.3.3,port=9001 4036-chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait 4037-chardev socket,id=compare_out0,host=3.3.3.3,port=9005 4038-object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 4039-object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 4040-object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 4041-object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0 4042 4043secondary: 4044-netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 4045-device e1000,netdev=hn0,mac=52:a4:00:12:78:66 4046-chardev socket,id=red0,host=3.3.3.3,port=9003 4047-chardev socket,id=red1,host=3.3.3.3,port=9004 4048-object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 4049-object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 4050 4051@end example 4052 4053If you want to know the detail of above command line, you can read 4054the colo-compare git log. 4055 4056@item -object cryptodev-backend-builtin,id=@var{id}[,queues=@var{queues}] 4057 4058Creates a cryptodev backend which executes crypto opreation from 4059the QEMU cipher APIS. The @var{id} parameter is 4060a unique ID that will be used to reference this cryptodev backend from 4061the @option{virtio-crypto} device. The @var{queues} parameter is optional, 4062which specify the queue number of cryptodev backend, the default of 4063@var{queues} is 1. 4064 4065@example 4066 4067 # qemu-system-x86_64 \ 4068 [...] \ 4069 -object cryptodev-backend-builtin,id=cryptodev0 \ 4070 -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \ 4071 [...] 4072@end example 4073 4074@item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}] 4075@item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}] 4076 4077Defines a secret to store a password, encryption key, or some other sensitive 4078data. The sensitive data can either be passed directly via the @var{data} 4079parameter, or indirectly via the @var{file} parameter. Using the @var{data} 4080parameter is insecure unless the sensitive data is encrypted. 4081 4082The sensitive data can be provided in raw format (the default), or base64. 4083When encoded as JSON, the raw format only supports valid UTF-8 characters, 4084so base64 is recommended for sending binary data. QEMU will convert from 4085which ever format is provided to the format it needs internally. eg, an 4086RBD password can be provided in raw format, even though it will be base64 4087encoded when passed onto the RBD sever. 4088 4089For added protection, it is possible to encrypt the data associated with 4090a secret using the AES-256-CBC cipher. Use of encryption is indicated 4091by providing the @var{keyid} and @var{iv} parameters. The @var{keyid} 4092parameter provides the ID of a previously defined secret that contains 4093the AES-256 decryption key. This key should be 32-bytes long and be 4094base64 encoded. The @var{iv} parameter provides the random initialization 4095vector used for encryption of this particular secret and should be a 4096base64 encrypted string of the 16-byte IV. 4097 4098The simplest (insecure) usage is to provide the secret inline 4099 4100@example 4101 4102 # $QEMU -object secret,id=sec0,data=letmein,format=raw 4103 4104@end example 4105 4106The simplest secure usage is to provide the secret via a file 4107 4108 # echo -n "letmein" > mypasswd.txt 4109 # $QEMU -object secret,id=sec0,file=mypasswd.txt,format=raw 4110 4111For greater security, AES-256-CBC should be used. To illustrate usage, 4112consider the openssl command line tool which can encrypt the data. Note 4113that when encrypting, the plaintext must be padded to the cipher block 4114size (32 bytes) using the standard PKCS#5/6 compatible padding algorithm. 4115 4116First a master key needs to be created in base64 encoding: 4117 4118@example 4119 # openssl rand -base64 32 > key.b64 4120 # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"') 4121@end example 4122 4123Each secret to be encrypted needs to have a random initialization vector 4124generated. These do not need to be kept secret 4125 4126@example 4127 # openssl rand -base64 16 > iv.b64 4128 # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"') 4129@end example 4130 4131The secret to be defined can now be encrypted, in this case we're 4132telling openssl to base64 encode the result, but it could be left 4133as raw bytes if desired. 4134 4135@example 4136 # SECRET=$(echo -n "letmein" | 4137 openssl enc -aes-256-cbc -a -K $KEY -iv $IV) 4138@end example 4139 4140When launching QEMU, create a master secret pointing to @code{key.b64} 4141and specify that to be used to decrypt the user password. Pass the 4142contents of @code{iv.b64} to the second secret 4143 4144@example 4145 # $QEMU \ 4146 -object secret,id=secmaster0,format=base64,file=key.b64 \ 4147 -object secret,id=sec0,keyid=secmaster0,format=base64,\ 4148 data=$SECRET,iv=$(<iv.b64) 4149@end example 4150 4151@end table 4152 4153ETEXI 4154 4155 4156HXCOMM This is the last statement. Insert new options before this line! 4157STEXI 4158@end table 4159ETEXI 4160
