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