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