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