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