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\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 @var{host}:@var{d} 1245 1246TCP connections will only be allowed from @var{host} on display @var{d}. 1247By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 1248be omitted in which case the server will accept connections from any host. 1249 1250@item unix:@var{path} 1251 1252Connections will be allowed over UNIX domain sockets where @var{path} is the 1253location of a unix socket to listen for connections on. 1254 1255@item none 1256 1257VNC is initialized but not started. The monitor @code{change} command 1258can be used to later start the VNC server. 1259 1260@end table 1261 1262Following the @var{display} value there may be one or more @var{option} flags 1263separated by commas. Valid options are 1264 1265@table @option 1266 1267@item reverse 1268 1269Connect to a listening VNC client via a ``reverse'' connection. The 1270client is specified by the @var{display}. For reverse network 1271connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 1272is a TCP port number, not a display number. 1273 1274@item websocket 1275 1276Opens an additional TCP listening port dedicated to VNC Websocket connections. 1277By definition the Websocket port is 5700+@var{display}. If @var{host} is 1278specified connections will only be allowed from this host. 1279As an alternative the Websocket port could be specified by using 1280@code{websocket}=@var{port}. 1281If no TLS credentials are provided, the websocket connection runs in 1282unencrypted mode. If TLS credentials are provided, the websocket connection 1283requires encrypted client connections. 1284 1285@item password 1286 1287Require that password based authentication is used for client connections. 1288 1289The password must be set separately using the @code{set_password} command in 1290the @ref{pcsys_monitor}. The syntax to change your password is: 1291@code{set_password <protocol> <password>} where <protocol> could be either 1292"vnc" or "spice". 1293 1294If you would like to change <protocol> password expiration, you should use 1295@code{expire_password <protocol> <expiration-time>} where expiration time could 1296be one of the following options: now, never, +seconds or UNIX time of 1297expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 1298to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 1299date and time). 1300 1301You can also use keywords "now" or "never" for the expiration time to 1302allow <protocol> password to expire immediately or never expire. 1303 1304@item tls-creds=@var{ID} 1305 1306Provides the ID of a set of TLS credentials to use to secure the 1307VNC server. They will apply to both the normal VNC server socket 1308and the websocket socket (if enabled). Setting TLS credentials 1309will cause the VNC server socket to enable the VeNCrypt auth 1310mechanism. The credentials should have been previously created 1311using the @option{-object tls-creds} argument. 1312 1313The @option{tls-creds} parameter obsoletes the @option{tls}, 1314@option{x509}, and @option{x509verify} options, and as such 1315it is not permitted to set both new and old type options at 1316the same time. 1317 1318@item tls 1319 1320Require that client use TLS when communicating with the VNC server. This 1321uses anonymous TLS credentials so is susceptible to a man-in-the-middle 1322attack. It is recommended that this option be combined with either the 1323@option{x509} or @option{x509verify} options. 1324 1325This option is now deprecated in favor of using the @option{tls-creds} 1326argument. 1327 1328@item x509=@var{/path/to/certificate/dir} 1329 1330Valid if @option{tls} is specified. Require that x509 credentials are used 1331for negotiating the TLS session. The server will send its x509 certificate 1332to the client. It is recommended that a password be set on the VNC server 1333to provide authentication of the client when this is used. The path following 1334this option specifies where the x509 certificates are to be loaded from. 1335See the @ref{vnc_security} section for details on generating certificates. 1336 1337This option is now deprecated in favour of using the @option{tls-creds} 1338argument. 1339 1340@item x509verify=@var{/path/to/certificate/dir} 1341 1342Valid if @option{tls} is specified. Require that x509 credentials are used 1343for negotiating the TLS session. The server will send its x509 certificate 1344to the client, and request that the client send its own x509 certificate. 1345The server will validate the client's certificate against the CA certificate, 1346and reject clients when validation fails. If the certificate authority is 1347trusted, this is a sufficient authentication mechanism. You may still wish 1348to set a password on the VNC server as a second authentication layer. The 1349path following this option specifies where the x509 certificates are to 1350be loaded from. See the @ref{vnc_security} section for details on generating 1351certificates. 1352 1353This option is now deprecated in favour of using the @option{tls-creds} 1354argument. 1355 1356@item sasl 1357 1358Require that the client use SASL to authenticate with the VNC server. 1359The exact choice of authentication method used is controlled from the 1360system / user's SASL configuration file for the 'qemu' service. This 1361is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 1362unprivileged user, an environment variable SASL_CONF_PATH can be used 1363to make it search alternate locations for the service config. 1364While some SASL auth methods can also provide data encryption (eg GSSAPI), 1365it is recommended that SASL always be combined with the 'tls' and 1366'x509' settings to enable use of SSL and server certificates. This 1367ensures a data encryption preventing compromise of authentication 1368credentials. See the @ref{vnc_security} section for details on using 1369SASL authentication. 1370 1371@item acl 1372 1373Turn on access control lists for checking of the x509 client certificate 1374and SASL party. For x509 certs, the ACL check is made against the 1375certificate's distinguished name. This is something that looks like 1376@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 1377made against the username, which depending on the SASL plugin, may 1378include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 1379When the @option{acl} flag is set, the initial access list will be 1380empty, with a @code{deny} policy. Thus no one will be allowed to 1381use the VNC server until the ACLs have been loaded. This can be 1382achieved using the @code{acl} monitor command. 1383 1384@item lossy 1385 1386Enable lossy compression methods (gradient, JPEG, ...). If this 1387option is set, VNC client may receive lossy framebuffer updates 1388depending on its encoding settings. Enabling this option can save 1389a lot of bandwidth at the expense of quality. 1390 1391@item non-adaptive 1392 1393Disable adaptive encodings. Adaptive encodings are enabled by default. 1394An adaptive encoding will try to detect frequently updated screen regions, 1395and send updates in these regions using a lossy encoding (like JPEG). 1396This can be really helpful to save bandwidth when playing videos. Disabling 1397adaptive encodings restores the original static behavior of encodings 1398like Tight. 1399 1400@item share=[allow-exclusive|force-shared|ignore] 1401 1402Set display sharing policy. 'allow-exclusive' allows clients to ask 1403for exclusive access. As suggested by the rfb spec this is 1404implemented by dropping other connections. Connecting multiple 1405clients in parallel requires all clients asking for a shared session 1406(vncviewer: -shared switch). This is the default. 'force-shared' 1407disables exclusive client access. Useful for shared desktop sessions, 1408where you don't want someone forgetting specify -shared disconnect 1409everybody else. 'ignore' completely ignores the shared flag and 1410allows everybody connect unconditionally. Doesn't conform to the rfb 1411spec but is traditional QEMU behavior. 1412 1413@item key-delay-ms 1414 1415Set keyboard delay, for key down and key up events, in milliseconds. 1416Default is 1. Keyboards are low-bandwidth devices, so this slowdown 1417can help the device and guest to keep up and not lose events in case 1418events are arriving in bulk. Possible causes for the latter are flaky 1419network connections, or scripts for automated testing. 1420 1421@end table 1422ETEXI 1423 1424STEXI 1425@end table 1426ETEXI 1427ARCHHEADING(, QEMU_ARCH_I386) 1428 1429ARCHHEADING(i386 target only:, QEMU_ARCH_I386) 1430STEXI 1431@table @option 1432ETEXI 1433 1434DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1435 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1436 QEMU_ARCH_I386) 1437STEXI 1438@item -win2k-hack 1439@findex -win2k-hack 1440Use it when installing Windows 2000 to avoid a disk full bug. After 1441Windows 2000 is installed, you no longer need this option (this option 1442slows down the IDE transfers). 1443ETEXI 1444 1445HXCOMM Deprecated by -rtc 1446DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 1447 1448DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1449 "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1450 QEMU_ARCH_I386) 1451STEXI 1452@item -no-fd-bootchk 1453@findex -no-fd-bootchk 1454Disable boot signature checking for floppy disks in BIOS. May 1455be needed to boot from old floppy disks. 1456ETEXI 1457 1458DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1459 "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 1460STEXI 1461@item -no-acpi 1462@findex -no-acpi 1463Disable ACPI (Advanced Configuration and Power Interface) support. Use 1464it if your guest OS complains about ACPI problems (PC target machine 1465only). 1466ETEXI 1467 1468DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1469 "-no-hpet disable HPET\n", QEMU_ARCH_I386) 1470STEXI 1471@item -no-hpet 1472@findex -no-hpet 1473Disable HPET support. 1474ETEXI 1475 1476DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1477 "-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" 1478 " ACPI table description\n", QEMU_ARCH_I386) 1479STEXI 1480@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}]...] 1481@findex -acpitable 1482Add ACPI table with specified header fields and context from specified files. 1483For file=, take whole ACPI table from the specified files, including all 1484ACPI headers (possible overridden by other options). 1485For data=, only data 1486portion of the table is used, all header information is specified in the 1487command line. 1488If a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id 1489fields will override the same in the RSDT and the FADT (a.k.a. FACP), in order 1490to ensure the field matches required by the Microsoft SLIC spec and the ACPI 1491spec. 1492ETEXI 1493 1494DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1495 "-smbios file=binary\n" 1496 " load SMBIOS entry from binary file\n" 1497 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1498 " [,uefi=on|off]\n" 1499 " specify SMBIOS type 0 fields\n" 1500 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1501 " [,uuid=uuid][,sku=str][,family=str]\n" 1502 " specify SMBIOS type 1 fields\n" 1503 "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1504 " [,asset=str][,location=str]\n" 1505 " specify SMBIOS type 2 fields\n" 1506 "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 1507 " [,sku=str]\n" 1508 " specify SMBIOS type 3 fields\n" 1509 "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 1510 " [,asset=str][,part=str]\n" 1511 " specify SMBIOS type 4 fields\n" 1512 "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 1513 " [,asset=str][,part=str][,speed=%d]\n" 1514 " specify SMBIOS type 17 fields\n", 1515 QEMU_ARCH_I386 | QEMU_ARCH_ARM) 1516STEXI 1517@item -smbios file=@var{binary} 1518@findex -smbios 1519Load SMBIOS entry from binary file. 1520 1521@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] 1522Specify SMBIOS type 0 fields 1523 1524@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}] 1525Specify SMBIOS type 1 fields 1526 1527@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}] 1528Specify SMBIOS type 2 fields 1529 1530@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}] 1531Specify SMBIOS type 3 fields 1532 1533@item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}] 1534Specify SMBIOS type 4 fields 1535 1536@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}] 1537Specify SMBIOS type 17 fields 1538ETEXI 1539 1540STEXI 1541@end table 1542ETEXI 1543DEFHEADING() 1544 1545DEFHEADING(Network options:) 1546STEXI 1547@table @option 1548ETEXI 1549 1550HXCOMM Legacy slirp options (now moved to -net user): 1551#ifdef CONFIG_SLIRP 1552DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1553DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1554DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1555#ifndef _WIN32 1556DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1557#endif 1558#endif 1559 1560DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1561#ifdef CONFIG_SLIRP 1562 "-netdev user,id=str[,ipv4[=on|off]][,net=addr[/mask]][,host=addr]\n" 1563 " [,ipv6[=on|off]][,ipv6-net=addr[/int]][,ipv6-host=addr]\n" 1564 " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n" 1565 " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,tftp=dir]\n" 1566 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1567#ifndef _WIN32 1568 "[,smb=dir[,smbserver=addr]]\n" 1569#endif 1570 " configure a user mode network backend with ID 'str',\n" 1571 " its DHCP server and optional services\n" 1572#endif 1573#ifdef _WIN32 1574 "-netdev tap,id=str,ifname=name\n" 1575 " configure a host TAP network backend with ID 'str'\n" 1576#else 1577 "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 1578 " [,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 1579 " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 1580 " configure a host TAP network backend with ID 'str'\n" 1581 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1582 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1583 " to deconfigure it\n" 1584 " use '[down]script=no' to disable script execution\n" 1585 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1586 " configure it\n" 1587 " use 'fd=h' to connect to an already opened TAP interface\n" 1588 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1589 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1590 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1591 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1592 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 1593 " use vhost=on to enable experimental in kernel accelerator\n" 1594 " (only has effect for virtio guests which use MSIX)\n" 1595 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 1596 " use 'vhostfd=h' to connect to an already opened vhost net device\n" 1597 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1598 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 1599 "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 1600 " configure a host TAP network backend with ID 'str' that is\n" 1601 " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 1602 " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 1603#endif 1604#ifdef __linux__ 1605 "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 1606 " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n" 1607 " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n" 1608 " [,rxcookie=rxcookie][,offset=offset]\n" 1609 " configure a network backend with ID 'str' connected to\n" 1610 " an Ethernet over L2TPv3 pseudowire.\n" 1611 " Linux kernel 3.3+ as well as most routers can talk\n" 1612 " L2TPv3. This transport allows connecting a VM to a VM,\n" 1613 " VM to a router and even VM to Host. It is a nearly-universal\n" 1614 " standard (RFC3391). Note - this implementation uses static\n" 1615 " pre-configured tunnels (same as the Linux kernel).\n" 1616 " use 'src=' to specify source address\n" 1617 " use 'dst=' to specify destination address\n" 1618 " use 'udp=on' to specify udp encapsulation\n" 1619 " use 'srcport=' to specify source udp port\n" 1620 " use 'dstport=' to specify destination udp port\n" 1621 " use 'ipv6=on' to force v6\n" 1622 " L2TPv3 uses cookies to prevent misconfiguration as\n" 1623 " well as a weak security measure\n" 1624 " use 'rxcookie=0x012345678' to specify a rxcookie\n" 1625 " use 'txcookie=0x012345678' to specify a txcookie\n" 1626 " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 1627 " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 1628 " use 'pincounter=on' to work around broken counter handling in peer\n" 1629 " use 'offset=X' to add an extra offset between header and data\n" 1630#endif 1631 "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 1632 " configure a network backend to connect to another network\n" 1633 " using a socket connection\n" 1634 "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 1635 " configure a network backend to connect to a multicast maddr and port\n" 1636 " use 'localaddr=addr' to specify the host address to send packets from\n" 1637 "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 1638 " configure a network backend to connect to another network\n" 1639 " using an UDP tunnel\n" 1640#ifdef CONFIG_VDE 1641 "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 1642 " configure a network backend to connect to port 'n' of a vde switch\n" 1643 " running on host and listening for incoming connections on 'socketpath'.\n" 1644 " Use group 'groupname' and mode 'octalmode' to change default\n" 1645 " ownership and permissions for communication port.\n" 1646#endif 1647#ifdef CONFIG_NETMAP 1648 "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 1649 " attach to the existing netmap-enabled network interface 'name', or to a\n" 1650 " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 1651 " netmap device, defaults to '/dev/netmap')\n" 1652#endif 1653 "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 1654 " configure a vhost-user network, backed by a chardev 'dev'\n" 1655 "-netdev hubport,id=str,hubid=n\n" 1656 " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL) 1657DEF("net", HAS_ARG, QEMU_OPTION_net, 1658 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 1659 " old way to create a new NIC and connect it to VLAN 'n'\n" 1660 " (use the '-device devtype,netdev=str' option if possible instead)\n" 1661 "-net dump[,vlan=n][,file=f][,len=n]\n" 1662 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1663 "-net none use it alone to have zero network devices. If no -net option\n" 1664 " is provided, the default is '-net nic -net user'\n" 1665 "-net [" 1666#ifdef CONFIG_SLIRP 1667 "user|" 1668#endif 1669 "tap|" 1670 "bridge|" 1671#ifdef CONFIG_VDE 1672 "vde|" 1673#endif 1674#ifdef CONFIG_NETMAP 1675 "netmap|" 1676#endif 1677 "socket][,vlan=n][,option][,option][,...]\n" 1678 " old way to initialize a host network interface\n" 1679 " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 1680STEXI 1681@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 1682@findex -net 1683Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 1684= 0 is the default). The NIC is an e1000 by default on the PC 1685target. Optionally, the MAC address can be changed to @var{mac}, the 1686device address set to @var{addr} (PCI cards only), 1687and a @var{name} can be assigned for use in monitor commands. 1688Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1689that the card should have; this option currently only affects virtio cards; set 1690@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1691NIC is created. QEMU can emulate several different models of network card. 1692Valid values for @var{type} are 1693@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 1694@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 1695@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1696Not all devices are supported on all targets. Use @code{-net nic,model=help} 1697for a list of available devices for your target. 1698 1699@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1700@findex -netdev 1701@item -net user[,@var{option}][,@var{option}][,...] 1702Use the user mode network stack which requires no administrator 1703privilege to run. Valid options are: 1704 1705@table @option 1706@item vlan=@var{n} 1707Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1708 1709@item id=@var{id} 1710@itemx name=@var{name} 1711Assign symbolic name for use in monitor commands. 1712 1713@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must 1714be enabled. If neither is specified both protocols are enabled. 1715 1716@item net=@var{addr}[/@var{mask}] 1717Set IP network address the guest will see. Optionally specify the netmask, 1718either in the form a.b.c.d or as number of valid top-most bits. Default is 171910.0.2.0/24. 1720 1721@item host=@var{addr} 1722Specify the guest-visible address of the host. Default is the 2nd IP in the 1723guest network, i.e. x.x.x.2. 1724 1725@item ipv6-net=@var{addr}[/@var{int}] 1726Set IPv6 network address the guest will see (default is fec0::/64). The 1727network prefix is given in the usual hexadecimal IPv6 address 1728notation. The prefix size is optional, and is given as the number of 1729valid top-most bits (default is 64). 1730 1731@item ipv6-host=@var{addr} 1732Specify the guest-visible IPv6 address of the host. Default is the 2nd IPv6 in 1733the guest network, i.e. xxxx::2. 1734 1735@item restrict=on|off 1736If this option is enabled, the guest will be isolated, i.e. it will not be 1737able to contact the host and no guest IP packets will be routed over the host 1738to the outside. This option does not affect any explicitly set forwarding rules. 1739 1740@item hostname=@var{name} 1741Specifies the client hostname reported by the built-in DHCP server. 1742 1743@item dhcpstart=@var{addr} 1744Specify the first of the 16 IPs the built-in DHCP server can assign. Default 1745is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1746 1747@item dns=@var{addr} 1748Specify the guest-visible address of the virtual nameserver. The address must 1749be different from the host address. Default is the 3rd IP in the guest network, 1750i.e. x.x.x.3. 1751 1752@item ipv6-dns=@var{addr} 1753Specify the guest-visible address of the IPv6 virtual nameserver. The address 1754must be different from the host address. Default is the 3rd IP in the guest 1755network, i.e. xxxx::3. 1756 1757@item dnssearch=@var{domain} 1758Provides an entry for the domain-search list sent by the built-in 1759DHCP server. More than one domain suffix can be transmitted by specifying 1760this option multiple times. If supported, this will cause the guest to 1761automatically try to append the given domain suffix(es) in case a domain name 1762can not be resolved. 1763 1764Example: 1765@example 1766qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 1767@end example 1768 1769@item tftp=@var{dir} 1770When using the user mode network stack, activate a built-in TFTP 1771server. The files in @var{dir} will be exposed as the root of a TFTP server. 1772The TFTP client on the guest must be configured in binary mode (use the command 1773@code{bin} of the Unix TFTP client). 1774 1775@item bootfile=@var{file} 1776When using the user mode network stack, broadcast @var{file} as the BOOTP 1777filename. In conjunction with @option{tftp}, this can be used to network boot 1778a guest from a local directory. 1779 1780Example (using pxelinux): 1781@example 1782qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1783@end example 1784 1785@item smb=@var{dir}[,smbserver=@var{addr}] 1786When using the user mode network stack, activate a built-in SMB 1787server so that Windows OSes can access to the host files in @file{@var{dir}} 1788transparently. The IP address of the SMB server can be set to @var{addr}. By 1789default the 4th IP in the guest network is used, i.e. x.x.x.4. 1790 1791In the guest Windows OS, the line: 1792@example 179310.0.2.4 smbserver 1794@end example 1795must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1796or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1797 1798Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1799 1800Note that a SAMBA server must be installed on the host OS. 1801QEMU was tested successfully with smbd versions from Red Hat 9, 1802Fedora Core 3 and OpenSUSE 11.x. 1803 1804@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1805Redirect incoming TCP or UDP connections to the host port @var{hostport} to 1806the guest IP address @var{guestaddr} on guest port @var{guestport}. If 1807@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 1808given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 1809be bound to a specific host interface. If no connection type is set, TCP is 1810used. This option can be given multiple times. 1811 1812For example, to redirect host X11 connection from screen 1 to guest 1813screen 0, use the following: 1814 1815@example 1816# on the host 1817qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1818# this host xterm should open in the guest X11 server 1819xterm -display :1 1820@end example 1821 1822To redirect telnet connections from host port 5555 to telnet port on 1823the guest, use the following: 1824 1825@example 1826# on the host 1827qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1828telnet localhost 5555 1829@end example 1830 1831Then when you use on the host @code{telnet localhost 5555}, you 1832connect to the guest telnet server. 1833 1834@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1835@itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 1836Forward guest TCP connections to the IP address @var{server} on port @var{port} 1837to the character device @var{dev} or to a program executed by @var{cmd:command} 1838which gets spawned for each connection. This option can be given multiple times. 1839 1840You can either use a chardev directly and have that one used throughout QEMU's 1841lifetime, like in the following example: 1842 1843@example 1844# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1845# the guest accesses it 1846qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1847@end example 1848 1849Or you can execute a command on every TCP connection established by the guest, 1850so that QEMU behaves similar to an inetd process for that virtual server: 1851 1852@example 1853# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1854# and connect the TCP stream to its stdin/stdout 1855qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1856@end example 1857 1858@end table 1859 1860Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1861processed and applied to -net user. Mixing them with the new configuration 1862syntax gives undefined results. Their use for new applications is discouraged 1863as they will be removed from future versions. 1864 1865@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1866@itemx -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1867Connect the host TAP network interface @var{name} to VLAN @var{n}. 1868 1869Use the network script @var{file} to configure it and the network script 1870@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1871automatically provides one. The default network configure script is 1872@file{/etc/qemu-ifup} and the default network deconfigure script is 1873@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1874to disable script execution. 1875 1876If running QEMU as an unprivileged user, use the network helper 1877@var{helper} to configure the TAP interface. The default network 1878helper executable is @file{/path/to/qemu-bridge-helper}. 1879 1880@option{fd}=@var{h} can be used to specify the handle of an already 1881opened host TAP interface. 1882 1883Examples: 1884 1885@example 1886#launch a QEMU instance with the default network script 1887qemu-system-i386 linux.img -net nic -net tap 1888@end example 1889 1890@example 1891#launch a QEMU instance with two NICs, each one connected 1892#to a TAP device 1893qemu-system-i386 linux.img \ 1894 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 1895 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 1896@end example 1897 1898@example 1899#launch a QEMU instance with the default network helper to 1900#connect a TAP device to bridge br0 1901qemu-system-i386 linux.img \ 1902 -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1903@end example 1904 1905@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1906@itemx -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1907Connect a host TAP network interface to a host bridge device. 1908 1909Use the network helper @var{helper} to configure the TAP interface and 1910attach it to the bridge. The default network helper executable is 1911@file{/path/to/qemu-bridge-helper} and the default bridge 1912device is @file{br0}. 1913 1914Examples: 1915 1916@example 1917#launch a QEMU instance with the default network helper to 1918#connect a TAP device to bridge br0 1919qemu-system-i386 linux.img -net bridge -net nic,model=virtio 1920@end example 1921 1922@example 1923#launch a QEMU instance with the default network helper to 1924#connect a TAP device to bridge qemubr0 1925qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1926@end example 1927 1928@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1929@itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1930 1931Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 1932machine using a TCP socket connection. If @option{listen} is 1933specified, QEMU waits for incoming connections on @var{port} 1934(@var{host} is optional). @option{connect} is used to connect to 1935another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 1936specifies an already opened TCP socket. 1937 1938Example: 1939@example 1940# launch a first QEMU instance 1941qemu-system-i386 linux.img \ 1942 -net nic,macaddr=52:54:00:12:34:56 \ 1943 -net socket,listen=:1234 1944# connect the VLAN 0 of this instance to the VLAN 0 1945# of the first instance 1946qemu-system-i386 linux.img \ 1947 -net nic,macaddr=52:54:00:12:34:57 \ 1948 -net socket,connect=127.0.0.1:1234 1949@end example 1950 1951@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1952@itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1953 1954Create a VLAN @var{n} shared with another QEMU virtual 1955machines using a UDP multicast socket, effectively making a bus for 1956every QEMU with same multicast address @var{maddr} and @var{port}. 1957NOTES: 1958@enumerate 1959@item 1960Several QEMU can be running on different hosts and share same bus (assuming 1961correct multicast setup for these hosts). 1962@item 1963mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 1964@url{http://user-mode-linux.sf.net}. 1965@item 1966Use @option{fd=h} to specify an already opened UDP multicast socket. 1967@end enumerate 1968 1969Example: 1970@example 1971# launch one QEMU instance 1972qemu-system-i386 linux.img \ 1973 -net nic,macaddr=52:54:00:12:34:56 \ 1974 -net socket,mcast=230.0.0.1:1234 1975# launch another QEMU instance on same "bus" 1976qemu-system-i386 linux.img \ 1977 -net nic,macaddr=52:54:00:12:34:57 \ 1978 -net socket,mcast=230.0.0.1:1234 1979# launch yet another QEMU instance on same "bus" 1980qemu-system-i386 linux.img \ 1981 -net nic,macaddr=52:54:00:12:34:58 \ 1982 -net socket,mcast=230.0.0.1:1234 1983@end example 1984 1985Example (User Mode Linux compat.): 1986@example 1987# launch QEMU instance (note mcast address selected 1988# is UML's default) 1989qemu-system-i386 linux.img \ 1990 -net nic,macaddr=52:54:00:12:34:56 \ 1991 -net socket,mcast=239.192.168.1:1102 1992# launch UML 1993/path/to/linux ubd0=/path/to/root_fs eth0=mcast 1994@end example 1995 1996Example (send packets from host's 1.2.3.4): 1997@example 1998qemu-system-i386 linux.img \ 1999 -net nic,macaddr=52:54:00:12:34:56 \ 2000 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 2001@end example 2002 2003@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}] 2004@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}] 2005Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular 2006protocol to transport Ethernet (and other Layer 2) data frames between 2007two systems. It is present in routers, firewalls and the Linux kernel 2008(from version 3.3 onwards). 2009 2010This transport allows a VM to communicate to another VM, router or firewall directly. 2011 2012@item src=@var{srcaddr} 2013 source address (mandatory) 2014@item dst=@var{dstaddr} 2015 destination address (mandatory) 2016@item udp 2017 select udp encapsulation (default is ip). 2018@item srcport=@var{srcport} 2019 source udp port. 2020@item dstport=@var{dstport} 2021 destination udp port. 2022@item ipv6 2023 force v6, otherwise defaults to v4. 2024@item rxcookie=@var{rxcookie} 2025@itemx txcookie=@var{txcookie} 2026 Cookies are a weak form of security in the l2tpv3 specification. 2027Their function is mostly to prevent misconfiguration. By default they are 32 2028bit. 2029@item cookie64 2030 Set cookie size to 64 bit instead of the default 32 2031@item counter=off 2032 Force a 'cut-down' L2TPv3 with no counter as in 2033draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 2034@item pincounter=on 2035 Work around broken counter handling in peer. This may also help on 2036networks which have packet reorder. 2037@item offset=@var{offset} 2038 Add an extra offset between header and data 2039 2040For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan 2041on the remote Linux host 1.2.3.4: 2042@example 2043# Setup tunnel on linux host using raw ip as encapsulation 2044# on 1.2.3.4 2045ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ 2046 encap udp udp_sport 16384 udp_dport 16384 2047ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ 2048 0xFFFFFFFF peer_session_id 0xFFFFFFFF 2049ifconfig vmtunnel0 mtu 1500 2050ifconfig vmtunnel0 up 2051brctl addif br-lan vmtunnel0 2052 2053 2054# on 4.3.2.1 2055# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 2056 2057qemu-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 2058 2059 2060@end example 2061 2062@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 2063@itemx -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 2064Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 2065listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 2066and MODE @var{octalmode} to change default ownership and permissions for 2067communication port. This option is only available if QEMU has been compiled 2068with vde support enabled. 2069 2070Example: 2071@example 2072# launch vde switch 2073vde_switch -F -sock /tmp/myswitch 2074# launch QEMU instance 2075qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 2076@end example 2077 2078@item -netdev hubport,id=@var{id},hubid=@var{hubid} 2079 2080Create a hub port on QEMU "vlan" @var{hubid}. 2081 2082The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 2083netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 2084required hub automatically. 2085 2086@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n] 2087 2088Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should 2089be a unix domain socket backed one. The vhost-user uses a specifically defined 2090protocol to pass vhost ioctl replacement messages to an application on the other 2091end of the socket. On non-MSIX guests, the feature can be forced with 2092@var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to 2093be created for multiqueue vhost-user. 2094 2095Example: 2096@example 2097qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 2098 -numa node,memdev=mem \ 2099 -chardev socket,path=/path/to/socket \ 2100 -netdev type=vhost-user,id=net0,chardev=chr0 \ 2101 -device virtio-net-pci,netdev=net0 2102@end example 2103 2104@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 2105Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 2106At most @var{len} bytes (64k by default) per packet are stored. The file format is 2107libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 2108Note: For devices created with '-netdev', use '-object filter-dump,...' instead. 2109 2110@item -net none 2111Indicate that no network devices should be configured. It is used to 2112override the default configuration (@option{-net nic -net user}) which 2113is activated if no @option{-net} options are provided. 2114ETEXI 2115 2116STEXI 2117@end table 2118ETEXI 2119DEFHEADING() 2120 2121DEFHEADING(Character device options:) 2122STEXI 2123 2124The general form of a character device option is: 2125@table @option 2126ETEXI 2127 2128DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 2129 "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2130 "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" 2131 " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off]\n" 2132 " [,logfile=PATH][,logappend=on|off][,tls-creds=ID] (tcp)\n" 2133 "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds]\n" 2134 " [,mux=on|off][,logfile=PATH][,logappend=on|off] (unix)\n" 2135 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 2136 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 2137 " [,logfile=PATH][,logappend=on|off]\n" 2138 "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2139 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 2140 " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2141 "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n" 2142 "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2143 "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2144#ifdef _WIN32 2145 "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2146 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2147#else 2148 "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2149 "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n" 2150#endif 2151#ifdef CONFIG_BRLAPI 2152 "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2153#endif 2154#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 2155 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 2156 "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2157 "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2158#endif 2159#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 2160 "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2161 "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2162#endif 2163#if defined(CONFIG_SPICE) 2164 "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 2165 "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 2166#endif 2167 , QEMU_ARCH_ALL 2168) 2169 2170STEXI 2171@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 2172@findex -chardev 2173Backend is one of: 2174@option{null}, 2175@option{socket}, 2176@option{udp}, 2177@option{msmouse}, 2178@option{vc}, 2179@option{ringbuf}, 2180@option{file}, 2181@option{pipe}, 2182@option{console}, 2183@option{serial}, 2184@option{pty}, 2185@option{stdio}, 2186@option{braille}, 2187@option{tty}, 2188@option{parallel}, 2189@option{parport}, 2190@option{spicevmc}. 2191@option{spiceport}. 2192The specific backend will determine the applicable options. 2193 2194All devices must have an id, which can be any string up to 127 characters long. 2195It is used to uniquely identify this device in other command line directives. 2196 2197A character device may be used in multiplexing mode by multiple front-ends. 2198Specify @option{mux=on} to enable this mode. 2199A multiplexer is a "1:N" device, and here the "1" end is your specified chardev 2200backend, and the "N" end is the various parts of QEMU that can talk to a chardev. 2201If you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will 2202create a multiplexer with your specified ID, and you can then configure multiple 2203front ends to use that chardev ID for their input/output. Up to four different 2204front ends can be connected to a single multiplexed chardev. (Without 2205multiplexing enabled, a chardev can only be used by a single front end.) 2206For instance you could use this to allow a single stdio chardev to be used by 2207two serial ports and the QEMU monitor: 2208 2209@example 2210-chardev stdio,mux=on,id=char0 \ 2211-mon chardev=char0,mode=readline,default \ 2212-serial chardev:char0 \ 2213-serial chardev:char0 2214@end example 2215 2216You can have more than one multiplexer in a system configuration; for instance 2217you could have a TCP port multiplexed between UART 0 and UART 1, and stdio 2218multiplexed between the QEMU monitor and a parallel port: 2219 2220@example 2221-chardev stdio,mux=on,id=char0 \ 2222-mon chardev=char0,mode=readline,default \ 2223-parallel chardev:char0 \ 2224-chardev tcp,...,mux=on,id=char1 \ 2225-serial chardev:char1 \ 2226-serial chardev:char1 2227@end example 2228 2229When you're using a multiplexed character device, some escape sequences are 2230interpreted in the input. @xref{mux_keys, Keys in the character backend 2231multiplexer}. 2232 2233Note that some other command line options may implicitly create multiplexed 2234character backends; for instance @option{-serial mon:stdio} creates a 2235multiplexed stdio backend connected to the serial port and the QEMU monitor, 2236and @option{-nographic} also multiplexes the console and the monitor to 2237stdio. 2238 2239There is currently no support for multiplexing in the other direction 2240(where a single QEMU front end takes input and output from multiple chardevs). 2241 2242Every backend supports the @option{logfile} option, which supplies the path 2243to a file to record all data transmitted via the backend. The @option{logappend} 2244option controls whether the log file will be truncated or appended to when 2245opened. 2246 2247Further options to each backend are described below. 2248 2249@item -chardev null ,id=@var{id} 2250A void device. This device will not emit any data, and will drop any data it 2251receives. The null backend does not take any options. 2252 2253@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] [,tls-creds=@var{id}] 2254 2255Create a two-way stream socket, which can be either a TCP or a unix socket. A 2256unix socket will be created if @option{path} is specified. Behaviour is 2257undefined if TCP options are specified for a unix socket. 2258 2259@option{server} specifies that the socket shall be a listening socket. 2260 2261@option{nowait} specifies that QEMU should not block waiting for a client to 2262connect to a listening socket. 2263 2264@option{telnet} specifies that traffic on the socket should interpret telnet 2265escape sequences. 2266 2267@option{reconnect} sets the timeout for reconnecting on non-server sockets when 2268the remote end goes away. qemu will delay this many seconds and then attempt 2269to reconnect. Zero disables reconnecting, and is the default. 2270 2271@option{tls-creds} requests enablement of the TLS protocol for encryption, 2272and specifies the id of the TLS credentials to use for the handshake. The 2273credentials must be previously created with the @option{-object tls-creds} 2274argument. 2275 2276TCP and unix socket options are given below: 2277 2278@table @option 2279 2280@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 2281 2282@option{host} for a listening socket specifies the local address to be bound. 2283For a connecting socket species the remote host to connect to. @option{host} is 2284optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 2285 2286@option{port} for a listening socket specifies the local port to be bound. For a 2287connecting socket specifies the port on the remote host to connect to. 2288@option{port} can be given as either a port number or a service name. 2289@option{port} is required. 2290 2291@option{to} is only relevant to listening sockets. If it is specified, and 2292@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 2293to and including @option{to} until it succeeds. @option{to} must be specified 2294as a port number. 2295 2296@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 2297If neither is specified the socket may use either protocol. 2298 2299@option{nodelay} disables the Nagle algorithm. 2300 2301@item unix options: path=@var{path} 2302 2303@option{path} specifies the local path of the unix socket. @option{path} is 2304required. 2305 2306@end table 2307 2308@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 2309 2310Sends all traffic from the guest to a remote host over UDP. 2311 2312@option{host} specifies the remote host to connect to. If not specified it 2313defaults to @code{localhost}. 2314 2315@option{port} specifies the port on the remote host to connect to. @option{port} 2316is required. 2317 2318@option{localaddr} specifies the local address to bind to. If not specified it 2319defaults to @code{0.0.0.0}. 2320 2321@option{localport} specifies the local port to bind to. If not specified any 2322available local port will be used. 2323 2324@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 2325If neither is specified the device may use either protocol. 2326 2327@item -chardev msmouse ,id=@var{id} 2328 2329Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 2330take any options. 2331 2332@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 2333 2334Connect to a QEMU text console. @option{vc} may optionally be given a specific 2335size. 2336 2337@option{width} and @option{height} specify the width and height respectively of 2338the console, in pixels. 2339 2340@option{cols} and @option{rows} specify that the console be sized to fit a text 2341console with the given dimensions. 2342 2343@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 2344 2345Create a ring buffer with fixed size @option{size}. 2346@var{size} must be a power of two, and defaults to @code{64K}). 2347 2348@item -chardev file ,id=@var{id} ,path=@var{path} 2349 2350Log all traffic received from the guest to a file. 2351 2352@option{path} specifies the path of the file to be opened. This file will be 2353created if it does not already exist, and overwritten if it does. @option{path} 2354is required. 2355 2356@item -chardev pipe ,id=@var{id} ,path=@var{path} 2357 2358Create a two-way connection to the guest. The behaviour differs slightly between 2359Windows hosts and other hosts: 2360 2361On Windows, a single duplex pipe will be created at 2362@file{\\.pipe\@option{path}}. 2363 2364On other hosts, 2 pipes will be created called @file{@option{path}.in} and 2365@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 2366received by the guest. Data written by the guest can be read from 2367@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 2368be present. 2369 2370@option{path} forms part of the pipe path as described above. @option{path} is 2371required. 2372 2373@item -chardev console ,id=@var{id} 2374 2375Send traffic from the guest to QEMU's standard output. @option{console} does not 2376take any options. 2377 2378@option{console} is only available on Windows hosts. 2379 2380@item -chardev serial ,id=@var{id} ,path=@option{path} 2381 2382Send traffic from the guest to a serial device on the host. 2383 2384On Unix hosts serial will actually accept any tty device, 2385not only serial lines. 2386 2387@option{path} specifies the name of the serial device to open. 2388 2389@item -chardev pty ,id=@var{id} 2390 2391Create a new pseudo-terminal on the host and connect to it. @option{pty} does 2392not take any options. 2393 2394@option{pty} is not available on Windows hosts. 2395 2396@item -chardev stdio ,id=@var{id} [,signal=on|off] 2397Connect to standard input and standard output of the QEMU process. 2398 2399@option{signal} controls if signals are enabled on the terminal, that includes 2400exiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2401default, use @option{signal=off} to disable it. 2402 2403@option{stdio} is not available on Windows hosts. 2404 2405@item -chardev braille ,id=@var{id} 2406 2407Connect to a local BrlAPI server. @option{braille} does not take any options. 2408 2409@item -chardev tty ,id=@var{id} ,path=@var{path} 2410 2411@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2412DragonFlyBSD hosts. It is an alias for @option{serial}. 2413 2414@option{path} specifies the path to the tty. @option{path} is required. 2415 2416@item -chardev parallel ,id=@var{id} ,path=@var{path} 2417@itemx -chardev parport ,id=@var{id} ,path=@var{path} 2418 2419@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 2420 2421Connect to a local parallel port. 2422 2423@option{path} specifies the path to the parallel port device. @option{path} is 2424required. 2425 2426@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2427 2428@option{spicevmc} is only available when spice support is built in. 2429 2430@option{debug} debug level for spicevmc 2431 2432@option{name} name of spice channel to connect to 2433 2434Connect to a spice virtual machine channel, such as vdiport. 2435 2436@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2437 2438@option{spiceport} is only available when spice support is built in. 2439 2440@option{debug} debug level for spicevmc 2441 2442@option{name} name of spice port to connect to 2443 2444Connect to a spice port, allowing a Spice client to handle the traffic 2445identified by a name (preferably a fqdn). 2446ETEXI 2447 2448STEXI 2449@end table 2450ETEXI 2451DEFHEADING() 2452 2453DEFHEADING(Device URL Syntax:) 2454STEXI 2455 2456In addition to using normal file images for the emulated storage devices, 2457QEMU can also use networked resources such as iSCSI devices. These are 2458specified using a special URL syntax. 2459 2460@table @option 2461@item iSCSI 2462iSCSI support allows QEMU to access iSCSI resources directly and use as 2463images for the guest storage. Both disk and cdrom images are supported. 2464 2465Syntax for specifying iSCSI LUNs is 2466``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 2467 2468By default qemu will use the iSCSI initiator-name 2469'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 2470line or a configuration file. 2471 2472Since version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect 2473stalled requests and force a reestablishment of the session. The timeout 2474is specified in seconds. The default is 0 which means no timeout. Libiscsi 24751.15.0 or greater is required for this feature. 2476 2477Example (without authentication): 2478@example 2479qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2480 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2481 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2482@end example 2483 2484Example (CHAP username/password via URL): 2485@example 2486qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 2487@end example 2488 2489Example (CHAP username/password via environment variables): 2490@example 2491LIBISCSI_CHAP_USERNAME="user" \ 2492LIBISCSI_CHAP_PASSWORD="password" \ 2493qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2494@end example 2495 2496iSCSI support is an optional feature of QEMU and only available when 2497compiled and linked against libiscsi. 2498ETEXI 2499DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2500 "-iscsi [user=user][,password=password]\n" 2501 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 2502 " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 2503 " [,timeout=timeout]\n" 2504 " iSCSI session parameters\n", QEMU_ARCH_ALL) 2505STEXI 2506 2507iSCSI parameters such as username and password can also be specified via 2508a configuration file. See qemu-doc for more information and examples. 2509 2510@item NBD 2511QEMU supports NBD (Network Block Devices) both using TCP protocol as well 2512as Unix Domain Sockets. 2513 2514Syntax for specifying a NBD device using TCP 2515``nbd:<server-ip>:<port>[:exportname=<export>]'' 2516 2517Syntax for specifying a NBD device using Unix Domain Sockets 2518``nbd:unix:<domain-socket>[:exportname=<export>]'' 2519 2520 2521Example for TCP 2522@example 2523qemu-system-i386 --drive file=nbd:192.0.2.1:30000 2524@end example 2525 2526Example for Unix Domain Sockets 2527@example 2528qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 2529@end example 2530 2531@item SSH 2532QEMU supports SSH (Secure Shell) access to remote disks. 2533 2534Examples: 2535@example 2536qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 2537qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 2538@end example 2539 2540Currently authentication must be done using ssh-agent. Other 2541authentication methods may be supported in future. 2542 2543@item Sheepdog 2544Sheepdog is a distributed storage system for QEMU. 2545QEMU supports using either local sheepdog devices or remote networked 2546devices. 2547 2548Syntax for specifying a sheepdog device 2549@example 2550sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 2551@end example 2552 2553Example 2554@example 2555qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2556@end example 2557 2558See also @url{http://http://www.osrg.net/sheepdog/}. 2559 2560@item GlusterFS 2561GlusterFS is an user space distributed file system. 2562QEMU supports the use of GlusterFS volumes for hosting VM disk images using 2563TCP, Unix Domain Sockets and RDMA transport protocols. 2564 2565Syntax for specifying a VM disk image on GlusterFS volume is 2566@example 2567gluster[+transport]://[server[:port]]/volname/image[?socket=...] 2568@end example 2569 2570 2571Example 2572@example 2573qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 2574@end example 2575 2576See also @url{http://www.gluster.org}. 2577 2578@item HTTP/HTTPS/FTP/FTPS/TFTP 2579QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. 2580 2581Syntax using a single filename: 2582@example 2583<protocol>://[<username>[:<password>]@@]<host>/<path> 2584@end example 2585 2586where: 2587@table @option 2588@item protocol 2589'http', 'https', 'ftp', 'ftps', or 'tftp'. 2590 2591@item username 2592Optional username for authentication to the remote server. 2593 2594@item password 2595Optional password for authentication to the remote server. 2596 2597@item host 2598Address of the remote server. 2599 2600@item path 2601Path on the remote server, including any query string. 2602@end table 2603 2604The following options are also supported: 2605@table @option 2606@item url 2607The full URL when passing options to the driver explicitly. 2608 2609@item readahead 2610The amount of data to read ahead with each range request to the remote server. 2611This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it 2612does not have a suffix, it will be assumed to be in bytes. The value must be a 2613multiple of 512 bytes. It defaults to 256k. 2614 2615@item sslverify 2616Whether to verify the remote server's certificate when connecting over SSL. It 2617can have the value 'on' or 'off'. It defaults to 'on'. 2618 2619@item cookie 2620Send this cookie (it can also be a list of cookies separated by ';') with 2621each outgoing request. Only supported when using protocols such as HTTP 2622which support cookies, otherwise ignored. 2623 2624@item timeout 2625Set the timeout in seconds of the CURL connection. This timeout is the time 2626that CURL waits for a response from the remote server to get the size of the 2627image to be downloaded. If not set, the default timeout of 5 seconds is used. 2628@end table 2629 2630Note that when passing options to qemu explicitly, @option{driver} is the value 2631of <protocol>. 2632 2633Example: boot from a remote Fedora 20 live ISO image 2634@example 2635qemu-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 2636 2637qemu-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 2638@end example 2639 2640Example: boot from a remote Fedora 20 cloud image using a local overlay for 2641writes, copy-on-read, and a readahead of 64k 2642@example 2643qemu-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 2644 2645qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on 2646@end example 2647 2648Example: boot from an image stored on a VMware vSphere server with a self-signed 2649certificate using a local overlay for writes, a readahead of 64k and a timeout 2650of 10 seconds. 2651@example 2652qemu-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 2653 2654qemu-system-x86_64 -drive file=/tmp/test.qcow2 2655@end example 2656ETEXI 2657 2658STEXI 2659@end table 2660ETEXI 2661 2662DEFHEADING(Bluetooth(R) options:) 2663STEXI 2664@table @option 2665ETEXI 2666 2667DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 2668 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 2669 "-bt hci,host[:id]\n" \ 2670 " use host's HCI with the given name\n" \ 2671 "-bt hci[,vlan=n]\n" \ 2672 " emulate a standard HCI in virtual scatternet 'n'\n" \ 2673 "-bt vhci[,vlan=n]\n" \ 2674 " add host computer to virtual scatternet 'n' using VHCI\n" \ 2675 "-bt device:dev[,vlan=n]\n" \ 2676 " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2677 QEMU_ARCH_ALL) 2678STEXI 2679@item -bt hci[...] 2680@findex -bt 2681Defines the function of the corresponding Bluetooth HCI. -bt options 2682are matched with the HCIs present in the chosen machine type. For 2683example when emulating a machine with only one HCI built into it, only 2684the first @code{-bt hci[...]} option is valid and defines the HCI's 2685logic. The Transport Layer is decided by the machine type. Currently 2686the machines @code{n800} and @code{n810} have one HCI and all other 2687machines have none. 2688 2689@anchor{bt-hcis} 2690The following three types are recognized: 2691 2692@table @option 2693@item -bt hci,null 2694(default) The corresponding Bluetooth HCI assumes no internal logic 2695and will not respond to any HCI commands or emit events. 2696 2697@item -bt hci,host[:@var{id}] 2698(@code{bluez} only) The corresponding HCI passes commands / events 2699to / from the physical HCI identified by the name @var{id} (default: 2700@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 2701capable systems like Linux. 2702 2703@item -bt hci[,vlan=@var{n}] 2704Add a virtual, standard HCI that will participate in the Bluetooth 2705scatternet @var{n} (default @code{0}). Similarly to @option{-net} 2706VLANs, devices inside a bluetooth network @var{n} can only communicate 2707with other devices in the same network (scatternet). 2708@end table 2709 2710@item -bt vhci[,vlan=@var{n}] 2711(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 2712to the host bluetooth stack instead of to the emulated target. This 2713allows the host and target machines to participate in a common scatternet 2714and communicate. Requires the Linux @code{vhci} driver installed. Can 2715be used as following: 2716 2717@example 2718qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 2719@end example 2720 2721@item -bt device:@var{dev}[,vlan=@var{n}] 2722Emulate a bluetooth device @var{dev} and place it in network @var{n} 2723(default @code{0}). QEMU can only emulate one type of bluetooth devices 2724currently: 2725 2726@table @option 2727@item keyboard 2728Virtual wireless keyboard implementing the HIDP bluetooth profile. 2729@end table 2730ETEXI 2731 2732STEXI 2733@end table 2734ETEXI 2735DEFHEADING() 2736 2737#ifdef CONFIG_TPM 2738DEFHEADING(TPM device options:) 2739 2740DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 2741 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 2742 " use path to provide path to a character device; default is /dev/tpm0\n" 2743 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 2744 " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2745 QEMU_ARCH_ALL) 2746STEXI 2747 2748The general form of a TPM device option is: 2749@table @option 2750 2751@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2752@findex -tpmdev 2753Backend type must be: 2754@option{passthrough}. 2755 2756The specific backend type will determine the applicable options. 2757The @code{-tpmdev} option creates the TPM backend and requires a 2758@code{-device} option that specifies the TPM frontend interface model. 2759 2760Options to each backend are described below. 2761 2762Use 'help' to print all available TPM backend types. 2763@example 2764qemu -tpmdev help 2765@end example 2766 2767@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 2768 2769(Linux-host only) Enable access to the host's TPM using the passthrough 2770driver. 2771 2772@option{path} specifies the path to the host's TPM device, i.e., on 2773a Linux host this would be @code{/dev/tpm0}. 2774@option{path} is optional and by default @code{/dev/tpm0} is used. 2775 2776@option{cancel-path} specifies the path to the host TPM device's sysfs 2777entry allowing for cancellation of an ongoing TPM command. 2778@option{cancel-path} is optional and by default QEMU will search for the 2779sysfs entry to use. 2780 2781Some notes about using the host's TPM with the passthrough driver: 2782 2783The TPM device accessed by the passthrough driver must not be 2784used by any other application on the host. 2785 2786Since the host's firmware (BIOS/UEFI) has already initialized the TPM, 2787the VM's firmware (BIOS/UEFI) will not be able to initialize the 2788TPM again and may therefore not show a TPM-specific menu that would 2789otherwise allow the user to configure the TPM, e.g., allow the user to 2790enable/disable or activate/deactivate the TPM. 2791Further, if TPM ownership is released from within a VM then the host's TPM 2792will get disabled and deactivated. To enable and activate the 2793TPM again afterwards, the host has to be rebooted and the user is 2794required to enter the firmware's menu to enable and activate the TPM. 2795If the TPM is left disabled and/or deactivated most TPM commands will fail. 2796 2797To create a passthrough TPM use the following two options: 2798@example 2799-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 2800@end example 2801Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by 2802@code{tpmdev=tpm0} in the device option. 2803 2804@end table 2805 2806ETEXI 2807 2808DEFHEADING() 2809 2810#endif 2811 2812DEFHEADING(Linux/Multiboot boot specific:) 2813STEXI 2814 2815When using these options, you can use a given Linux or Multiboot 2816kernel without installing it in the disk image. It can be useful 2817for easier testing of various kernels. 2818 2819@table @option 2820ETEXI 2821 2822DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2823 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 2824STEXI 2825@item -kernel @var{bzImage} 2826@findex -kernel 2827Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel 2828or in multiboot format. 2829ETEXI 2830 2831DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2832 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 2833STEXI 2834@item -append @var{cmdline} 2835@findex -append 2836Use @var{cmdline} as kernel command line 2837ETEXI 2838 2839DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2840 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 2841STEXI 2842@item -initrd @var{file} 2843@findex -initrd 2844Use @var{file} as initial ram disk. 2845 2846@item -initrd "@var{file1} arg=foo,@var{file2}" 2847 2848This syntax is only available with multiboot. 2849 2850Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 2851first module. 2852ETEXI 2853 2854DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2855 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2856STEXI 2857@item -dtb @var{file} 2858@findex -dtb 2859Use @var{file} as a device tree binary (dtb) image and pass it to the kernel 2860on boot. 2861ETEXI 2862 2863STEXI 2864@end table 2865ETEXI 2866DEFHEADING() 2867 2868DEFHEADING(Debug/Expert options:) 2869STEXI 2870@table @option 2871ETEXI 2872 2873DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 2874 "-fw_cfg [name=]<name>,file=<file>\n" 2875 " add named fw_cfg entry with contents from file\n" 2876 "-fw_cfg [name=]<name>,string=<str>\n" 2877 " add named fw_cfg entry with contents from string\n", 2878 QEMU_ARCH_ALL) 2879STEXI 2880 2881@item -fw_cfg [name=]@var{name},file=@var{file} 2882@findex -fw_cfg 2883Add named fw_cfg entry with contents from file @var{file}. 2884 2885@item -fw_cfg [name=]@var{name},string=@var{str} 2886Add named fw_cfg entry with contents from string @var{str}. 2887 2888The terminating NUL character of the contents of @var{str} will not be 2889included as part of the fw_cfg item data. To insert contents with 2890embedded NUL characters, you have to use the @var{file} parameter. 2891 2892The fw_cfg entries are passed by QEMU through to the guest. 2893 2894Example: 2895@example 2896 -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin 2897@end example 2898creates an fw_cfg entry named opt/com.mycompany/blob with contents 2899from ./my_blob.bin. 2900 2901ETEXI 2902 2903DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2904 "-serial dev redirect the serial port to char device 'dev'\n", 2905 QEMU_ARCH_ALL) 2906STEXI 2907@item -serial @var{dev} 2908@findex -serial 2909Redirect the virtual serial port to host character device 2910@var{dev}. The default device is @code{vc} in graphical mode and 2911@code{stdio} in non graphical mode. 2912 2913This option can be used several times to simulate up to 4 serial 2914ports. 2915 2916Use @code{-serial none} to disable all serial ports. 2917 2918Available character devices are: 2919@table @option 2920@item vc[:@var{W}x@var{H}] 2921Virtual console. Optionally, a width and height can be given in pixel with 2922@example 2923vc:800x600 2924@end example 2925It is also possible to specify width or height in characters: 2926@example 2927vc:80Cx24C 2928@end example 2929@item pty 2930[Linux only] Pseudo TTY (a new PTY is automatically allocated) 2931@item none 2932No device is allocated. 2933@item null 2934void device 2935@item chardev:@var{id} 2936Use a named character device defined with the @code{-chardev} option. 2937@item /dev/XXX 2938[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 2939parameters are set according to the emulated ones. 2940@item /dev/parport@var{N} 2941[Linux only, parallel port only] Use host parallel port 2942@var{N}. Currently SPP and EPP parallel port features can be used. 2943@item file:@var{filename} 2944Write output to @var{filename}. No character can be read. 2945@item stdio 2946[Unix only] standard input/output 2947@item pipe:@var{filename} 2948name pipe @var{filename} 2949@item COM@var{n} 2950[Windows only] Use host serial port @var{n} 2951@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 2952This implements UDP Net Console. 2953When @var{remote_host} or @var{src_ip} are not specified 2954they default to @code{0.0.0.0}. 2955When not using a specified @var{src_port} a random port is automatically chosen. 2956 2957If you just want a simple readonly console you can use @code{netcat} or 2958@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2959@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 2960will appear in the netconsole session. 2961 2962If you plan to send characters back via netconsole or you want to stop 2963and start QEMU a lot of times, you should have QEMU use the same 2964source port each time by using something like @code{-serial 2965udp::4555@@:4556} to QEMU. Another approach is to use a patched 2966version of netcat which can listen to a TCP port and send and receive 2967characters via udp. If you have a patched version of netcat which 2968activates telnet remote echo and single char transfer, then you can 2969use the following options to step up a netcat redirector to allow 2970telnet on port 5555 to access the QEMU port. 2971@table @code 2972@item QEMU Options: 2973-serial udp::4555@@:4556 2974@item netcat options: 2975-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 2976@item telnet options: 2977localhost 5555 2978@end table 2979 2980@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] 2981The TCP Net Console has two modes of operation. It can send the serial 2982I/O to a location or wait for a connection from a location. By default 2983the TCP Net Console is sent to @var{host} at the @var{port}. If you use 2984the @var{server} option QEMU will wait for a client socket application 2985to connect to the port before continuing, unless the @code{nowait} 2986option was specified. The @code{nodelay} option disables the Nagle buffering 2987algorithm. The @code{reconnect} option only applies if @var{noserver} is 2988set, if the connection goes down it will attempt to reconnect at the 2989given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only 2990one TCP connection at a time is accepted. You can use @code{telnet} to 2991connect to the corresponding character device. 2992@table @code 2993@item Example to send tcp console to 192.168.0.2 port 4444 2994-serial tcp:192.168.0.2:4444 2995@item Example to listen and wait on port 4444 for connection 2996-serial tcp::4444,server 2997@item Example to not wait and listen on ip 192.168.0.100 port 4444 2998-serial tcp:192.168.0.100:4444,server,nowait 2999@end table 3000 3001@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 3002The telnet protocol is used instead of raw tcp sockets. The options 3003work the same as if you had specified @code{-serial tcp}. The 3004difference is that the port acts like a telnet server or client using 3005telnet option negotiation. This will also allow you to send the 3006MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 3007sequence. Typically in unix telnet you do it with Control-] and then 3008type "send break" followed by pressing the enter key. 3009 3010@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] 3011A unix domain socket is used instead of a tcp socket. The option works the 3012same as if you had specified @code{-serial tcp} except the unix domain socket 3013@var{path} is used for connections. 3014 3015@item mon:@var{dev_string} 3016This is a special option to allow the monitor to be multiplexed onto 3017another serial port. The monitor is accessed with key sequence of 3018@key{Control-a} and then pressing @key{c}. 3019@var{dev_string} should be any one of the serial devices specified 3020above. An example to multiplex the monitor onto a telnet server 3021listening on port 4444 would be: 3022@table @code 3023@item -serial mon:telnet::4444,server,nowait 3024@end table 3025When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 3026QEMU any more but will be passed to the guest instead. 3027 3028@item braille 3029Braille device. This will use BrlAPI to display the braille output on a real 3030or fake device. 3031 3032@item msmouse 3033Three button serial mouse. Configure the guest to use Microsoft protocol. 3034@end table 3035ETEXI 3036 3037DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 3038 "-parallel dev redirect the parallel port to char device 'dev'\n", 3039 QEMU_ARCH_ALL) 3040STEXI 3041@item -parallel @var{dev} 3042@findex -parallel 3043Redirect the virtual parallel port to host device @var{dev} (same 3044devices as the serial port). On Linux hosts, @file{/dev/parportN} can 3045be used to use hardware devices connected on the corresponding host 3046parallel port. 3047 3048This option can be used several times to simulate up to 3 parallel 3049ports. 3050 3051Use @code{-parallel none} to disable all parallel ports. 3052ETEXI 3053 3054DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 3055 "-monitor dev redirect the monitor to char device 'dev'\n", 3056 QEMU_ARCH_ALL) 3057STEXI 3058@item -monitor @var{dev} 3059@findex -monitor 3060Redirect the monitor to host device @var{dev} (same devices as the 3061serial port). 3062The default device is @code{vc} in graphical mode and @code{stdio} in 3063non graphical mode. 3064Use @code{-monitor none} to disable the default monitor. 3065ETEXI 3066DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 3067 "-qmp dev like -monitor but opens in 'control' mode\n", 3068 QEMU_ARCH_ALL) 3069STEXI 3070@item -qmp @var{dev} 3071@findex -qmp 3072Like -monitor but opens in 'control' mode. 3073ETEXI 3074DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 3075 "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 3076 QEMU_ARCH_ALL) 3077STEXI 3078@item -qmp-pretty @var{dev} 3079@findex -qmp-pretty 3080Like -qmp but uses pretty JSON formatting. 3081ETEXI 3082 3083DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 3084 "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 3085STEXI 3086@item -mon [chardev=]name[,mode=readline|control][,default] 3087@findex -mon 3088Setup monitor on chardev @var{name}. 3089ETEXI 3090 3091DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 3092 "-debugcon dev redirect the debug console to char device 'dev'\n", 3093 QEMU_ARCH_ALL) 3094STEXI 3095@item -debugcon @var{dev} 3096@findex -debugcon 3097Redirect the debug console to host device @var{dev} (same devices as the 3098serial port). The debug console is an I/O port which is typically port 30990xe9; writing to that I/O port sends output to this device. 3100The default device is @code{vc} in graphical mode and @code{stdio} in 3101non graphical mode. 3102ETEXI 3103 3104DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 3105 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 3106STEXI 3107@item -pidfile @var{file} 3108@findex -pidfile 3109Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 3110from a script. 3111ETEXI 3112 3113DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 3114 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 3115STEXI 3116@item -singlestep 3117@findex -singlestep 3118Run the emulation in single step mode. 3119ETEXI 3120 3121DEF("S", 0, QEMU_OPTION_S, \ 3122 "-S freeze CPU at startup (use 'c' to start execution)\n", 3123 QEMU_ARCH_ALL) 3124STEXI 3125@item -S 3126@findex -S 3127Do not start CPU at startup (you must type 'c' in the monitor). 3128ETEXI 3129 3130DEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 3131 "-realtime [mlock=on|off]\n" 3132 " run qemu with realtime features\n" 3133 " mlock=on|off controls mlock support (default: on)\n", 3134 QEMU_ARCH_ALL) 3135STEXI 3136@item -realtime mlock=on|off 3137@findex -realtime 3138Run qemu with realtime features. 3139mlocking qemu and guest memory can be enabled via @option{mlock=on} 3140(enabled by default). 3141ETEXI 3142 3143DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 3144 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 3145STEXI 3146@item -gdb @var{dev} 3147@findex -gdb 3148Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 3149connections will likely be TCP-based, but also UDP, pseudo TTY, or even 3150stdio are reasonable use case. The latter is allowing to start QEMU from 3151within gdb and establish the connection via a pipe: 3152@example 3153(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 3154@end example 3155ETEXI 3156 3157DEF("s", 0, QEMU_OPTION_s, \ 3158 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 3159 QEMU_ARCH_ALL) 3160STEXI 3161@item -s 3162@findex -s 3163Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 3164(@pxref{gdb_usage}). 3165ETEXI 3166 3167DEF("d", HAS_ARG, QEMU_OPTION_d, \ 3168 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 3169 QEMU_ARCH_ALL) 3170STEXI 3171@item -d @var{item1}[,...] 3172@findex -d 3173Enable logging of specified items. Use '-d help' for a list of log items. 3174ETEXI 3175 3176DEF("D", HAS_ARG, QEMU_OPTION_D, \ 3177 "-D logfile output log to logfile (default stderr)\n", 3178 QEMU_ARCH_ALL) 3179STEXI 3180@item -D @var{logfile} 3181@findex -D 3182Output log in @var{logfile} instead of to stderr 3183ETEXI 3184 3185DEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \ 3186 "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n", 3187 QEMU_ARCH_ALL) 3188STEXI 3189@item -dfilter @var{range1}[,...] 3190@findex -dfilter 3191Filter debug output to that relevant to a range of target addresses. The filter 3192spec can be either @var{start}+@var{size}, @var{start}-@var{size} or 3193@var{start}..@var{end} where @var{start} @var{end} and @var{size} are the 3194addresses and sizes required. For example: 3195@example 3196 -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000 3197@end example 3198Will dump output for any code in the 0x1000 sized block starting at 0x8000 and 3199the 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized 3200block starting at 0xffffffc00005f000. 3201ETEXI 3202 3203DEF("L", HAS_ARG, QEMU_OPTION_L, \ 3204 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 3205 QEMU_ARCH_ALL) 3206STEXI 3207@item -L @var{path} 3208@findex -L 3209Set the directory for the BIOS, VGA BIOS and keymaps. 3210ETEXI 3211 3212DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 3213 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 3214STEXI 3215@item -bios @var{file} 3216@findex -bios 3217Set the filename for the BIOS. 3218ETEXI 3219 3220DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 3221 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 3222STEXI 3223@item -enable-kvm 3224@findex -enable-kvm 3225Enable KVM full virtualization support. This option is only available 3226if KVM support is enabled when compiling. 3227ETEXI 3228 3229DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 3230 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 3231DEF("xen-create", 0, QEMU_OPTION_xen_create, 3232 "-xen-create create domain using xen hypercalls, bypassing xend\n" 3233 " warning: should not be used when xend is in use\n", 3234 QEMU_ARCH_ALL) 3235DEF("xen-attach", 0, QEMU_OPTION_xen_attach, 3236 "-xen-attach attach to existing xen domain\n" 3237 " xend will use this when starting QEMU\n", 3238 QEMU_ARCH_ALL) 3239STEXI 3240@item -xen-domid @var{id} 3241@findex -xen-domid 3242Specify xen guest domain @var{id} (XEN only). 3243@item -xen-create 3244@findex -xen-create 3245Create domain using xen hypercalls, bypassing xend. 3246Warning: should not be used when xend is in use (XEN only). 3247@item -xen-attach 3248@findex -xen-attach 3249Attach to existing xen domain. 3250xend will use this when starting QEMU (XEN only). 3251ETEXI 3252 3253DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 3254 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 3255STEXI 3256@item -no-reboot 3257@findex -no-reboot 3258Exit instead of rebooting. 3259ETEXI 3260 3261DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 3262 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 3263STEXI 3264@item -no-shutdown 3265@findex -no-shutdown 3266Don't exit QEMU on guest shutdown, but instead only stop the emulation. 3267This allows for instance switching to monitor to commit changes to the 3268disk image. 3269ETEXI 3270 3271DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 3272 "-loadvm [tag|id]\n" \ 3273 " start right away with a saved state (loadvm in monitor)\n", 3274 QEMU_ARCH_ALL) 3275STEXI 3276@item -loadvm @var{file} 3277@findex -loadvm 3278Start right away with a saved state (@code{loadvm} in monitor) 3279ETEXI 3280 3281#ifndef _WIN32 3282DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 3283 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 3284#endif 3285STEXI 3286@item -daemonize 3287@findex -daemonize 3288Daemonize the QEMU process after initialization. QEMU will not detach from 3289standard IO until it is ready to receive connections on any of its devices. 3290This option is a useful way for external programs to launch QEMU without having 3291to cope with initialization race conditions. 3292ETEXI 3293 3294DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 3295 "-option-rom rom load a file, rom, into the option ROM space\n", 3296 QEMU_ARCH_ALL) 3297STEXI 3298@item -option-rom @var{file} 3299@findex -option-rom 3300Load the contents of @var{file} as an option ROM. 3301This option is useful to load things like EtherBoot. 3302ETEXI 3303 3304HXCOMM Silently ignored for compatibility 3305DEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL) 3306 3307HXCOMM Options deprecated by -rtc 3308DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 3309DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 3310 3311DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 3312 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 3313 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 3314 QEMU_ARCH_ALL) 3315 3316STEXI 3317 3318@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 3319@findex -rtc 3320Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 3321UTC or local time, respectively. @code{localtime} is required for correct date in 3322MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 3323format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 3324 3325By default the RTC is driven by the host system time. This allows using of the 3326RTC as accurate reference clock inside the guest, specifically if the host 3327time is smoothly following an accurate external reference clock, e.g. via NTP. 3328If you want to isolate the guest time from the host, you can set @option{clock} 3329to @code{rt} instead. To even prevent it from progressing during suspension, 3330you can set it to @code{vm}. 3331 3332Enable @option{driftfix} (i386 targets only) if you experience time drift problems, 3333specifically with Windows' ACPI HAL. This option will try to figure out how 3334many timer interrupts were not processed by the Windows guest and will 3335re-inject them. 3336ETEXI 3337 3338DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 3339 "-icount [shift=N|auto][,align=on|off][,sleep=on|off,rr=record|replay,rrfile=<filename>]\n" \ 3340 " enable virtual instruction counter with 2^N clock ticks per\n" \ 3341 " instruction, enable aligning the host and virtual clocks\n" \ 3342 " or disable real time cpu sleeping\n", QEMU_ARCH_ALL) 3343STEXI 3344@item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename}] 3345@findex -icount 3346Enable virtual instruction counter. The virtual cpu will execute one 3347instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 3348then the virtual cpu speed will be automatically adjusted to keep virtual 3349time within a few seconds of real time. 3350 3351When the virtual cpu is sleeping, the virtual time will advance at default 3352speed unless @option{sleep=on|off} is specified. 3353With @option{sleep=on|off}, the virtual time will jump to the next timer deadline 3354instantly whenever the virtual cpu goes to sleep mode and will not advance 3355if no timer is enabled. This behavior give deterministic execution times from 3356the guest point of view. 3357 3358Note that while this option can give deterministic behavior, it does not 3359provide cycle accurate emulation. Modern CPUs contain superscalar out of 3360order cores with complex cache hierarchies. The number of instructions 3361executed often has little or no correlation with actual performance. 3362 3363@option{align=on} will activate the delay algorithm which will try 3364to synchronise the host clock and the virtual clock. The goal is to 3365have a guest running at the real frequency imposed by the shift option. 3366Whenever the guest clock is behind the host clock and if 3367@option{align=on} is specified then we print a message to the user 3368to inform about the delay. 3369Currently this option does not work when @option{shift} is @code{auto}. 3370Note: The sync algorithm will work for those shift values for which 3371the guest clock runs ahead of the host clock. Typically this happens 3372when the shift value is high (how high depends on the host machine). 3373 3374When @option{rr} option is specified deterministic record/replay is enabled. 3375Replay log is written into @var{filename} file in record mode and 3376read from this file in replay mode. 3377ETEXI 3378 3379DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 3380 "-watchdog model\n" \ 3381 " enable virtual hardware watchdog [default=none]\n", 3382 QEMU_ARCH_ALL) 3383STEXI 3384@item -watchdog @var{model} 3385@findex -watchdog 3386Create a virtual hardware watchdog device. Once enabled (by a guest 3387action), the watchdog must be periodically polled by an agent inside 3388the guest or else the guest will be restarted. Choose a model for 3389which your guest has drivers. 3390 3391The @var{model} is the model of hardware watchdog to emulate. Use 3392@code{-watchdog help} to list available hardware models. Only one 3393watchdog can be enabled for a guest. 3394 3395The following models may be available: 3396@table @option 3397@item ib700 3398iBASE 700 is a very simple ISA watchdog with a single timer. 3399@item i6300esb 3400Intel 6300ESB I/O controller hub is a much more featureful PCI-based 3401dual-timer watchdog. 3402@item diag288 3403A virtual watchdog for s390x backed by the diagnose 288 hypercall 3404(currently KVM only). 3405@end table 3406ETEXI 3407 3408DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 3409 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 3410 " action when watchdog fires [default=reset]\n", 3411 QEMU_ARCH_ALL) 3412STEXI 3413@item -watchdog-action @var{action} 3414@findex -watchdog-action 3415 3416The @var{action} controls what QEMU will do when the watchdog timer 3417expires. 3418The default is 3419@code{reset} (forcefully reset the guest). 3420Other possible actions are: 3421@code{shutdown} (attempt to gracefully shutdown the guest), 3422@code{poweroff} (forcefully poweroff the guest), 3423@code{pause} (pause the guest), 3424@code{debug} (print a debug message and continue), or 3425@code{none} (do nothing). 3426 3427Note that the @code{shutdown} action requires that the guest responds 3428to ACPI signals, which it may not be able to do in the sort of 3429situations where the watchdog would have expired, and thus 3430@code{-watchdog-action shutdown} is not recommended for production use. 3431 3432Examples: 3433 3434@table @code 3435@item -watchdog i6300esb -watchdog-action pause 3436@itemx -watchdog ib700 3437@end table 3438ETEXI 3439 3440DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 3441 "-echr chr set terminal escape character instead of ctrl-a\n", 3442 QEMU_ARCH_ALL) 3443STEXI 3444 3445@item -echr @var{numeric_ascii_value} 3446@findex -echr 3447Change the escape character used for switching to the monitor when using 3448monitor and serial sharing. The default is @code{0x01} when using the 3449@code{-nographic} option. @code{0x01} is equal to pressing 3450@code{Control-a}. You can select a different character from the ascii 3451control keys where 1 through 26 map to Control-a through Control-z. For 3452instance you could use the either of the following to change the escape 3453character to Control-t. 3454@table @code 3455@item -echr 0x14 3456@itemx -echr 20 3457@end table 3458ETEXI 3459 3460DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 3461 "-virtioconsole c\n" \ 3462 " set virtio console\n", QEMU_ARCH_ALL) 3463STEXI 3464@item -virtioconsole @var{c} 3465@findex -virtioconsole 3466Set virtio console. 3467 3468This option is maintained for backward compatibility. 3469 3470Please use @code{-device virtconsole} for the new way of invocation. 3471ETEXI 3472 3473DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3474 "-show-cursor show cursor\n", QEMU_ARCH_ALL) 3475STEXI 3476@item -show-cursor 3477@findex -show-cursor 3478Show cursor. 3479ETEXI 3480 3481DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3482 "-tb-size n set TB size\n", QEMU_ARCH_ALL) 3483STEXI 3484@item -tb-size @var{n} 3485@findex -tb-size 3486Set TB size. 3487ETEXI 3488 3489DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 3490 "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \ 3491 "-incoming rdma:host:port[,ipv4][,ipv6]\n" \ 3492 "-incoming unix:socketpath\n" \ 3493 " prepare for incoming migration, listen on\n" \ 3494 " specified protocol and socket address\n" \ 3495 "-incoming fd:fd\n" \ 3496 "-incoming exec:cmdline\n" \ 3497 " accept incoming migration on given file descriptor\n" \ 3498 " or from given external command\n" \ 3499 "-incoming defer\n" \ 3500 " wait for the URI to be specified via migrate_incoming\n", 3501 QEMU_ARCH_ALL) 3502STEXI 3503@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6] 3504@itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6] 3505@findex -incoming 3506Prepare for incoming migration, listen on a given tcp port. 3507 3508@item -incoming unix:@var{socketpath} 3509Prepare for incoming migration, listen on a given unix socket. 3510 3511@item -incoming fd:@var{fd} 3512Accept incoming migration from a given filedescriptor. 3513 3514@item -incoming exec:@var{cmdline} 3515Accept incoming migration as an output from specified external command. 3516 3517@item -incoming defer 3518Wait for the URI to be specified via migrate_incoming. The monitor can 3519be used to change settings (such as migration parameters) prior to issuing 3520the migrate_incoming to allow the migration to begin. 3521ETEXI 3522 3523DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3524 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3525STEXI 3526@item -nodefaults 3527@findex -nodefaults 3528Don't create default devices. Normally, QEMU sets the default devices like serial 3529port, parallel port, virtual console, monitor device, VGA adapter, floppy and 3530CD-ROM drive and others. The @code{-nodefaults} option will disable all those 3531default devices. 3532ETEXI 3533 3534#ifndef _WIN32 3535DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3536 "-chroot dir chroot to dir just before starting the VM\n", 3537 QEMU_ARCH_ALL) 3538#endif 3539STEXI 3540@item -chroot @var{dir} 3541@findex -chroot 3542Immediately before starting guest execution, chroot to the specified 3543directory. Especially useful in combination with -runas. 3544ETEXI 3545 3546#ifndef _WIN32 3547DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 3548 "-runas user change to user id user just before starting the VM\n", 3549 QEMU_ARCH_ALL) 3550#endif 3551STEXI 3552@item -runas @var{user} 3553@findex -runas 3554Immediately before starting guest execution, drop root privileges, switching 3555to the specified user. 3556ETEXI 3557 3558DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 3559 "-prom-env variable=value\n" 3560 " set OpenBIOS nvram variables\n", 3561 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 3562STEXI 3563@item -prom-env @var{variable}=@var{value} 3564@findex -prom-env 3565Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 3566ETEXI 3567DEF("semihosting", 0, QEMU_OPTION_semihosting, 3568 "-semihosting semihosting mode\n", 3569 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 3570 QEMU_ARCH_MIPS) 3571STEXI 3572@item -semihosting 3573@findex -semihosting 3574Enable semihosting mode (ARM, M68K, Xtensa, MIPS only). 3575ETEXI 3576DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 3577 "-semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]]\n" \ 3578 " semihosting configuration\n", 3579QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 3580QEMU_ARCH_MIPS) 3581STEXI 3582@item -semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]] 3583@findex -semihosting-config 3584Enable and configure semihosting (ARM, M68K, Xtensa, MIPS only). 3585@table @option 3586@item target=@code{native|gdb|auto} 3587Defines where the semihosting calls will be addressed, to QEMU (@code{native}) 3588or to GDB (@code{gdb}). The default is @code{auto}, which means @code{gdb} 3589during debug sessions and @code{native} otherwise. 3590@item arg=@var{str1},arg=@var{str2},... 3591Allows the user to pass input arguments, and can be used multiple times to build 3592up a list. The old-style @code{-kernel}/@code{-append} method of passing a 3593command line is still supported for backward compatibility. If both the 3594@code{--semihosting-config arg} and the @code{-kernel}/@code{-append} are 3595specified, the former is passed to semihosting as it always takes precedence. 3596@end table 3597ETEXI 3598DEF("old-param", 0, QEMU_OPTION_old_param, 3599 "-old-param old param mode\n", QEMU_ARCH_ARM) 3600STEXI 3601@item -old-param 3602@findex -old-param (ARM) 3603Old param mode (ARM only). 3604ETEXI 3605 3606DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 3607 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 3608 QEMU_ARCH_ALL) 3609STEXI 3610@item -sandbox @var{arg} 3611@findex -sandbox 3612Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 3613disable it. The default is 'off'. 3614ETEXI 3615 3616DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3617 "-readconfig <file>\n", QEMU_ARCH_ALL) 3618STEXI 3619@item -readconfig @var{file} 3620@findex -readconfig 3621Read device configuration from @var{file}. This approach is useful when you want to spawn 3622QEMU process with many command line options but you don't want to exceed the command line 3623character limit. 3624ETEXI 3625DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3626 "-writeconfig <file>\n" 3627 " read/write config file\n", QEMU_ARCH_ALL) 3628STEXI 3629@item -writeconfig @var{file} 3630@findex -writeconfig 3631Write device configuration to @var{file}. The @var{file} can be either filename to save 3632command line and device configuration into file or dash @code{-}) character to print the 3633output to stdout. This can be later used as input file for @code{-readconfig} option. 3634ETEXI 3635DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3636 "-nodefconfig\n" 3637 " do not load default config files at startup\n", 3638 QEMU_ARCH_ALL) 3639STEXI 3640@item -nodefconfig 3641@findex -nodefconfig 3642Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3643The @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3644ETEXI 3645DEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3646 "-no-user-config\n" 3647 " do not load user-provided config files at startup\n", 3648 QEMU_ARCH_ALL) 3649STEXI 3650@item -no-user-config 3651@findex -no-user-config 3652The @code{-no-user-config} option makes QEMU not load any of the user-provided 3653config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3654files from @var{datadir}. 3655ETEXI 3656DEF("trace", HAS_ARG, QEMU_OPTION_trace, 3657 "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 3658 " specify tracing options\n", 3659 QEMU_ARCH_ALL) 3660STEXI 3661HXCOMM This line is not accurate, as some sub-options are backend-specific but 3662HXCOMM HX does not support conditional compilation of text. 3663@item -trace [events=@var{file}][,file=@var{file}] 3664@findex -trace 3665 3666Specify tracing options. 3667 3668@table @option 3669@item [enable=]@var{pattern} 3670Immediately enable events matching @var{pattern}. 3671The file must contain one event name (as listed in the @file{trace-events} file) 3672per line; globbing patterns are accepted too. This option is only 3673available if QEMU has been compiled with the @var{simple}, @var{stderr} 3674or @var{ftrace} tracing backend. To specify multiple events or patterns, 3675specify the @option{-trace} option multiple times. 3676 3677Use @code{-trace help} to print a list of names of trace points. 3678 3679@item events=@var{file} 3680Immediately enable events listed in @var{file}. 3681The file must contain one event name (as listed in the @file{trace-events} file) 3682per line; globbing patterns are accepted too. This option is only 3683available if QEMU has been compiled with the @var{simple}, @var{stderr} or 3684@var{ftrace} tracing backend. 3685 3686@item file=@var{file} 3687Log output traces to @var{file}. 3688This option is only available if QEMU has been compiled with 3689the @var{simple} tracing backend. 3690@end table 3691ETEXI 3692 3693HXCOMM Internal use 3694DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 3695DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3696 3697#ifdef __linux__ 3698DEF("enable-fips", 0, QEMU_OPTION_enablefips, 3699 "-enable-fips enable FIPS 140-2 compliance\n", 3700 QEMU_ARCH_ALL) 3701#endif 3702STEXI 3703@item -enable-fips 3704@findex -enable-fips 3705Enable FIPS 140-2 compliance mode. 3706ETEXI 3707 3708HXCOMM Deprecated by -machine accel=tcg property 3709DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3710 3711HXCOMM Deprecated by kvm-pit driver properties 3712DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3713 "", QEMU_ARCH_I386) 3714 3715HXCOMM Deprecated (ignored) 3716DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 3717 3718HXCOMM Deprecated by -machine kernel_irqchip=on|off property 3719DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3720 3721HXCOMM Deprecated (ignored) 3722DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 3723 3724DEF("msg", HAS_ARG, QEMU_OPTION_msg, 3725 "-msg timestamp[=on|off]\n" 3726 " change the format of messages\n" 3727 " on|off controls leading timestamps (default:on)\n", 3728 QEMU_ARCH_ALL) 3729STEXI 3730@item -msg timestamp[=on|off] 3731@findex -msg 3732prepend a timestamp to each log message.(default:on) 3733ETEXI 3734 3735DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 3736 "-dump-vmstate <file>\n" 3737 " Output vmstate information in JSON format to file.\n" 3738 " Use the scripts/vmstate-static-checker.py file to\n" 3739 " check for possible regressions in migration code\n" 3740 " by comparing two such vmstate dumps.\n", 3741 QEMU_ARCH_ALL) 3742STEXI 3743@item -dump-vmstate @var{file} 3744@findex -dump-vmstate 3745Dump json-encoded vmstate information for current machine type to file 3746in @var{file} 3747ETEXI 3748 3749DEFHEADING(Generic object creation) 3750 3751DEF("object", HAS_ARG, QEMU_OPTION_object, 3752 "-object TYPENAME[,PROP1=VALUE1,...]\n" 3753 " create a new object of type TYPENAME setting properties\n" 3754 " in the order they are specified. Note that the 'id'\n" 3755 " property must be set. These objects are placed in the\n" 3756 " '/objects' path.\n", 3757 QEMU_ARCH_ALL) 3758STEXI 3759@item -object @var{typename}[,@var{prop1}=@var{value1},...] 3760@findex -object 3761Create a new object of type @var{typename} setting properties 3762in the order they are specified. Note that the 'id' 3763property must be set. These objects are placed in the 3764'/objects' path. 3765 3766@table @option 3767 3768@item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off} 3769 3770Creates a memory file backend object, which can be used to back 3771the guest RAM with huge pages. The @option{id} parameter is a 3772unique ID that will be used to reference this memory region 3773when configuring the @option{-numa} argument. The @option{size} 3774option provides the size of the memory region, and accepts 3775common suffixes, eg @option{500M}. The @option{mem-path} provides 3776the path to either a shared memory or huge page filesystem mount. 3777The @option{share} boolean option determines whether the memory 3778region is marked as private to QEMU, or shared. The latter allows 3779a co-operating external process to access the QEMU memory region. 3780 3781@item -object rng-random,id=@var{id},filename=@var{/dev/random} 3782 3783Creates a random number generator backend which obtains entropy from 3784a device on the host. The @option{id} parameter is a unique ID that 3785will be used to reference this entropy backend from the @option{virtio-rng} 3786device. The @option{filename} parameter specifies which file to obtain 3787entropy from and if omitted defaults to @option{/dev/random}. 3788 3789@item -object rng-egd,id=@var{id},chardev=@var{chardevid} 3790 3791Creates a random number generator backend which obtains entropy from 3792an external daemon running on the host. The @option{id} parameter is 3793a unique ID that will be used to reference this entropy backend from 3794the @option{virtio-rng} device. The @option{chardev} parameter is 3795the unique ID of a character device backend that provides the connection 3796to the RNG daemon. 3797 3798@item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off} 3799 3800Creates a TLS anonymous credentials object, which can be used to provide 3801TLS support on network backends. The @option{id} parameter is a unique 3802ID which network backends will use to access the credentials. The 3803@option{endpoint} is either @option{server} or @option{client} depending 3804on whether the QEMU network backend that uses the credentials will be 3805acting as a client or as a server. If @option{verify-peer} is enabled 3806(the default) then once the handshake is completed, the peer credentials 3807will be verified, though this is a no-op for anonymous credentials. 3808 3809The @var{dir} parameter tells QEMU where to find the credential 3810files. For server endpoints, this directory may contain a file 3811@var{dh-params.pem} providing diffie-hellman parameters to use 3812for the TLS server. If the file is missing, QEMU will generate 3813a set of DH parameters at startup. This is a computationally 3814expensive operation that consumes random pool entropy, so it is 3815recommended that a persistent set of parameters be generated 3816upfront and saved. 3817 3818@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} 3819 3820Creates a TLS anonymous credentials object, which can be used to provide 3821TLS support on network backends. The @option{id} parameter is a unique 3822ID which network backends will use to access the credentials. The 3823@option{endpoint} is either @option{server} or @option{client} depending 3824on whether the QEMU network backend that uses the credentials will be 3825acting as a client or as a server. If @option{verify-peer} is enabled 3826(the default) then once the handshake is completed, the peer credentials 3827will be verified. With x509 certificates, this implies that the clients 3828must be provided with valid client certificates too. 3829 3830The @var{dir} parameter tells QEMU where to find the credential 3831files. For server endpoints, this directory may contain a file 3832@var{dh-params.pem} providing diffie-hellman parameters to use 3833for the TLS server. If the file is missing, QEMU will generate 3834a set of DH parameters at startup. This is a computationally 3835expensive operation that consumes random pool entropy, so it is 3836recommended that a persistent set of parameters be generated 3837upfront and saved. 3838 3839For x509 certificate credentials the directory will contain further files 3840providing the x509 certificates. The certificates must be stored 3841in PEM format, in filenames @var{ca-cert.pem}, @var{ca-crl.pem} (optional), 3842@var{server-cert.pem} (only servers), @var{server-key.pem} (only servers), 3843@var{client-cert.pem} (only clients), and @var{client-key.pem} (only clients). 3844 3845For the @var{server-key.pem} and @var{client-key.pem} files which 3846contain sensitive private keys, it is possible to use an encrypted 3847version by providing the @var{passwordid} parameter. This provides 3848the ID of a previously created @code{secret} object containing the 3849password for decryption. 3850 3851@item -object filter-buffer,id=@var{id},netdev=@var{netdevid},interval=@var{t}[,queue=@var{all|rx|tx}][,status=@var{on|off}] 3852 3853Interval @var{t} can't be 0, this filter batches the packet delivery: all 3854packets arriving in a given interval on netdev @var{netdevid} are delayed 3855until the end of the interval. Interval is in microseconds. 3856@option{status} is optional that indicate whether the netfilter is 3857on (enabled) or off (disabled), the default status for netfilter will be 'on'. 3858 3859queue @var{all|rx|tx} is an option that can be applied to any netfilter. 3860 3861@option{all}: the filter is attached both to the receive and the transmit 3862 queue of the netdev (default). 3863 3864@option{rx}: the filter is attached to the receive queue of the netdev, 3865 where it will receive packets sent to the netdev. 3866 3867@option{tx}: the filter is attached to the transmit queue of the netdev, 3868 where it will receive packets sent by the netdev. 3869 3870@item -object filter-mirror,id=@var{id},netdev=@var{netdevid},outdev=@var{chardevid}[,queue=@var{all|rx|tx}] 3871 3872filter-mirror on netdev @var{netdevid},mirror net packet to chardev 3873@var{chardevid} 3874 3875@item -object filter-redirector,id=@var{id},netdev=@var{netdevid},indev=@var{chardevid}, 3876outdev=@var{chardevid}[,queue=@var{all|rx|tx}] 3877 3878filter-redirector on netdev @var{netdevid},redirect filter's net packet to chardev 3879@var{chardevid},and redirect indev's packet to filter. 3880Create a filter-redirector we need to differ outdev id from indev id, id can not 3881be the same. we can just use indev or outdev, but at least one of indev or outdev 3882need to be specified. 3883 3884@item -object filter-dump,id=@var{id},netdev=@var{dev},file=@var{filename}][,maxlen=@var{len}] 3885 3886Dump the network traffic on netdev @var{dev} to the file specified by 3887@var{filename}. At most @var{len} bytes (64k by default) per packet are stored. 3888The file format is libpcap, so it can be analyzed with tools such as tcpdump 3889or Wireshark. 3890 3891@item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}] 3892@item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}] 3893 3894Defines a secret to store a password, encryption key, or some other sensitive 3895data. The sensitive data can either be passed directly via the @var{data} 3896parameter, or indirectly via the @var{file} parameter. Using the @var{data} 3897parameter is insecure unless the sensitive data is encrypted. 3898 3899The sensitive data can be provided in raw format (the default), or base64. 3900When encoded as JSON, the raw format only supports valid UTF-8 characters, 3901so base64 is recommended for sending binary data. QEMU will convert from 3902which ever format is provided to the format it needs internally. eg, an 3903RBD password can be provided in raw format, even though it will be base64 3904encoded when passed onto the RBD sever. 3905 3906For added protection, it is possible to encrypt the data associated with 3907a secret using the AES-256-CBC cipher. Use of encryption is indicated 3908by providing the @var{keyid} and @var{iv} parameters. The @var{keyid} 3909parameter provides the ID of a previously defined secret that contains 3910the AES-256 decryption key. This key should be 32-bytes long and be 3911base64 encoded. The @var{iv} parameter provides the random initialization 3912vector used for encryption of this particular secret and should be a 3913base64 encrypted string of the 16-byte IV. 3914 3915The simplest (insecure) usage is to provide the secret inline 3916 3917@example 3918 3919 # $QEMU -object secret,id=sec0,data=letmein,format=raw 3920 3921@end example 3922 3923The simplest secure usage is to provide the secret via a file 3924 3925 # echo -n "letmein" > mypasswd.txt 3926 # $QEMU -object secret,id=sec0,file=mypasswd.txt,format=raw 3927 3928For greater security, AES-256-CBC should be used. To illustrate usage, 3929consider the openssl command line tool which can encrypt the data. Note 3930that when encrypting, the plaintext must be padded to the cipher block 3931size (32 bytes) using the standard PKCS#5/6 compatible padding algorithm. 3932 3933First a master key needs to be created in base64 encoding: 3934 3935@example 3936 # openssl rand -base64 32 > key.b64 3937 # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"') 3938@end example 3939 3940Each secret to be encrypted needs to have a random initialization vector 3941generated. These do not need to be kept secret 3942 3943@example 3944 # openssl rand -base64 16 > iv.b64 3945 # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"') 3946@end example 3947 3948The secret to be defined can now be encrypted, in this case we're 3949telling openssl to base64 encode the result, but it could be left 3950as raw bytes if desired. 3951 3952@example 3953 # SECRET=$(echo -n "letmein" | 3954 openssl enc -aes-256-cbc -a -K $KEY -iv $IV) 3955@end example 3956 3957When launching QEMU, create a master secret pointing to @code{key.b64} 3958and specify that to be used to decrypt the user password. Pass the 3959contents of @code{iv.b64} to the second secret 3960 3961@example 3962 # $QEMU \ 3963 -object secret,id=secmaster0,format=base64,file=key.b64 \ 3964 -object secret,id=sec0,keyid=secmaster0,format=base64,\ 3965 data=$SECRET,iv=$(<iv.b64) 3966@end example 3967 3968@end table 3969 3970ETEXI 3971 3972 3973HXCOMM This is the last statement. Insert new options before this line! 3974STEXI 3975@end table 3976ETEXI 3977
