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