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