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