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