15824d651Sblueswir1HXCOMM Use DEFHEADING() to define headings in both help text and texi 25824d651Sblueswir1HXCOMM Text between STEXI and ETEXI are copied to texi version and 35824d651Sblueswir1HXCOMM discarded from C version 4ad96090aSBlue SwirlHXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to 5ad96090aSBlue SwirlHXCOMM construct option structures, enums and help message for specified 6ad96090aSBlue SwirlHXCOMM architectures. 75824d651Sblueswir1HXCOMM HXCOMM can be used for comments, discarded from both texi and C 85824d651Sblueswir1 9de6b4f90SMarkus ArmbrusterDEFHEADING(Standard options:) 105824d651Sblueswir1STEXI 115824d651Sblueswir1@table @option 125824d651Sblueswir1ETEXI 135824d651Sblueswir1 145824d651Sblueswir1DEF("help", 0, QEMU_OPTION_h, 15ad96090aSBlue Swirl "-h or -help display this help and exit\n", QEMU_ARCH_ALL) 165824d651Sblueswir1STEXI 175824d651Sblueswir1@item -h 186616b2adSStefan Weil@findex -h 195824d651Sblueswir1Display help and exit 205824d651Sblueswir1ETEXI 215824d651Sblueswir1 229bd7e6d9SpbrookDEF("version", 0, QEMU_OPTION_version, 23ad96090aSBlue Swirl "-version display version information and exit\n", QEMU_ARCH_ALL) 249bd7e6d9SpbrookSTEXI 259bd7e6d9Spbrook@item -version 266616b2adSStefan Weil@findex -version 279bd7e6d9SpbrookDisplay version information and exit 289bd7e6d9SpbrookETEXI 299bd7e6d9Spbrook 3080f52a66SJan KiszkaDEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 3180f52a66SJan Kiszka "-machine [type=]name[,prop[=value][,...]]\n" 32585f6036SPeter Maydell " selects emulated machine ('-machine help' for list)\n" 3380f52a66SJan Kiszka " property accel=accel1[:accel2[:...]] selects accelerator\n" 34d661d9a4SJustin Terry (VM) " supported accelerators are kvm, xen, hax, hvf, whpx or tcg (default: tcg)\n" 3532c18a2dSMatt Gingell " kernel_irqchip=on|off|split controls accelerated irqchip support (default=off)\n" 36d1048befSDon Slutz " vmport=on|off|auto controls emulation of vmport (default: auto)\n" 3796404013SPeter Maydell " kvm_shadow_mem=size of KVM shadow MMU in bytes\n" 388490fc78SLuiz Capitulino " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 39a52a7fdfSLe Tan " mem-merge=on|off controls memory merge support (default: on)\n" 4079814179STiejun Chen " igd-passthru=on|off controls IGD GFX passthrough support (default=off)\n" 412eb1cd07STony Krowiak " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n" 429850c604SAlexander Graf " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n" 4387252e1bSXiao Guangrong " suppress-vmdesc=on|off disables self-describing migration (default=off)\n" 44902c053dSGreg Kurz " nvdimm=on|off controls NVDIMM support (default=off)\n" 45274250c3SXiao Feng Ren " enforce-config-section=on|off enforce configuration section migration (default=off)\n" 46db588194SBrijesh Singh " memory-encryption=@var{} memory encryption object to use (default=none)\n", 4780f52a66SJan Kiszka QEMU_ARCH_ALL) 485824d651Sblueswir1STEXI 4980f52a66SJan Kiszka@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 5080f52a66SJan Kiszka@findex -machine 51585f6036SPeter MaydellSelect the emulated machine by @var{name}. Use @code{-machine help} to list 528bfce83aSDaniel P. Berrangeavailable machines. 538bfce83aSDaniel P. Berrange 548bfce83aSDaniel P. BerrangeFor architectures which aim to support live migration compatibility 558bfce83aSDaniel P. Berrangeacross releases, each release will introduce a new versioned machine 568bfce83aSDaniel P. Berrangetype. For example, the 2.8.0 release introduced machine types 578bfce83aSDaniel P. Berrange``pc-i440fx-2.8'' and ``pc-q35-2.8'' for the x86_64/i686 architectures. 588bfce83aSDaniel P. Berrange 598bfce83aSDaniel P. BerrangeTo allow live migration of guests from QEMU version 2.8.0, to QEMU 608bfce83aSDaniel P. Berrangeversion 2.9.0, the 2.9.0 version must support the ``pc-i440fx-2.8'' 618bfce83aSDaniel P. Berrangeand ``pc-q35-2.8'' machines too. To allow users live migrating VMs 628bfce83aSDaniel P. Berrangeto skip multiple intermediate releases when upgrading, new releases 638bfce83aSDaniel P. Berrangeof QEMU will support machine types from many previous versions. 648bfce83aSDaniel P. Berrange 658bfce83aSDaniel P. BerrangeSupported machine properties are: 6680f52a66SJan Kiszka@table @option 6780f52a66SJan Kiszka@item accel=@var{accels1}[:@var{accels2}[:...]] 6880f52a66SJan KiszkaThis is used to enable an accelerator. Depending on the target architecture, 69d661d9a4SJustin Terry (VM)kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used. If there is 70bde4d920SThomas Huthmore than one accelerator specified, the next one is used if the previous one 71bde4d920SThomas Huthfails to initialize. 726a48ffaaSJan Kiszka@item kernel_irqchip=on|off 7332c18a2dSMatt GingellControls in-kernel irqchip support for the chosen accelerator when available. 7479814179STiejun Chen@item gfx_passthru=on|off 7579814179STiejun ChenEnables IGD GFX passthrough support for the chosen machine when available. 76d1048befSDon Slutz@item vmport=on|off|auto 77d1048befSDon SlutzEnables emulation of VMWare IO port, for vmmouse etc. auto says to select the 78d1048befSDon Slutzvalue based on accel. For accel=xen the default is off otherwise the default 79d1048befSDon Slutzis on. 8039d6960aSJan Kiszka@item kvm_shadow_mem=size 8139d6960aSJan KiszkaDefines the size of the KVM shadow MMU. 82ddb97f1dSJason Baron@item dump-guest-core=on|off 83ddb97f1dSJason BaronInclude guest memory in a core dump. The default is on. 848490fc78SLuiz Capitulino@item mem-merge=on|off 858490fc78SLuiz CapitulinoEnables or disables memory merge support. This feature, when supported by 868490fc78SLuiz Capitulinothe host, de-duplicates identical memory pages among VMs instances 878490fc78SLuiz Capitulino(enabled by default). 882eb1cd07STony Krowiak@item aes-key-wrap=on|off 892eb1cd07STony KrowiakEnables or disables AES key wrapping support on s390-ccw hosts. This feature 902eb1cd07STony Krowiakcontrols whether AES wrapping keys will be created to allow 912eb1cd07STony Krowiakexecution of AES cryptographic functions. The default is on. 922eb1cd07STony Krowiak@item dea-key-wrap=on|off 932eb1cd07STony KrowiakEnables or disables DEA key wrapping support on s390-ccw hosts. This feature 942eb1cd07STony Krowiakcontrols whether DEA wrapping keys will be created to allow 952eb1cd07STony Krowiakexecution of DEA cryptographic functions. The default is on. 9687252e1bSXiao Guangrong@item nvdimm=on|off 9787252e1bSXiao GuangrongEnables or disables NVDIMM support. The default is off. 9816f72448SPeter Xu@item enforce-config-section=on|off 9916f72448SPeter XuIf @option{enforce-config-section} is set to @var{on}, force migration 10016f72448SPeter Xucode to send configuration section even if the machine-type sets the 10116f72448SPeter Xu@option{migration.send-configuration} property to @var{off}. 10216f72448SPeter XuNOTE: this parameter is deprecated. Please use @option{-global} 10316f72448SPeter Xu@option{migration.send-configuration}=@var{on|off} instead. 104db588194SBrijesh Singh@item memory-encryption=@var{} 105db588194SBrijesh SinghMemory encryption object to use. The default is none. 10680f52a66SJan Kiszka@end table 1075824d651Sblueswir1ETEXI 1085824d651Sblueswir1 10980f52a66SJan KiszkaHXCOMM Deprecated by -machine 11080f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 11180f52a66SJan Kiszka 1125824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 113585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 1145824d651Sblueswir1STEXI 1155824d651Sblueswir1@item -cpu @var{model} 1166616b2adSStefan Weil@findex -cpu 117585f6036SPeter MaydellSelect CPU model (@code{-cpu help} for list and additional feature selection) 1185824d651Sblueswir1ETEXI 1195824d651Sblueswir1 1208d4e9146SKONRAD FredericDEF("accel", HAS_ARG, QEMU_OPTION_accel, 1218d4e9146SKONRAD Frederic "-accel [accel=]accelerator[,thread=single|multi]\n" 122d661d9a4SJustin Terry (VM) " select accelerator (kvm, xen, hax, hvf, whpx or tcg; use 'help' for a list)\n" 1230b3c5c81SEduardo Habkost " thread=single|multi (enable multi-threaded TCG)\n", QEMU_ARCH_ALL) 1248d4e9146SKONRAD FredericSTEXI 1258d4e9146SKONRAD Frederic@item -accel @var{name}[,prop=@var{value}[,...]] 1268d4e9146SKONRAD Frederic@findex -accel 1278d4e9146SKONRAD FredericThis is used to enable an accelerator. Depending on the target architecture, 128d661d9a4SJustin Terry (VM)kvm, xen, hax, hvf, whpx or tcg can be available. By default, tcg is used. If there is 129bde4d920SThomas Huthmore than one accelerator specified, the next one is used if the previous one 130bde4d920SThomas Huthfails to initialize. 1318d4e9146SKONRAD Frederic@table @option 1328d4e9146SKONRAD Frederic@item thread=single|multi 1338d4e9146SKONRAD FredericControls number of TCG threads. When the TCG is multi-threaded there will be one 1348d4e9146SKONRAD Fredericthread per vCPU therefor taking advantage of additional host cores. The default 1358d4e9146SKONRAD Fredericis to enable multi-threading where both the back-end and front-ends support it and 1368d4e9146SKONRAD Fredericno incompatible TCG features have been enabled (e.g. icount/replay). 1378d4e9146SKONRAD Frederic@end table 1388d4e9146SKONRAD FredericETEXI 1398d4e9146SKONRAD Frederic 1405824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 14112b7f57eSMichael Tokarev "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 1426be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 1436be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 144ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 14558a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 14658a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 147ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 148ad96090aSBlue Swirl QEMU_ARCH_ALL) 1495824d651Sblueswir1STEXI 15012b7f57eSMichael Tokarev@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 1516616b2adSStefan Weil@findex -smp 1525824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 1535824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 1545824d651Sblueswir1to 4. 15558a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 15658a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 15758a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 15858a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 15958a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 1605824d651Sblueswir1ETEXI 1615824d651Sblueswir1 162268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 163e0ee9fd0SEduardo Habkost "-numa node[,mem=size][,cpus=firstcpu[-lastcpu]][,nodeid=node]\n" 1640f203430SHe Chen "-numa node[,memdev=id][,cpus=firstcpu[-lastcpu]][,nodeid=node]\n" 1652d19c656SIgor Mammedov "-numa dist,src=source,dst=destination,val=distance\n" 1662d19c656SIgor Mammedov "-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]\n", 1672d19c656SIgor Mammedov QEMU_ARCH_ALL) 168268a362cSaliguoriSTEXI 169e0ee9fd0SEduardo Habkost@item -numa node[,mem=@var{size}][,cpus=@var{firstcpu}[-@var{lastcpu}]][,nodeid=@var{node}] 170e0ee9fd0SEduardo Habkost@itemx -numa node[,memdev=@var{id}][,cpus=@var{firstcpu}[-@var{lastcpu}]][,nodeid=@var{node}] 1710f203430SHe Chen@itemx -numa dist,src=@var{source},dst=@var{destination},val=@var{distance} 172419fcdecSIgor Mammedov@itemx -numa cpu,node-id=@var{node}[,socket-id=@var{x}][,core-id=@var{y}][,thread-id=@var{z}] 1736616b2adSStefan Weil@findex -numa 1744b9a5dd7SEduardo HabkostDefine a NUMA node and assign RAM and VCPUs to it. 1750f203430SHe ChenSet the NUMA distance from a source node to a destination node. 1767febe36fSPaolo Bonzini 177419fcdecSIgor MammedovLegacy VCPU assignment uses @samp{cpus} option where 1784b9a5dd7SEduardo Habkost@var{firstcpu} and @var{lastcpu} are CPU indexes. Each 1794b9a5dd7SEduardo Habkost@samp{cpus} option represent a contiguous range of CPU indexes 1804b9a5dd7SEduardo Habkost(or a single VCPU if @var{lastcpu} is omitted). A non-contiguous 1814b9a5dd7SEduardo Habkostset of VCPUs can be represented by providing multiple @samp{cpus} 1824b9a5dd7SEduardo Habkostoptions. If @samp{cpus} is omitted on all nodes, VCPUs are automatically 1834b9a5dd7SEduardo Habkostsplit between them. 1844b9a5dd7SEduardo Habkost 1854b9a5dd7SEduardo HabkostFor example, the following option assigns VCPUs 0, 1, 2 and 5 to 1864b9a5dd7SEduardo Habkosta NUMA node: 1874b9a5dd7SEduardo Habkost@example 1884b9a5dd7SEduardo Habkost-numa node,cpus=0-2,cpus=5 1894b9a5dd7SEduardo Habkost@end example 1904b9a5dd7SEduardo Habkost 191419fcdecSIgor Mammedov@samp{cpu} option is a new alternative to @samp{cpus} option 192419fcdecSIgor Mammedovwhich uses @samp{socket-id|core-id|thread-id} properties to assign 193419fcdecSIgor MammedovCPU objects to a @var{node} using topology layout properties of CPU. 194419fcdecSIgor MammedovThe set of properties is machine specific, and depends on used 195419fcdecSIgor Mammedovmachine type/@samp{smp} options. It could be queried with 196419fcdecSIgor Mammedov@samp{hotpluggable-cpus} monitor command. 197419fcdecSIgor Mammedov@samp{node-id} property specifies @var{node} to which CPU object 198419fcdecSIgor Mammedovwill be assigned, it's required for @var{node} to be declared 199419fcdecSIgor Mammedovwith @samp{node} option before it's used with @samp{cpu} option. 200419fcdecSIgor Mammedov 201419fcdecSIgor MammedovFor example: 202419fcdecSIgor Mammedov@example 203419fcdecSIgor Mammedov-M pc \ 204419fcdecSIgor Mammedov-smp 1,sockets=2,maxcpus=2 \ 205419fcdecSIgor Mammedov-numa node,nodeid=0 -numa node,nodeid=1 \ 206419fcdecSIgor Mammedov-numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1 207419fcdecSIgor Mammedov@end example 208419fcdecSIgor Mammedov 2094b9a5dd7SEduardo Habkost@samp{mem} assigns a given RAM amount to a node. @samp{memdev} 2104b9a5dd7SEduardo Habkostassigns RAM from a given memory backend device to a node. If 2114b9a5dd7SEduardo Habkost@samp{mem} and @samp{memdev} are omitted in all nodes, RAM is 2124b9a5dd7SEduardo Habkostsplit equally between them. 2134b9a5dd7SEduardo Habkost 2144b9a5dd7SEduardo Habkost@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, 2154b9a5dd7SEduardo Habkostif one node uses @samp{memdev}, all of them have to use it. 2164b9a5dd7SEduardo Habkost 2170f203430SHe Chen@var{source} and @var{destination} are NUMA node IDs. 2180f203430SHe Chen@var{distance} is the NUMA distance from @var{source} to @var{destination}. 2190f203430SHe ChenThe distance from a node to itself is always 10. If any pair of nodes is 2200f203430SHe Chengiven a distance, then all pairs must be given distances. Although, when 2210f203430SHe Chendistances are only given in one direction for each pair of nodes, then 2220f203430SHe Chenthe distances in the opposite directions are assumed to be the same. If, 2230f203430SHe Chenhowever, an asymmetrical pair of distances is given for even one node 2240f203430SHe Chenpair, then all node pairs must be provided distance values for both 2250f203430SHe Chendirections, even when they are symmetrical. When a node is unreachable 2260f203430SHe Chenfrom another node, set the pair's distance to 255. 2270f203430SHe Chen 2284b9a5dd7SEduardo HabkostNote that the -@option{numa} option doesn't allocate any of the 2294b9a5dd7SEduardo Habkostspecified resources, it just assigns existing resources to NUMA 2304b9a5dd7SEduardo Habkostnodes. This means that one still has to use the @option{-m}, 2314b9a5dd7SEduardo Habkost@option{-smp} options to allocate RAM and VCPUs respectively. 2324b9a5dd7SEduardo Habkost 233268a362cSaliguoriETEXI 234268a362cSaliguori 23510adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 23610adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 23710adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 23810adb8beSMarkus ArmbrusterSTEXI 23910adb8beSMarkus Armbruster@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 24010adb8beSMarkus Armbruster@findex -add-fd 24110adb8beSMarkus Armbruster 24210adb8beSMarkus ArmbrusterAdd a file descriptor to an fd set. Valid options are: 24310adb8beSMarkus Armbruster 24410adb8beSMarkus Armbruster@table @option 24510adb8beSMarkus Armbruster@item fd=@var{fd} 24610adb8beSMarkus ArmbrusterThis option defines the file descriptor of which a duplicate is added to fd set. 24710adb8beSMarkus ArmbrusterThe file descriptor cannot be stdin, stdout, or stderr. 24810adb8beSMarkus Armbruster@item set=@var{set} 24910adb8beSMarkus ArmbrusterThis option defines the ID of the fd set to add the file descriptor to. 25010adb8beSMarkus Armbruster@item opaque=@var{opaque} 25110adb8beSMarkus ArmbrusterThis option defines a free-form string that can be used to describe @var{fd}. 25210adb8beSMarkus Armbruster@end table 25310adb8beSMarkus Armbruster 25410adb8beSMarkus ArmbrusterYou can open an image using pre-opened file descriptors from an fd set: 25510adb8beSMarkus Armbruster@example 25610adb8beSMarkus Armbrusterqemu-system-i386 25710adb8beSMarkus Armbruster-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 25810adb8beSMarkus Armbruster-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 25910adb8beSMarkus Armbruster-drive file=/dev/fdset/2,index=0,media=disk 26010adb8beSMarkus Armbruster@end example 26110adb8beSMarkus ArmbrusterETEXI 26210adb8beSMarkus Armbruster 26310adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 26410adb8beSMarkus Armbruster "-set group.id.arg=value\n" 26510adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 26610adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 26710adb8beSMarkus ArmbrusterSTEXI 26810adb8beSMarkus Armbruster@item -set @var{group}.@var{id}.@var{arg}=@var{value} 26910adb8beSMarkus Armbruster@findex -set 270e1f3b974SMichael TokarevSet parameter @var{arg} for item @var{id} of type @var{group} 27110adb8beSMarkus ArmbrusterETEXI 27210adb8beSMarkus Armbruster 27310adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 2743751d7c4SPaolo Bonzini "-global driver.property=value\n" 2753751d7c4SPaolo Bonzini "-global driver=driver,property=property,value=value\n" 27610adb8beSMarkus Armbruster " set a global default for a driver property\n", 27710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 27810adb8beSMarkus ArmbrusterSTEXI 27910adb8beSMarkus Armbruster@item -global @var{driver}.@var{prop}=@var{value} 2803751d7c4SPaolo Bonzini@itemx -global driver=@var{driver},property=@var{property},value=@var{value} 28110adb8beSMarkus Armbruster@findex -global 28210adb8beSMarkus ArmbrusterSet default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 28310adb8beSMarkus Armbruster 28410adb8beSMarkus Armbruster@example 2851c9f3b88SMarkus Armbrusterqemu-system-i386 -global ide-hd.physical_block_size=4096 disk-image.img 28610adb8beSMarkus Armbruster@end example 28710adb8beSMarkus Armbruster 28810adb8beSMarkus ArmbrusterIn particular, you can use this to set driver properties for devices which are 28910adb8beSMarkus Armbrustercreated automatically by the machine model. To create a device which is not 29010adb8beSMarkus Armbrustercreated automatically and set properties on it, use -@option{device}. 2913751d7c4SPaolo Bonzini 292ae08fd5aSMarkus Armbruster-global @var{driver}.@var{prop}=@var{value} is shorthand for -global 293ae08fd5aSMarkus Armbrusterdriver=@var{driver},property=@var{prop},value=@var{value}. The 294ae08fd5aSMarkus Armbrusterlonghand syntax works even when @var{driver} contains a dot. 29510adb8beSMarkus ArmbrusterETEXI 29610adb8beSMarkus Armbruster 29710adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 29810adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 299c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 30010adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 30110adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 30210adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 30310adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 30410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 30510adb8beSMarkus ArmbrusterSTEXI 306c8a6ae8bSAmos Kong@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}][,strict=on|off] 30710adb8beSMarkus Armbruster@findex -boot 30810adb8beSMarkus ArmbrusterSpecify boot order @var{drives} as a string of drive letters. Valid 309d274e07cSGongleidrive letters depend on the target architecture. The x86 PC uses: a, b 31010adb8beSMarkus Armbruster(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 31110adb8beSMarkus Armbrusterfrom network adapter 1-4), hard disk boot is the default. To apply a 31210adb8beSMarkus Armbrusterparticular boot order only on the first startup, specify it via 313c0d9f7d0SThomas Huth@option{once}. Note that the @option{order} or @option{once} parameter 314c0d9f7d0SThomas Huthshould not be used together with the @option{bootindex} property of 315c0d9f7d0SThomas Huthdevices, since the firmware implementations normally do not support both 316c0d9f7d0SThomas Huthat the same time. 31710adb8beSMarkus Armbruster 31810adb8beSMarkus ArmbrusterInteractive boot menus/prompts can be enabled via @option{menu=on} as far 31910adb8beSMarkus Armbrusteras firmware/BIOS supports them. The default is non-interactive boot. 32010adb8beSMarkus Armbruster 32110adb8beSMarkus ArmbrusterA splash picture could be passed to bios, enabling user to show it as logo, 32210adb8beSMarkus Armbrusterwhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 32310adb8beSMarkus Armbrustersupports them. Currently Seabios for X86 system support it. 32410adb8beSMarkus Armbrusterlimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 32510adb8beSMarkus Armbrusterformat(true color). The resolution should be supported by the SVGA mode, so 32610adb8beSMarkus Armbrusterthe recommended is 320x240, 640x480, 800x640. 32710adb8beSMarkus Armbruster 32810adb8beSMarkus ArmbrusterA timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 32910adb8beSMarkus Armbrusterwhen boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not 33010adb8beSMarkus Armbrusterreboot, qemu passes '-1' to bios by default. Currently Seabios for X86 33110adb8beSMarkus Armbrustersystem support it. 33210adb8beSMarkus Armbruster 333c8a6ae8bSAmos KongDo strict boot via @option{strict=on} as far as firmware/BIOS 334c8a6ae8bSAmos Kongsupports it. This only effects when boot priority is changed by 335c8a6ae8bSAmos Kongbootindex options. The default is non-strict boot. 336c8a6ae8bSAmos Kong 33710adb8beSMarkus Armbruster@example 33810adb8beSMarkus Armbruster# try to boot from network first, then from hard disk 33910adb8beSMarkus Armbrusterqemu-system-i386 -boot order=nc 34010adb8beSMarkus Armbruster# boot from CD-ROM first, switch back to default order after reboot 34110adb8beSMarkus Armbrusterqemu-system-i386 -boot once=d 34210adb8beSMarkus Armbruster# boot with a splash picture for 5 seconds. 34310adb8beSMarkus Armbrusterqemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 34410adb8beSMarkus Armbruster@end example 34510adb8beSMarkus Armbruster 34610adb8beSMarkus ArmbrusterNote: The legacy format '-boot @var{drives}' is still supported but its 34710adb8beSMarkus Armbrusteruse is discouraged as it may be removed from future versions. 34810adb8beSMarkus ArmbrusterETEXI 34910adb8beSMarkus Armbruster 35010adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 35189f3ea2bSMichael Tokarev "-m [size=]megs[,slots=n,maxmem=size]\n" 3526e1d3c1cSIgor Mammedov " configure guest RAM\n" 3530daba1f0SAlexander Graf " size: initial amount of guest memory\n" 354c270fb9eSIgor Mammedov " slots: number of hotplug slots (default: none)\n" 355b6fe0124SMatthew Rosato " maxmem: maximum amount of guest memory (default: none)\n" 356b6fe0124SMatthew Rosato "NOTE: Some architectures might enforce a specific granularity\n", 3576e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 35810adb8beSMarkus ArmbrusterSTEXI 3599fcc0794SLuiz Capitulino@item -m [size=]@var{megs}[,slots=n,maxmem=size] 36010adb8beSMarkus Armbruster@findex -m 3619fcc0794SLuiz CapitulinoSets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB. 3629fcc0794SLuiz CapitulinoOptionally, a suffix of ``M'' or ``G'' can be used to signify a value in 3639fcc0794SLuiz Capitulinomegabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem} 3649fcc0794SLuiz Capitulinocould be used to set amount of hotpluggable memory slots and maximum amount of 3659fcc0794SLuiz Capitulinomemory. Note that @var{maxmem} must be aligned to the page size. 3669fcc0794SLuiz Capitulino 3679fcc0794SLuiz CapitulinoFor example, the following command-line sets the guest startup RAM size to 3689fcc0794SLuiz Capitulino1GB, creates 3 slots to hotplug additional memory and sets the maximum 3699fcc0794SLuiz Capitulinomemory the guest can reach to 4GB: 3709fcc0794SLuiz Capitulino 3719fcc0794SLuiz Capitulino@example 3729fcc0794SLuiz Capitulinoqemu-system-x86_64 -m 1G,slots=3,maxmem=4G 3739fcc0794SLuiz Capitulino@end example 3749fcc0794SLuiz Capitulino 3759fcc0794SLuiz CapitulinoIf @var{slots} and @var{maxmem} are not specified, memory hotplug won't 3769fcc0794SLuiz Capitulinobe enabled and the guest startup RAM will never increase. 37710adb8beSMarkus ArmbrusterETEXI 37810adb8beSMarkus Armbruster 37910adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 38010adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 38110adb8beSMarkus ArmbrusterSTEXI 38210adb8beSMarkus Armbruster@item -mem-path @var{path} 38310adb8beSMarkus Armbruster@findex -mem-path 38410adb8beSMarkus ArmbrusterAllocate guest RAM from a temporarily created file in @var{path}. 38510adb8beSMarkus ArmbrusterETEXI 38610adb8beSMarkus Armbruster 38710adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 38810adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 38910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 39010adb8beSMarkus ArmbrusterSTEXI 39110adb8beSMarkus Armbruster@item -mem-prealloc 39210adb8beSMarkus Armbruster@findex -mem-prealloc 39310adb8beSMarkus ArmbrusterPreallocate memory when using -mem-path. 39410adb8beSMarkus ArmbrusterETEXI 39510adb8beSMarkus Armbruster 39610adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 39710adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 39810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 39910adb8beSMarkus ArmbrusterSTEXI 40010adb8beSMarkus Armbruster@item -k @var{language} 40110adb8beSMarkus Armbruster@findex -k 40210adb8beSMarkus ArmbrusterUse keyboard layout @var{language} (for example @code{fr} for 40310adb8beSMarkus ArmbrusterFrench). This option is only needed where it is not easy to get raw PC 40432945472SSamuel Thibaultkeycodes (e.g. on Macs, with some X11 servers or with a VNC or curses 40510adb8beSMarkus Armbrusterdisplay). You don't normally need to use it on PC/Linux or PC/Windows 40610adb8beSMarkus Armbrusterhosts. 40710adb8beSMarkus Armbruster 40810adb8beSMarkus ArmbrusterThe available layouts are: 40910adb8beSMarkus Armbruster@example 41010adb8beSMarkus Armbrusterar de-ch es fo fr-ca hu ja mk no pt-br sv 41110adb8beSMarkus Armbrusterda en-gb et fr fr-ch is lt nl pl ru th 41210adb8beSMarkus Armbrusterde en-us fi fr-be hr it lv nl-be pt sl tr 41310adb8beSMarkus Armbruster@end example 41410adb8beSMarkus Armbruster 41510adb8beSMarkus ArmbrusterThe default is @code{en-us}. 41610adb8beSMarkus ArmbrusterETEXI 41710adb8beSMarkus Armbruster 41810adb8beSMarkus Armbruster 41910adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 42010adb8beSMarkus Armbruster "-audio-help print list of audio drivers and their options\n", 42110adb8beSMarkus Armbruster QEMU_ARCH_ALL) 42210adb8beSMarkus ArmbrusterSTEXI 42310adb8beSMarkus Armbruster@item -audio-help 42410adb8beSMarkus Armbruster@findex -audio-help 42510adb8beSMarkus ArmbrusterWill show the audio subsystem help: list of drivers, tunable 42610adb8beSMarkus Armbrusterparameters. 42710adb8beSMarkus ArmbrusterETEXI 42810adb8beSMarkus Armbruster 42910adb8beSMarkus ArmbrusterDEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 43010adb8beSMarkus Armbruster "-soundhw c1,... enable audio support\n" 43110adb8beSMarkus Armbruster " and only specified sound cards (comma separated list)\n" 43210adb8beSMarkus Armbruster " use '-soundhw help' to get the list of supported cards\n" 43310adb8beSMarkus Armbruster " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 43410adb8beSMarkus ArmbrusterSTEXI 43510adb8beSMarkus Armbruster@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 43610adb8beSMarkus Armbruster@findex -soundhw 43710adb8beSMarkus ArmbrusterEnable audio and selected sound hardware. Use 'help' to print all 43810adb8beSMarkus Armbrusteravailable sound hardware. 43910adb8beSMarkus Armbruster 44010adb8beSMarkus Armbruster@example 44110adb8beSMarkus Armbrusterqemu-system-i386 -soundhw sb16,adlib disk.img 44210adb8beSMarkus Armbrusterqemu-system-i386 -soundhw es1370 disk.img 44310adb8beSMarkus Armbrusterqemu-system-i386 -soundhw ac97 disk.img 44410adb8beSMarkus Armbrusterqemu-system-i386 -soundhw hda disk.img 44510adb8beSMarkus Armbrusterqemu-system-i386 -soundhw all disk.img 44610adb8beSMarkus Armbrusterqemu-system-i386 -soundhw help 44710adb8beSMarkus Armbruster@end example 44810adb8beSMarkus Armbruster 44910adb8beSMarkus ArmbrusterNote that Linux's i810_audio OSS kernel (for AC97) module might 45010adb8beSMarkus Armbrusterrequire manually specifying clocking. 45110adb8beSMarkus Armbruster 45210adb8beSMarkus Armbruster@example 45310adb8beSMarkus Armbrustermodprobe i810_audio clocking=48000 45410adb8beSMarkus Armbruster@end example 45510adb8beSMarkus ArmbrusterETEXI 45610adb8beSMarkus Armbruster 45710adb8beSMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 45810adb8beSMarkus Armbruster "-balloon virtio[,addr=str]\n" 4594060e671SThomas Huth " enable virtio balloon device (deprecated)\n", QEMU_ARCH_ALL) 46010adb8beSMarkus ArmbrusterSTEXI 46110adb8beSMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 4624060e671SThomas Huth@findex -balloon 4634060e671SThomas HuthEnable virtio balloon device, optionally with PCI address @var{addr}. This 464dfaa7d50SBALATON Zoltanoption is deprecated, use @option{-device virtio-balloon} instead. 46510adb8beSMarkus ArmbrusterETEXI 46610adb8beSMarkus Armbruster 46710adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 46810adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 46910adb8beSMarkus Armbruster " add device (based on driver)\n" 47010adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 47110adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 47210adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 47310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 47410adb8beSMarkus ArmbrusterSTEXI 47510adb8beSMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 47610adb8beSMarkus Armbruster@findex -device 47710adb8beSMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 47810adb8beSMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 47910adb8beSMarkus Armbrusterpossible drivers and properties, use @code{-device help} and 48010adb8beSMarkus Armbruster@code{-device @var{driver},help}. 481f8490451SCorey Minyard 482f8490451SCorey MinyardSome drivers are: 483540c07d3SCédric Le Goater@item -device ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}][,sdrfile=@var{file}][,furareasize=@var{val}][,furdatafile=@var{file}] 484f8490451SCorey Minyard 485f8490451SCorey MinyardAdd an IPMI BMC. This is a simulation of a hardware management 486f8490451SCorey Minyardinterface processor that normally sits on a system. It provides 487f8490451SCorey Minyarda watchdog and the ability to reset and power control the system. 488f8490451SCorey MinyardYou need to connect this to an IPMI interface to make it useful 489f8490451SCorey Minyard 490f8490451SCorey MinyardThe IPMI slave address to use for the BMC. The default is 0x20. 491f8490451SCorey MinyardThis address is the BMC's address on the I2C network of management 492f8490451SCorey Minyardcontrollers. If you don't know what this means, it is safe to ignore 493f8490451SCorey Minyardit. 494f8490451SCorey Minyard 4958c6fd7f3SCédric Le Goater@table @option 4968c6fd7f3SCédric Le Goater@item bmc=@var{id} 4978c6fd7f3SCédric Le GoaterThe BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above. 4988c6fd7f3SCédric Le Goater@item slave_addr=@var{val} 4998c6fd7f3SCédric Le GoaterDefine slave address to use for the BMC. The default is 0x20. 5008c6fd7f3SCédric Le Goater@item sdrfile=@var{file} 5018c6fd7f3SCédric Le Goaterfile containing raw Sensor Data Records (SDR) data. The default is none. 502540c07d3SCédric Le Goater@item fruareasize=@var{val} 503540c07d3SCédric Le Goatersize of a Field Replaceable Unit (FRU) area. The default is 1024. 504540c07d3SCédric Le Goater@item frudatafile=@var{file} 505540c07d3SCédric Le Goaterfile containing raw Field Replaceable Unit (FRU) inventory data. The default is none. 5068c6fd7f3SCédric Le Goater@end table 5078c6fd7f3SCédric Le Goater 508f8490451SCorey Minyard@item -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}] 509f8490451SCorey Minyard 510f8490451SCorey MinyardAdd a connection to an external IPMI BMC simulator. Instead of 511f8490451SCorey Minyardlocally emulating the BMC like the above item, instead connect 512f8490451SCorey Minyardto an external entity that provides the IPMI services. 513f8490451SCorey Minyard 514f8490451SCorey MinyardA connection is made to an external BMC simulator. If you do this, it 515f8490451SCorey Minyardis strongly recommended that you use the "reconnect=" chardev option 516f8490451SCorey Minyardto reconnect to the simulator if the connection is lost. Note that if 517f8490451SCorey Minyardthis is not used carefully, it can be a security issue, as the 518f8490451SCorey Minyardinterface has the ability to send resets, NMIs, and power off the VM. 519f8490451SCorey MinyardIt's best if QEMU makes a connection to an external simulator running 520f8490451SCorey Minyardon a secure port on localhost, so neither the simulator nor QEMU is 521f8490451SCorey Minyardexposed to any outside network. 522f8490451SCorey Minyard 523f8490451SCorey MinyardSee the "lanserv/README.vm" file in the OpenIPMI library for more 524f8490451SCorey Minyarddetails on the external interface. 525f8490451SCorey Minyard 526f8490451SCorey Minyard@item -device isa-ipmi-kcs,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}] 527f8490451SCorey Minyard 528f8490451SCorey MinyardAdd a KCS IPMI interafce on the ISA bus. This also adds a 529f8490451SCorey Minyardcorresponding ACPI and SMBIOS entries, if appropriate. 530f8490451SCorey Minyard 531f8490451SCorey Minyard@table @option 532f8490451SCorey Minyard@item bmc=@var{id} 533f8490451SCorey MinyardThe BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above. 534f8490451SCorey Minyard@item ioport=@var{val} 535f8490451SCorey MinyardDefine the I/O address of the interface. The default is 0xca0 for KCS. 536f8490451SCorey Minyard@item irq=@var{val} 537f8490451SCorey MinyardDefine the interrupt to use. The default is 5. To disable interrupts, 538f8490451SCorey Minyardset this to 0. 539f8490451SCorey Minyard@end table 540f8490451SCorey Minyard 541f8490451SCorey Minyard@item -device isa-ipmi-bt,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}] 542f8490451SCorey Minyard 543f8490451SCorey MinyardLike the KCS interface, but defines a BT interface. The default port is 544f8490451SCorey Minyard0xe4 and the default interrupt is 5. 545f8490451SCorey Minyard 54610adb8beSMarkus ArmbrusterETEXI 54710adb8beSMarkus Armbruster 54810adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 5498f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 55010adb8beSMarkus Armbruster " set the name of the guest\n" 5518f480de0SDr. David Alan Gilbert " string1 sets the window title and string2 the process name (on Linux)\n" 5528f480de0SDr. David Alan Gilbert " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" 5538f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 55410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 55510adb8beSMarkus ArmbrusterSTEXI 55610adb8beSMarkus Armbruster@item -name @var{name} 55710adb8beSMarkus Armbruster@findex -name 55810adb8beSMarkus ArmbrusterSets the @var{name} of the guest. 55910adb8beSMarkus ArmbrusterThis name will be displayed in the SDL window caption. 56010adb8beSMarkus ArmbrusterThe @var{name} will also be used for the VNC server. 56110adb8beSMarkus ArmbrusterAlso optionally set the top visible process name in Linux. 5628f480de0SDr. David Alan GilbertNaming of individual threads can also be enabled on Linux to aid debugging. 56310adb8beSMarkus ArmbrusterETEXI 56410adb8beSMarkus Armbruster 56510adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 56610adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 56710adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 56810adb8beSMarkus ArmbrusterSTEXI 56910adb8beSMarkus Armbruster@item -uuid @var{uuid} 57010adb8beSMarkus Armbruster@findex -uuid 57110adb8beSMarkus ArmbrusterSet system UUID. 57210adb8beSMarkus ArmbrusterETEXI 57310adb8beSMarkus Armbruster 57410adb8beSMarkus ArmbrusterSTEXI 57510adb8beSMarkus Armbruster@end table 57610adb8beSMarkus ArmbrusterETEXI 57710adb8beSMarkus ArmbrusterDEFHEADING() 57810adb8beSMarkus Armbruster 579de6b4f90SMarkus ArmbrusterDEFHEADING(Block device options:) 58010adb8beSMarkus ArmbrusterSTEXI 58110adb8beSMarkus Armbruster@table @option 58210adb8beSMarkus ArmbrusterETEXI 58310adb8beSMarkus Armbruster 5845824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 585ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 586ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 5875824d651Sblueswir1STEXI 5885824d651Sblueswir1@item -fda @var{file} 589f9cfd655SMarkus Armbruster@itemx -fdb @var{file} 5906616b2adSStefan Weil@findex -fda 5916616b2adSStefan Weil@findex -fdb 59292a539d2SMarkus ArmbrusterUse @var{file} as floppy disk 0/1 image (@pxref{disk_images}). 5935824d651Sblueswir1ETEXI 5945824d651Sblueswir1 5955824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 596ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 597ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 5985824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 599ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 600ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 6015824d651Sblueswir1STEXI 6025824d651Sblueswir1@item -hda @var{file} 603f9cfd655SMarkus Armbruster@itemx -hdb @var{file} 604f9cfd655SMarkus Armbruster@itemx -hdc @var{file} 605f9cfd655SMarkus Armbruster@itemx -hdd @var{file} 6066616b2adSStefan Weil@findex -hda 6076616b2adSStefan Weil@findex -hdb 6086616b2adSStefan Weil@findex -hdc 6096616b2adSStefan Weil@findex -hdd 6105824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 6115824d651Sblueswir1ETEXI 6125824d651Sblueswir1 6135824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 614ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 615ad96090aSBlue Swirl QEMU_ARCH_ALL) 6165824d651Sblueswir1STEXI 6175824d651Sblueswir1@item -cdrom @var{file} 6186616b2adSStefan Weil@findex -cdrom 6195824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 6205824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 6215824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 6225824d651Sblueswir1ETEXI 6235824d651Sblueswir1 62442e5f393SMarkus ArmbrusterDEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev, 62542e5f393SMarkus Armbruster "-blockdev [driver=]driver[,node-name=N][,discard=ignore|unmap]\n" 62642e5f393SMarkus Armbruster " [,cache.direct=on|off][,cache.no-flush=on|off]\n" 62742e5f393SMarkus Armbruster " [,read-only=on|off][,detect-zeroes=on|off|unmap]\n" 62842e5f393SMarkus Armbruster " [,driver specific parameters...]\n" 62942e5f393SMarkus Armbruster " configure a block backend\n", QEMU_ARCH_ALL) 630dfaca464SKevin WolfSTEXI 631dfaca464SKevin Wolf@item -blockdev @var{option}[,@var{option}[,@var{option}[,...]]] 632dfaca464SKevin Wolf@findex -blockdev 633dfaca464SKevin Wolf 634370e8328SKevin WolfDefine a new block driver node. Some of the options apply to all block drivers, 635370e8328SKevin Wolfother options are only accepted for a specific block driver. See below for a 636370e8328SKevin Wolflist of generic options and options for the most common block drivers. 637370e8328SKevin Wolf 638370e8328SKevin WolfOptions that expect a reference to another node (e.g. @code{file}) can be 639370e8328SKevin Wolfgiven in two ways. Either you specify the node name of an already existing node 640370e8328SKevin Wolf(file=@var{node-name}), or you define a new node inline, adding options 641370e8328SKevin Wolffor the referenced node after a dot (file.filename=@var{path},file.aio=native). 642370e8328SKevin Wolf 643370e8328SKevin WolfA block driver node created with @option{-blockdev} can be used for a guest 644370e8328SKevin Wolfdevice by specifying its node name for the @code{drive} property in a 645370e8328SKevin Wolf@option{-device} argument that defines a block device. 646dfaca464SKevin Wolf 647dfaca464SKevin Wolf@table @option 648dfaca464SKevin Wolf@item Valid options for any block driver node: 649dfaca464SKevin Wolf 650dfaca464SKevin Wolf@table @code 651dfaca464SKevin Wolf@item driver 652dfaca464SKevin WolfSpecifies the block driver to use for the given node. 653dfaca464SKevin Wolf@item node-name 654dfaca464SKevin WolfThis defines the name of the block driver node by which it will be referenced 655dfaca464SKevin Wolflater. The name must be unique, i.e. it must not match the name of a different 656dfaca464SKevin Wolfblock driver node, or (if you use @option{-drive} as well) the ID of a drive. 657dfaca464SKevin Wolf 658dfaca464SKevin WolfIf no node name is specified, it is automatically generated. The generated node 659dfaca464SKevin Wolfname is not intended to be predictable and changes between QEMU invocations. 660dfaca464SKevin WolfFor the top level, an explicit node name must be specified. 661dfaca464SKevin Wolf@item read-only 662dfaca464SKevin WolfOpen the node read-only. Guest write attempts will fail. 663dfaca464SKevin Wolf@item cache.direct 664dfaca464SKevin WolfThe host page cache can be avoided with @option{cache.direct=on}. This will 665dfaca464SKevin Wolfattempt to do disk IO directly to the guest's memory. QEMU may still perform an 666dfaca464SKevin Wolfinternal copy of the data. 667dfaca464SKevin Wolf@item cache.no-flush 668dfaca464SKevin WolfIn case you don't care about data integrity over host failures, you can use 669dfaca464SKevin Wolf@option{cache.no-flush=on}. This option tells QEMU that it never needs to write 670dfaca464SKevin Wolfany data to the disk but can instead keep things in cache. If anything goes 671dfaca464SKevin Wolfwrong, like your host losing power, the disk storage getting disconnected 672dfaca464SKevin Wolfaccidentally, etc. your image will most probably be rendered unusable. 673dfaca464SKevin Wolf@item discard=@var{discard} 674dfaca464SKevin Wolf@var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls 675dfaca464SKevin Wolfwhether @code{discard} (also known as @code{trim} or @code{unmap}) requests are 676dfaca464SKevin Wolfignored or passed to the filesystem. Some machine types may not support 677dfaca464SKevin Wolfdiscard requests. 678dfaca464SKevin Wolf@item detect-zeroes=@var{detect-zeroes} 679dfaca464SKevin Wolf@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic 680dfaca464SKevin Wolfconversion of plain zero writes by the OS to driver specific optimized 681dfaca464SKevin Wolfzero write commands. You may even choose "unmap" if @var{discard} is set 682dfaca464SKevin Wolfto "unmap" to allow a zero write to be converted to an @code{unmap} operation. 683dfaca464SKevin Wolf@end table 684dfaca464SKevin Wolf 685370e8328SKevin Wolf@item Driver-specific options for @code{file} 686370e8328SKevin Wolf 687370e8328SKevin WolfThis is the protocol-level block driver for accessing regular files. 688370e8328SKevin Wolf 689370e8328SKevin Wolf@table @code 690370e8328SKevin Wolf@item filename 691370e8328SKevin WolfThe path to the image file in the local filesystem 692370e8328SKevin Wolf@item aio 693370e8328SKevin WolfSpecifies the AIO backend (threads/native, default: threads) 6941878eaffSFam Zheng@item locking 6951878eaffSFam ZhengSpecifies whether the image file is protected with Linux OFD / POSIX locks. The 6961878eaffSFam Zhengdefault is to use the Linux Open File Descriptor API if available, otherwise no 6971878eaffSFam Zhenglock is applied. (auto/on/off, default: auto) 698370e8328SKevin Wolf@end table 699370e8328SKevin WolfExample: 700370e8328SKevin Wolf@example 701370e8328SKevin Wolf-blockdev driver=file,node-name=disk,filename=disk.img 702370e8328SKevin Wolf@end example 703370e8328SKevin Wolf 704370e8328SKevin Wolf@item Driver-specific options for @code{raw} 705370e8328SKevin Wolf 706370e8328SKevin WolfThis is the image format block driver for raw images. It is usually 707370e8328SKevin Wolfstacked on top of a protocol level block driver such as @code{file}. 708370e8328SKevin Wolf 709370e8328SKevin Wolf@table @code 710370e8328SKevin Wolf@item file 711370e8328SKevin WolfReference to or definition of the data source block driver node 712370e8328SKevin Wolf(e.g. a @code{file} driver node) 713370e8328SKevin Wolf@end table 714370e8328SKevin WolfExample 1: 715370e8328SKevin Wolf@example 716370e8328SKevin Wolf-blockdev driver=file,node-name=disk_file,filename=disk.img 717370e8328SKevin Wolf-blockdev driver=raw,node-name=disk,file=disk_file 718370e8328SKevin Wolf@end example 719370e8328SKevin WolfExample 2: 720370e8328SKevin Wolf@example 721370e8328SKevin Wolf-blockdev driver=raw,node-name=disk,file.driver=file,file.filename=disk.img 722370e8328SKevin Wolf@end example 723370e8328SKevin Wolf 724370e8328SKevin Wolf@item Driver-specific options for @code{qcow2} 725370e8328SKevin Wolf 726370e8328SKevin WolfThis is the image format block driver for qcow2 images. It is usually 727370e8328SKevin Wolfstacked on top of a protocol level block driver such as @code{file}. 728370e8328SKevin Wolf 729370e8328SKevin Wolf@table @code 730370e8328SKevin Wolf@item file 731370e8328SKevin WolfReference to or definition of the data source block driver node 732370e8328SKevin Wolf(e.g. a @code{file} driver node) 733370e8328SKevin Wolf 734370e8328SKevin Wolf@item backing 735370e8328SKevin WolfReference to or definition of the backing file block device (default is taken 7364f7be280SMax Reitzfrom the image file). It is allowed to pass @code{null} here in order to disable 7374f7be280SMax Reitzthe default backing file. 738370e8328SKevin Wolf 739370e8328SKevin Wolf@item lazy-refcounts 740370e8328SKevin WolfWhether to enable the lazy refcounts feature (on/off; default is taken from the 741370e8328SKevin Wolfimage file) 742370e8328SKevin Wolf 743370e8328SKevin Wolf@item cache-size 744370e8328SKevin WolfThe maximum total size of the L2 table and refcount block caches in bytes 745370e8328SKevin Wolf(default: 1048576 bytes or 8 clusters, whichever is larger) 746370e8328SKevin Wolf 747370e8328SKevin Wolf@item l2-cache-size 748370e8328SKevin WolfThe maximum size of the L2 table cache in bytes 749370e8328SKevin Wolf(default: 4/5 of the total cache size) 750370e8328SKevin Wolf 751370e8328SKevin Wolf@item refcount-cache-size 752370e8328SKevin WolfThe maximum size of the refcount block cache in bytes 753370e8328SKevin Wolf(default: 1/5 of the total cache size) 754370e8328SKevin Wolf 755370e8328SKevin Wolf@item cache-clean-interval 756370e8328SKevin WolfClean unused entries in the L2 and refcount caches. The interval is in seconds. 757370e8328SKevin WolfThe default value is 0 and it disables this feature. 758370e8328SKevin Wolf 759370e8328SKevin Wolf@item pass-discard-request 760370e8328SKevin WolfWhether discard requests to the qcow2 device should be forwarded to the data 761370e8328SKevin Wolfsource (on/off; default: on if discard=unmap is specified, off otherwise) 762370e8328SKevin Wolf 763370e8328SKevin Wolf@item pass-discard-snapshot 764370e8328SKevin WolfWhether discard requests for the data source should be issued when a snapshot 765370e8328SKevin Wolfoperation (e.g. deleting a snapshot) frees clusters in the qcow2 file (on/off; 766370e8328SKevin Wolfdefault: on) 767370e8328SKevin Wolf 768370e8328SKevin Wolf@item pass-discard-other 769370e8328SKevin WolfWhether discard requests for the data source should be issued on other 770370e8328SKevin Wolfoccasions where a cluster gets freed (on/off; default: off) 771370e8328SKevin Wolf 772370e8328SKevin Wolf@item overlap-check 773370e8328SKevin WolfWhich overlap checks to perform for writes to the image 774370e8328SKevin Wolf(none/constant/cached/all; default: cached). For details or finer 775370e8328SKevin Wolfgranularity control refer to the QAPI documentation of @code{blockdev-add}. 776370e8328SKevin Wolf@end table 777370e8328SKevin Wolf 778370e8328SKevin WolfExample 1: 779370e8328SKevin Wolf@example 780370e8328SKevin Wolf-blockdev driver=file,node-name=my_file,filename=/tmp/disk.qcow2 781370e8328SKevin Wolf-blockdev driver=qcow2,node-name=hda,file=my_file,overlap-check=none,cache-size=16777216 782370e8328SKevin Wolf@end example 783370e8328SKevin WolfExample 2: 784370e8328SKevin Wolf@example 785370e8328SKevin Wolf-blockdev driver=qcow2,node-name=disk,file.driver=http,file.filename=http://example.com/image.qcow2 786370e8328SKevin Wolf@end example 787370e8328SKevin Wolf 788370e8328SKevin Wolf@item Driver-specific options for other drivers 789370e8328SKevin WolfPlease refer to the QAPI documentation of the @code{blockdev-add} QMP command. 790370e8328SKevin Wolf 791dfaca464SKevin Wolf@end table 792dfaca464SKevin Wolf 793dfaca464SKevin WolfETEXI 79442e5f393SMarkus Armbruster 7955824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 7965824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 79792196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 798572023f7SKevin Wolf " [,snapshot=on|off][,rerror=ignore|stop|report]\n" 799d1db760dSStefan Hajnoczi " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 800fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 8012f7133b2SPeter Lieven " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 8023e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 8033e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 8043e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 8053e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 8062024c1dfSBenoît Canet " [[,iops_size=is]]\n" 80776f4afb4SAlberto Garcia " [[,group=g]]\n" 808ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 8095824d651Sblueswir1STEXI 8105824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 8116616b2adSStefan Weil@findex -drive 8125824d651Sblueswir1 813dfaca464SKevin WolfDefine a new drive. This includes creating a block driver node (the backend) as 814dfaca464SKevin Wolfwell as a guest device, and is mostly a shortcut for defining the corresponding 815dfaca464SKevin Wolf@option{-blockdev} and @option{-device} options. 816dfaca464SKevin Wolf 817dfaca464SKevin Wolf@option{-drive} accepts all options that are accepted by @option{-blockdev}. In 818dfaca464SKevin Wolfaddition, it knows the following options: 8195824d651Sblueswir1 820b3f046c2SKevin Wolf@table @option 8215824d651Sblueswir1@item file=@var{file} 8225824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 8235824d651Sblueswir1this drive. If the filename contains comma, you must double it 8245824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 8250f5314a2SRonnie Sahlberg 8260f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 8270f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 8285824d651Sblueswir1@item if=@var{interface} 8295824d651Sblueswir1This option defines on which type on interface the drive is connected. 830ed1fcd00SCraig JellickAvailable types are: ide, scsi, sd, mtd, floppy, pflash, virtio, none. 8315824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 8325824d651Sblueswir1These options define where is connected the drive by defining the bus number and 8335824d651Sblueswir1the unit id. 8345824d651Sblueswir1@item index=@var{index} 8355824d651Sblueswir1This option defines where is connected the drive by using an index in the list 8365824d651Sblueswir1of available connectors of a given interface type. 8375824d651Sblueswir1@item media=@var{media} 8385824d651Sblueswir1This option defines the type of the media: disk or cdrom. 8395824d651Sblueswir1@item snapshot=@var{snapshot} 8409d85d557SMichael Tokarev@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive 8419d85d557SMichael Tokarev(see @option{-snapshot}). 8425824d651Sblueswir1@item cache=@var{cache} 843dfaca464SKevin Wolf@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" 844dfaca464SKevin Wolfand controls how the host cache is used to access block data. This is a 845dfaca464SKevin Wolfshortcut that sets the @option{cache.direct} and @option{cache.no-flush} 846dfaca464SKevin Wolfoptions (as in @option{-blockdev}), and additionally @option{cache.writeback}, 847dfaca464SKevin Wolfwhich provides a default for the @option{write-cache} option of block guest 848dfaca464SKevin Wolfdevices (as in @option{-device}). The modes correspond to the following 849dfaca464SKevin Wolfsettings: 850dfaca464SKevin Wolf 851dfaca464SKevin Wolf@c Our texi2pod.pl script doesn't support @multitable, so fall back to using 852dfaca464SKevin Wolf@c plain ASCII art (well, UTF-8 art really). This looks okay both in the manpage 853dfaca464SKevin Wolf@c and the HTML output. 854dfaca464SKevin Wolf@example 855dfaca464SKevin Wolf@ │ cache.writeback cache.direct cache.no-flush 856dfaca464SKevin Wolf─────────────┼───────────────────────────────────────────────── 857dfaca464SKevin Wolfwriteback │ on off off 858dfaca464SKevin Wolfnone │ on on off 859dfaca464SKevin Wolfwritethrough │ off off off 860dfaca464SKevin Wolfdirectsync │ off on off 861dfaca464SKevin Wolfunsafe │ on off on 862dfaca464SKevin Wolf@end example 863dfaca464SKevin Wolf 864dfaca464SKevin WolfThe default mode is @option{cache=writeback}. 865dfaca464SKevin Wolf 8665c6c3a6cSChristoph Hellwig@item aio=@var{aio} 8675c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 8685824d651Sblueswir1@item format=@var{format} 8695824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 870d33c8a7dSMichael Tokarevthe format. Can be used to specify format=raw to avoid interpreting 8715824d651Sblueswir1an untrusted format header. 872ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 873ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 874ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 875ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 876ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 877ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 878fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 879fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 880fb0490f6SStefan Hajnoczifile sectors into the image file. 88101f9cfabSStefan Hajnoczi@item bps=@var{b},bps_rd=@var{r},bps_wr=@var{w} 88201f9cfabSStefan HajnocziSpecify bandwidth throttling limits in bytes per second, either for all request 88301f9cfabSStefan Hajnoczitypes or for reads or writes only. Small values can lead to timeouts or hangs 88401f9cfabSStefan Hajnocziinside the guest. A safe minimum for disks is 2 MB/s. 88501f9cfabSStefan Hajnoczi@item bps_max=@var{bm},bps_rd_max=@var{rm},bps_wr_max=@var{wm} 88601f9cfabSStefan HajnocziSpecify bursts in bytes per second, either for all request types or for reads 88701f9cfabSStefan Hajnoczior writes only. Bursts allow the guest I/O to spike above the limit 88801f9cfabSStefan Hajnoczitemporarily. 88901f9cfabSStefan Hajnoczi@item iops=@var{i},iops_rd=@var{r},iops_wr=@var{w} 89001f9cfabSStefan HajnocziSpecify request rate limits in requests per second, either for all request 89101f9cfabSStefan Hajnoczitypes or for reads or writes only. 89201f9cfabSStefan Hajnoczi@item iops_max=@var{bm},iops_rd_max=@var{rm},iops_wr_max=@var{wm} 89301f9cfabSStefan HajnocziSpecify bursts in requests per second, either for all request types or for reads 89401f9cfabSStefan Hajnoczior writes only. Bursts allow the guest I/O to spike above the limit 89501f9cfabSStefan Hajnoczitemporarily. 89601f9cfabSStefan Hajnoczi@item iops_size=@var{is} 89701f9cfabSStefan HajnocziLet every @var{is} bytes of a request count as a new request for iops 89801f9cfabSStefan Hajnoczithrottling purposes. Use this option to prevent guests from circumventing iops 89901f9cfabSStefan Hajnoczilimits by sending fewer but larger requests. 90001f9cfabSStefan Hajnoczi@item group=@var{g} 90101f9cfabSStefan HajnocziJoin a throttling quota group with given name @var{g}. All drives that are 90201f9cfabSStefan Hajnoczimembers of the same group are accounted for together. Use this option to 90301f9cfabSStefan Hajnocziprevent guests from circumventing throttling limits by using many small disks 90401f9cfabSStefan Hajnocziinstead of a single larger disk. 9055824d651Sblueswir1@end table 9065824d651Sblueswir1 907dfaca464SKevin WolfBy default, the @option{cache.writeback=on} mode is used. It will report data 908a13e5e05SKevin Wolfwrites as completed as soon as the data is present in the host page cache. 909a13e5e05SKevin WolfThis is safe as long as your guest OS makes sure to correctly flush disk caches 910a13e5e05SKevin Wolfwhere needed. If your guest OS does not handle volatile disk write caches 911a13e5e05SKevin Wolfcorrectly and your host crashes or loses power, then the guest may experience 912a13e5e05SKevin Wolfdata corruption. 9135824d651Sblueswir1 914dfaca464SKevin WolfFor such guests, you should consider using @option{cache.writeback=off}. This 915a13e5e05SKevin Wolfmeans that the host page cache will be used to read and write data, but write 916a13e5e05SKevin Wolfnotification will be sent to the guest only after QEMU has made sure to flush 917a13e5e05SKevin Wolfeach write to the disk. Be aware that this has a major impact on performance. 9185824d651Sblueswir1 919dfaca464SKevin WolfWhen using the @option{-snapshot} option, unsafe caching is always used. 920016f5cf6SAlexander Graf 921fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 922fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 923fb0490f6SStefan Hajnocziis off. 924fb0490f6SStefan Hajnoczi 9255824d651Sblueswir1Instead of @option{-cdrom} you can use: 9265824d651Sblueswir1@example 9273804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=cdrom 9285824d651Sblueswir1@end example 9295824d651Sblueswir1 9305824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 9315824d651Sblueswir1use: 9325824d651Sblueswir1@example 9333804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,media=disk 9343804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,media=disk 9353804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=disk 9363804da9dSStefan Weilqemu-system-i386 -drive file=file,index=3,media=disk 9375824d651Sblueswir1@end example 9385824d651Sblueswir1 939587ed6beSCorey BryantYou can open an image using pre-opened file descriptors from an fd set: 940587ed6beSCorey Bryant@example 941587ed6beSCorey Bryantqemu-system-i386 942587ed6beSCorey Bryant-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 943587ed6beSCorey Bryant-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 944587ed6beSCorey Bryant-drive file=/dev/fdset/2,index=0,media=disk 945587ed6beSCorey Bryant@end example 946587ed6beSCorey Bryant 9475824d651Sblueswir1You can connect a CDROM to the slave of ide0: 9485824d651Sblueswir1@example 9493804da9dSStefan Weilqemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 9505824d651Sblueswir1@end example 9515824d651Sblueswir1 9525824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 9535824d651Sblueswir1@example 9543804da9dSStefan Weilqemu-system-i386 -drive if=ide,index=1,media=cdrom 9555824d651Sblueswir1@end example 9565824d651Sblueswir1 9575824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 9585824d651Sblueswir1@example 9593804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,if=floppy 9603804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,if=floppy 9615824d651Sblueswir1@end example 9625824d651Sblueswir1 9635824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 9645824d651Sblueswir1incremented: 9655824d651Sblueswir1@example 9663804da9dSStefan Weilqemu-system-i386 -drive file=a -drive file=b" 9675824d651Sblueswir1@end example 9685824d651Sblueswir1is interpreted like: 9695824d651Sblueswir1@example 9703804da9dSStefan Weilqemu-system-i386 -hda a -hdb b 9715824d651Sblueswir1@end example 9725824d651Sblueswir1ETEXI 9735824d651Sblueswir1 9745824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 975ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 976ad96090aSBlue Swirl QEMU_ARCH_ALL) 9775824d651Sblueswir1STEXI 9784e257e5eSKevin Wolf@item -mtdblock @var{file} 9796616b2adSStefan Weil@findex -mtdblock 9804e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 9815824d651Sblueswir1ETEXI 9825824d651Sblueswir1 9835824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 984ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 9855824d651Sblueswir1STEXI 9864e257e5eSKevin Wolf@item -sd @var{file} 9876616b2adSStefan Weil@findex -sd 9884e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 9895824d651Sblueswir1ETEXI 9905824d651Sblueswir1 9915824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 992ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 9935824d651Sblueswir1STEXI 9944e257e5eSKevin Wolf@item -pflash @var{file} 9956616b2adSStefan Weil@findex -pflash 9964e257e5eSKevin WolfUse @var{file} as a parallel flash image. 9975824d651Sblueswir1ETEXI 9985824d651Sblueswir1 9995824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 1000ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 1001ad96090aSBlue Swirl QEMU_ARCH_ALL) 10025824d651Sblueswir1STEXI 10035824d651Sblueswir1@item -snapshot 10046616b2adSStefan Weil@findex -snapshot 10055824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 10065824d651Sblueswir1the raw disk image you use is not written back. You can however force 10075824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 10085824d651Sblueswir1ETEXI 10095824d651Sblueswir1 101074db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 10112c30dd74SAneesh Kumar K.V "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 1012b96feb2cSTobias Schramm " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd][,fmode=fmode][,dmode=dmode]\n" 1013b8bbdb88SPradeep Jagadeesh " [[,throttling.bps-total=b]|[[,throttling.bps-read=r][,throttling.bps-write=w]]]\n" 1014b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-total=i]|[[,throttling.iops-read=r][,throttling.iops-write=w]]]\n" 1015b8bbdb88SPradeep Jagadeesh " [[,throttling.bps-total-max=bm]|[[,throttling.bps-read-max=rm][,throttling.bps-write-max=wm]]]\n" 1016b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-total-max=im]|[[,throttling.iops-read-max=irm][,throttling.iops-write-max=iwm]]]\n" 1017b8bbdb88SPradeep Jagadeesh " [[,throttling.iops-size=is]]\n", 101874db920cSGautham R Shenoy QEMU_ARCH_ALL) 101974db920cSGautham R Shenoy 102074db920cSGautham R ShenoySTEXI 102174db920cSGautham R Shenoy 1022b96feb2cSTobias Schramm@item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}][,fmode=@var{fmode}][,dmode=@var{dmode}] 102374db920cSGautham R Shenoy@findex -fsdev 10247c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 10257c92a3d2SAneesh Kumar K.V@table @option 10267c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 10277c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 1028f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 10297c92a3d2SAneesh Kumar K.V@item id=@var{id} 10307c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 10317c92a3d2SAneesh Kumar K.V@item path=@var{path} 10327c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 10337c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 10347c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 10357c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 10362c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 10377c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 1038b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 10392c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 10407c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 10412c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 10422c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 10437c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 10447c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 1045d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 1046f67e3ffdSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle, proxy) don't take 1047d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 10487c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 10497c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 10507c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 10517c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 10527c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 10532c74c2cbSM. Mohan Kumar@item readonly 10542c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 10552c74c2cbSM. Mohan Kumarread-write access is given. 105684a87cc4SM. Mohan Kumar@item socket=@var{socket} 105784a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for communicating 105884a87cc4SM. Mohan Kumarwith virtfs-proxy-helper 1059f67e3ffdSM. Mohan Kumar@item sock_fd=@var{sock_fd} 1060f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed socket descriptor for 1061f67e3ffdSM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 1062f67e3ffdSM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 1063b96feb2cSTobias Schramm@item fmode=@var{fmode} 1064b96feb2cSTobias SchrammSpecifies the default mode for newly created files on the host. Works only 1065b96feb2cSTobias Schrammwith security models "mapped-xattr" and "mapped-file". 1066b96feb2cSTobias Schramm@item dmode=@var{dmode} 1067b96feb2cSTobias SchrammSpecifies the default mode for newly created directories on the host. Works 1068b96feb2cSTobias Schrammonly with security models "mapped-xattr" and "mapped-file". 106974db920cSGautham R Shenoy@end table 10707c92a3d2SAneesh Kumar K.V 10717c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 10727c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 10737c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 10747c92a3d2SAneesh Kumar K.V@table @option 10757c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 10767c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 10777c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 10787c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 10797c92a3d2SAneesh Kumar K.V@end table 10807c92a3d2SAneesh Kumar K.V 108174db920cSGautham R ShenoyETEXI 108274db920cSGautham R Shenoy 10833d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 10842c30dd74SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 1085b96feb2cSTobias Schramm " [,id=id][,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd][,fmode=fmode][,dmode=dmode]\n", 10863d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 10873d54abc7SGautham R Shenoy 10883d54abc7SGautham R ShenoySTEXI 10893d54abc7SGautham R Shenoy 1090b96feb2cSTobias Schramm@item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}][,fmode=@var{fmode}][,dmode=@var{dmode}] 10913d54abc7SGautham R Shenoy@findex -virtfs 10923d54abc7SGautham R Shenoy 10937c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 10947c92a3d2SAneesh Kumar K.V@table @option 10957c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 10967c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 1097f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 10987c92a3d2SAneesh Kumar K.V@item id=@var{id} 10997c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 11007c92a3d2SAneesh Kumar K.V@item path=@var{path} 11017c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 11027c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 11037c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 11047c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 11052c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 11067c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 1107b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 11082c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 11097c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 11102c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 11112c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 11127c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 11137c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 1114d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 1115f67e3ffdSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle, proxy) don't take security 1116d9b36a6eSM. Mohan Kumarmodel as a parameter. 11177c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 11187c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 11197c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 11207c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 11217c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 11222c74c2cbSM. Mohan Kumar@item readonly 11232c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 11242c74c2cbSM. Mohan Kumarread-write access is given. 112584a87cc4SM. Mohan Kumar@item socket=@var{socket} 112684a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for 112784a87cc4SM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 112884a87cc4SM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 1129f67e3ffdSM. Mohan Kumar@item sock_fd 1130f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed 'sock_fd' as the socket 1131f67e3ffdSM. Mohan Kumardescriptor for interfacing with virtfs-proxy-helper 1132b96feb2cSTobias Schramm@item fmode=@var{fmode} 1133b96feb2cSTobias SchrammSpecifies the default mode for newly created files on the host. Works only 1134b96feb2cSTobias Schrammwith security models "mapped-xattr" and "mapped-file". 1135b96feb2cSTobias Schramm@item dmode=@var{dmode} 1136b96feb2cSTobias SchrammSpecifies the default mode for newly created directories on the host. Works 1137b96feb2cSTobias Schrammonly with security models "mapped-xattr" and "mapped-file". 11383d54abc7SGautham R Shenoy@end table 11393d54abc7SGautham R ShenoyETEXI 11403d54abc7SGautham R Shenoy 11419db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 11429db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 11439db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 11449db221aeSAneesh Kumar K.VSTEXI 11459db221aeSAneesh Kumar K.V@item -virtfs_synth 11469db221aeSAneesh Kumar K.V@findex -virtfs_synth 11479db221aeSAneesh Kumar K.VCreate synthetic file system image 11489db221aeSAneesh Kumar K.VETEXI 11499db221aeSAneesh Kumar K.V 115061d70487SMarkus ArmbrusterDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 115161d70487SMarkus Armbruster "-iscsi [user=user][,password=password]\n" 115261d70487SMarkus Armbruster " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 115361d70487SMarkus Armbruster " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 115461d70487SMarkus Armbruster " [,timeout=timeout]\n" 115561d70487SMarkus Armbruster " iSCSI session parameters\n", QEMU_ARCH_ALL) 115661d70487SMarkus Armbruster 11575824d651Sblueswir1STEXI 115844743148SMarkus Armbruster@item -iscsi 115944743148SMarkus Armbruster@findex -iscsi 116044743148SMarkus ArmbrusterConfigure iSCSI session parameters. 116144743148SMarkus ArmbrusterETEXI 116244743148SMarkus Armbruster 116344743148SMarkus ArmbrusterSTEXI 11645824d651Sblueswir1@end table 11655824d651Sblueswir1ETEXI 11665824d651Sblueswir1DEFHEADING() 11675824d651Sblueswir1 1168de6b4f90SMarkus ArmbrusterDEFHEADING(USB options:) 116910adb8beSMarkus ArmbrusterSTEXI 117010adb8beSMarkus Armbruster@table @option 117110adb8beSMarkus ArmbrusterETEXI 117210adb8beSMarkus Armbruster 117310adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 1174a358a3afSThomas Huth "-usb enable the USB driver (if it is not used by default yet)\n", 117510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 117610adb8beSMarkus ArmbrusterSTEXI 117710adb8beSMarkus Armbruster@item -usb 117810adb8beSMarkus Armbruster@findex -usb 1179a358a3afSThomas HuthEnable the USB driver (if it is not used by default yet). 118010adb8beSMarkus ArmbrusterETEXI 118110adb8beSMarkus Armbruster 118210adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 118310adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 118410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 118510adb8beSMarkus ArmbrusterSTEXI 118610adb8beSMarkus Armbruster 118710adb8beSMarkus Armbruster@item -usbdevice @var{devname} 118810adb8beSMarkus Armbruster@findex -usbdevice 1189a358a3afSThomas HuthAdd the USB device @var{devname}. Note that this option is deprecated, 1190a358a3afSThomas Huthplease use @code{-device usb-...} instead. @xref{usb_devices}. 119110adb8beSMarkus Armbruster 119210adb8beSMarkus Armbruster@table @option 119310adb8beSMarkus Armbruster 119410adb8beSMarkus Armbruster@item mouse 119510adb8beSMarkus ArmbrusterVirtual Mouse. This will override the PS/2 mouse emulation when activated. 119610adb8beSMarkus Armbruster 119710adb8beSMarkus Armbruster@item tablet 119810adb8beSMarkus ArmbrusterPointer device that uses absolute coordinates (like a touchscreen). This 119910adb8beSMarkus Armbrustermeans QEMU is able to report the mouse position without having to grab the 120010adb8beSMarkus Armbrustermouse. Also overrides the PS/2 mouse emulation when activated. 120110adb8beSMarkus Armbruster 120210adb8beSMarkus Armbruster@item braille 120310adb8beSMarkus ArmbrusterBraille device. This will use BrlAPI to display the braille output on a real 120410adb8beSMarkus Armbrusteror fake device. 120510adb8beSMarkus Armbruster 120610adb8beSMarkus Armbruster@end table 120710adb8beSMarkus ArmbrusterETEXI 120810adb8beSMarkus Armbruster 120910adb8beSMarkus ArmbrusterSTEXI 121010adb8beSMarkus Armbruster@end table 121110adb8beSMarkus ArmbrusterETEXI 121210adb8beSMarkus ArmbrusterDEFHEADING() 121310adb8beSMarkus Armbruster 1214de6b4f90SMarkus ArmbrusterDEFHEADING(Display options:) 12155824d651Sblueswir1STEXI 12165824d651Sblueswir1@table @option 12175824d651Sblueswir1ETEXI 12185824d651Sblueswir1 12191472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 12201472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 12214867e47cSElie Tournier " [,window_close=on|off][,gl=on|core|es|off]\n" 1222f04ec5afSRobert Ho "-display gtk[,grab_on_hover=on|off][,gl=on|off]|\n" 1223f04ec5afSRobert Ho "-display vnc=<display>[,<optargs>]\n" 1224f04ec5afSRobert Ho "-display curses\n" 1225f04ec5afSRobert Ho "-display none" 1226f04ec5afSRobert Ho " select display type\n" 1227f04ec5afSRobert Ho "The default display is equivalent to\n" 1228f04ec5afSRobert Ho#if defined(CONFIG_GTK) 1229f04ec5afSRobert Ho "\t\"-display gtk\"\n" 1230f04ec5afSRobert Ho#elif defined(CONFIG_SDL) 1231f04ec5afSRobert Ho "\t\"-display sdl\"\n" 1232f04ec5afSRobert Ho#elif defined(CONFIG_COCOA) 1233f04ec5afSRobert Ho "\t\"-display cocoa\"\n" 1234f04ec5afSRobert Ho#elif defined(CONFIG_VNC) 1235f04ec5afSRobert Ho "\t\"-vnc localhost:0,to=99,id=default\"\n" 1236f04ec5afSRobert Ho#else 1237f04ec5afSRobert Ho "\t\"-display none\"\n" 1238f04ec5afSRobert Ho#endif 1239f04ec5afSRobert Ho , QEMU_ARCH_ALL) 12401472a95bSJes SorensenSTEXI 12411472a95bSJes Sorensen@item -display @var{type} 12421472a95bSJes Sorensen@findex -display 12431472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 12441472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 12451472a95bSJes Sorensen@table @option 12461472a95bSJes Sorensen@item sdl 12471472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 12481472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 12491472a95bSJes Sorensen@item curses 12501472a95bSJes SorensenDisplay video output via curses. For graphics device models which 12511472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 12521472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 12531472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 12541472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 12554171d32eSJes Sorensen@item none 12564171d32eSJes SorensenDo not display video output. The guest will still see an emulated 12574171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 12584171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 12594171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 12604171d32eSJes Sorensenthe destination of the serial and parallel port data. 1261881249c7SJan Kiszka@item gtk 1262881249c7SJan KiszkaDisplay video output in a GTK window. This interface provides drop-down 1263881249c7SJan Kiszkamenus and other UI elements to configure and control the VM during 1264881249c7SJan Kiszkaruntime. 12653264ff12SJes Sorensen@item vnc 12663264ff12SJes SorensenStart a VNC server on display <arg> 12671472a95bSJes Sorensen@end table 12681472a95bSJes SorensenETEXI 12691472a95bSJes Sorensen 12705824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 1271ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 1272ad96090aSBlue Swirl QEMU_ARCH_ALL) 12735824d651Sblueswir1STEXI 12745824d651Sblueswir1@item -nographic 12756616b2adSStefan Weil@findex -nographic 1276dc0a3e44SColin LordNormally, if QEMU is compiled with graphical window support, it displays 1277dc0a3e44SColin Lordoutput such as guest graphics, guest console, and the QEMU monitor in a 1278dc0a3e44SColin Lordwindow. With this option, you can totally disable graphical output so 1279dc0a3e44SColin Lordthat QEMU is a simple command line application. The emulated serial port 1280dc0a3e44SColin Lordis redirected on the console and muxed with the monitor (unless 1281dc0a3e44SColin Lordredirected elsewhere explicitly). Therefore, you can still use QEMU to 1282dc0a3e44SColin Lorddebug a Linux kernel with a serial console. Use @key{C-a h} for help on 1283dc0a3e44SColin Lordswitching between the console and monitor. 12845824d651Sblueswir1ETEXI 12855824d651Sblueswir1 12865824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 1287f04ec5afSRobert Ho "-curses shorthand for -display curses\n", 1288ad96090aSBlue Swirl QEMU_ARCH_ALL) 12895824d651Sblueswir1STEXI 12905824d651Sblueswir1@item -curses 1291b8f490ebSMarkus Armbruster@findex -curses 1292dc0a3e44SColin LordNormally, if QEMU is compiled with graphical window support, it displays 1293dc0a3e44SColin Lordoutput such as guest graphics, guest console, and the QEMU monitor in a 1294dc0a3e44SColin Lordwindow. With this option, QEMU can display the VGA output when in text 1295dc0a3e44SColin Lordmode using a curses/ncurses interface. Nothing is displayed in graphical 1296dc0a3e44SColin Lordmode. 12975824d651Sblueswir1ETEXI 12985824d651Sblueswir1 12995824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 1300ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 1301ad96090aSBlue Swirl QEMU_ARCH_ALL) 13025824d651Sblueswir1STEXI 13035824d651Sblueswir1@item -no-frame 13046616b2adSStefan Weil@findex -no-frame 13055824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 13065824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 13075824d651Sblueswir1workspace more convenient. 13085824d651Sblueswir1ETEXI 13095824d651Sblueswir1 13105824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 1311ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 1312ad96090aSBlue Swirl QEMU_ARCH_ALL) 13135824d651Sblueswir1STEXI 13145824d651Sblueswir1@item -alt-grab 13156616b2adSStefan Weil@findex -alt-grab 1316de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 1317de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 13185824d651Sblueswir1ETEXI 13195824d651Sblueswir1 13200ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 1321ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 1322ad96090aSBlue Swirl QEMU_ARCH_ALL) 13230ca9f8a4SDustin KirklandSTEXI 13240ca9f8a4SDustin Kirkland@item -ctrl-grab 13256616b2adSStefan Weil@findex -ctrl-grab 1326de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 1327de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 13280ca9f8a4SDustin KirklandETEXI 13290ca9f8a4SDustin Kirkland 13305824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 1331ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 13325824d651Sblueswir1STEXI 13335824d651Sblueswir1@item -no-quit 13346616b2adSStefan Weil@findex -no-quit 13355824d651Sblueswir1Disable SDL window close capability. 13365824d651Sblueswir1ETEXI 13375824d651Sblueswir1 13385824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 1339f04ec5afSRobert Ho "-sdl shorthand for -display sdl\n", QEMU_ARCH_ALL) 13405824d651Sblueswir1STEXI 13415824d651Sblueswir1@item -sdl 13426616b2adSStefan Weil@findex -sdl 13435824d651Sblueswir1Enable SDL. 13445824d651Sblueswir1ETEXI 13455824d651Sblueswir1 134629b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 134727af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 134827af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 134927af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 1350fe4831b1SMarc-André Lureau " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n" 135127af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 135227af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 135327af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 135427af7788SYonit Halperin " [,sasl][,password=<secret>][,disable-ticketing]\n" 135527af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 135627af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 135727af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 135827af7788SYonit Halperin " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 13595ad24e5fSHans de Goede " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" 13605ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 13617b525508SMarc-André Lureau " [,gl=[on|off]][,rendernode=<file>]\n" 136227af7788SYonit Halperin " enable spice\n" 136327af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 136427af7788SYonit Halperin QEMU_ARCH_ALL) 136529b0040bSGerd HoffmannSTEXI 136629b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 136729b0040bSGerd Hoffmann@findex -spice 136829b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 136929b0040bSGerd Hoffmann 137029b0040bSGerd Hoffmann@table @option 137129b0040bSGerd Hoffmann 137229b0040bSGerd Hoffmann@item port=<nr> 1373c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 137429b0040bSGerd Hoffmann 1375333b0eebSGerd Hoffmann@item addr=<addr> 1376333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 1377333b0eebSGerd Hoffmann 1378333b0eebSGerd Hoffmann@item ipv4 1379f9cfd655SMarkus Armbruster@itemx ipv6 1380f9cfd655SMarkus Armbruster@itemx unix 1381333b0eebSGerd HoffmannForce using the specified IP version. 1382333b0eebSGerd Hoffmann 138329b0040bSGerd Hoffmann@item password=<secret> 138429b0040bSGerd HoffmannSet the password you need to authenticate. 138529b0040bSGerd Hoffmann 138648b3ed0aSMarc-André Lureau@item sasl 138748b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 138848b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 138948b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 139048b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 139148b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 139248b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 139348b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 139448b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 139548b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 139648b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 139748b3ed0aSMarc-André Lureaucredentials. 139848b3ed0aSMarc-André Lureau 139929b0040bSGerd Hoffmann@item disable-ticketing 140029b0040bSGerd HoffmannAllow client connects without authentication. 140129b0040bSGerd Hoffmann 1402d4970b07SHans de Goede@item disable-copy-paste 1403d4970b07SHans de GoedeDisable copy paste between the client and the guest. 1404d4970b07SHans de Goede 14055ad24e5fSHans de Goede@item disable-agent-file-xfer 14065ad24e5fSHans de GoedeDisable spice-vdagent based file-xfer between the client and the guest. 14075ad24e5fSHans de Goede 1408c448e855SGerd Hoffmann@item tls-port=<nr> 1409c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 1410c448e855SGerd Hoffmann 1411c448e855SGerd Hoffmann@item x509-dir=<dir> 1412c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 1413c448e855SGerd Hoffmann 1414c448e855SGerd Hoffmann@item x509-key-file=<file> 1415f9cfd655SMarkus Armbruster@itemx x509-key-password=<file> 1416f9cfd655SMarkus Armbruster@itemx x509-cert-file=<file> 1417f9cfd655SMarkus Armbruster@itemx x509-cacert-file=<file> 1418f9cfd655SMarkus Armbruster@itemx x509-dh-key-file=<file> 1419c448e855SGerd HoffmannThe x509 file names can also be configured individually. 1420c448e855SGerd Hoffmann 1421c448e855SGerd Hoffmann@item tls-ciphers=<list> 1422c448e855SGerd HoffmannSpecify which ciphers to use. 1423c448e855SGerd Hoffmann 1424d70d6b31SAlon Levy@item tls-channel=[main|display|cursor|inputs|record|playback] 1425f9cfd655SMarkus Armbruster@itemx plaintext-channel=[main|display|cursor|inputs|record|playback] 142617b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 142717b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 142817b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 142917b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 143017b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 143117b6dea0SGerd Hoffmann 14329f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 14339f04e09eSYonit HalperinConfigure image compression (lossless). 14349f04e09eSYonit HalperinDefault is auto_glz. 14359f04e09eSYonit Halperin 14369f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 1437f9cfd655SMarkus Armbruster@itemx zlib-glz-wan-compression=[auto|never|always] 14389f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 14399f04e09eSYonit HalperinDefault is auto. 14409f04e09eSYonit Halperin 144184a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 144293ca519eSLi ZhijianConfigure video stream detection. Default is off. 144384a23f25SGerd Hoffmann 144484a23f25SGerd Hoffmann@item agent-mouse=[on|off] 144584a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 144684a23f25SGerd Hoffmann 144784a23f25SGerd Hoffmann@item playback-compression=[on|off] 144884a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 144984a23f25SGerd Hoffmann 14508c957053SYonit Halperin@item seamless-migration=[on|off] 14518c957053SYonit HalperinEnable/disable spice seamless migration. Default is off. 14528c957053SYonit Halperin 1453474114b7SGerd Hoffmann@item gl=[on|off] 1454474114b7SGerd HoffmannEnable/disable OpenGL context. Default is off. 1455474114b7SGerd Hoffmann 14567b525508SMarc-André Lureau@item rendernode=<file> 14577b525508SMarc-André LureauDRM render node for OpenGL rendering. If not specified, it will pick 14587b525508SMarc-André Lureauthe first available. (Since 2.9) 14597b525508SMarc-André Lureau 146029b0040bSGerd Hoffmann@end table 146129b0040bSGerd HoffmannETEXI 146229b0040bSGerd Hoffmann 14635824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 1464ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1465ad96090aSBlue Swirl QEMU_ARCH_ALL) 14665824d651Sblueswir1STEXI 14675824d651Sblueswir1@item -portrait 14686616b2adSStefan Weil@findex -portrait 14695824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 14705824d651Sblueswir1ETEXI 14715824d651Sblueswir1 14729312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 14739312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 14749312805dSVasily Khoruzhick QEMU_ARCH_ALL) 14759312805dSVasily KhoruzhickSTEXI 14766265c43bSMarkus Armbruster@item -rotate @var{deg} 14779312805dSVasily Khoruzhick@findex -rotate 14789312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 14799312805dSVasily KhoruzhickETEXI 14809312805dSVasily Khoruzhick 14815824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 1482a94f0c5cSGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n" 1483ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 14845824d651Sblueswir1STEXI 1485e4558dcaSmalc@item -vga @var{type} 14866616b2adSStefan Weil@findex -vga 14875824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 1488b3f046c2SKevin Wolf@table @option 14895824d651Sblueswir1@item cirrus 14905824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 14915824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 14925824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 149341eeb0e6SAlberto Garcia(This card was the default before QEMU 2.2) 14945824d651Sblueswir1@item std 14955824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 14965824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 14975824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 149841eeb0e6SAlberto Garciathis option. (This card is the default since QEMU 2.2) 14995824d651Sblueswir1@item vmware 15005824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 15015824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 15025824d651Sblueswir1card. 1503a19cbfb3SGerd Hoffmann@item qxl 1504a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 1505a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 1506a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 150733632788SMark Cave-Ayland@item tcx 150833632788SMark Cave-Ayland(sun4m only) Sun TCX framebuffer. This is the default framebuffer for 150933632788SMark Cave-Aylandsun4m machines and offers both 8-bit and 24-bit colour depths at a 151033632788SMark Cave-Aylandfixed resolution of 1024x768. 151133632788SMark Cave-Ayland@item cg3 151233632788SMark Cave-Ayland(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer 151333632788SMark Cave-Aylandfor sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) 151433632788SMark Cave-Aylandresolutions aimed at people wishing to run older Solaris versions. 1515a94f0c5cSGerd Hoffmann@item virtio 1516a94f0c5cSGerd HoffmannVirtio VGA card. 15175824d651Sblueswir1@item none 15185824d651Sblueswir1Disable VGA card. 15195824d651Sblueswir1@end table 15205824d651Sblueswir1ETEXI 15215824d651Sblueswir1 15225824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 1523ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 15245824d651Sblueswir1STEXI 15255824d651Sblueswir1@item -full-screen 15266616b2adSStefan Weil@findex -full-screen 15275824d651Sblueswir1Start in full screen. 15285824d651Sblueswir1ETEXI 15295824d651Sblueswir1 15305824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 1531ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1532ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 15335824d651Sblueswir1STEXI 153495d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 15356616b2adSStefan Weil@findex -g 153695d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 15375824d651Sblueswir1ETEXI 15385824d651Sblueswir1 15395824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1540f04ec5afSRobert Ho "-vnc <display> shorthand for -display vnc=<display>\n", QEMU_ARCH_ALL) 15415824d651Sblueswir1STEXI 15425824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 15436616b2adSStefan Weil@findex -vnc 1544dc0a3e44SColin LordNormally, if QEMU is compiled with graphical window support, it displays 1545dc0a3e44SColin Lordoutput such as guest graphics, guest console, and the QEMU monitor in a 1546dc0a3e44SColin Lordwindow. With this option, you can have QEMU listen on VNC display 1547dc0a3e44SColin Lord@var{display} and redirect the VGA display over the VNC session. It is 1548dc0a3e44SColin Lordvery useful to enable the usb tablet device when using this option 1549a358a3afSThomas Huth(option @option{-device usb-tablet}). When using the VNC display, you 1550dc0a3e44SColin Lordmust use the @option{-k} parameter to set the keyboard layout if you are 1551dc0a3e44SColin Lordnot using en-us. Valid syntax for the @var{display} is 15525824d651Sblueswir1 1553b3f046c2SKevin Wolf@table @option 15545824d651Sblueswir1 155599a9a52aSRobert Ho@item to=@var{L} 155699a9a52aSRobert Ho 155799a9a52aSRobert HoWith this option, QEMU will try next available VNC @var{display}s, until the 155899a9a52aSRobert Honumber @var{L}, if the origianlly defined "-vnc @var{display}" is not 155999a9a52aSRobert Hoavailable, e.g. port 5900+@var{display} is already used by another 156099a9a52aSRobert Hoapplication. By default, to=0. 156199a9a52aSRobert Ho 15625824d651Sblueswir1@item @var{host}:@var{d} 15635824d651Sblueswir1 15645824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 15655824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 15665824d651Sblueswir1be omitted in which case the server will accept connections from any host. 15675824d651Sblueswir1 15684e257e5eSKevin Wolf@item unix:@var{path} 15695824d651Sblueswir1 15705824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 15715824d651Sblueswir1location of a unix socket to listen for connections on. 15725824d651Sblueswir1 15735824d651Sblueswir1@item none 15745824d651Sblueswir1 15755824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 15765824d651Sblueswir1can be used to later start the VNC server. 15775824d651Sblueswir1 15785824d651Sblueswir1@end table 15795824d651Sblueswir1 15805824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 15815824d651Sblueswir1separated by commas. Valid options are 15825824d651Sblueswir1 1583b3f046c2SKevin Wolf@table @option 15845824d651Sblueswir1 15855824d651Sblueswir1@item reverse 15865824d651Sblueswir1 15875824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 15885824d651Sblueswir1client is specified by the @var{display}. For reverse network 15895824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 15905824d651Sblueswir1is a TCP port number, not a display number. 15915824d651Sblueswir1 15927536ee4bSTim Hardeck@item websocket 15937536ee4bSTim Hardeck 15947536ee4bSTim HardeckOpens an additional TCP listening port dedicated to VNC Websocket connections. 1595275e0d61SDaniel P. BerrangeIf a bare @var{websocket} option is given, the Websocket port is 1596275e0d61SDaniel P. Berrange5700+@var{display}. An alternative port can be specified with the 1597275e0d61SDaniel P. Berrangesyntax @code{websocket}=@var{port}. 1598275e0d61SDaniel P. Berrange 1599275e0d61SDaniel P. BerrangeIf @var{host} is specified connections will only be allowed from this host. 1600275e0d61SDaniel P. BerrangeIt is possible to control the websocket listen address independently, using 1601275e0d61SDaniel P. Berrangethe syntax @code{websocket}=@var{host}:@var{port}. 1602275e0d61SDaniel P. Berrange 16033e305e4aSDaniel P. BerrangeIf no TLS credentials are provided, the websocket connection runs in 16043e305e4aSDaniel P. Berrangeunencrypted mode. If TLS credentials are provided, the websocket connection 16053e305e4aSDaniel P. Berrangerequires encrypted client connections. 16067536ee4bSTim Hardeck 16075824d651Sblueswir1@item password 16085824d651Sblueswir1 16095824d651Sblueswir1Require that password based authentication is used for client connections. 161086ee5bc3SMichal Novotny 161186ee5bc3SMichal NovotnyThe password must be set separately using the @code{set_password} command in 161286ee5bc3SMichal Novotnythe @ref{pcsys_monitor}. The syntax to change your password is: 161386ee5bc3SMichal Novotny@code{set_password <protocol> <password>} where <protocol> could be either 161486ee5bc3SMichal Novotny"vnc" or "spice". 161586ee5bc3SMichal Novotny 161686ee5bc3SMichal NovotnyIf you would like to change <protocol> password expiration, you should use 161786ee5bc3SMichal Novotny@code{expire_password <protocol> <expiration-time>} where expiration time could 161886ee5bc3SMichal Novotnybe one of the following options: now, never, +seconds or UNIX time of 161986ee5bc3SMichal Novotnyexpiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 162086ee5bc3SMichal Novotnyto make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 162186ee5bc3SMichal Novotnydate and time). 162286ee5bc3SMichal Novotny 162386ee5bc3SMichal NovotnyYou can also use keywords "now" or "never" for the expiration time to 162486ee5bc3SMichal Novotnyallow <protocol> password to expire immediately or never expire. 16255824d651Sblueswir1 16263e305e4aSDaniel P. Berrange@item tls-creds=@var{ID} 16273e305e4aSDaniel P. Berrange 16283e305e4aSDaniel P. BerrangeProvides the ID of a set of TLS credentials to use to secure the 16293e305e4aSDaniel P. BerrangeVNC server. They will apply to both the normal VNC server socket 16303e305e4aSDaniel P. Berrangeand the websocket socket (if enabled). Setting TLS credentials 16313e305e4aSDaniel P. Berrangewill cause the VNC server socket to enable the VeNCrypt auth 16323e305e4aSDaniel P. Berrangemechanism. The credentials should have been previously created 16333e305e4aSDaniel P. Berrangeusing the @option{-object tls-creds} argument. 16343e305e4aSDaniel P. Berrange 16353e305e4aSDaniel P. BerrangeThe @option{tls-creds} parameter obsoletes the @option{tls}, 16363e305e4aSDaniel P. Berrange@option{x509}, and @option{x509verify} options, and as such 16373e305e4aSDaniel P. Berrangeit is not permitted to set both new and old type options at 16383e305e4aSDaniel P. Berrangethe same time. 16393e305e4aSDaniel P. Berrange 16405824d651Sblueswir1@item tls 16415824d651Sblueswir1 16425824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 16435824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 16445824d651Sblueswir1attack. It is recommended that this option be combined with either the 16454e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 16465824d651Sblueswir1 16473e305e4aSDaniel P. BerrangeThis option is now deprecated in favor of using the @option{tls-creds} 16483e305e4aSDaniel P. Berrangeargument. 16493e305e4aSDaniel P. Berrange 16505824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 16515824d651Sblueswir1 16525824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 16535824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 16545824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 16555824d651Sblueswir1to provide authentication of the client when this is used. The path following 16565824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 16575824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 16585824d651Sblueswir1 16593e305e4aSDaniel P. BerrangeThis option is now deprecated in favour of using the @option{tls-creds} 16603e305e4aSDaniel P. Berrangeargument. 16613e305e4aSDaniel P. Berrange 16625824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 16635824d651Sblueswir1 16645824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 16655824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 16665824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 16675824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 16685824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 16695824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 16705824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 16715824d651Sblueswir1path following this option specifies where the x509 certificates are to 16725824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 16735824d651Sblueswir1certificates. 16745824d651Sblueswir1 16753e305e4aSDaniel P. BerrangeThis option is now deprecated in favour of using the @option{tls-creds} 16763e305e4aSDaniel P. Berrangeargument. 16773e305e4aSDaniel P. Berrange 16785824d651Sblueswir1@item sasl 16795824d651Sblueswir1 16805824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 16815824d651Sblueswir1The exact choice of authentication method used is controlled from the 16825824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 16835824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 16845824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 16855824d651Sblueswir1to make it search alternate locations for the service config. 16865824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 16875824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 16885824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 16895824d651Sblueswir1ensures a data encryption preventing compromise of authentication 16905824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 16915824d651Sblueswir1SASL authentication. 16925824d651Sblueswir1 16935824d651Sblueswir1@item acl 16945824d651Sblueswir1 16955824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 16965824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 16975824d651Sblueswir1certificate's distinguished name. This is something that looks like 16985824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 16995824d651Sblueswir1made against the username, which depending on the SASL plugin, may 17005824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 17015824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 17025824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 17035824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 17045824d651Sblueswir1achieved using the @code{acl} monitor command. 17055824d651Sblueswir1 17066f9c78c1SCorentin Chary@item lossy 17076f9c78c1SCorentin Chary 17086f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 17096f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 17106f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 17116f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 17126f9c78c1SCorentin Chary 171380e0c8c3SCorentin Chary@item non-adaptive 171480e0c8c3SCorentin Chary 171580e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 171680e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 171780e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 171861cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 17199d85d557SMichael Tokarevadaptive encodings restores the original static behavior of encodings 172080e0c8c3SCorentin Charylike Tight. 172180e0c8c3SCorentin Chary 17228cf36489SGerd Hoffmann@item share=[allow-exclusive|force-shared|ignore] 17238cf36489SGerd Hoffmann 17248cf36489SGerd HoffmannSet display sharing policy. 'allow-exclusive' allows clients to ask 17258cf36489SGerd Hoffmannfor exclusive access. As suggested by the rfb spec this is 17268cf36489SGerd Hoffmannimplemented by dropping other connections. Connecting multiple 17278cf36489SGerd Hoffmannclients in parallel requires all clients asking for a shared session 17288cf36489SGerd Hoffmann(vncviewer: -shared switch). This is the default. 'force-shared' 17298cf36489SGerd Hoffmanndisables exclusive client access. Useful for shared desktop sessions, 17308cf36489SGerd Hoffmannwhere you don't want someone forgetting specify -shared disconnect 17318cf36489SGerd Hoffmanneverybody else. 'ignore' completely ignores the shared flag and 17328cf36489SGerd Hoffmannallows everybody connect unconditionally. Doesn't conform to the rfb 1733b65ee4faSStefan Weilspec but is traditional QEMU behavior. 17348cf36489SGerd Hoffmann 1735c5ce8333SGerd Hoffmann@item key-delay-ms 1736c5ce8333SGerd Hoffmann 1737c5ce8333SGerd HoffmannSet keyboard delay, for key down and key up events, in milliseconds. 1738d3b0db6dSAlexander GrafDefault is 10. Keyboards are low-bandwidth devices, so this slowdown 1739c5ce8333SGerd Hoffmanncan help the device and guest to keep up and not lose events in case 1740c5ce8333SGerd Hoffmannevents are arriving in bulk. Possible causes for the latter are flaky 1741c5ce8333SGerd Hoffmannnetwork connections, or scripts for automated testing. 1742c5ce8333SGerd Hoffmann 17435824d651Sblueswir1@end table 17445824d651Sblueswir1ETEXI 17455824d651Sblueswir1 17465824d651Sblueswir1STEXI 17475824d651Sblueswir1@end table 17485824d651Sblueswir1ETEXI 1749a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 17505824d651Sblueswir1 1751de6b4f90SMarkus ArmbrusterARCHHEADING(i386 target only:, QEMU_ARCH_I386) 17525824d651Sblueswir1STEXI 17535824d651Sblueswir1@table @option 17545824d651Sblueswir1ETEXI 17555824d651Sblueswir1 17565824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1757ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1758ad96090aSBlue Swirl QEMU_ARCH_I386) 17595824d651Sblueswir1STEXI 17605824d651Sblueswir1@item -win2k-hack 17616616b2adSStefan Weil@findex -win2k-hack 17625824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 17635824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 17645824d651Sblueswir1slows down the IDE transfers). 17655824d651Sblueswir1ETEXI 17665824d651Sblueswir1 17671ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1768ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 17695824d651Sblueswir1 17705824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1771ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1772ad96090aSBlue Swirl QEMU_ARCH_I386) 17735824d651Sblueswir1STEXI 17745824d651Sblueswir1@item -no-fd-bootchk 17756616b2adSStefan Weil@findex -no-fd-bootchk 17764eda32f5SMarkus ArmbrusterDisable boot signature checking for floppy disks in BIOS. May 17775824d651Sblueswir1be needed to boot from old floppy disks. 17785824d651Sblueswir1ETEXI 17795824d651Sblueswir1 17805824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1781f5d8c8cdSShannon Zhao "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 17825824d651Sblueswir1STEXI 17835824d651Sblueswir1@item -no-acpi 17846616b2adSStefan Weil@findex -no-acpi 17855824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 17865824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 17875824d651Sblueswir1only). 17885824d651Sblueswir1ETEXI 17895824d651Sblueswir1 17905824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1791ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 17925824d651Sblueswir1STEXI 17935824d651Sblueswir1@item -no-hpet 17946616b2adSStefan Weil@findex -no-hpet 17955824d651Sblueswir1Disable HPET support. 17965824d651Sblueswir1ETEXI 17975824d651Sblueswir1 17985824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1799104bf02eSMichael Tokarev "-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" 1800ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 18015824d651Sblueswir1STEXI 18025824d651Sblueswir1@item -acpitable [sig=@var{str}][,rev=@var{n}][,oem_id=@var{str}][,oem_table_id=@var{str}][,oem_rev=@var{n}] [,asl_compiler_id=@var{str}][,asl_compiler_rev=@var{n}][,data=@var{file1}[:@var{file2}]...] 18036616b2adSStefan Weil@findex -acpitable 18045824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1805104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1806104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1807104bf02eSMichael TokarevFor data=, only data 1808104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1809104bf02eSMichael Tokarevcommand line. 1810ae123749SLaszlo ErsekIf a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id 1811ae123749SLaszlo Ersekfields will override the same in the RSDT and the FADT (a.k.a. FACP), in order 1812ae123749SLaszlo Ersekto ensure the field matches required by the Microsoft SLIC spec and the ACPI 1813ae123749SLaszlo Ersekspec. 18145824d651Sblueswir1ETEXI 18155824d651Sblueswir1 1816b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1817b6f6e3d3Saliguori "-smbios file=binary\n" 1818ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1819b155eb1dSGabriel L. Somlo "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1820b155eb1dSGabriel L. Somlo " [,uefi=on|off]\n" 1821ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1822b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1823b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1824b155eb1dSGabriel L. Somlo " specify SMBIOS type 1 fields\n" 1825b155eb1dSGabriel L. Somlo "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1826b155eb1dSGabriel L. Somlo " [,asset=str][,location=str]\n" 1827b155eb1dSGabriel L. Somlo " specify SMBIOS type 2 fields\n" 1828b155eb1dSGabriel L. Somlo "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 1829b155eb1dSGabriel L. Somlo " [,sku=str]\n" 1830b155eb1dSGabriel L. Somlo " specify SMBIOS type 3 fields\n" 1831b155eb1dSGabriel L. Somlo "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 1832b155eb1dSGabriel L. Somlo " [,asset=str][,part=str]\n" 1833b155eb1dSGabriel L. Somlo " specify SMBIOS type 4 fields\n" 1834b155eb1dSGabriel L. Somlo "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 18353ebd6cc8SGabriel L. Somlo " [,asset=str][,part=str][,speed=%d]\n" 1836b155eb1dSGabriel L. Somlo " specify SMBIOS type 17 fields\n", 1837c30e1565SWei Huang QEMU_ARCH_I386 | QEMU_ARCH_ARM) 1838b6f6e3d3SaliguoriSTEXI 1839b6f6e3d3Saliguori@item -smbios file=@var{binary} 18406616b2adSStefan Weil@findex -smbios 1841b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1842b6f6e3d3Saliguori 184384351843SGabriel L. Somlo@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] 1844b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1845b6f6e3d3Saliguori 1846b6f6e3d3Saliguori@item -smbios type=1[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,uuid=@var{uuid}][,sku=@var{str}][,family=@var{str}] 1847b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1848b155eb1dSGabriel L. Somlo 1849b155eb1dSGabriel L. Somlo@item -smbios type=2[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,location=@var{str}][,family=@var{str}] 1850b155eb1dSGabriel L. SomloSpecify SMBIOS type 2 fields 1851b155eb1dSGabriel L. Somlo 1852b155eb1dSGabriel L. Somlo@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}] 1853b155eb1dSGabriel L. SomloSpecify SMBIOS type 3 fields 1854b155eb1dSGabriel L. Somlo 1855b155eb1dSGabriel L. Somlo@item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}] 1856b155eb1dSGabriel L. SomloSpecify SMBIOS type 4 fields 1857b155eb1dSGabriel L. Somlo 18583ebd6cc8SGabriel L. Somlo@item -smbios type=17[,loc_pfx=@var{str}][,bank=@var{str}][,manufacturer=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}][,speed=@var{%d}] 1859b155eb1dSGabriel L. SomloSpecify SMBIOS type 17 fields 1860b6f6e3d3SaliguoriETEXI 1861b6f6e3d3Saliguori 18625824d651Sblueswir1STEXI 18635824d651Sblueswir1@end table 18645824d651Sblueswir1ETEXI 1865c70a01e4SMarkus ArmbrusterDEFHEADING() 18665824d651Sblueswir1 1867de6b4f90SMarkus ArmbrusterDEFHEADING(Network options:) 18685824d651Sblueswir1STEXI 18695824d651Sblueswir1@table @option 18705824d651Sblueswir1ETEXI 18715824d651Sblueswir1 1872ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1873ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1874ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1875ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1876ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1877ad196a9dSJan Kiszka#ifndef _WIN32 1878ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1879ad196a9dSJan Kiszka#endif 1880ad196a9dSJan Kiszka#endif 1881ad196a9dSJan Kiszka 18826a8b4a5bSThomas HuthDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 18835824d651Sblueswir1#ifdef CONFIG_SLIRP 18840b11c036SSamuel Thibault "-netdev user,id=str[,ipv4[=on|off]][,net=addr[/mask]][,host=addr]\n" 18850b11c036SSamuel Thibault " [,ipv6[=on|off]][,ipv6-net=addr[/int]][,ipv6-host=addr]\n" 18860b11c036SSamuel Thibault " [,restrict=on|off][,hostname=host][,dhcpstart=addr]\n" 1887f18d1375SBenjamin Drung " [,dns=addr][,ipv6-dns=addr][,dnssearch=domain][,domainname=domain]\n" 1888f18d1375SBenjamin Drung " [,tftp=dir][,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1889ad196a9dSJan Kiszka#ifndef _WIN32 1890c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1891ad196a9dSJan Kiszka#endif 18926a8b4a5bSThomas Huth " configure a user mode network backend with ID 'str',\n" 18936a8b4a5bSThomas Huth " its DHCP server and optional services\n" 18945824d651Sblueswir1#endif 18955824d651Sblueswir1#ifdef _WIN32 18966a8b4a5bSThomas Huth "-netdev tap,id=str,ifname=name\n" 18976a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 18985824d651Sblueswir1#else 18996a8b4a5bSThomas Huth "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 1900584613eaSAlexey Kardashevskiy " [,br=bridge][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 19016a8b4a5bSThomas Huth " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 190269e87b32SJason Wang " [,poll-us=n]\n" 19036a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 1904584613eaSAlexey Kardashevskiy " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 1905a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1906a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1907a7c36ee4SCorey Bryant " to deconfigure it\n" 1908ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 1909a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1910a7c36ee4SCorey Bryant " configure it\n" 19115824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 19122ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1913ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1914f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1915ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1916ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 191782b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 19185430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 19195430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 192082b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 19212ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1922ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 192369e87b32SJason Wang " use 'poll-us=n' to speciy the maximum number of microseconds that could be\n" 192469e87b32SJason Wang " spent on busy polling for vhost net\n" 19256a8b4a5bSThomas Huth "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 19266a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str' that is\n" 19276a8b4a5bSThomas Huth " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 19286a8b4a5bSThomas Huth " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 19290df0ff6dSMark McLoughlin#endif 19303fb69aa1SAnton Ivanov#ifdef __linux__ 19316a8b4a5bSThomas Huth "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 19326a8b4a5bSThomas Huth " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n" 19336a8b4a5bSThomas Huth " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n" 19346a8b4a5bSThomas Huth " [,rxcookie=rxcookie][,offset=offset]\n" 19356a8b4a5bSThomas Huth " configure a network backend with ID 'str' connected to\n" 19366a8b4a5bSThomas Huth " an Ethernet over L2TPv3 pseudowire.\n" 19373fb69aa1SAnton Ivanov " Linux kernel 3.3+ as well as most routers can talk\n" 19382f47b403SMichael Tokarev " L2TPv3. This transport allows connecting a VM to a VM,\n" 19393fb69aa1SAnton Ivanov " VM to a router and even VM to Host. It is a nearly-universal\n" 19403fb69aa1SAnton Ivanov " standard (RFC3391). Note - this implementation uses static\n" 19413fb69aa1SAnton Ivanov " pre-configured tunnels (same as the Linux kernel).\n" 19423fb69aa1SAnton Ivanov " use 'src=' to specify source address\n" 19433fb69aa1SAnton Ivanov " use 'dst=' to specify destination address\n" 19443fb69aa1SAnton Ivanov " use 'udp=on' to specify udp encapsulation\n" 19453952651aSGonglei " use 'srcport=' to specify source udp port\n" 19463fb69aa1SAnton Ivanov " use 'dstport=' to specify destination udp port\n" 19473fb69aa1SAnton Ivanov " use 'ipv6=on' to force v6\n" 19483fb69aa1SAnton Ivanov " L2TPv3 uses cookies to prevent misconfiguration as\n" 19493fb69aa1SAnton Ivanov " well as a weak security measure\n" 19503fb69aa1SAnton Ivanov " use 'rxcookie=0x012345678' to specify a rxcookie\n" 19513fb69aa1SAnton Ivanov " use 'txcookie=0x012345678' to specify a txcookie\n" 19523fb69aa1SAnton Ivanov " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 19533fb69aa1SAnton Ivanov " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 19543fb69aa1SAnton Ivanov " use 'pincounter=on' to work around broken counter handling in peer\n" 19553fb69aa1SAnton Ivanov " use 'offset=X' to add an extra offset between header and data\n" 19563fb69aa1SAnton Ivanov#endif 19576a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 19586a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 19596a8b4a5bSThomas Huth " using a socket connection\n" 19606a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 19616a8b4a5bSThomas Huth " configure a network backend to connect to a multicast maddr and port\n" 19623a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 19636a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 19646a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 19656a8b4a5bSThomas Huth " using an UDP tunnel\n" 19665824d651Sblueswir1#ifdef CONFIG_VDE 19676a8b4a5bSThomas Huth "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 19686a8b4a5bSThomas Huth " configure a network backend to connect to port 'n' of a vde switch\n" 19696a8b4a5bSThomas Huth " running on host and listening for incoming connections on 'socketpath'.\n" 19705824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 19715824d651Sblueswir1 " ownership and permissions for communication port.\n" 19725824d651Sblueswir1#endif 197358952137SVincenzo Maffione#ifdef CONFIG_NETMAP 19746a8b4a5bSThomas Huth "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 197558952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 197658952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 197758952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 197858952137SVincenzo Maffione#endif 1979253dc14cSThomas Huth#ifdef CONFIG_POSIX 19806a8b4a5bSThomas Huth "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 19816a8b4a5bSThomas Huth " configure a vhost-user network, backed by a chardev 'dev'\n" 1982253dc14cSThomas Huth#endif 198318d65d22SThomas Huth "-netdev hubport,id=str,hubid=n[,netdev=nd]\n" 1984af1a5c3eSThomas Huth " configure a hub port on the hub with ID 'n'\n", QEMU_ARCH_ALL) 198578cd6f7bSThomas HuthDEF("nic", HAS_ARG, QEMU_OPTION_nic, 1986dfaa7d50SBALATON Zoltan "-nic [tap|bridge|" 198778cd6f7bSThomas Huth#ifdef CONFIG_SLIRP 198878cd6f7bSThomas Huth "user|" 198978cd6f7bSThomas Huth#endif 199078cd6f7bSThomas Huth#ifdef __linux__ 199178cd6f7bSThomas Huth "l2tpv3|" 199278cd6f7bSThomas Huth#endif 199378cd6f7bSThomas Huth#ifdef CONFIG_VDE 199478cd6f7bSThomas Huth "vde|" 199578cd6f7bSThomas Huth#endif 199678cd6f7bSThomas Huth#ifdef CONFIG_NETMAP 199778cd6f7bSThomas Huth "netmap|" 199878cd6f7bSThomas Huth#endif 199978cd6f7bSThomas Huth#ifdef CONFIG_POSIX 200078cd6f7bSThomas Huth "vhost-user|" 200178cd6f7bSThomas Huth#endif 200278cd6f7bSThomas Huth "socket][,option][,...][mac=macaddr]\n" 200378cd6f7bSThomas Huth " initialize an on-board / default host NIC (using MAC address\n" 200478cd6f7bSThomas Huth " macaddr) and connect it to the given host network backend\n" 2005dfaa7d50SBALATON Zoltan "-nic none use it alone to have zero network devices (the default is to\n" 200678cd6f7bSThomas Huth " provided a 'user' network connection)\n", 200778cd6f7bSThomas Huth QEMU_ARCH_ALL) 20086a8b4a5bSThomas HuthDEF("net", HAS_ARG, QEMU_OPTION_net, 2009af1a5c3eSThomas Huth "-net nic[,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 20100e60a82dSThomas Huth " configure or create an on-board (or machine default) NIC and\n" 2011af1a5c3eSThomas Huth " connect it to hub 0 (please use -nic unless you need a hub)\n" 20126a8b4a5bSThomas Huth "-net [" 2013a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 2014a1ea458fSMark McLoughlin "user|" 2015a1ea458fSMark McLoughlin#endif 2016a1ea458fSMark McLoughlin "tap|" 2017a7c36ee4SCorey Bryant "bridge|" 2018a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 2019a1ea458fSMark McLoughlin "vde|" 2020a1ea458fSMark McLoughlin#endif 202158952137SVincenzo Maffione#ifdef CONFIG_NETMAP 202258952137SVincenzo Maffione "netmap|" 202358952137SVincenzo Maffione#endif 2024af1a5c3eSThomas Huth "socket][,option][,option][,...]\n" 20256a8b4a5bSThomas Huth " old way to initialize a host network interface\n" 20266a8b4a5bSThomas Huth " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 20275824d651Sblueswir1STEXI 2028abbbb035SThomas Huth@item -nic [tap|bridge|user|l2tpv3|vde|netmap|vhost-user|socket][,...][,mac=macaddr][,model=mn] 2029abbbb035SThomas Huth@findex -nic 2030abbbb035SThomas HuthThis option is a shortcut for configuring both the on-board (default) guest 2031abbbb035SThomas HuthNIC hardware and the host network backend in one go. The host backend options 2032abbbb035SThomas Huthare the same as with the corresponding @option{-netdev} options below. 2033abbbb035SThomas HuthThe guest NIC model can be set with @option{model=@var{modelname}}. 2034abbbb035SThomas HuthUse @option{model=help} to list the available device types. 2035abbbb035SThomas HuthThe hardware MAC address can be set with @option{mac=@var{macaddr}}. 2036abbbb035SThomas Huth 2037abbbb035SThomas HuthThe following two example do exactly the same, to show how @option{-nic} can 2038abbbb035SThomas Huthbe used to shorten the command line length (note that the e1000 is the default 2039abbbb035SThomas Huthon i386, so the @option{model=e1000} parameter could even be omitted here, too): 2040abbbb035SThomas Huth@example 2041abbbb035SThomas Huthqemu-system-i386 -netdev user,id=n1,ipv6=off -device e1000,netdev=n1,mac=52:54:98:76:54:32 2042abbbb035SThomas Huthqemu-system-i386 -nic user,ipv6=off,model=e1000,mac=52:54:98:76:54:32 2043abbbb035SThomas Huth@end example 2044abbbb035SThomas Huth 2045abbbb035SThomas Huth@item -nic none 2046abbbb035SThomas HuthIndicate that no network devices should be configured. It is used to override 2047abbbb035SThomas Huththe default configuration (default NIC with ``user'' host network backend) 2048abbbb035SThomas Huthwhich is activated if no other networking options are provided. 20495824d651Sblueswir1 205008d12022SStefan Hajnoczi@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 2051b8f490ebSMarkus Armbruster@findex -netdev 2052abbbb035SThomas HuthConfigure user mode host network backend which requires no administrator 2053ad196a9dSJan Kiszkaprivilege to run. Valid options are: 20545824d651Sblueswir1 2055b3f046c2SKevin Wolf@table @option 205608d12022SStefan Hajnoczi@item id=@var{id} 2057ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 2058ad196a9dSJan Kiszka 2059abbbb035SThomas Huth@item ipv4=on|off and ipv6=on|off 2060abbbb035SThomas HuthSpecify that either IPv4 or IPv6 must be enabled. If neither is specified 2061abbbb035SThomas Huthboth protocols are enabled. 20620b11c036SSamuel Thibault 2063c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 2064c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 2065c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 2066b0b36e5dSBrad Hards10.0.2.0/24. 2067c92ef6a2SJan Kiszka 2068c92ef6a2SJan Kiszka@item host=@var{addr} 2069c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 2070c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 2071ad196a9dSJan Kiszka 2072d8eb3864SSamuel Thibault@item ipv6-net=@var{addr}[/@var{int}] 2073d8eb3864SSamuel ThibaultSet IPv6 network address the guest will see (default is fec0::/64). The 2074d8eb3864SSamuel Thibaultnetwork prefix is given in the usual hexadecimal IPv6 address 2075d8eb3864SSamuel Thibaultnotation. The prefix size is optional, and is given as the number of 2076d8eb3864SSamuel Thibaultvalid top-most bits (default is 64). 20777aac531eSYann Bordenave 2078d8eb3864SSamuel Thibault@item ipv6-host=@var{addr} 20797aac531eSYann BordenaveSpecify the guest-visible IPv6 address of the host. Default is the 2nd IPv6 in 20807aac531eSYann Bordenavethe guest network, i.e. xxxx::2. 20817aac531eSYann Bordenave 2082c54ed5bcSJan Kiszka@item restrict=on|off 2083caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 2084ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 2085caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 2086ad196a9dSJan Kiszka 2087ad196a9dSJan Kiszka@item hostname=@var{name} 208863d2960bSKlaus StengelSpecifies the client hostname reported by the built-in DHCP server. 2089ad196a9dSJan Kiszka 2090c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 2091c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 2092b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 2093c92ef6a2SJan Kiszka 2094c92ef6a2SJan Kiszka@item dns=@var{addr} 2095c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 2096c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 2097c92ef6a2SJan Kiszkai.e. x.x.x.3. 2098c92ef6a2SJan Kiszka 2099d8eb3864SSamuel Thibault@item ipv6-dns=@var{addr} 21007aac531eSYann BordenaveSpecify the guest-visible address of the IPv6 virtual nameserver. The address 21017aac531eSYann Bordenavemust be different from the host address. Default is the 3rd IP in the guest 21027aac531eSYann Bordenavenetwork, i.e. xxxx::3. 21037aac531eSYann Bordenave 210463d2960bSKlaus Stengel@item dnssearch=@var{domain} 210563d2960bSKlaus StengelProvides an entry for the domain-search list sent by the built-in 210663d2960bSKlaus StengelDHCP server. More than one domain suffix can be transmitted by specifying 210763d2960bSKlaus Stengelthis option multiple times. If supported, this will cause the guest to 210863d2960bSKlaus Stengelautomatically try to append the given domain suffix(es) in case a domain name 210963d2960bSKlaus Stengelcan not be resolved. 211063d2960bSKlaus Stengel 211163d2960bSKlaus StengelExample: 211263d2960bSKlaus Stengel@example 2113abbbb035SThomas Huthqemu-system-i386 -nic user,dnssearch=mgmt.example.org,dnssearch=example.org 211463d2960bSKlaus Stengel@end example 211563d2960bSKlaus Stengel 2116f18d1375SBenjamin Drung@item domainname=@var{domain} 2117f18d1375SBenjamin DrungSpecifies the client domain name reported by the built-in DHCP server. 2118f18d1375SBenjamin Drung 2119ad196a9dSJan Kiszka@item tftp=@var{dir} 2120ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 2121ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 2122ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 2123c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 2124ad196a9dSJan Kiszka 2125ad196a9dSJan Kiszka@item bootfile=@var{file} 2126ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 2127ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 2128ad196a9dSJan Kiszkaa guest from a local directory. 2129ad196a9dSJan Kiszka 2130ad196a9dSJan KiszkaExample (using pxelinux): 2131ad196a9dSJan Kiszka@example 2132abbbb035SThomas Huthqemu-system-i386 -hda linux.img -boot n -device e1000,netdev=n1 \ 2133abbbb035SThomas Huth -netdev user,id=n1,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 2134ad196a9dSJan Kiszka@end example 2135ad196a9dSJan Kiszka 2136c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 2137ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 2138ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 2139c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 2140c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 2141ad196a9dSJan Kiszka 2142ad196a9dSJan KiszkaIn the guest Windows OS, the line: 2143ad196a9dSJan Kiszka@example 2144ad196a9dSJan Kiszka10.0.2.4 smbserver 2145ad196a9dSJan Kiszka@end example 2146ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 2147ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 2148ad196a9dSJan Kiszka 2149ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 2150ad196a9dSJan Kiszka 2151e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 2152ad196a9dSJan Kiszka 21533c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 2154c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 2155c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 2156c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 21573c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 21583c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 2159c92ef6a2SJan Kiszkaused. This option can be given multiple times. 2160ad196a9dSJan Kiszka 2161ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 2162ad196a9dSJan Kiszkascreen 0, use the following: 2163ad196a9dSJan Kiszka 2164ad196a9dSJan Kiszka@example 2165ad196a9dSJan Kiszka# on the host 2166abbbb035SThomas Huthqemu-system-i386 -nic user,hostfwd=tcp:127.0.0.1:6001-:6000 2167ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 2168ad196a9dSJan Kiszkaxterm -display :1 2169ad196a9dSJan Kiszka@end example 2170ad196a9dSJan Kiszka 2171ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 2172ad196a9dSJan Kiszkathe guest, use the following: 2173ad196a9dSJan Kiszka 2174ad196a9dSJan Kiszka@example 2175ad196a9dSJan Kiszka# on the host 2176abbbb035SThomas Huthqemu-system-i386 -nic user,hostfwd=tcp::5555-:23 2177ad196a9dSJan Kiszkatelnet localhost 5555 2178ad196a9dSJan Kiszka@end example 2179ad196a9dSJan Kiszka 2180ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 2181ad196a9dSJan Kiszkaconnect to the guest telnet server. 2182ad196a9dSJan Kiszka 2183c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 2184f9cfd655SMarkus Armbruster@itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 21853c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 2186b412eb61SAlexander Grafto the character device @var{dev} or to a program executed by @var{cmd:command} 2187b412eb61SAlexander Grafwhich gets spawned for each connection. This option can be given multiple times. 2188b412eb61SAlexander Graf 218943ffe61fSStefan WeilYou can either use a chardev directly and have that one used throughout QEMU's 2190b412eb61SAlexander Graflifetime, like in the following example: 2191b412eb61SAlexander Graf 2192b412eb61SAlexander Graf@example 2193b412eb61SAlexander Graf# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 2194b412eb61SAlexander Graf# the guest accesses it 2195abbbb035SThomas Huthqemu-system-i386 -nic user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 2196b412eb61SAlexander Graf@end example 2197b412eb61SAlexander Graf 2198b412eb61SAlexander GrafOr you can execute a command on every TCP connection established by the guest, 219943ffe61fSStefan Weilso that QEMU behaves similar to an inetd process for that virtual server: 2200b412eb61SAlexander Graf 2201b412eb61SAlexander Graf@example 2202b412eb61SAlexander Graf# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 2203b412eb61SAlexander Graf# and connect the TCP stream to its stdin/stdout 2204abbbb035SThomas Huthqemu-system-i386 -nic 'user,id=n1,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 2205b412eb61SAlexander Graf@end example 2206ad196a9dSJan Kiszka 2207ad196a9dSJan Kiszka@end table 2208ad196a9dSJan Kiszka 2209ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 2210ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 2211ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 2212ad196a9dSJan Kiszkaas they will be removed from future versions. 22135824d651Sblueswir1 2214584613eaSAlexey Kardashevskiy@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,br=@var{bridge}][,helper=@var{helper}] 2215abbbb035SThomas HuthConfigure a host TAP network backend with ID @var{id}. 2216a7c36ee4SCorey Bryant 2217a7c36ee4SCorey BryantUse the network script @var{file} to configure it and the network script 22185824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 2219a7c36ee4SCorey Bryantautomatically provides one. The default network configure script is 2220a7c36ee4SCorey Bryant@file{/etc/qemu-ifup} and the default network deconfigure script is 2221a7c36ee4SCorey Bryant@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 2222a7c36ee4SCorey Bryantto disable script execution. 2223a7c36ee4SCorey Bryant 2224a7c36ee4SCorey BryantIf running QEMU as an unprivileged user, use the network helper 2225584613eaSAlexey Kardashevskiy@var{helper} to configure the TAP interface and attach it to the bridge. 2226584613eaSAlexey KardashevskiyThe default network helper executable is @file{/path/to/qemu-bridge-helper} 2227584613eaSAlexey Kardashevskiyand the default bridge device is @file{br0}. 2228a7c36ee4SCorey Bryant 2229a7c36ee4SCorey Bryant@option{fd}=@var{h} can be used to specify the handle of an already 2230a7c36ee4SCorey Bryantopened host TAP interface. 2231a7c36ee4SCorey Bryant 2232a7c36ee4SCorey BryantExamples: 22335824d651Sblueswir1 22345824d651Sblueswir1@example 2235a7c36ee4SCorey Bryant#launch a QEMU instance with the default network script 2236abbbb035SThomas Huthqemu-system-i386 linux.img -nic tap 22375824d651Sblueswir1@end example 22385824d651Sblueswir1 22395824d651Sblueswir1@example 2240a7c36ee4SCorey Bryant#launch a QEMU instance with two NICs, each one connected 2241a7c36ee4SCorey Bryant#to a TAP device 22423804da9dSStefan Weilqemu-system-i386 linux.img \ 224374f78b99SThomas Huth -netdev tap,id=nd0,ifname=tap0 -device e1000,netdev=nd0 \ 224474f78b99SThomas Huth -netdev tap,id=nd1,ifname=tap1 -device rtl8139,netdev=nd1 22455824d651Sblueswir1@end example 22465824d651Sblueswir1 2247a7c36ee4SCorey Bryant@example 2248a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 2249a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 2250abbbb035SThomas Huthqemu-system-i386 linux.img -device virtio-net-pci,netdev=n1 \ 2251abbbb035SThomas Huth -netdev tap,id=n1,"helper=/path/to/qemu-bridge-helper" 2252a7c36ee4SCorey Bryant@end example 2253a7c36ee4SCorey Bryant 225408d12022SStefan Hajnoczi@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 2255a7c36ee4SCorey BryantConnect a host TAP network interface to a host bridge device. 2256a7c36ee4SCorey Bryant 2257a7c36ee4SCorey BryantUse the network helper @var{helper} to configure the TAP interface and 2258a7c36ee4SCorey Bryantattach it to the bridge. The default network helper executable is 2259420508fbSAmos Kong@file{/path/to/qemu-bridge-helper} and the default bridge 2260a7c36ee4SCorey Bryantdevice is @file{br0}. 2261a7c36ee4SCorey Bryant 2262a7c36ee4SCorey BryantExamples: 2263a7c36ee4SCorey Bryant 2264a7c36ee4SCorey Bryant@example 2265a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 2266a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 2267abbbb035SThomas Huthqemu-system-i386 linux.img -netdev bridge,id=n1 -device virtio-net,netdev=n1 2268a7c36ee4SCorey Bryant@end example 2269a7c36ee4SCorey Bryant 2270a7c36ee4SCorey Bryant@example 2271a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 2272a7c36ee4SCorey Bryant#connect a TAP device to bridge qemubr0 2273abbbb035SThomas Huthqemu-system-i386 linux.img -netdev bridge,br=qemubr0,id=n1 -device virtio-net,netdev=n1 2274a7c36ee4SCorey Bryant@end example 2275a7c36ee4SCorey Bryant 227608d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 22775824d651Sblueswir1 2278abbbb035SThomas HuthThis host network backend can be used to connect the guest's network to 2279abbbb035SThomas Huthanother QEMU virtual machine using a TCP socket connection. If @option{listen} 2280abbbb035SThomas Huthis specified, QEMU waits for incoming connections on @var{port} 22815824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 22825824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 22835824d651Sblueswir1specifies an already opened TCP socket. 22845824d651Sblueswir1 22855824d651Sblueswir1Example: 22865824d651Sblueswir1@example 22875824d651Sblueswir1# launch a first QEMU instance 22883804da9dSStefan Weilqemu-system-i386 linux.img \ 2289abbbb035SThomas Huth -device e1000,netdev=n1,mac=52:54:00:12:34:56 \ 2290abbbb035SThomas Huth -netdev socket,id=n1,listen=:1234 2291abbbb035SThomas Huth# connect the network of this instance to the network of the first instance 22923804da9dSStefan Weilqemu-system-i386 linux.img \ 2293abbbb035SThomas Huth -device e1000,netdev=n2,mac=52:54:00:12:34:57 \ 2294abbbb035SThomas Huth -netdev socket,id=n2,connect=127.0.0.1:1234 22955824d651Sblueswir1@end example 22965824d651Sblueswir1 229708d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 22985824d651Sblueswir1 2299abbbb035SThomas HuthConfigure a socket host network backend to share the guest's network traffic 2300abbbb035SThomas Huthwith another QEMU virtual machines using a UDP multicast socket, effectively 2301abbbb035SThomas Huthmaking a bus for every QEMU with same multicast address @var{maddr} and @var{port}. 23025824d651Sblueswir1NOTES: 23035824d651Sblueswir1@enumerate 23045824d651Sblueswir1@item 23055824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 23065824d651Sblueswir1correct multicast setup for these hosts). 23075824d651Sblueswir1@item 23085824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 23095824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 23105824d651Sblueswir1@item 23115824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 23125824d651Sblueswir1@end enumerate 23135824d651Sblueswir1 23145824d651Sblueswir1Example: 23155824d651Sblueswir1@example 23165824d651Sblueswir1# launch one QEMU instance 23173804da9dSStefan Weilqemu-system-i386 linux.img \ 2318abbbb035SThomas Huth -device e1000,netdev=n1,mac=52:54:00:12:34:56 \ 2319abbbb035SThomas Huth -netdev socket,id=n1,mcast=230.0.0.1:1234 23205824d651Sblueswir1# launch another QEMU instance on same "bus" 23213804da9dSStefan Weilqemu-system-i386 linux.img \ 2322abbbb035SThomas Huth -device e1000,netdev=n2,mac=52:54:00:12:34:57 \ 2323abbbb035SThomas Huth -netdev socket,id=n2,mcast=230.0.0.1:1234 23245824d651Sblueswir1# launch yet another QEMU instance on same "bus" 23253804da9dSStefan Weilqemu-system-i386 linux.img \ 2326abbbb035SThomas Huth -device e1000,netdev=n3,macaddr=52:54:00:12:34:58 \ 2327abbbb035SThomas Huth -netdev socket,id=n3,mcast=230.0.0.1:1234 23285824d651Sblueswir1@end example 23295824d651Sblueswir1 23305824d651Sblueswir1Example (User Mode Linux compat.): 23315824d651Sblueswir1@example 2332abbbb035SThomas Huth# launch QEMU instance (note mcast address selected is UML's default) 23333804da9dSStefan Weilqemu-system-i386 linux.img \ 2334abbbb035SThomas Huth -device e1000,netdev=n1,mac=52:54:00:12:34:56 \ 2335abbbb035SThomas Huth -netdev socket,id=n1,mcast=239.192.168.1:1102 23365824d651Sblueswir1# launch UML 23375824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 23385824d651Sblueswir1@end example 23395824d651Sblueswir1 23403a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 23413a75e74cSMike Ryan@example 23423804da9dSStefan Weilqemu-system-i386 linux.img \ 2343abbbb035SThomas Huth -device e1000,netdev=n1,mac=52:54:00:12:34:56 \ 2344abbbb035SThomas Huth -netdev socket,id=n1,mcast=239.192.168.1:1102,localaddr=1.2.3.4 23453a75e74cSMike Ryan@end example 23463a75e74cSMike Ryan 23473fb69aa1SAnton Ivanov@item -netdev l2tpv3,id=@var{id},src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}] 2348abbbb035SThomas HuthConfigure a L2TPv3 pseudowire host network backend. L2TPv3 (RFC3391) is a 2349abbbb035SThomas Huthpopular protocol to transport Ethernet (and other Layer 2) data frames between 23503fb69aa1SAnton Ivanovtwo systems. It is present in routers, firewalls and the Linux kernel 23513fb69aa1SAnton Ivanov(from version 3.3 onwards). 23523fb69aa1SAnton Ivanov 23533fb69aa1SAnton IvanovThis transport allows a VM to communicate to another VM, router or firewall directly. 23543fb69aa1SAnton Ivanov 23551e9a7379SMarkus Armbruster@table @option 23563fb69aa1SAnton Ivanov@item src=@var{srcaddr} 23573fb69aa1SAnton Ivanov source address (mandatory) 23583fb69aa1SAnton Ivanov@item dst=@var{dstaddr} 23593fb69aa1SAnton Ivanov destination address (mandatory) 23603fb69aa1SAnton Ivanov@item udp 23613fb69aa1SAnton Ivanov select udp encapsulation (default is ip). 23623fb69aa1SAnton Ivanov@item srcport=@var{srcport} 23633fb69aa1SAnton Ivanov source udp port. 23643fb69aa1SAnton Ivanov@item dstport=@var{dstport} 23653fb69aa1SAnton Ivanov destination udp port. 23663fb69aa1SAnton Ivanov@item ipv6 23673fb69aa1SAnton Ivanov force v6, otherwise defaults to v4. 23683fb69aa1SAnton Ivanov@item rxcookie=@var{rxcookie} 2369f9cfd655SMarkus Armbruster@itemx txcookie=@var{txcookie} 23703fb69aa1SAnton Ivanov Cookies are a weak form of security in the l2tpv3 specification. 23713fb69aa1SAnton IvanovTheir function is mostly to prevent misconfiguration. By default they are 32 23723fb69aa1SAnton Ivanovbit. 23733fb69aa1SAnton Ivanov@item cookie64 23743fb69aa1SAnton Ivanov Set cookie size to 64 bit instead of the default 32 23753fb69aa1SAnton Ivanov@item counter=off 23763fb69aa1SAnton Ivanov Force a 'cut-down' L2TPv3 with no counter as in 23773fb69aa1SAnton Ivanovdraft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 23783fb69aa1SAnton Ivanov@item pincounter=on 23793fb69aa1SAnton Ivanov Work around broken counter handling in peer. This may also help on 23803fb69aa1SAnton Ivanovnetworks which have packet reorder. 23813fb69aa1SAnton Ivanov@item offset=@var{offset} 23823fb69aa1SAnton Ivanov Add an extra offset between header and data 23831e9a7379SMarkus Armbruster@end table 23843fb69aa1SAnton Ivanov 23853fb69aa1SAnton IvanovFor example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan 23863fb69aa1SAnton Ivanovon the remote Linux host 1.2.3.4: 23873fb69aa1SAnton Ivanov@example 23883fb69aa1SAnton Ivanov# Setup tunnel on linux host using raw ip as encapsulation 23893fb69aa1SAnton Ivanov# on 1.2.3.4 23903fb69aa1SAnton Ivanovip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ 23913fb69aa1SAnton Ivanov encap udp udp_sport 16384 udp_dport 16384 23923fb69aa1SAnton Ivanovip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ 23933fb69aa1SAnton Ivanov 0xFFFFFFFF peer_session_id 0xFFFFFFFF 23943fb69aa1SAnton Ivanovifconfig vmtunnel0 mtu 1500 23953fb69aa1SAnton Ivanovifconfig vmtunnel0 up 23963fb69aa1SAnton Ivanovbrctl addif br-lan vmtunnel0 23973fb69aa1SAnton Ivanov 23983fb69aa1SAnton Ivanov 23993fb69aa1SAnton Ivanov# on 4.3.2.1 24003fb69aa1SAnton Ivanov# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 24013fb69aa1SAnton Ivanov 2402abbbb035SThomas Huthqemu-system-i386 linux.img -device e1000,netdev=n1 \ 2403abbbb035SThomas Huth -netdev l2tpv3,id=n1,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter 24043fb69aa1SAnton Ivanov 24053fb69aa1SAnton Ivanov@end example 24063fb69aa1SAnton Ivanov 240708d12022SStefan Hajnoczi@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 2408abbbb035SThomas HuthConfigure VDE backend to connect to PORT @var{n} of a vde switch running on host and 24095824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 24105824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 2411c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 24125824d651Sblueswir1with vde support enabled. 24135824d651Sblueswir1 24145824d651Sblueswir1Example: 24155824d651Sblueswir1@example 24165824d651Sblueswir1# launch vde switch 24175824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 24185824d651Sblueswir1# launch QEMU instance 2419abbbb035SThomas Huthqemu-system-i386 linux.img -nic vde,sock=/tmp/myswitch 24205824d651Sblueswir1@end example 24215824d651Sblueswir1 2422b931bfbfSChangchun Ouyang@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n] 242303ce5744SNikolay Nikolaev 242403ce5744SNikolay NikolaevEstablish a vhost-user netdev, backed by a chardev @var{id}. The chardev should 242503ce5744SNikolay Nikolaevbe a unix domain socket backed one. The vhost-user uses a specifically defined 242603ce5744SNikolay Nikolaevprotocol to pass vhost ioctl replacement messages to an application on the other 242703ce5744SNikolay Nikolaevend of the socket. On non-MSIX guests, the feature can be forced with 2428b931bfbfSChangchun Ouyang@var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to 2429b931bfbfSChangchun Ouyangbe created for multiqueue vhost-user. 243003ce5744SNikolay Nikolaev 243103ce5744SNikolay NikolaevExample: 243203ce5744SNikolay Nikolaev@example 243303ce5744SNikolay Nikolaevqemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 243403ce5744SNikolay Nikolaev -numa node,memdev=mem \ 243579cad2faSVincenzo Maffione -chardev socket,id=chr0,path=/path/to/socket \ 243603ce5744SNikolay Nikolaev -netdev type=vhost-user,id=net0,chardev=chr0 \ 243703ce5744SNikolay Nikolaev -device virtio-net-pci,netdev=net0 243803ce5744SNikolay Nikolaev@end example 243903ce5744SNikolay Nikolaev 2440abbbb035SThomas Huth@item -netdev hubport,id=@var{id},hubid=@var{hubid}[,netdev=@var{nd}] 244178cd6f7bSThomas Huth 2442abbbb035SThomas HuthCreate a hub port on the emulated hub with ID @var{hubid}. 244378cd6f7bSThomas Huth 2444abbbb035SThomas HuthThe hubport netdev lets you connect a NIC to a QEMU emulated hub instead of a 2445af1a5c3eSThomas Huthsingle netdev. Alternatively, you can also connect the hubport to another 2446af1a5c3eSThomas Huthnetdev with ID @var{nd} by using the @option{netdev=@var{nd}} option. 2447abbbb035SThomas Huth 2448af1a5c3eSThomas Huth@item -net nic[,netdev=@var{nd}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 2449abbbb035SThomas Huth@findex -net 2450abbbb035SThomas HuthLegacy option to configure or create an on-board (or machine default) Network 2451af1a5c3eSThomas HuthInterface Card(NIC) and connect it either to the emulated hub with ID 0 (i.e. 2452af1a5c3eSThomas Huththe default hub), or to the netdev @var{nd}. 2453abbbb035SThomas HuthThe NIC is an e1000 by default on the PC target. Optionally, the MAC address 2454abbbb035SThomas Huthcan be changed to @var{mac}, the device address set to @var{addr} (PCI cards 2455abbbb035SThomas Huthonly), and a @var{name} can be assigned for use in monitor commands. 2456abbbb035SThomas HuthOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 2457abbbb035SThomas Huththat the card should have; this option currently only affects virtio cards; set 2458abbbb035SThomas Huth@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 2459abbbb035SThomas HuthNIC is created. QEMU can emulate several different models of network card. 2460abbbb035SThomas HuthUse @code{-net nic,model=help} for a list of available devices for your target. 2461abbbb035SThomas Huth 2462af1a5c3eSThomas Huth@item -net user|tap|bridge|socket|l2tpv3|vde[,...][,name=@var{name}] 2463abbbb035SThomas HuthConfigure a host network backend (with the options corresponding to the same 2464af1a5c3eSThomas Huth@option{-netdev} option) and connect it to the emulated hub 0 (the default 2465af1a5c3eSThomas Huthhub). Use @var{name} to specify the name of the hub port. 24665824d651Sblueswir1ETEXI 24675824d651Sblueswir1 2468c70a01e4SMarkus ArmbrusterSTEXI 2469c70a01e4SMarkus Armbruster@end table 2470c70a01e4SMarkus ArmbrusterETEXI 24717273a2dbSMatthew BoothDEFHEADING() 24727273a2dbSMatthew Booth 2473de6b4f90SMarkus ArmbrusterDEFHEADING(Character device options:) 24747273a2dbSMatthew Booth 24757273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 2476517b3d40SLin Ma "-chardev help\n" 2477d0d7708bSDaniel P. Berrange "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 24785dd1f02bSCorey Minyard "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" 2479d0d7708bSDaniel P. Berrange " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off]\n" 2480a8fb5427SDaniel P. Berrange " [,logfile=PATH][,logappend=on|off][,tls-creds=ID] (tcp)\n" 2481d0d7708bSDaniel P. Berrange "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds]\n" 2482d0d7708bSDaniel P. Berrange " [,mux=on|off][,logfile=PATH][,logappend=on|off] (unix)\n" 24837273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 248497331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 2485d0d7708bSDaniel P. Berrange " [,logfile=PATH][,logappend=on|off]\n" 2486d0d7708bSDaniel P. Berrange "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 24877273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 2488d0d7708bSDaniel P. Berrange " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2489d0d7708bSDaniel P. Berrange "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n" 2490d0d7708bSDaniel P. Berrange "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2491d0d7708bSDaniel P. Berrange "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 24927273a2dbSMatthew Booth#ifdef _WIN32 2493d0d7708bSDaniel P. Berrange "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2494d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 24957273a2dbSMatthew Booth#else 2496d0d7708bSDaniel P. Berrange "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2497d0d7708bSDaniel P. Berrange "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n" 24987273a2dbSMatthew Booth#endif 24997273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 2500d0d7708bSDaniel P. Berrange "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 25017273a2dbSMatthew Booth#endif 25027273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 25037273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 2504d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2505d0d7708bSDaniel P. Berrange "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 25067273a2dbSMatthew Booth#endif 25077273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 2508d0d7708bSDaniel P. Berrange "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2509d0d7708bSDaniel P. Berrange "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 25107273a2dbSMatthew Booth#endif 2511cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 2512d0d7708bSDaniel P. Berrange "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 2513d0d7708bSDaniel P. Berrange "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 2514cbcc6336SAlon Levy#endif 2515ad96090aSBlue Swirl , QEMU_ARCH_ALL 25167273a2dbSMatthew Booth) 25177273a2dbSMatthew Booth 25187273a2dbSMatthew BoothSTEXI 2519dddba068SMarkus Armbruster 2520dddba068SMarkus ArmbrusterThe general form of a character device option is: 2521dddba068SMarkus Armbruster@table @option 252297331287SJan Kiszka@item -chardev @var{backend},id=@var{id}[,mux=on|off][,@var{options}] 25236616b2adSStefan Weil@findex -chardev 25247273a2dbSMatthew BoothBackend is one of: 25257273a2dbSMatthew Booth@option{null}, 25267273a2dbSMatthew Booth@option{socket}, 25277273a2dbSMatthew Booth@option{udp}, 25287273a2dbSMatthew Booth@option{msmouse}, 25297273a2dbSMatthew Booth@option{vc}, 25304f57378fSMarkus Armbruster@option{ringbuf}, 25317273a2dbSMatthew Booth@option{file}, 25327273a2dbSMatthew Booth@option{pipe}, 25337273a2dbSMatthew Booth@option{console}, 25347273a2dbSMatthew Booth@option{serial}, 25357273a2dbSMatthew Booth@option{pty}, 25367273a2dbSMatthew Booth@option{stdio}, 25377273a2dbSMatthew Booth@option{braille}, 25387273a2dbSMatthew Booth@option{tty}, 253988a946d3SGerd Hoffmann@option{parallel}, 2540cbcc6336SAlon Levy@option{parport}, 254116fdc56aSThomas Huth@option{spicevmc}, 25425a49d3e9SMarc-André Lureau@option{spiceport}. 25437273a2dbSMatthew BoothThe specific backend will determine the applicable options. 25447273a2dbSMatthew Booth 2545dddba068SMarkus ArmbrusterUse @code{-chardev help} to print all available chardev backend types. 2546517b3d40SLin Ma 25477273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 25487273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 25497273a2dbSMatthew Booth 255097331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 2551a40db1b3SPeter MaydellSpecify @option{mux=on} to enable this mode. 2552a40db1b3SPeter MaydellA multiplexer is a "1:N" device, and here the "1" end is your specified chardev 2553a40db1b3SPeter Maydellbackend, and the "N" end is the various parts of QEMU that can talk to a chardev. 2554a40db1b3SPeter MaydellIf you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will 2555a40db1b3SPeter Maydellcreate a multiplexer with your specified ID, and you can then configure multiple 2556a40db1b3SPeter Maydellfront ends to use that chardev ID for their input/output. Up to four different 2557a40db1b3SPeter Maydellfront ends can be connected to a single multiplexed chardev. (Without 2558a40db1b3SPeter Maydellmultiplexing enabled, a chardev can only be used by a single front end.) 2559a40db1b3SPeter MaydellFor instance you could use this to allow a single stdio chardev to be used by 2560a40db1b3SPeter Maydelltwo serial ports and the QEMU monitor: 2561a40db1b3SPeter Maydell 2562a40db1b3SPeter Maydell@example 2563a40db1b3SPeter Maydell-chardev stdio,mux=on,id=char0 \ 2564bdbcb547SMarc-André Lureau-mon chardev=char0,mode=readline \ 2565a40db1b3SPeter Maydell-serial chardev:char0 \ 2566a40db1b3SPeter Maydell-serial chardev:char0 2567a40db1b3SPeter Maydell@end example 2568a40db1b3SPeter Maydell 2569a40db1b3SPeter MaydellYou can have more than one multiplexer in a system configuration; for instance 2570a40db1b3SPeter Maydellyou could have a TCP port multiplexed between UART 0 and UART 1, and stdio 2571a40db1b3SPeter Maydellmultiplexed between the QEMU monitor and a parallel port: 2572a40db1b3SPeter Maydell 2573a40db1b3SPeter Maydell@example 2574a40db1b3SPeter Maydell-chardev stdio,mux=on,id=char0 \ 2575bdbcb547SMarc-André Lureau-mon chardev=char0,mode=readline \ 2576a40db1b3SPeter Maydell-parallel chardev:char0 \ 2577a40db1b3SPeter Maydell-chardev tcp,...,mux=on,id=char1 \ 2578a40db1b3SPeter Maydell-serial chardev:char1 \ 2579a40db1b3SPeter Maydell-serial chardev:char1 2580a40db1b3SPeter Maydell@end example 2581a40db1b3SPeter Maydell 2582a40db1b3SPeter MaydellWhen you're using a multiplexed character device, some escape sequences are 2583a40db1b3SPeter Maydellinterpreted in the input. @xref{mux_keys, Keys in the character backend 2584a40db1b3SPeter Maydellmultiplexer}. 2585a40db1b3SPeter Maydell 2586a40db1b3SPeter MaydellNote that some other command line options may implicitly create multiplexed 2587a40db1b3SPeter Maydellcharacter backends; for instance @option{-serial mon:stdio} creates a 2588a40db1b3SPeter Maydellmultiplexed stdio backend connected to the serial port and the QEMU monitor, 2589a40db1b3SPeter Maydelland @option{-nographic} also multiplexes the console and the monitor to 2590a40db1b3SPeter Maydellstdio. 2591a40db1b3SPeter Maydell 2592a40db1b3SPeter MaydellThere is currently no support for multiplexing in the other direction 2593a40db1b3SPeter Maydell(where a single QEMU front end takes input and output from multiple chardevs). 259497331287SJan Kiszka 2595d0d7708bSDaniel P. BerrangeEvery backend supports the @option{logfile} option, which supplies the path 2596d0d7708bSDaniel P. Berrangeto a file to record all data transmitted via the backend. The @option{logappend} 2597d0d7708bSDaniel P. Berrangeoption controls whether the log file will be truncated or appended to when 2598d0d7708bSDaniel P. Berrangeopened. 2599d0d7708bSDaniel P. Berrange 2600dddba068SMarkus Armbruster@end table 26017273a2dbSMatthew Booth 2602dddba068SMarkus ArmbrusterThe available backends are: 2603dddba068SMarkus Armbruster 2604dddba068SMarkus Armbruster@table @option 26057273a2dbSMatthew Booth@item -chardev null,id=@var{id} 26067273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 26077273a2dbSMatthew Boothreceives. The null backend does not take any options. 26087273a2dbSMatthew Booth 260916fdc56aSThomas Huth@item -chardev socket,id=@var{id}[,@var{TCP options} or @var{unix options}][,server][,nowait][,telnet][,reconnect=@var{seconds}][,tls-creds=@var{id}] 26107273a2dbSMatthew Booth 26117273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 26127273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 26137273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 26147273a2dbSMatthew Booth 26157273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 26167273a2dbSMatthew Booth 26177273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 26187273a2dbSMatthew Boothconnect to a listening socket. 26197273a2dbSMatthew Booth 26207273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 26217273a2dbSMatthew Boothescape sequences. 26227273a2dbSMatthew Booth 26235dd1f02bSCorey Minyard@option{reconnect} sets the timeout for reconnecting on non-server sockets when 26245dd1f02bSCorey Minyardthe remote end goes away. qemu will delay this many seconds and then attempt 26255dd1f02bSCorey Minyardto reconnect. Zero disables reconnecting, and is the default. 26265dd1f02bSCorey Minyard 2627a8fb5427SDaniel P. Berrange@option{tls-creds} requests enablement of the TLS protocol for encryption, 2628a8fb5427SDaniel P. Berrangeand specifies the id of the TLS credentials to use for the handshake. The 2629a8fb5427SDaniel P. Berrangecredentials must be previously created with the @option{-object tls-creds} 2630a8fb5427SDaniel P. Berrangeargument. 2631a8fb5427SDaniel P. Berrange 26327273a2dbSMatthew BoothTCP and unix socket options are given below: 26337273a2dbSMatthew Booth 26347273a2dbSMatthew Booth@table @option 26357273a2dbSMatthew Booth 26368d533561SAurelien Jarno@item TCP options: port=@var{port}[,host=@var{host}][,to=@var{to}][,ipv4][,ipv6][,nodelay] 26377273a2dbSMatthew Booth 26387273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 26397273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 26407273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 26417273a2dbSMatthew Booth 26427273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 26437273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 26447273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 26457273a2dbSMatthew Booth@option{port} is required. 26467273a2dbSMatthew Booth 26477273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 26487273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 26497273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 26507273a2dbSMatthew Boothas a port number. 26517273a2dbSMatthew Booth 26527273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 26537273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 26547273a2dbSMatthew Booth 26557273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 26567273a2dbSMatthew Booth 26577273a2dbSMatthew Booth@item unix options: path=@var{path} 26587273a2dbSMatthew Booth 26597273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 26607273a2dbSMatthew Boothrequired. 26617273a2dbSMatthew Booth 26627273a2dbSMatthew Booth@end table 26637273a2dbSMatthew Booth 26647273a2dbSMatthew Booth@item -chardev udp,id=@var{id}[,host=@var{host}],port=@var{port}[,localaddr=@var{localaddr}][,localport=@var{localport}][,ipv4][,ipv6] 26657273a2dbSMatthew Booth 26667273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 26677273a2dbSMatthew Booth 26687273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 26697273a2dbSMatthew Boothdefaults to @code{localhost}. 26707273a2dbSMatthew Booth 26717273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 26727273a2dbSMatthew Boothis required. 26737273a2dbSMatthew Booth 26747273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 26757273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 26767273a2dbSMatthew Booth 26777273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 26787273a2dbSMatthew Boothavailable local port will be used. 26797273a2dbSMatthew Booth 26807273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 26817273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 26827273a2dbSMatthew Booth 26837273a2dbSMatthew Booth@item -chardev msmouse,id=@var{id} 26847273a2dbSMatthew Booth 26857273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 26867273a2dbSMatthew Boothtake any options. 26877273a2dbSMatthew Booth 26887273a2dbSMatthew Booth@item -chardev vc,id=@var{id}[[,width=@var{width}][,height=@var{height}]][[,cols=@var{cols}][,rows=@var{rows}]] 26897273a2dbSMatthew Booth 26907273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 26917273a2dbSMatthew Boothsize. 26927273a2dbSMatthew Booth 26937273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 26947273a2dbSMatthew Booththe console, in pixels. 26957273a2dbSMatthew Booth 26967273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 26977273a2dbSMatthew Boothconsole with the given dimensions. 26987273a2dbSMatthew Booth 26994f57378fSMarkus Armbruster@item -chardev ringbuf,id=@var{id}[,size=@var{size}] 270051767e7cSLei Li 27013949e594SMarkus ArmbrusterCreate a ring buffer with fixed size @option{size}. 2702e69f7d25SStefan Hajnoczi@var{size} must be a power of two and defaults to @code{64K}. 270351767e7cSLei Li 27047273a2dbSMatthew Booth@item -chardev file,id=@var{id},path=@var{path} 27057273a2dbSMatthew Booth 27067273a2dbSMatthew BoothLog all traffic received from the guest to a file. 27077273a2dbSMatthew Booth 27087273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 27097273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 27107273a2dbSMatthew Boothis required. 27117273a2dbSMatthew Booth 27127273a2dbSMatthew Booth@item -chardev pipe,id=@var{id},path=@var{path} 27137273a2dbSMatthew Booth 27147273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 27157273a2dbSMatthew BoothWindows hosts and other hosts: 27167273a2dbSMatthew Booth 27177273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 27187273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 27197273a2dbSMatthew Booth 27207273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 27217273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 27227273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 27237273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 27247273a2dbSMatthew Boothbe present. 27257273a2dbSMatthew Booth 27267273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 27277273a2dbSMatthew Boothrequired. 27287273a2dbSMatthew Booth 27297273a2dbSMatthew Booth@item -chardev console,id=@var{id} 27307273a2dbSMatthew Booth 27317273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 27327273a2dbSMatthew Boothtake any options. 27337273a2dbSMatthew Booth 27347273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 27357273a2dbSMatthew Booth 27367273a2dbSMatthew Booth@item -chardev serial,id=@var{id},path=@option{path} 27377273a2dbSMatthew Booth 27387273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 27397273a2dbSMatthew Booth 2740d59044efSGerd HoffmannOn Unix hosts serial will actually accept any tty device, 2741d59044efSGerd Hoffmannnot only serial lines. 27427273a2dbSMatthew Booth 27437273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 27447273a2dbSMatthew Booth 27457273a2dbSMatthew Booth@item -chardev pty,id=@var{id} 27467273a2dbSMatthew Booth 27477273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 27487273a2dbSMatthew Boothnot take any options. 27497273a2dbSMatthew Booth 27507273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 27517273a2dbSMatthew Booth 2752b7fdb3abSAurelien Jarno@item -chardev stdio,id=@var{id}[,signal=on|off] 2753b65ee4faSStefan WeilConnect to standard input and standard output of the QEMU process. 2754b7fdb3abSAurelien Jarno 2755b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 2756b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2757b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 2758b7fdb3abSAurelien Jarno 27597273a2dbSMatthew Booth@item -chardev braille,id=@var{id} 27607273a2dbSMatthew Booth 27617273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 27627273a2dbSMatthew Booth 27637273a2dbSMatthew Booth@item -chardev tty,id=@var{id},path=@var{path} 27647273a2dbSMatthew Booth 27657273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2766d037d6bbSMarkus ArmbrusterDragonFlyBSD hosts. It is an alias for @option{serial}. 27677273a2dbSMatthew Booth 27687273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 27697273a2dbSMatthew Booth 277088a946d3SGerd Hoffmann@item -chardev parallel,id=@var{id},path=@var{path} 2771f9cfd655SMarkus Armbruster@itemx -chardev parport,id=@var{id},path=@var{path} 27727273a2dbSMatthew Booth 277388a946d3SGerd Hoffmann@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 27747273a2dbSMatthew Booth 27757273a2dbSMatthew BoothConnect to a local parallel port. 27767273a2dbSMatthew Booth 27777273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 27787273a2dbSMatthew Boothrequired. 27797273a2dbSMatthew Booth 2780cbcc6336SAlon Levy@item -chardev spicevmc,id=@var{id},debug=@var{debug},name=@var{name} 2781cbcc6336SAlon Levy 27823a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 27833a846906SStefan Hajnoczi 2784cbcc6336SAlon Levy@option{debug} debug level for spicevmc 2785cbcc6336SAlon Levy 2786cbcc6336SAlon Levy@option{name} name of spice channel to connect to 2787cbcc6336SAlon Levy 2788cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 2789cbcc6336SAlon Levy 27905a49d3e9SMarc-André Lureau@item -chardev spiceport,id=@var{id},debug=@var{debug},name=@var{name} 27915a49d3e9SMarc-André Lureau 27925a49d3e9SMarc-André Lureau@option{spiceport} is only available when spice support is built in. 27935a49d3e9SMarc-André Lureau 27945a49d3e9SMarc-André Lureau@option{debug} debug level for spicevmc 27955a49d3e9SMarc-André Lureau 27965a49d3e9SMarc-André Lureau@option{name} name of spice port to connect to 27975a49d3e9SMarc-André Lureau 27985a49d3e9SMarc-André LureauConnect to a spice port, allowing a Spice client to handle the traffic 27995a49d3e9SMarc-André Lureauidentified by a name (preferably a fqdn). 28007273a2dbSMatthew BoothETEXI 28017273a2dbSMatthew Booth 2802c70a01e4SMarkus ArmbrusterSTEXI 2803c70a01e4SMarkus Armbruster@end table 2804c70a01e4SMarkus ArmbrusterETEXI 28057273a2dbSMatthew BoothDEFHEADING() 28067273a2dbSMatthew Booth 2807de6b4f90SMarkus ArmbrusterDEFHEADING(Bluetooth(R) options:) 2808c70a01e4SMarkus ArmbrusterSTEXI 2809c70a01e4SMarkus Armbruster@table @option 2810c70a01e4SMarkus ArmbrusterETEXI 28117273a2dbSMatthew Booth 28125824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 28135824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 28145824d651Sblueswir1 "-bt hci,host[:id]\n" \ 28155824d651Sblueswir1 " use host's HCI with the given name\n" \ 28165824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 28175824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 28185824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 28195824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 28205824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 2821ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2822ad96090aSBlue Swirl QEMU_ARCH_ALL) 28235824d651Sblueswir1STEXI 28245824d651Sblueswir1@item -bt hci[...] 28256616b2adSStefan Weil@findex -bt 28265824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 28275824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 28285824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 28295824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 28305824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 28315824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 28325824d651Sblueswir1machines have none. 28335824d651Sblueswir1 28345824d651Sblueswir1@anchor{bt-hcis} 28355824d651Sblueswir1The following three types are recognized: 28365824d651Sblueswir1 2837b3f046c2SKevin Wolf@table @option 28385824d651Sblueswir1@item -bt hci,null 28395824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 28405824d651Sblueswir1and will not respond to any HCI commands or emit events. 28415824d651Sblueswir1 28425824d651Sblueswir1@item -bt hci,host[:@var{id}] 28435824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 28445824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 28455824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 28465824d651Sblueswir1capable systems like Linux. 28475824d651Sblueswir1 28485824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 28495824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 28505824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 28515824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 28525824d651Sblueswir1with other devices in the same network (scatternet). 28535824d651Sblueswir1@end table 28545824d651Sblueswir1 28555824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 28565824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 28575824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 28585824d651Sblueswir1allows the host and target machines to participate in a common scatternet 28595824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 28605824d651Sblueswir1be used as following: 28615824d651Sblueswir1 28625824d651Sblueswir1@example 28633804da9dSStefan Weilqemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 28645824d651Sblueswir1@end example 28655824d651Sblueswir1 28665824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 28675824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 28685824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 28695824d651Sblueswir1currently: 28705824d651Sblueswir1 2871b3f046c2SKevin Wolf@table @option 28725824d651Sblueswir1@item keyboard 28735824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 28745824d651Sblueswir1@end table 28755824d651Sblueswir1ETEXI 28765824d651Sblueswir1 2877c70a01e4SMarkus ArmbrusterSTEXI 2878c70a01e4SMarkus Armbruster@end table 2879c70a01e4SMarkus ArmbrusterETEXI 28805824d651Sblueswir1DEFHEADING() 28815824d651Sblueswir1 2882d1a0cf73SStefan Berger#ifdef CONFIG_TPM 2883de6b4f90SMarkus ArmbrusterDEFHEADING(TPM device options:) 2884d1a0cf73SStefan Berger 2885d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 288692dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 288792dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 288892dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 2889f4ede81eSAmarnath Valluri " not provided it will be searched for in /sys/class/misc/tpm?/device\n" 2890f4ede81eSAmarnath Valluri "-tpmdev emulator,id=id,chardev=dev\n" 2891f4ede81eSAmarnath Valluri " configure the TPM device using chardev backend\n", 2892d1a0cf73SStefan Berger QEMU_ARCH_ALL) 2893d1a0cf73SStefan BergerSTEXI 2894d1a0cf73SStefan Berger 2895d1a0cf73SStefan BergerThe general form of a TPM device option is: 2896d1a0cf73SStefan Berger@table @option 2897d1a0cf73SStefan Berger 2898d1a0cf73SStefan Berger@item -tpmdev @var{backend},id=@var{id}[,@var{options}] 2899d1a0cf73SStefan Berger@findex -tpmdev 2900d1a0cf73SStefan Berger 2901d1a0cf73SStefan BergerThe specific backend type will determine the applicable options. 290228c4fa32SCorey BryantThe @code{-tpmdev} option creates the TPM backend and requires a 290328c4fa32SCorey Bryant@code{-device} option that specifies the TPM frontend interface model. 2904d1a0cf73SStefan Berger 29052252aaf0SMarkus ArmbrusterUse @code{-tpmdev help} to print all available TPM backend types. 2906d1a0cf73SStefan Berger 29072252aaf0SMarkus Armbruster@end table 29082252aaf0SMarkus Armbruster 29092252aaf0SMarkus ArmbrusterThe available backends are: 29102252aaf0SMarkus Armbruster 29112252aaf0SMarkus Armbruster@table @option 2912d1a0cf73SStefan Berger 291392dcc234SStefan Berger@item -tpmdev passthrough,id=@var{id},path=@var{path},cancel-path=@var{cancel-path} 29144549a8b7SStefan Berger 29154549a8b7SStefan Berger(Linux-host only) Enable access to the host's TPM using the passthrough 29164549a8b7SStefan Bergerdriver. 29174549a8b7SStefan Berger 29184549a8b7SStefan Berger@option{path} specifies the path to the host's TPM device, i.e., on 29194549a8b7SStefan Bergera Linux host this would be @code{/dev/tpm0}. 29204549a8b7SStefan Berger@option{path} is optional and by default @code{/dev/tpm0} is used. 29214549a8b7SStefan Berger 292292dcc234SStefan Berger@option{cancel-path} specifies the path to the host TPM device's sysfs 292392dcc234SStefan Bergerentry allowing for cancellation of an ongoing TPM command. 292492dcc234SStefan Berger@option{cancel-path} is optional and by default QEMU will search for the 292592dcc234SStefan Bergersysfs entry to use. 292692dcc234SStefan Berger 29274549a8b7SStefan BergerSome notes about using the host's TPM with the passthrough driver: 29284549a8b7SStefan Berger 29294549a8b7SStefan BergerThe TPM device accessed by the passthrough driver must not be 29304549a8b7SStefan Bergerused by any other application on the host. 29314549a8b7SStefan Berger 29324549a8b7SStefan BergerSince the host's firmware (BIOS/UEFI) has already initialized the TPM, 29334549a8b7SStefan Bergerthe VM's firmware (BIOS/UEFI) will not be able to initialize the 29344549a8b7SStefan BergerTPM again and may therefore not show a TPM-specific menu that would 29354549a8b7SStefan Bergerotherwise allow the user to configure the TPM, e.g., allow the user to 29364549a8b7SStefan Bergerenable/disable or activate/deactivate the TPM. 29374549a8b7SStefan BergerFurther, if TPM ownership is released from within a VM then the host's TPM 29384549a8b7SStefan Bergerwill get disabled and deactivated. To enable and activate the 29394549a8b7SStefan BergerTPM again afterwards, the host has to be rebooted and the user is 29404549a8b7SStefan Bergerrequired to enter the firmware's menu to enable and activate the TPM. 29414549a8b7SStefan BergerIf the TPM is left disabled and/or deactivated most TPM commands will fail. 29424549a8b7SStefan Berger 29434549a8b7SStefan BergerTo create a passthrough TPM use the following two options: 29444549a8b7SStefan Berger@example 29454549a8b7SStefan Berger-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 29464549a8b7SStefan Berger@end example 29474549a8b7SStefan BergerNote that the @code{-tpmdev} id is @code{tpm0} and is referenced by 29484549a8b7SStefan Berger@code{tpmdev=tpm0} in the device option. 29494549a8b7SStefan Berger 2950f4ede81eSAmarnath Valluri@item -tpmdev emulator,id=@var{id},chardev=@var{dev} 2951f4ede81eSAmarnath Valluri 2952f4ede81eSAmarnath Valluri(Linux-host only) Enable access to a TPM emulator using Unix domain socket based 2953f4ede81eSAmarnath Vallurichardev backend. 2954f4ede81eSAmarnath Valluri 2955f4ede81eSAmarnath Valluri@option{chardev} specifies the unique ID of a character device backend that provides connection to the software TPM server. 2956f4ede81eSAmarnath Valluri 2957f4ede81eSAmarnath ValluriTo create a TPM emulator backend device with chardev socket backend: 2958f4ede81eSAmarnath Valluri@example 2959f4ede81eSAmarnath Valluri 2960f4ede81eSAmarnath Valluri-chardev socket,id=chrtpm,path=/tmp/swtpm-sock -tpmdev emulator,id=tpm0,chardev=chrtpm -device tpm-tis,tpmdev=tpm0 2961f4ede81eSAmarnath Valluri 2962f4ede81eSAmarnath Valluri@end example 2963f4ede81eSAmarnath Valluri 2964d1a0cf73SStefan BergerETEXI 2965d1a0cf73SStefan Berger 29662252aaf0SMarkus ArmbrusterSTEXI 29672252aaf0SMarkus Armbruster@end table 29682252aaf0SMarkus ArmbrusterETEXI 2969d1a0cf73SStefan BergerDEFHEADING() 2970d1a0cf73SStefan Berger 2971d1a0cf73SStefan Berger#endif 2972d1a0cf73SStefan Berger 2973de6b4f90SMarkus ArmbrusterDEFHEADING(Linux/Multiboot boot specific:) 29745824d651Sblueswir1STEXI 29757677f05dSAlexander Graf 29767677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 29777677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 29785824d651Sblueswir1for easier testing of various kernels. 29795824d651Sblueswir1 29805824d651Sblueswir1@table @option 29815824d651Sblueswir1ETEXI 29825824d651Sblueswir1 29835824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2984ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 29855824d651Sblueswir1STEXI 29865824d651Sblueswir1@item -kernel @var{bzImage} 29876616b2adSStefan Weil@findex -kernel 29887677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 29897677f05dSAlexander Grafor in multiboot format. 29905824d651Sblueswir1ETEXI 29915824d651Sblueswir1 29925824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2993ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 29945824d651Sblueswir1STEXI 29955824d651Sblueswir1@item -append @var{cmdline} 29966616b2adSStefan Weil@findex -append 29975824d651Sblueswir1Use @var{cmdline} as kernel command line 29985824d651Sblueswir1ETEXI 29995824d651Sblueswir1 30005824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 3001ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 30025824d651Sblueswir1STEXI 30035824d651Sblueswir1@item -initrd @var{file} 30046616b2adSStefan Weil@findex -initrd 30055824d651Sblueswir1Use @var{file} as initial ram disk. 30067677f05dSAlexander Graf 30077677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 30087677f05dSAlexander Graf 30097677f05dSAlexander GrafThis syntax is only available with multiboot. 30107677f05dSAlexander Graf 30117677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 30127677f05dSAlexander Graffirst module. 30135824d651Sblueswir1ETEXI 30145824d651Sblueswir1 3015412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 3016379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 3017412beee6SGrant LikelySTEXI 3018412beee6SGrant Likely@item -dtb @var{file} 3019412beee6SGrant Likely@findex -dtb 3020412beee6SGrant LikelyUse @var{file} as a device tree binary (dtb) image and pass it to the kernel 3021412beee6SGrant Likelyon boot. 3022412beee6SGrant LikelyETEXI 3023412beee6SGrant Likely 30245824d651Sblueswir1STEXI 30255824d651Sblueswir1@end table 30265824d651Sblueswir1ETEXI 30275824d651Sblueswir1DEFHEADING() 30285824d651Sblueswir1 3029de6b4f90SMarkus ArmbrusterDEFHEADING(Debug/Expert options:) 30305824d651Sblueswir1STEXI 30315824d651Sblueswir1@table @option 30325824d651Sblueswir1ETEXI 30335824d651Sblueswir1 303481b2b810SGabriel L. SomloDEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 303581b2b810SGabriel L. Somlo "-fw_cfg [name=]<name>,file=<file>\n" 303663d3145aSMarkus Armbruster " add named fw_cfg entry with contents from file\n" 30376407d76eSGabriel L. Somlo "-fw_cfg [name=]<name>,string=<str>\n" 303863d3145aSMarkus Armbruster " add named fw_cfg entry with contents from string\n", 303981b2b810SGabriel L. Somlo QEMU_ARCH_ALL) 304081b2b810SGabriel L. SomloSTEXI 304163d3145aSMarkus Armbruster 304281b2b810SGabriel L. Somlo@item -fw_cfg [name=]@var{name},file=@var{file} 304381b2b810SGabriel L. Somlo@findex -fw_cfg 304463d3145aSMarkus ArmbrusterAdd named fw_cfg entry with contents from file @var{file}. 30456407d76eSGabriel L. Somlo 30466407d76eSGabriel L. Somlo@item -fw_cfg [name=]@var{name},string=@var{str} 304763d3145aSMarkus ArmbrusterAdd named fw_cfg entry with contents from string @var{str}. 304863d3145aSMarkus Armbruster 304963d3145aSMarkus ArmbrusterThe terminating NUL character of the contents of @var{str} will not be 305063d3145aSMarkus Armbrusterincluded as part of the fw_cfg item data. To insert contents with 305163d3145aSMarkus Armbrusterembedded NUL characters, you have to use the @var{file} parameter. 305263d3145aSMarkus Armbruster 305363d3145aSMarkus ArmbrusterThe fw_cfg entries are passed by QEMU through to the guest. 305463d3145aSMarkus Armbruster 305563d3145aSMarkus ArmbrusterExample: 305663d3145aSMarkus Armbruster@example 305763d3145aSMarkus Armbruster -fw_cfg name=opt/com.mycompany/blob,file=./my_blob.bin 305863d3145aSMarkus Armbruster@end example 305963d3145aSMarkus Armbrustercreates an fw_cfg entry named opt/com.mycompany/blob with contents 306063d3145aSMarkus Armbrusterfrom ./my_blob.bin. 306163d3145aSMarkus Armbruster 306281b2b810SGabriel L. SomloETEXI 306381b2b810SGabriel L. Somlo 30645824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 3065ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 3066ad96090aSBlue Swirl QEMU_ARCH_ALL) 30675824d651Sblueswir1STEXI 30685824d651Sblueswir1@item -serial @var{dev} 30696616b2adSStefan Weil@findex -serial 30705824d651Sblueswir1Redirect the virtual serial port to host character device 30715824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 30725824d651Sblueswir1@code{stdio} in non graphical mode. 30735824d651Sblueswir1 30745824d651Sblueswir1This option can be used several times to simulate up to 4 serial 30755824d651Sblueswir1ports. 30765824d651Sblueswir1 30775824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 30785824d651Sblueswir1 30795824d651Sblueswir1Available character devices are: 3080b3f046c2SKevin Wolf@table @option 30814e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 30825824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 30835824d651Sblueswir1@example 30845824d651Sblueswir1vc:800x600 30855824d651Sblueswir1@end example 30865824d651Sblueswir1It is also possible to specify width or height in characters: 30875824d651Sblueswir1@example 30885824d651Sblueswir1vc:80Cx24C 30895824d651Sblueswir1@end example 30905824d651Sblueswir1@item pty 30915824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 30925824d651Sblueswir1@item none 30935824d651Sblueswir1No device is allocated. 30945824d651Sblueswir1@item null 30955824d651Sblueswir1void device 309688e020e5SIngo van Lil@item chardev:@var{id} 309788e020e5SIngo van LilUse a named character device defined with the @code{-chardev} option. 30985824d651Sblueswir1@item /dev/XXX 30995824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 31005824d651Sblueswir1parameters are set according to the emulated ones. 31015824d651Sblueswir1@item /dev/parport@var{N} 31025824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 31035824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 31045824d651Sblueswir1@item file:@var{filename} 31055824d651Sblueswir1Write output to @var{filename}. No character can be read. 31065824d651Sblueswir1@item stdio 31075824d651Sblueswir1[Unix only] standard input/output 31085824d651Sblueswir1@item pipe:@var{filename} 31095824d651Sblueswir1name pipe @var{filename} 31105824d651Sblueswir1@item COM@var{n} 31115824d651Sblueswir1[Windows only] Use host serial port @var{n} 31125824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 31135824d651Sblueswir1This implements UDP Net Console. 31145824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 31155824d651Sblueswir1they default to @code{0.0.0.0}. 31165824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 31175824d651Sblueswir1 31185824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 3119b65ee4faSStefan Weil@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 3120b65ee4faSStefan Weil@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 31215824d651Sblueswir1will appear in the netconsole session. 31225824d651Sblueswir1 31235824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 3124b65ee4faSStefan Weiland start QEMU a lot of times, you should have QEMU use the same 31255824d651Sblueswir1source port each time by using something like @code{-serial 3126b65ee4faSStefan Weiludp::4555@@:4556} to QEMU. Another approach is to use a patched 31275824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 31285824d651Sblueswir1characters via udp. If you have a patched version of netcat which 31295824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 3130bd1caa3fSMarc-André Lureauuse the following options to set up a netcat redirector to allow 3131b65ee4faSStefan Weiltelnet on port 5555 to access the QEMU port. 31325824d651Sblueswir1@table @code 3133071c9394SStefan Weil@item QEMU Options: 31345824d651Sblueswir1-serial udp::4555@@:4556 31355824d651Sblueswir1@item netcat options: 31365824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 31375824d651Sblueswir1@item telnet options: 31385824d651Sblueswir1localhost 5555 31395824d651Sblueswir1@end table 31405824d651Sblueswir1 31415dd1f02bSCorey Minyard@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] 31425824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 31435824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 31445824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 31455824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 31465824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 31475824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 31485dd1f02bSCorey Minyardalgorithm. The @code{reconnect} option only applies if @var{noserver} is 31495dd1f02bSCorey Minyardset, if the connection goes down it will attempt to reconnect at the 31505dd1f02bSCorey Minyardgiven interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only 31515824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 31525824d651Sblueswir1connect to the corresponding character device. 31535824d651Sblueswir1@table @code 31545824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 31555824d651Sblueswir1-serial tcp:192.168.0.2:4444 31565824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 31575824d651Sblueswir1-serial tcp::4444,server 31585824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 31595824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 31605824d651Sblueswir1@end table 31615824d651Sblueswir1 31625824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 31635824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 31645824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 31655824d651Sblueswir1difference is that the port acts like a telnet server or client using 31665824d651Sblueswir1telnet option negotiation. This will also allow you to send the 31675824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 31685824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 31695824d651Sblueswir1type "send break" followed by pressing the enter key. 31705824d651Sblueswir1 31715dd1f02bSCorey Minyard@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] 31725824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 31735824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 31745824d651Sblueswir1@var{path} is used for connections. 31755824d651Sblueswir1 31765824d651Sblueswir1@item mon:@var{dev_string} 31775824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 31785824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 317902c4bdf1SPaolo Bonzini@key{Control-a} and then pressing @key{c}. 31805824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 31815824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 31825824d651Sblueswir1listening on port 4444 would be: 31835824d651Sblueswir1@table @code 31845824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 31855824d651Sblueswir1@end table 3186be022d61SMichael TokarevWhen the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 318702c4bdf1SPaolo BonziniQEMU any more but will be passed to the guest instead. 31885824d651Sblueswir1 31895824d651Sblueswir1@item braille 31905824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 31915824d651Sblueswir1or fake device. 31925824d651Sblueswir1 3193be8b28a9SKevin Wolf@item msmouse 3194be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 31955824d651Sblueswir1@end table 31965824d651Sblueswir1ETEXI 31975824d651Sblueswir1 31985824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 3199ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 3200ad96090aSBlue Swirl QEMU_ARCH_ALL) 32015824d651Sblueswir1STEXI 32025824d651Sblueswir1@item -parallel @var{dev} 32036616b2adSStefan Weil@findex -parallel 32045824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 32055824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 32065824d651Sblueswir1be used to use hardware devices connected on the corresponding host 32075824d651Sblueswir1parallel port. 32085824d651Sblueswir1 32095824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 32105824d651Sblueswir1ports. 32115824d651Sblueswir1 32125824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 32135824d651Sblueswir1ETEXI 32145824d651Sblueswir1 32155824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 3216ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 3217ad96090aSBlue Swirl QEMU_ARCH_ALL) 32185824d651Sblueswir1STEXI 32194e307fc8SGerd Hoffmann@item -monitor @var{dev} 32206616b2adSStefan Weil@findex -monitor 32215824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 32225824d651Sblueswir1serial port). 32235824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 32245824d651Sblueswir1non graphical mode. 322570e098afSLuiz CapitulinoUse @code{-monitor none} to disable the default monitor. 32265824d651Sblueswir1ETEXI 32276ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 3228ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 3229ad96090aSBlue Swirl QEMU_ARCH_ALL) 323095d5f08bSStefan WeilSTEXI 323195d5f08bSStefan Weil@item -qmp @var{dev} 32326616b2adSStefan Weil@findex -qmp 323395d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 323495d5f08bSStefan WeilETEXI 32354821cd4cSMax ReitzDEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 32364821cd4cSMax Reitz "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 32374821cd4cSMax Reitz QEMU_ARCH_ALL) 32384821cd4cSMax ReitzSTEXI 32394821cd4cSMax Reitz@item -qmp-pretty @var{dev} 32404821cd4cSMax Reitz@findex -qmp-pretty 32414821cd4cSMax ReitzLike -qmp but uses pretty JSON formatting. 32424821cd4cSMax ReitzETEXI 32435824d651Sblueswir1 324422a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 3245ef670726SVicente Jimenez Aguilar "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL) 324622a0e04bSGerd HoffmannSTEXI 3247ef670726SVicente Jimenez Aguilar@item -mon [chardev=]name[,mode=readline|control][,pretty[=on|off]] 32486616b2adSStefan Weil@findex -mon 3249ef670726SVicente Jimenez AguilarSetup monitor on chardev @var{name}. @code{pretty} turns on JSON pretty printing 3250ef670726SVicente Jimenez Aguilareasing human reading and debugging. 325122a0e04bSGerd HoffmannETEXI 325222a0e04bSGerd Hoffmann 3253c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 3254ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 3255ad96090aSBlue Swirl QEMU_ARCH_ALL) 3256c9f398e5SH. Peter AnvinSTEXI 3257c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 32586616b2adSStefan Weil@findex -debugcon 3259c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 3260c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 3261c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 3262c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 3263c9f398e5SH. Peter Anvinnon graphical mode. 3264c9f398e5SH. Peter AnvinETEXI 3265c9f398e5SH. Peter Anvin 32665824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 3267ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 32685824d651Sblueswir1STEXI 32695824d651Sblueswir1@item -pidfile @var{file} 32706616b2adSStefan Weil@findex -pidfile 32715824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 32725824d651Sblueswir1from a script. 32735824d651Sblueswir1ETEXI 32745824d651Sblueswir1 32751b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 3276ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 32771b530a6dSaurel32STEXI 32781b530a6dSaurel32@item -singlestep 32796616b2adSStefan Weil@findex -singlestep 32801b530a6dSaurel32Run the emulation in single step mode. 32811b530a6dSaurel32ETEXI 32821b530a6dSaurel32 3283047f7038SIgor MammedovDEF("preconfig", 0, QEMU_OPTION_preconfig, \ 3284361ac948SMarkus Armbruster "--preconfig pause QEMU before machine is initialized (experimental)\n", 3285047f7038SIgor Mammedov QEMU_ARCH_ALL) 3286047f7038SIgor MammedovSTEXI 3287047f7038SIgor Mammedov@item --preconfig 3288047f7038SIgor Mammedov@findex --preconfig 3289047f7038SIgor MammedovPause QEMU for interactive configuration before the machine is created, 3290047f7038SIgor Mammedovwhich allows querying and configuring properties that will affect 3291361ac948SMarkus Armbrustermachine initialization. Use QMP command 'x-exit-preconfig' to exit 3292361ac948SMarkus Armbrusterthe preconfig state and move to the next state (i.e. run guest if -S 3293361ac948SMarkus Armbrusterisn't used or pause the second time if -S is used). This option is 3294361ac948SMarkus Armbrusterexperimental. 3295047f7038SIgor MammedovETEXI 3296047f7038SIgor Mammedov 32975824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 3298ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 3299ad96090aSBlue Swirl QEMU_ARCH_ALL) 33005824d651Sblueswir1STEXI 33015824d651Sblueswir1@item -S 33026616b2adSStefan Weil@findex -S 33035824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 33045824d651Sblueswir1ETEXI 33055824d651Sblueswir1 3306888a6bc6SSatoru MoriyaDEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 3307888a6bc6SSatoru Moriya "-realtime [mlock=on|off]\n" 3308888a6bc6SSatoru Moriya " run qemu with realtime features\n" 3309888a6bc6SSatoru Moriya " mlock=on|off controls mlock support (default: on)\n", 3310888a6bc6SSatoru Moriya QEMU_ARCH_ALL) 3311888a6bc6SSatoru MoriyaSTEXI 3312888a6bc6SSatoru Moriya@item -realtime mlock=on|off 3313888a6bc6SSatoru Moriya@findex -realtime 3314888a6bc6SSatoru MoriyaRun qemu with realtime features. 3315888a6bc6SSatoru Moriyamlocking qemu and guest memory can be enabled via @option{mlock=on} 3316888a6bc6SSatoru Moriya(enabled by default). 3317888a6bc6SSatoru MoriyaETEXI 3318888a6bc6SSatoru Moriya 33196f131f13SMichael S. TsirkinDEF("overcommit", HAS_ARG, QEMU_OPTION_overcommit, 3320dfaa7d50SBALATON Zoltan "-overcommit [mem-lock=on|off][cpu-pm=on|off]\n" 33216f131f13SMichael S. Tsirkin " run qemu with overcommit hints\n" 33226f131f13SMichael S. Tsirkin " mem-lock=on|off controls memory lock support (default: off)\n" 33236f131f13SMichael S. Tsirkin " cpu-pm=on|off controls cpu power management (default: off)\n", 33246f131f13SMichael S. Tsirkin QEMU_ARCH_ALL) 33256f131f13SMichael S. TsirkinSTEXI 33266f131f13SMichael S. Tsirkin@item -overcommit mem-lock=on|off 33276f131f13SMichael S. Tsirkin@item -overcommit cpu-pm=on|off 33286f131f13SMichael S. Tsirkin@findex -overcommit 33296f131f13SMichael S. TsirkinRun qemu with hints about host resource overcommit. The default is 33306f131f13SMichael S. Tsirkinto assume that host overcommits all resources. 33316f131f13SMichael S. Tsirkin 33326f131f13SMichael S. TsirkinLocking qemu and guest memory can be enabled via @option{mem-lock=on} (disabled 33336f131f13SMichael S. Tsirkinby default). This works when host memory is not overcommitted and reduces the 33346f131f13SMichael S. Tsirkinworst-case latency for guest. This is equivalent to @option{realtime}. 33356f131f13SMichael S. Tsirkin 33366f131f13SMichael S. TsirkinGuest ability to manage power state of host cpus (increasing latency for other 33376f131f13SMichael S. Tsirkinprocesses on the same host cpu, but decreasing latency for guest) can be 33386f131f13SMichael S. Tsirkinenabled via @option{cpu-pm=on} (disabled by default). This works best when 33396f131f13SMichael S. Tsirkinhost CPU is not overcommitted. When used, host estimates of CPU cycle and power 33406f131f13SMichael S. Tsirkinutilization will be incorrect, not taking into account guest idle time. 33416f131f13SMichael S. TsirkinETEXI 33426f131f13SMichael S. Tsirkin 334359030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 3344ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 33455824d651Sblueswir1STEXI 334659030a8cSaliguori@item -gdb @var{dev} 33476616b2adSStefan Weil@findex -gdb 334859030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 334959030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 3350b65ee4faSStefan Weilstdio are reasonable use case. The latter is allowing to start QEMU from 335159030a8cSaliguoriwithin gdb and establish the connection via a pipe: 335259030a8cSaliguori@example 33533804da9dSStefan Weil(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 335459030a8cSaliguori@end example 33555824d651Sblueswir1ETEXI 33565824d651Sblueswir1 335759030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 3358ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 3359ad96090aSBlue Swirl QEMU_ARCH_ALL) 33605824d651Sblueswir1STEXI 336159030a8cSaliguori@item -s 33626616b2adSStefan Weil@findex -s 336359030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 336459030a8cSaliguori(@pxref{gdb_usage}). 33655824d651Sblueswir1ETEXI 33665824d651Sblueswir1 33675824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 3368989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 3369ad96090aSBlue Swirl QEMU_ARCH_ALL) 33705824d651Sblueswir1STEXI 3371989b697dSPeter Maydell@item -d @var{item1}[,...] 33726616b2adSStefan Weil@findex -d 3373989b697dSPeter MaydellEnable logging of specified items. Use '-d help' for a list of log items. 33745824d651Sblueswir1ETEXI 33755824d651Sblueswir1 3376c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 3377989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 3378c235d738SMatthew Fernandez QEMU_ARCH_ALL) 3379c235d738SMatthew FernandezSTEXI 33808bd383b4SStefan Weil@item -D @var{logfile} 3381c235d738SMatthew Fernandez@findex -D 3382989b697dSPeter MaydellOutput log in @var{logfile} instead of to stderr 3383c235d738SMatthew FernandezETEXI 3384c235d738SMatthew Fernandez 33853514552eSAlex BennéeDEF("dfilter", HAS_ARG, QEMU_OPTION_DFILTER, \ 33863514552eSAlex Bennée "-dfilter range,.. filter debug output to range of addresses (useful for -d cpu,exec,etc..)\n", 33873514552eSAlex Bennée QEMU_ARCH_ALL) 33883514552eSAlex BennéeSTEXI 33893514552eSAlex Bennée@item -dfilter @var{range1}[,...] 33903514552eSAlex Bennée@findex -dfilter 33913514552eSAlex BennéeFilter debug output to that relevant to a range of target addresses. The filter 33923514552eSAlex Bennéespec can be either @var{start}+@var{size}, @var{start}-@var{size} or 33933514552eSAlex Bennée@var{start}..@var{end} where @var{start} @var{end} and @var{size} are the 33943514552eSAlex Bennéeaddresses and sizes required. For example: 33953514552eSAlex Bennée@example 33963514552eSAlex Bennée -dfilter 0x8000..0x8fff,0xffffffc000080000+0x200,0xffffffc000060000-0x1000 33973514552eSAlex Bennée@end example 33983514552eSAlex BennéeWill dump output for any code in the 0x1000 sized block starting at 0x8000 and 33993514552eSAlex Bennéethe 0x200 sized block starting at 0xffffffc000080000 and another 0x1000 sized 34003514552eSAlex Bennéeblock starting at 0xffffffc00005f000. 34013514552eSAlex BennéeETEXI 34023514552eSAlex Bennée 34035824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 3404ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 3405ad96090aSBlue Swirl QEMU_ARCH_ALL) 34065824d651Sblueswir1STEXI 34075824d651Sblueswir1@item -L @var{path} 34086616b2adSStefan Weil@findex -L 34095824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 341037146e7eSRichard W.M. Jones 341137146e7eSRichard W.M. JonesTo list all the data directories, use @code{-L help}. 34125824d651Sblueswir1ETEXI 34135824d651Sblueswir1 34145824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 3415ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 34165824d651Sblueswir1STEXI 34175824d651Sblueswir1@item -bios @var{file} 34186616b2adSStefan Weil@findex -bios 34195824d651Sblueswir1Set the filename for the BIOS. 34205824d651Sblueswir1ETEXI 34215824d651Sblueswir1 34225824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 3423ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 34245824d651Sblueswir1STEXI 34255824d651Sblueswir1@item -enable-kvm 34266616b2adSStefan Weil@findex -enable-kvm 34275824d651Sblueswir1Enable KVM full virtualization support. This option is only available 34285824d651Sblueswir1if KVM support is enabled when compiling. 34295824d651Sblueswir1ETEXI 34305824d651Sblueswir1 3431b0cb0a66SVincent PalatinDEF("enable-hax", 0, QEMU_OPTION_enable_hax, \ 3432b0cb0a66SVincent Palatin "-enable-hax enable HAX virtualization support\n", QEMU_ARCH_I386) 3433b0cb0a66SVincent PalatinSTEXI 3434b0cb0a66SVincent Palatin@item -enable-hax 3435b0cb0a66SVincent Palatin@findex -enable-hax 3436b0cb0a66SVincent PalatinEnable HAX (Hardware-based Acceleration eXecution) support. This option 3437b0cb0a66SVincent Palatinis only available if HAX support is enabled when compiling. HAX is only 3438b0cb0a66SVincent Palatinapplicable to MAC and Windows platform, and thus does not conflict with 3439c44df2ffSThomas HuthKVM. This option is deprecated, use @option{-accel hax} instead. 3440b0cb0a66SVincent PalatinETEXI 3441b0cb0a66SVincent Palatin 3442e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 3443ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 3444e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 3445e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 3446ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 3447ad96090aSBlue Swirl QEMU_ARCH_ALL) 3448e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 3449e37630caSaliguori "-xen-attach attach to existing xen domain\n" 3450b65ee4faSStefan Weil " xend will use this when starting QEMU\n", 3451ad96090aSBlue Swirl QEMU_ARCH_ALL) 34521c599472SPaul DurrantDEF("xen-domid-restrict", 0, QEMU_OPTION_xen_domid_restrict, 34531c599472SPaul Durrant "-xen-domid-restrict restrict set of available xen operations\n" 34541c599472SPaul Durrant " to specified domain id. (Does not affect\n" 34551c599472SPaul Durrant " xenpv machine type).\n", 34561c599472SPaul Durrant QEMU_ARCH_ALL) 345795d5f08bSStefan WeilSTEXI 345895d5f08bSStefan Weil@item -xen-domid @var{id} 34596616b2adSStefan Weil@findex -xen-domid 346095d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 346195d5f08bSStefan Weil@item -xen-create 34626616b2adSStefan Weil@findex -xen-create 346395d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 346495d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 346595d5f08bSStefan Weil@item -xen-attach 34666616b2adSStefan Weil@findex -xen-attach 346795d5f08bSStefan WeilAttach to existing xen domain. 3468b65ee4faSStefan Weilxend will use this when starting QEMU (XEN only). 34691c599472SPaul Durrant@findex -xen-domid-restrict 34701c599472SPaul DurrantRestrict set of available xen operations to specified domain id (XEN only). 347195d5f08bSStefan WeilETEXI 3472e37630caSaliguori 34735824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 3474ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 34755824d651Sblueswir1STEXI 34765824d651Sblueswir1@item -no-reboot 34776616b2adSStefan Weil@findex -no-reboot 34785824d651Sblueswir1Exit instead of rebooting. 34795824d651Sblueswir1ETEXI 34805824d651Sblueswir1 34815824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 3482ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 34835824d651Sblueswir1STEXI 34845824d651Sblueswir1@item -no-shutdown 34856616b2adSStefan Weil@findex -no-shutdown 34865824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 34875824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 34885824d651Sblueswir1disk image. 34895824d651Sblueswir1ETEXI 34905824d651Sblueswir1 34915824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 34925824d651Sblueswir1 "-loadvm [tag|id]\n" \ 3493ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 3494ad96090aSBlue Swirl QEMU_ARCH_ALL) 34955824d651Sblueswir1STEXI 34965824d651Sblueswir1@item -loadvm @var{file} 34976616b2adSStefan Weil@findex -loadvm 34985824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 34995824d651Sblueswir1ETEXI 35005824d651Sblueswir1 35015824d651Sblueswir1#ifndef _WIN32 35025824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 3503ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 35045824d651Sblueswir1#endif 35055824d651Sblueswir1STEXI 35065824d651Sblueswir1@item -daemonize 35076616b2adSStefan Weil@findex -daemonize 35085824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 35095824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 35105824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 35115824d651Sblueswir1to cope with initialization race conditions. 35125824d651Sblueswir1ETEXI 35135824d651Sblueswir1 35145824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 3515ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 3516ad96090aSBlue Swirl QEMU_ARCH_ALL) 35175824d651Sblueswir1STEXI 35185824d651Sblueswir1@item -option-rom @var{file} 35196616b2adSStefan Weil@findex -option-rom 35205824d651Sblueswir1Load the contents of @var{file} as an option ROM. 35215824d651Sblueswir1This option is useful to load things like EtherBoot. 35225824d651Sblueswir1ETEXI 35235824d651Sblueswir1 3524e218052fSMarkus ArmbrusterHXCOMM Silently ignored for compatibility 3525e218052fSMarkus ArmbrusterDEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL) 35265824d651Sblueswir1 35271ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 3528ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 3529ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 35305824d651Sblueswir1 35311ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 353278808141SPaolo Bonzini "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 3533ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 3534ad96090aSBlue Swirl QEMU_ARCH_ALL) 35351ed2fc1fSJan Kiszka 35365824d651Sblueswir1STEXI 35375824d651Sblueswir1 35386875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 35396616b2adSStefan Weil@findex -rtc 35401ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 35411ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 35421ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 35431ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 35441ed2fc1fSJan Kiszka 35459d85d557SMichael TokarevBy default the RTC is driven by the host system time. This allows using of the 35466875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 35476875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 354878808141SPaolo BonziniIf you want to isolate the guest time from the host, you can set @option{clock} 354978808141SPaolo Bonzinito @code{rt} instead. To even prevent it from progressing during suspension, 355078808141SPaolo Bonziniyou can set it to @code{vm}. 35516875204cSJan Kiszka 35521ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 35531ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 35541ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 35551ed2fc1fSJan Kiszkare-inject them. 35565824d651Sblueswir1ETEXI 35575824d651Sblueswir1 35585824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 35599c2037d0SPavel Dovgalyuk "-icount [shift=N|auto][,align=on|off][,sleep=on|off,rr=record|replay,rrfile=<filename>,rrsnapshot=<snapshot>]\n" \ 3560bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 3561f1f4b57eSVictor CLEMENT " instruction, enable aligning the host and virtual clocks\n" \ 3562f1f4b57eSVictor CLEMENT " or disable real time cpu sleeping\n", QEMU_ARCH_ALL) 35635824d651Sblueswir1STEXI 35649c2037d0SPavel Dovgalyuk@item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename},rrsnapshot=@var{snapshot}] 35656616b2adSStefan Weil@findex -icount 35665824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 35674e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 35685824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 35695824d651Sblueswir1time within a few seconds of real time. 35705824d651Sblueswir1 3571f1f4b57eSVictor CLEMENTWhen the virtual cpu is sleeping, the virtual time will advance at default 3572778d9f9bSPranith Kumarspeed unless @option{sleep=on|off} is specified. 3573778d9f9bSPranith KumarWith @option{sleep=on|off}, the virtual time will jump to the next timer deadline 3574f1f4b57eSVictor CLEMENTinstantly whenever the virtual cpu goes to sleep mode and will not advance 3575f1f4b57eSVictor CLEMENTif no timer is enabled. This behavior give deterministic execution times from 3576f1f4b57eSVictor CLEMENTthe guest point of view. 3577f1f4b57eSVictor CLEMENT 35785824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 35795824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 35805824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 35815824d651Sblueswir1executed often has little or no correlation with actual performance. 3582a8bfac37SSebastian Tanase 3583b6af0975SDaniel P. Berrange@option{align=on} will activate the delay algorithm which will try 3584a8bfac37SSebastian Tanaseto synchronise the host clock and the virtual clock. The goal is to 3585a8bfac37SSebastian Tanasehave a guest running at the real frequency imposed by the shift option. 3586a8bfac37SSebastian TanaseWhenever the guest clock is behind the host clock and if 358782597615SMichael Tokarev@option{align=on} is specified then we print a message to the user 3588a8bfac37SSebastian Tanaseto inform about the delay. 3589a8bfac37SSebastian TanaseCurrently this option does not work when @option{shift} is @code{auto}. 3590a8bfac37SSebastian TanaseNote: The sync algorithm will work for those shift values for which 3591a8bfac37SSebastian Tanasethe guest clock runs ahead of the host clock. Typically this happens 3592a8bfac37SSebastian Tanasewhen the shift value is high (how high depends on the host machine). 35934c27b859SPavel Dovgalyuk 35944c27b859SPavel DovgalyukWhen @option{rr} option is specified deterministic record/replay is enabled. 35954c27b859SPavel DovgalyukReplay log is written into @var{filename} file in record mode and 35964c27b859SPavel Dovgalyukread from this file in replay mode. 35979c2037d0SPavel Dovgalyuk 35989c2037d0SPavel DovgalyukOption rrsnapshot is used to create new vm snapshot named @var{snapshot} 35999c2037d0SPavel Dovgalyukat the start of execution recording. In replay mode this option is used 36009c2037d0SPavel Dovgalyukto load the initial VM state. 36015824d651Sblueswir1ETEXI 36025824d651Sblueswir1 36039dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 3604d7933ef3SXu Wang "-watchdog model\n" \ 3605ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 3606ad96090aSBlue Swirl QEMU_ARCH_ALL) 36079dd986ccSRichard W.M. JonesSTEXI 36089dd986ccSRichard W.M. Jones@item -watchdog @var{model} 36096616b2adSStefan Weil@findex -watchdog 36109dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 36119dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 3612d7933ef3SXu Wangthe guest or else the guest will be restarted. Choose a model for 3613d7933ef3SXu Wangwhich your guest has drivers. 36149dd986ccSRichard W.M. Jones 3615d7933ef3SXu WangThe @var{model} is the model of hardware watchdog to emulate. Use 3616d7933ef3SXu Wang@code{-watchdog help} to list available hardware models. Only one 36179dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 3618d7933ef3SXu Wang 3619d7933ef3SXu WangThe following models may be available: 3620d7933ef3SXu Wang@table @option 3621d7933ef3SXu Wang@item ib700 3622d7933ef3SXu WangiBASE 700 is a very simple ISA watchdog with a single timer. 3623d7933ef3SXu Wang@item i6300esb 3624d7933ef3SXu WangIntel 6300ESB I/O controller hub is a much more featureful PCI-based 3625d7933ef3SXu Wangdual-timer watchdog. 3626188f24c2SXu Wang@item diag288 3627188f24c2SXu WangA virtual watchdog for s390x backed by the diagnose 288 hypercall 3628188f24c2SXu Wang(currently KVM only). 3629d7933ef3SXu Wang@end table 36309dd986ccSRichard W.M. JonesETEXI 36319dd986ccSRichard W.M. Jones 36329dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 36337ad9270eSMarkus Armbruster "-watchdog-action reset|shutdown|poweroff|inject-nmi|pause|debug|none\n" \ 3634ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 3635ad96090aSBlue Swirl QEMU_ARCH_ALL) 36369dd986ccSRichard W.M. JonesSTEXI 36379dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 3638b8f490ebSMarkus Armbruster@findex -watchdog-action 36399dd986ccSRichard W.M. Jones 36409dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 36419dd986ccSRichard W.M. Jonesexpires. 36429dd986ccSRichard W.M. JonesThe default is 36439dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 36449dd986ccSRichard W.M. JonesOther possible actions are: 36459dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 36469dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 36477ad9270eSMarkus Armbruster@code{inject-nmi} (inject a NMI into the guest), 36489dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 36499dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 36509dd986ccSRichard W.M. Jones@code{none} (do nothing). 36519dd986ccSRichard W.M. Jones 36529dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 36539dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 36549dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 36559dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 36569dd986ccSRichard W.M. Jones 36579dd986ccSRichard W.M. JonesExamples: 36589dd986ccSRichard W.M. Jones 36599dd986ccSRichard W.M. Jones@table @code 36609dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 3661f9cfd655SMarkus Armbruster@itemx -watchdog ib700 36629dd986ccSRichard W.M. Jones@end table 36639dd986ccSRichard W.M. JonesETEXI 36649dd986ccSRichard W.M. Jones 36655824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 3666ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 3667ad96090aSBlue Swirl QEMU_ARCH_ALL) 36685824d651Sblueswir1STEXI 36695824d651Sblueswir1 36704e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 36716616b2adSStefan Weil@findex -echr 36725824d651Sblueswir1Change the escape character used for switching to the monitor when using 36735824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 36745824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 36755824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 36765824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 36775824d651Sblueswir1instance you could use the either of the following to change the escape 36785824d651Sblueswir1character to Control-t. 36795824d651Sblueswir1@table @code 36805824d651Sblueswir1@item -echr 0x14 3681f9cfd655SMarkus Armbruster@itemx -echr 20 36825824d651Sblueswir1@end table 36835824d651Sblueswir1ETEXI 36845824d651Sblueswir1 36855824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 36865824d651Sblueswir1 "-virtioconsole c\n" \ 3687ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 36885824d651Sblueswir1STEXI 36895824d651Sblueswir1@item -virtioconsole @var{c} 36906616b2adSStefan Weil@findex -virtioconsole 36915824d651Sblueswir1Set virtio console. 369245401299SThomas HuthThis option is deprecated, please use @option{-device virtconsole} instead. 36935824d651Sblueswir1ETEXI 36945824d651Sblueswir1 36955824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3696ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 36975824d651Sblueswir1STEXI 369895d5f08bSStefan Weil@item -show-cursor 36996616b2adSStefan Weil@findex -show-cursor 370095d5f08bSStefan WeilShow cursor. 37015824d651Sblueswir1ETEXI 37025824d651Sblueswir1 37035824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3704ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 37055824d651Sblueswir1STEXI 370695d5f08bSStefan Weil@item -tb-size @var{n} 37076616b2adSStefan Weil@findex -tb-size 370895d5f08bSStefan WeilSet TB size. 37095824d651Sblueswir1ETEXI 37105824d651Sblueswir1 37115824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 37127c601803SMichael Tokarev "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \ 37137c601803SMichael Tokarev "-incoming rdma:host:port[,ipv4][,ipv6]\n" \ 37147c601803SMichael Tokarev "-incoming unix:socketpath\n" \ 37157c601803SMichael Tokarev " prepare for incoming migration, listen on\n" \ 37167c601803SMichael Tokarev " specified protocol and socket address\n" \ 37177c601803SMichael Tokarev "-incoming fd:fd\n" \ 37187c601803SMichael Tokarev "-incoming exec:cmdline\n" \ 37197c601803SMichael Tokarev " accept incoming migration on given file descriptor\n" \ 37201597051bSDr. David Alan Gilbert " or from given external command\n" \ 37211597051bSDr. David Alan Gilbert "-incoming defer\n" \ 37221597051bSDr. David Alan Gilbert " wait for the URI to be specified via migrate_incoming\n", 3723ad96090aSBlue Swirl QEMU_ARCH_ALL) 37245824d651Sblueswir1STEXI 37257c601803SMichael Tokarev@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6] 3726f9cfd655SMarkus Armbruster@itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6] 37276616b2adSStefan Weil@findex -incoming 37287c601803SMichael TokarevPrepare for incoming migration, listen on a given tcp port. 37297c601803SMichael Tokarev 37307c601803SMichael Tokarev@item -incoming unix:@var{socketpath} 37317c601803SMichael TokarevPrepare for incoming migration, listen on a given unix socket. 37327c601803SMichael Tokarev 37337c601803SMichael Tokarev@item -incoming fd:@var{fd} 37347c601803SMichael TokarevAccept incoming migration from a given filedescriptor. 37357c601803SMichael Tokarev 37367c601803SMichael Tokarev@item -incoming exec:@var{cmdline} 37377c601803SMichael TokarevAccept incoming migration as an output from specified external command. 37381597051bSDr. David Alan Gilbert 37391597051bSDr. David Alan Gilbert@item -incoming defer 37401597051bSDr. David Alan GilbertWait for the URI to be specified via migrate_incoming. The monitor can 37411597051bSDr. David Alan Gilbertbe used to change settings (such as migration parameters) prior to issuing 37421597051bSDr. David Alan Gilbertthe migrate_incoming to allow the migration to begin. 37435824d651Sblueswir1ETEXI 37445824d651Sblueswir1 3745d15c05fcSAshijeet AcharyaDEF("only-migratable", 0, QEMU_OPTION_only_migratable, \ 3746d15c05fcSAshijeet Acharya "-only-migratable allow only migratable devices\n", QEMU_ARCH_ALL) 3747d15c05fcSAshijeet AcharyaSTEXI 3748d15c05fcSAshijeet Acharya@item -only-migratable 3749d15c05fcSAshijeet Acharya@findex -only-migratable 3750d15c05fcSAshijeet AcharyaOnly allow migratable devices. Devices will not be allowed to enter an 3751d15c05fcSAshijeet Acharyaunmigratable state. 3752d15c05fcSAshijeet AcharyaETEXI 3753d15c05fcSAshijeet Acharya 3754d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3755ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3756d8c208ddSGerd HoffmannSTEXI 37573dbf2c7fSStefan Weil@item -nodefaults 37586616b2adSStefan Weil@findex -nodefaults 375966c19bf1SMichal NovotnyDon't create default devices. Normally, QEMU sets the default devices like serial 376066c19bf1SMichal Novotnyport, parallel port, virtual console, monitor device, VGA adapter, floppy and 376166c19bf1SMichal NovotnyCD-ROM drive and others. The @code{-nodefaults} option will disable all those 376266c19bf1SMichal Novotnydefault devices. 3763d8c208ddSGerd HoffmannETEXI 3764d8c208ddSGerd Hoffmann 37655824d651Sblueswir1#ifndef _WIN32 37665824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3767ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 3768ad96090aSBlue Swirl QEMU_ARCH_ALL) 37695824d651Sblueswir1#endif 37705824d651Sblueswir1STEXI 37714e257e5eSKevin Wolf@item -chroot @var{dir} 37726616b2adSStefan Weil@findex -chroot 37735824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 37745824d651Sblueswir1directory. Especially useful in combination with -runas. 37755824d651Sblueswir1ETEXI 37765824d651Sblueswir1 37775824d651Sblueswir1#ifndef _WIN32 37785824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 37792c42f1e8SIan Jackson "-runas user change to user id user just before starting the VM\n" \ 37802c42f1e8SIan Jackson " user can be numeric uid:gid instead\n", 3781ad96090aSBlue Swirl QEMU_ARCH_ALL) 37825824d651Sblueswir1#endif 37835824d651Sblueswir1STEXI 37844e257e5eSKevin Wolf@item -runas @var{user} 37856616b2adSStefan Weil@findex -runas 37865824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 37875824d651Sblueswir1to the specified user. 37885824d651Sblueswir1ETEXI 37895824d651Sblueswir1 37905824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 37915824d651Sblueswir1 "-prom-env variable=value\n" 3792ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 3793ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 379495d5f08bSStefan WeilSTEXI 379595d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 37966616b2adSStefan Weil@findex -prom-env 379795d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 379895d5f08bSStefan WeilETEXI 37995824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 3800f7bbcfb5SMichael Walle "-semihosting semihosting mode\n", 38013b3c1694SLeon Alrae QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 38023b3c1694SLeon Alrae QEMU_ARCH_MIPS) 380395d5f08bSStefan WeilSTEXI 380495d5f08bSStefan Weil@item -semihosting 38056616b2adSStefan Weil@findex -semihosting 38063b3c1694SLeon AlraeEnable semihosting mode (ARM, M68K, Xtensa, MIPS only). 3807a38bb079SLiviu IonescuETEXI 3808a38bb079SLiviu IonescuDEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 3809a59d31a1SLeon Alrae "-semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]]\n" \ 3810a59d31a1SLeon Alrae " semihosting configuration\n", 38113b3c1694SLeon AlraeQEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 38123b3c1694SLeon AlraeQEMU_ARCH_MIPS) 3813a38bb079SLiviu IonescuSTEXI 3814a59d31a1SLeon Alrae@item -semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]] 3815a38bb079SLiviu Ionescu@findex -semihosting-config 38163b3c1694SLeon AlraeEnable and configure semihosting (ARM, M68K, Xtensa, MIPS only). 3817a59d31a1SLeon Alrae@table @option 3818a59d31a1SLeon Alrae@item target=@code{native|gdb|auto} 3819a59d31a1SLeon AlraeDefines where the semihosting calls will be addressed, to QEMU (@code{native}) 3820a59d31a1SLeon Alraeor to GDB (@code{gdb}). The default is @code{auto}, which means @code{gdb} 3821a59d31a1SLeon Alraeduring debug sessions and @code{native} otherwise. 3822a59d31a1SLeon Alrae@item arg=@var{str1},arg=@var{str2},... 3823a59d31a1SLeon AlraeAllows the user to pass input arguments, and can be used multiple times to build 3824a59d31a1SLeon Alraeup a list. The old-style @code{-kernel}/@code{-append} method of passing a 3825a59d31a1SLeon Alraecommand line is still supported for backward compatibility. If both the 3826a59d31a1SLeon Alrae@code{--semihosting-config arg} and the @code{-kernel}/@code{-append} are 3827a59d31a1SLeon Alraespecified, the former is passed to semihosting as it always takes precedence. 3828a59d31a1SLeon Alrae@end table 382995d5f08bSStefan WeilETEXI 38305824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 3831ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 383295d5f08bSStefan WeilSTEXI 383395d5f08bSStefan Weil@item -old-param 38346616b2adSStefan Weil@findex -old-param (ARM) 383595d5f08bSStefan WeilOld param mode (ARM only). 383695d5f08bSStefan WeilETEXI 383795d5f08bSStefan Weil 38387d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 383973a1e647SEduardo Otubo "-sandbox on[,obsolete=allow|deny][,elevateprivileges=allow|deny|children]\n" \ 384024f8cdc5SEduardo Otubo " [,spawn=allow|deny][,resourcecontrol=allow|deny]\n" \ 38412b716fa6SEduardo Otubo " Enable seccomp mode 2 system call filter (default 'off').\n" \ 38422b716fa6SEduardo Otubo " use 'obsolete' to allow obsolete system calls that are provided\n" \ 38432b716fa6SEduardo Otubo " by the kernel, but typically no longer used by modern\n" \ 384473a1e647SEduardo Otubo " C library implementations.\n" \ 384573a1e647SEduardo Otubo " use 'elevateprivileges' to allow or deny QEMU process to elevate\n" \ 384673a1e647SEduardo Otubo " its privileges by blacklisting all set*uid|gid system calls.\n" \ 384773a1e647SEduardo Otubo " The value 'children' will deny set*uid|gid system calls for\n" \ 3848995a226fSEduardo Otubo " main QEMU process but will allow forks and execves to run unprivileged\n" \ 3849995a226fSEduardo Otubo " use 'spawn' to avoid QEMU to spawn new threads or processes by\n" \ 385024f8cdc5SEduardo Otubo " blacklisting *fork and execve\n" \ 385124f8cdc5SEduardo Otubo " use 'resourcecontrol' to disable process affinity and schedular priority\n", 38527d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 38537d76ad4fSEduardo OtuboSTEXI 385424f8cdc5SEduardo Otubo@item -sandbox @var{arg}[,obsolete=@var{string}][,elevateprivileges=@var{string}][,spawn=@var{string}][,resourcecontrol=@var{string}] 38557d76ad4fSEduardo Otubo@findex -sandbox 38567d76ad4fSEduardo OtuboEnable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 38577d76ad4fSEduardo Otubodisable it. The default is 'off'. 38582b716fa6SEduardo Otubo@table @option 38592b716fa6SEduardo Otubo@item obsolete=@var{string} 38602b716fa6SEduardo OtuboEnable Obsolete system calls 386173a1e647SEduardo Otubo@item elevateprivileges=@var{string} 386273a1e647SEduardo OtuboDisable set*uid|gid system calls 3863995a226fSEduardo Otubo@item spawn=@var{string} 3864995a226fSEduardo OtuboDisable *fork and execve 386524f8cdc5SEduardo Otubo@item resourcecontrol=@var{string} 386624f8cdc5SEduardo OtuboDisable process affinity and schedular priority 38672b716fa6SEduardo Otubo@end table 38687d76ad4fSEduardo OtuboETEXI 38697d76ad4fSEduardo Otubo 3870715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3871ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 38723dbf2c7fSStefan WeilSTEXI 38733dbf2c7fSStefan Weil@item -readconfig @var{file} 38746616b2adSStefan Weil@findex -readconfig 3875ed24cfacSMichal NovotnyRead device configuration from @var{file}. This approach is useful when you want to spawn 3876ed24cfacSMichal NovotnyQEMU process with many command line options but you don't want to exceed the command line 3877ed24cfacSMichal Novotnycharacter limit. 38783dbf2c7fSStefan WeilETEXI 3879715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3880715a664aSGerd Hoffmann "-writeconfig <file>\n" 3881ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 38823dbf2c7fSStefan WeilSTEXI 38833dbf2c7fSStefan Weil@item -writeconfig @var{file} 38846616b2adSStefan Weil@findex -writeconfig 3885ed24cfacSMichal NovotnyWrite device configuration to @var{file}. The @var{file} can be either filename to save 3886ed24cfacSMichal Novotnycommand line and device configuration into file or dash @code{-}) character to print the 3887ed24cfacSMichal Novotnyoutput to stdout. This can be later used as input file for @code{-readconfig} option. 38883dbf2c7fSStefan WeilETEXI 38893478eae9SEduardo HabkostHXCOMM Deprecated, same as -no-user-config 38903478eae9SEduardo HabkostDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, "", QEMU_ARCH_ALL) 3891f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3892f29a5614SEduardo Habkost "-no-user-config\n" 38933478eae9SEduardo Habkost " do not load default user-provided config files at startup\n", 3894f29a5614SEduardo Habkost QEMU_ARCH_ALL) 3895f29a5614SEduardo HabkostSTEXI 3896f29a5614SEduardo Habkost@item -no-user-config 3897f29a5614SEduardo Habkost@findex -no-user-config 3898f29a5614SEduardo HabkostThe @code{-no-user-config} option makes QEMU not load any of the user-provided 38993478eae9SEduardo Habkostconfig files on @var{sysconfdir}. 3900292444cbSAnthony LiguoriETEXI 3901ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 390210578a25SPaolo Bonzini "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 390323d15e86SLluís " specify tracing options\n", 3904ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 3905ab6540d5SPrerna SaxenaSTEXI 390623d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 390723d15e86SLluísHXCOMM HX does not support conditional compilation of text. 3908e370ad99SDenis V. Lunev@item -trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}] 3909ab6540d5SPrerna Saxena@findex -trace 3910eeb2b8f7SDenis V. Lunev@include qemu-option-trace.texi 3911ab6540d5SPrerna SaxenaETEXI 39123dbf2c7fSStefan Weil 391331e70d6cSMarkus ArmbrusterHXCOMM Internal use 391431e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 391531e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3916c7f0f3b1SAnthony Liguori 39170f66998fSPaul Moore#ifdef __linux__ 39180f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 39190f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 39200f66998fSPaul Moore QEMU_ARCH_ALL) 39210f66998fSPaul Moore#endif 39220f66998fSPaul MooreSTEXI 39230f66998fSPaul Moore@item -enable-fips 39240f66998fSPaul Moore@findex -enable-fips 39250f66998fSPaul MooreEnable FIPS 140-2 compliance mode. 39260f66998fSPaul MooreETEXI 39270f66998fSPaul Moore 3928a0dac021SJan KiszkaHXCOMM Deprecated by -machine accel=tcg property 3929c6e88b3bSBruce RogersDEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3930a0dac021SJan Kiszka 39315e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 39325e2ac519SSeiji Aguchi "-msg timestamp[=on|off]\n" 39335e2ac519SSeiji Aguchi " change the format of messages\n" 39345e2ac519SSeiji Aguchi " on|off controls leading timestamps (default:on)\n", 39355e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 39365e2ac519SSeiji AguchiSTEXI 39375e2ac519SSeiji Aguchi@item -msg timestamp[=on|off] 39385e2ac519SSeiji Aguchi@findex -msg 39395e2ac519SSeiji Aguchiprepend a timestamp to each log message.(default:on) 39405e2ac519SSeiji AguchiETEXI 39415e2ac519SSeiji Aguchi 3942abfd9ce3SAmit ShahDEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 3943abfd9ce3SAmit Shah "-dump-vmstate <file>\n" 3944abfd9ce3SAmit Shah " Output vmstate information in JSON format to file.\n" 3945abfd9ce3SAmit Shah " Use the scripts/vmstate-static-checker.py file to\n" 3946abfd9ce3SAmit Shah " check for possible regressions in migration code\n" 39472382053fSLaurent Vivier " by comparing two such vmstate dumps.\n", 3948abfd9ce3SAmit Shah QEMU_ARCH_ALL) 3949abfd9ce3SAmit ShahSTEXI 3950abfd9ce3SAmit Shah@item -dump-vmstate @var{file} 3951abfd9ce3SAmit Shah@findex -dump-vmstate 3952abfd9ce3SAmit ShahDump json-encoded vmstate information for current machine type to file 3953abfd9ce3SAmit Shahin @var{file} 3954abfd9ce3SAmit ShahETEXI 3955abfd9ce3SAmit Shah 3956*12df189dSEmilio G. CotaDEF("enable-sync-profile", 0, QEMU_OPTION_enable_sync_profile, 3957*12df189dSEmilio G. Cota "-enable-sync-profile\n" 3958*12df189dSEmilio G. Cota " enable synchronization profiling\n", 3959*12df189dSEmilio G. Cota QEMU_ARCH_ALL) 3960*12df189dSEmilio G. CotaSTEXI 3961*12df189dSEmilio G. Cota@item -enable-sync-profile 3962*12df189dSEmilio G. Cota@findex -enable-sync-profile 3963*12df189dSEmilio G. CotaEnable synchronization profiling. 3964*12df189dSEmilio G. CotaETEXI 3965*12df189dSEmilio G. Cota 396643f187a5SPaolo BonziniSTEXI 396743f187a5SPaolo Bonzini@end table 396843f187a5SPaolo BonziniETEXI 396943f187a5SPaolo BonziniDEFHEADING() 3970de6b4f90SMarkus Armbruster 3971de6b4f90SMarkus ArmbrusterDEFHEADING(Generic object creation:) 397243f187a5SPaolo BonziniSTEXI 397343f187a5SPaolo Bonzini@table @option 397443f187a5SPaolo BonziniETEXI 3975b9174d4fSDaniel P. Berrange 3976b9174d4fSDaniel P. BerrangeDEF("object", HAS_ARG, QEMU_OPTION_object, 3977b9174d4fSDaniel P. Berrange "-object TYPENAME[,PROP1=VALUE1,...]\n" 3978b9174d4fSDaniel P. Berrange " create a new object of type TYPENAME setting properties\n" 3979b9174d4fSDaniel P. Berrange " in the order they are specified. Note that the 'id'\n" 3980b9174d4fSDaniel P. Berrange " property must be set. These objects are placed in the\n" 3981b9174d4fSDaniel P. Berrange " '/objects' path.\n", 3982b9174d4fSDaniel P. Berrange QEMU_ARCH_ALL) 3983b9174d4fSDaniel P. BerrangeSTEXI 3984b9174d4fSDaniel P. Berrange@item -object @var{typename}[,@var{prop1}=@var{value1},...] 3985b9174d4fSDaniel P. Berrange@findex -object 3986b9174d4fSDaniel P. BerrangeCreate a new object of type @var{typename} setting properties 3987b9174d4fSDaniel P. Berrangein the order they are specified. Note that the 'id' 3988b9174d4fSDaniel P. Berrangeproperty must be set. These objects are placed in the 3989b9174d4fSDaniel P. Berrange'/objects' path. 3990b9174d4fSDaniel P. Berrange 3991b9174d4fSDaniel P. Berrange@table @option 3992b9174d4fSDaniel P. Berrange 399398376843SHaozhong Zhang@item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off},discard-data=@var{on|off},merge=@var{on|off},dump=@var{on|off},prealloc=@var{on|off},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave},align=@var{align} 3994b9174d4fSDaniel P. Berrange 3995b9174d4fSDaniel P. BerrangeCreates a memory file backend object, which can be used to back 3996c7cddce1SStefan Hajnoczithe guest RAM with huge pages. 3997c7cddce1SStefan Hajnoczi 3998c7cddce1SStefan HajnocziThe @option{id} parameter is a unique ID that will be used to reference this 3999c7cddce1SStefan Hajnoczimemory region when configuring the @option{-numa} argument. 4000c7cddce1SStefan Hajnoczi 4001c7cddce1SStefan HajnocziThe @option{size} option provides the size of the memory region, and accepts 4002c7cddce1SStefan Hajnoczicommon suffixes, eg @option{500M}. 4003c7cddce1SStefan Hajnoczi 4004c7cddce1SStefan HajnocziThe @option{mem-path} provides the path to either a shared memory or huge page 4005c7cddce1SStefan Hajnoczifilesystem mount. 4006c7cddce1SStefan Hajnoczi 4007b9174d4fSDaniel P. BerrangeThe @option{share} boolean option determines whether the memory 4008b9174d4fSDaniel P. Berrangeregion is marked as private to QEMU, or shared. The latter allows 4009b9174d4fSDaniel P. Berrangea co-operating external process to access the QEMU memory region. 4010c7cddce1SStefan Hajnoczi 401106329cceSMarcel ApfelbaumThe @option{share} is also required for pvrdma devices due to 401206329cceSMarcel Apfelbaumlimitations in the RDMA API provided by Linux. 401306329cceSMarcel Apfelbaum 401406329cceSMarcel ApfelbaumSetting share=on might affect the ability to configure NUMA 401506329cceSMarcel Apfelbaumbindings for the memory backend under some circumstances, see 401606329cceSMarcel ApfelbaumDocumentation/vm/numa_memory_policy.txt on the Linux kernel 401706329cceSMarcel Apfelbaumsource tree for additional details. 401806329cceSMarcel Apfelbaum 401911ae6ed8SEduardo HabkostSetting the @option{discard-data} boolean option to @var{on} 402011ae6ed8SEduardo Habkostindicates that file contents can be destroyed when QEMU exits, 402111ae6ed8SEduardo Habkostto avoid unnecessarily flushing data to the backing file. Note 402211ae6ed8SEduardo Habkostthat @option{discard-data} is only an optimization, and QEMU 402311ae6ed8SEduardo Habkostmight not discard file contents if it aborts unexpectedly or is 402411ae6ed8SEduardo Habkostterminated using SIGKILL. 4025b9174d4fSDaniel P. Berrange 4026c7cddce1SStefan HajnocziThe @option{merge} boolean option enables memory merge, also known as 4027c7cddce1SStefan HajnocziMADV_MERGEABLE, so that Kernel Samepage Merging will consider the pages for 4028c7cddce1SStefan Hajnoczimemory deduplication. 4029c7cddce1SStefan Hajnoczi 4030c7cddce1SStefan HajnocziSetting the @option{dump} boolean option to @var{off} excludes the memory from 4031c7cddce1SStefan Hajnoczicore dumps. This feature is also known as MADV_DONTDUMP. 4032c7cddce1SStefan Hajnoczi 4033c7cddce1SStefan HajnocziThe @option{prealloc} boolean option enables memory preallocation. 4034c7cddce1SStefan Hajnoczi 4035c7cddce1SStefan HajnocziThe @option{host-nodes} option binds the memory range to a list of NUMA host 4036c7cddce1SStefan Hajnoczinodes. 4037c7cddce1SStefan Hajnoczi 4038c7cddce1SStefan HajnocziThe @option{policy} option sets the NUMA policy to one of the following values: 4039c7cddce1SStefan Hajnoczi 4040c7cddce1SStefan Hajnoczi@table @option 4041c7cddce1SStefan Hajnoczi@item @var{default} 4042c7cddce1SStefan Hajnoczidefault host policy 4043c7cddce1SStefan Hajnoczi 4044c7cddce1SStefan Hajnoczi@item @var{preferred} 4045c7cddce1SStefan Hajnocziprefer the given host node list for allocation 4046c7cddce1SStefan Hajnoczi 4047c7cddce1SStefan Hajnoczi@item @var{bind} 4048c7cddce1SStefan Hajnoczirestrict memory allocation to the given host node list 4049c7cddce1SStefan Hajnoczi 4050c7cddce1SStefan Hajnoczi@item @var{interleave} 4051c7cddce1SStefan Hajnocziinterleave memory allocations across the given host node list 4052c7cddce1SStefan Hajnoczi@end table 4053c7cddce1SStefan Hajnoczi 405498376843SHaozhong ZhangThe @option{align} option specifies the base address alignment when 405598376843SHaozhong ZhangQEMU mmap(2) @option{mem-path}, and accepts common suffixes, eg 405698376843SHaozhong Zhang@option{2M}. Some backend store specified by @option{mem-path} 405798376843SHaozhong Zhangrequires an alignment different than the default one used by QEMU, eg 405898376843SHaozhong Zhangthe device DAX /dev/dax0.0 requires 2M alignment rather than 4K. In 405998376843SHaozhong Zhangsuch cases, users can specify the required alignment via this option. 406098376843SHaozhong Zhang 4061a4de8552SJunyan HeThe @option{pmem} option specifies whether the backing file specified 4062a4de8552SJunyan Heby @option{mem-path} is in host persistent memory that can be accessed 4063a4de8552SJunyan Heusing the SNIA NVM programming model (e.g. Intel NVDIMM). 4064a4de8552SJunyan HeIf @option{pmem} is set to 'on', QEMU will take necessary operations to 4065a4de8552SJunyan Heguarantee the persistence of its own writes to @option{mem-path} 4066a4de8552SJunyan He(e.g. in vNVDIMM label emulation and live migration). 4067a4de8552SJunyan He 406806329cceSMarcel Apfelbaum@item -object memory-backend-ram,id=@var{id},merge=@var{on|off},dump=@var{on|off},share=@var{on|off},prealloc=@var{on|off},size=@var{size},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave} 4069cd19491aSStefan Hajnoczi 4070cd19491aSStefan HajnocziCreates a memory backend object, which can be used to back the guest RAM. 4071cd19491aSStefan HajnocziMemory backend objects offer more control than the @option{-m} option that is 4072cd19491aSStefan Hajnoczitraditionally used to define guest RAM. Please refer to 4073cd19491aSStefan Hajnoczi@option{memory-backend-file} for a description of the options. 4074cd19491aSStefan Hajnoczi 4075dbb9e0f4SMarc-André Lureau@item -object memory-backend-memfd,id=@var{id},merge=@var{on|off},dump=@var{on|off},prealloc=@var{on|off},size=@var{size},host-nodes=@var{host-nodes},policy=@var{default|preferred|bind|interleave},seal=@var{on|off},hugetlb=@var{on|off},hugetlbsize=@var{size} 4076dbb9e0f4SMarc-André Lureau 4077dbb9e0f4SMarc-André LureauCreates an anonymous memory file backend object, which allows QEMU to 4078dbb9e0f4SMarc-André Lureaushare the memory with an external process (e.g. when using 4079dbb9e0f4SMarc-André Lureauvhost-user). The memory is allocated with memfd and optional 4080dbb9e0f4SMarc-André Lureausealing. (Linux only) 4081dbb9e0f4SMarc-André Lureau 4082dbb9e0f4SMarc-André LureauThe @option{seal} option creates a sealed-file, that will block 4083dbb9e0f4SMarc-André Lureaufurther resizing the memory ('on' by default). 4084dbb9e0f4SMarc-André Lureau 4085dbb9e0f4SMarc-André LureauThe @option{hugetlb} option specify the file to be created resides in 4086dbb9e0f4SMarc-André Lureauthe hugetlbfs filesystem (since Linux 4.14). Used in conjunction with 4087dbb9e0f4SMarc-André Lureauthe @option{hugetlb} option, the @option{hugetlbsize} option specify 4088dbb9e0f4SMarc-André Lureauthe hugetlb page size on systems that support multiple hugetlb page 4089dbb9e0f4SMarc-André Lureausizes (it must be a power of 2 value supported by the system). 4090dbb9e0f4SMarc-André Lureau 4091dbb9e0f4SMarc-André LureauIn some versions of Linux, the @option{hugetlb} option is incompatible 4092dbb9e0f4SMarc-André Lureauwith the @option{seal} option (requires at least Linux 4.16). 4093dbb9e0f4SMarc-André Lureau 4094dbb9e0f4SMarc-André LureauPlease refer to @option{memory-backend-file} for a description of the 4095dbb9e0f4SMarc-André Lureauother options. 4096dbb9e0f4SMarc-André Lureau 4097b9174d4fSDaniel P. Berrange@item -object rng-random,id=@var{id},filename=@var{/dev/random} 4098b9174d4fSDaniel P. Berrange 4099b9174d4fSDaniel P. BerrangeCreates a random number generator backend which obtains entropy from 4100b9174d4fSDaniel P. Berrangea device on the host. The @option{id} parameter is a unique ID that 4101b9174d4fSDaniel P. Berrangewill be used to reference this entropy backend from the @option{virtio-rng} 4102b9174d4fSDaniel P. Berrangedevice. The @option{filename} parameter specifies which file to obtain 4103b9174d4fSDaniel P. Berrangeentropy from and if omitted defaults to @option{/dev/random}. 4104b9174d4fSDaniel P. Berrange 4105b9174d4fSDaniel P. Berrange@item -object rng-egd,id=@var{id},chardev=@var{chardevid} 4106b9174d4fSDaniel P. Berrange 4107b9174d4fSDaniel P. BerrangeCreates a random number generator backend which obtains entropy from 4108b9174d4fSDaniel P. Berrangean external daemon running on the host. The @option{id} parameter is 4109b9174d4fSDaniel P. Berrangea unique ID that will be used to reference this entropy backend from 4110b9174d4fSDaniel P. Berrangethe @option{virtio-rng} device. The @option{chardev} parameter is 4111b9174d4fSDaniel P. Berrangethe unique ID of a character device backend that provides the connection 4112b9174d4fSDaniel P. Berrangeto the RNG daemon. 4113b9174d4fSDaniel P. Berrange 4114e00adf6cSDaniel P. Berrange@item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off} 4115e00adf6cSDaniel P. Berrange 4116e00adf6cSDaniel P. BerrangeCreates a TLS anonymous credentials object, which can be used to provide 4117e00adf6cSDaniel P. BerrangeTLS support on network backends. The @option{id} parameter is a unique 4118e00adf6cSDaniel P. BerrangeID which network backends will use to access the credentials. The 4119e00adf6cSDaniel P. Berrange@option{endpoint} is either @option{server} or @option{client} depending 4120e00adf6cSDaniel P. Berrangeon whether the QEMU network backend that uses the credentials will be 4121e00adf6cSDaniel P. Berrangeacting as a client or as a server. If @option{verify-peer} is enabled 4122e00adf6cSDaniel P. Berrange(the default) then once the handshake is completed, the peer credentials 4123e00adf6cSDaniel P. Berrangewill be verified, though this is a no-op for anonymous credentials. 4124e00adf6cSDaniel P. Berrange 4125e00adf6cSDaniel P. BerrangeThe @var{dir} parameter tells QEMU where to find the credential 4126e00adf6cSDaniel P. Berrangefiles. For server endpoints, this directory may contain a file 4127e00adf6cSDaniel P. Berrange@var{dh-params.pem} providing diffie-hellman parameters to use 4128e00adf6cSDaniel P. Berrangefor the TLS server. If the file is missing, QEMU will generate 4129e00adf6cSDaniel P. Berrangea set of DH parameters at startup. This is a computationally 4130e00adf6cSDaniel P. Berrangeexpensive operation that consumes random pool entropy, so it is 4131e00adf6cSDaniel P. Berrangerecommended that a persistent set of parameters be generated 4132e00adf6cSDaniel P. Berrangeupfront and saved. 4133e00adf6cSDaniel P. Berrange 4134e1a6dc91SRichard W.M. Jones@item -object tls-creds-psk,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/keys/dir}[,username=@var{username}] 4135e1a6dc91SRichard W.M. Jones 4136e1a6dc91SRichard W.M. JonesCreates a TLS Pre-Shared Keys (PSK) credentials object, which can be used to provide 4137e1a6dc91SRichard W.M. JonesTLS support on network backends. The @option{id} parameter is a unique 4138e1a6dc91SRichard W.M. JonesID which network backends will use to access the credentials. The 4139e1a6dc91SRichard W.M. Jones@option{endpoint} is either @option{server} or @option{client} depending 4140e1a6dc91SRichard W.M. Joneson whether the QEMU network backend that uses the credentials will be 4141e1a6dc91SRichard W.M. Jonesacting as a client or as a server. For clients only, @option{username} 4142e1a6dc91SRichard W.M. Jonesis the username which will be sent to the server. If omitted 4143e1a6dc91SRichard W.M. Jonesit defaults to ``qemu''. 4144e1a6dc91SRichard W.M. Jones 4145e1a6dc91SRichard W.M. JonesThe @var{dir} parameter tells QEMU where to find the keys file. 4146e1a6dc91SRichard W.M. JonesIt is called ``@var{dir}/keys.psk'' and contains ``username:key'' 4147e1a6dc91SRichard W.M. Jonespairs. This file can most easily be created using the GnuTLS 4148e1a6dc91SRichard W.M. Jones@code{psktool} program. 4149e1a6dc91SRichard W.M. Jones 4150e1a6dc91SRichard W.M. JonesFor server endpoints, @var{dir} may also contain a file 4151e1a6dc91SRichard W.M. Jones@var{dh-params.pem} providing diffie-hellman parameters to use 4152e1a6dc91SRichard W.M. Jonesfor the TLS server. If the file is missing, QEMU will generate 4153e1a6dc91SRichard W.M. Jonesa set of DH parameters at startup. This is a computationally 4154e1a6dc91SRichard W.M. Jonesexpensive operation that consumes random pool entropy, so it is 4155e1a6dc91SRichard W.M. Jonesrecommended that a persistent set of parameters be generated 4156e1a6dc91SRichard W.M. Jonesup front and saved. 4157e1a6dc91SRichard W.M. Jones 415800e5e9dfSChristophe Fergeau@item -object tls-creds-x509,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},priority=@var{priority},verify-peer=@var{on|off},passwordid=@var{id} 415985bcbc78SDaniel P. Berrange 416085bcbc78SDaniel P. BerrangeCreates a TLS anonymous credentials object, which can be used to provide 416185bcbc78SDaniel P. BerrangeTLS support on network backends. The @option{id} parameter is a unique 416285bcbc78SDaniel P. BerrangeID which network backends will use to access the credentials. The 416385bcbc78SDaniel P. Berrange@option{endpoint} is either @option{server} or @option{client} depending 416485bcbc78SDaniel P. Berrangeon whether the QEMU network backend that uses the credentials will be 416585bcbc78SDaniel P. Berrangeacting as a client or as a server. If @option{verify-peer} is enabled 416685bcbc78SDaniel P. Berrange(the default) then once the handshake is completed, the peer credentials 416785bcbc78SDaniel P. Berrangewill be verified. With x509 certificates, this implies that the clients 416885bcbc78SDaniel P. Berrangemust be provided with valid client certificates too. 416985bcbc78SDaniel P. Berrange 417085bcbc78SDaniel P. BerrangeThe @var{dir} parameter tells QEMU where to find the credential 417185bcbc78SDaniel P. Berrangefiles. For server endpoints, this directory may contain a file 417285bcbc78SDaniel P. Berrange@var{dh-params.pem} providing diffie-hellman parameters to use 417385bcbc78SDaniel P. Berrangefor the TLS server. If the file is missing, QEMU will generate 417485bcbc78SDaniel P. Berrangea set of DH parameters at startup. This is a computationally 417585bcbc78SDaniel P. Berrangeexpensive operation that consumes random pool entropy, so it is 417685bcbc78SDaniel P. Berrangerecommended that a persistent set of parameters be generated 417785bcbc78SDaniel P. Berrangeupfront and saved. 417885bcbc78SDaniel P. Berrange 417985bcbc78SDaniel P. BerrangeFor x509 certificate credentials the directory will contain further files 418085bcbc78SDaniel P. Berrangeproviding the x509 certificates. The certificates must be stored 418185bcbc78SDaniel P. Berrangein PEM format, in filenames @var{ca-cert.pem}, @var{ca-crl.pem} (optional), 418285bcbc78SDaniel P. Berrange@var{server-cert.pem} (only servers), @var{server-key.pem} (only servers), 418385bcbc78SDaniel P. Berrange@var{client-cert.pem} (only clients), and @var{client-key.pem} (only clients). 418485bcbc78SDaniel P. Berrange 41851d7b5b4aSDaniel P. BerrangeFor the @var{server-key.pem} and @var{client-key.pem} files which 41861d7b5b4aSDaniel P. Berrangecontain sensitive private keys, it is possible to use an encrypted 41871d7b5b4aSDaniel P. Berrangeversion by providing the @var{passwordid} parameter. This provides 41881d7b5b4aSDaniel P. Berrangethe ID of a previously created @code{secret} object containing the 41891d7b5b4aSDaniel P. Berrangepassword for decryption. 41901d7b5b4aSDaniel P. Berrange 419100e5e9dfSChristophe FergeauThe @var{priority} parameter allows to override the global default 419200e5e9dfSChristophe Fergeaupriority used by gnutls. This can be useful if the system administrator 419300e5e9dfSChristophe Fergeauneeds to use a weaker set of crypto priorities for QEMU without 419400e5e9dfSChristophe Fergeaupotentially forcing the weakness onto all applications. Or conversely 419500e5e9dfSChristophe Fergeauif one wants wants a stronger default for QEMU than for all other 419600e5e9dfSChristophe Fergeauapplications, they can do this through this parameter. Its format is 419700e5e9dfSChristophe Fergeaua gnutls priority string as described at 419800e5e9dfSChristophe Fergeau@url{https://gnutls.org/manual/html_node/Priority-Strings.html}. 419900e5e9dfSChristophe Fergeau 4200338d3f41Szhanghailiang@item -object filter-buffer,id=@var{id},netdev=@var{netdevid},interval=@var{t}[,queue=@var{all|rx|tx}][,status=@var{on|off}] 42017dbb11c8SYang Hongyang 42027dbb11c8SYang HongyangInterval @var{t} can't be 0, this filter batches the packet delivery: all 42037dbb11c8SYang Hongyangpackets arriving in a given interval on netdev @var{netdevid} are delayed 42047dbb11c8SYang Hongyanguntil the end of the interval. Interval is in microseconds. 4205338d3f41Szhanghailiang@option{status} is optional that indicate whether the netfilter is 4206338d3f41Szhanghailiangon (enabled) or off (disabled), the default status for netfilter will be 'on'. 42077dbb11c8SYang Hongyang 42087dbb11c8SYang Hongyangqueue @var{all|rx|tx} is an option that can be applied to any netfilter. 42097dbb11c8SYang Hongyang 42107dbb11c8SYang Hongyang@option{all}: the filter is attached both to the receive and the transmit 42117dbb11c8SYang Hongyang queue of the netdev (default). 42127dbb11c8SYang Hongyang 42137dbb11c8SYang Hongyang@option{rx}: the filter is attached to the receive queue of the netdev, 42147dbb11c8SYang Hongyang where it will receive packets sent to the netdev. 42157dbb11c8SYang Hongyang 42167dbb11c8SYang Hongyang@option{tx}: the filter is attached to the transmit queue of the netdev, 42177dbb11c8SYang Hongyang where it will receive packets sent by the netdev. 42187dbb11c8SYang Hongyang 4219e2521f0eSZhang Chen@item -object filter-mirror,id=@var{id},netdev=@var{netdevid},outdev=@var{chardevid},queue=@var{all|rx|tx}[,vnet_hdr_support] 4220f6d3afb5SZhang Chen 4221e2521f0eSZhang Chenfilter-mirror on netdev @var{netdevid},mirror net packet to chardev@var{chardevid}, if it has the vnet_hdr_support flag, filter-mirror will mirror packet with vnet_hdr_len. 4222f6d3afb5SZhang Chen 422300d5c240SZhang Chen@item -object filter-redirector,id=@var{id},netdev=@var{netdevid},indev=@var{chardevid},outdev=@var{chardevid},queue=@var{all|rx|tx}[,vnet_hdr_support] 4224d46f75b2SZhang Chen 4225d46f75b2SZhang Chenfilter-redirector on netdev @var{netdevid},redirect filter's net packet to chardev 422600d5c240SZhang Chen@var{chardevid},and redirect indev's packet to filter.if it has the vnet_hdr_support flag, 422700d5c240SZhang Chenfilter-redirector will redirect packet with vnet_hdr_len. 4228d46f75b2SZhang ChenCreate a filter-redirector we need to differ outdev id from indev id, id can not 4229d46f75b2SZhang Chenbe the same. we can just use indev or outdev, but at least one of indev or outdev 4230d46f75b2SZhang Chenneed to be specified. 4231d46f75b2SZhang Chen 42324b39bdceSZhang Chen@item -object filter-rewriter,id=@var{id},netdev=@var{netdevid},queue=@var{all|rx|tx},[vnet_hdr_support] 4233e6eee8abSZhang Chen 4234e6eee8abSZhang ChenFilter-rewriter is a part of COLO project.It will rewrite tcp packet to 4235e6eee8abSZhang Chensecondary from primary to keep secondary tcp connection,and rewrite 4236e6eee8abSZhang Chentcp packet to primary from secondary make tcp packet can be handled by 42374b39bdceSZhang Chenclient.if it has the vnet_hdr_support flag, we can parse packet with vnet header. 4238e6eee8abSZhang Chen 4239e6eee8abSZhang Chenusage: 4240e6eee8abSZhang Chencolo secondary: 4241e6eee8abSZhang Chen-object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 4242e6eee8abSZhang Chen-object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 4243e6eee8abSZhang Chen-object filter-rewriter,id=rew0,netdev=hn0,queue=all 4244e6eee8abSZhang Chen 4245c551cd52SChanglong Xie@item -object filter-dump,id=@var{id},netdev=@var{dev}[,file=@var{filename}][,maxlen=@var{len}] 4246d3e0c032SThomas Huth 4247d3e0c032SThomas HuthDump the network traffic on netdev @var{dev} to the file specified by 4248d3e0c032SThomas Huth@var{filename}. At most @var{len} bytes (64k by default) per packet are stored. 4249d3e0c032SThomas HuthThe file format is libpcap, so it can be analyzed with tools such as tcpdump 4250d3e0c032SThomas Huthor Wireshark. 4251d3e0c032SThomas Huth 4252aa3a7032SZhang Chen@item -object colo-compare,id=@var{id},primary_in=@var{chardevid},secondary_in=@var{chardevid},outdev=@var{chardevid}[,vnet_hdr_support] 42537dce4e6fSZhang Chen 42547dce4e6fSZhang ChenColo-compare gets packet from primary_in@var{chardevid} and secondary_in@var{chardevid}, than compare primary packet with 42557dce4e6fSZhang Chensecondary packet. If the packets are same, we will output primary 42567dce4e6fSZhang Chenpacket to outdev@var{chardevid}, else we will notify colo-frame 42577dce4e6fSZhang Chendo checkpoint and send primary packet to outdev@var{chardevid}. 4258aa3a7032SZhang Chenif it has the vnet_hdr_support flag, colo compare will send/recv packet with vnet_hdr_len. 42597dce4e6fSZhang Chen 42607dce4e6fSZhang Chenwe must use it with the help of filter-mirror and filter-redirector. 42617dce4e6fSZhang Chen 42627dce4e6fSZhang Chen@example 42637dce4e6fSZhang Chen 42647dce4e6fSZhang Chenprimary: 42657dce4e6fSZhang Chen-netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown 42667dce4e6fSZhang Chen-device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66 42677dce4e6fSZhang Chen-chardev socket,id=mirror0,host=3.3.3.3,port=9003,server,nowait 42687dce4e6fSZhang Chen-chardev socket,id=compare1,host=3.3.3.3,port=9004,server,nowait 42697dce4e6fSZhang Chen-chardev socket,id=compare0,host=3.3.3.3,port=9001,server,nowait 42707dce4e6fSZhang Chen-chardev socket,id=compare0-0,host=3.3.3.3,port=9001 42717dce4e6fSZhang Chen-chardev socket,id=compare_out,host=3.3.3.3,port=9005,server,nowait 42727dce4e6fSZhang Chen-chardev socket,id=compare_out0,host=3.3.3.3,port=9005 42737dce4e6fSZhang Chen-object filter-mirror,id=m0,netdev=hn0,queue=tx,outdev=mirror0 42747dce4e6fSZhang Chen-object filter-redirector,netdev=hn0,id=redire0,queue=rx,indev=compare_out 42757dce4e6fSZhang Chen-object filter-redirector,netdev=hn0,id=redire1,queue=rx,outdev=compare0 42767dce4e6fSZhang Chen-object colo-compare,id=comp0,primary_in=compare0-0,secondary_in=compare1,outdev=compare_out0 42777dce4e6fSZhang Chen 42787dce4e6fSZhang Chensecondary: 42797dce4e6fSZhang Chen-netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,down script=/etc/qemu-ifdown 42807dce4e6fSZhang Chen-device e1000,netdev=hn0,mac=52:a4:00:12:78:66 42817dce4e6fSZhang Chen-chardev socket,id=red0,host=3.3.3.3,port=9003 42827dce4e6fSZhang Chen-chardev socket,id=red1,host=3.3.3.3,port=9004 42837dce4e6fSZhang Chen-object filter-redirector,id=f1,netdev=hn0,queue=tx,indev=red0 42847dce4e6fSZhang Chen-object filter-redirector,id=f2,netdev=hn0,queue=rx,outdev=red1 42857dce4e6fSZhang Chen 42867dce4e6fSZhang Chen@end example 42877dce4e6fSZhang Chen 42887dce4e6fSZhang ChenIf you want to know the detail of above command line, you can read 42897dce4e6fSZhang Chenthe colo-compare git log. 42907dce4e6fSZhang Chen 42911653a5f3SGonglei@item -object cryptodev-backend-builtin,id=@var{id}[,queues=@var{queues}] 42921653a5f3SGonglei 42931653a5f3SGongleiCreates a cryptodev backend which executes crypto opreation from 42941653a5f3SGongleithe QEMU cipher APIS. The @var{id} parameter is 42951653a5f3SGongleia unique ID that will be used to reference this cryptodev backend from 42961653a5f3SGongleithe @option{virtio-crypto} device. The @var{queues} parameter is optional, 42971653a5f3SGongleiwhich specify the queue number of cryptodev backend, the default of 42981653a5f3SGonglei@var{queues} is 1. 42991653a5f3SGonglei 43001653a5f3SGonglei@example 43011653a5f3SGonglei 43021653a5f3SGonglei # qemu-system-x86_64 \ 43031653a5f3SGonglei [...] \ 43041653a5f3SGonglei -object cryptodev-backend-builtin,id=cryptodev0 \ 43051653a5f3SGonglei -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \ 43061653a5f3SGonglei [...] 43071653a5f3SGonglei@end example 43081653a5f3SGonglei 4309042cea27SGonglei@item -object cryptodev-vhost-user,id=@var{id},chardev=@var{chardevid}[,queues=@var{queues}] 4310042cea27SGonglei 4311042cea27SGongleiCreates a vhost-user cryptodev backend, backed by a chardev @var{chardevid}. 4312042cea27SGongleiThe @var{id} parameter is a unique ID that will be used to reference this 4313042cea27SGongleicryptodev backend from the @option{virtio-crypto} device. 4314042cea27SGongleiThe chardev should be a unix domain socket backed one. The vhost-user uses 4315042cea27SGongleia specifically defined protocol to pass vhost ioctl replacement messages 4316042cea27SGongleito an application on the other end of the socket. 4317042cea27SGongleiThe @var{queues} parameter is optional, which specify the queue number 4318042cea27SGongleiof cryptodev backend for multiqueue vhost-user, the default of @var{queues} is 1. 4319042cea27SGonglei 4320042cea27SGonglei@example 4321042cea27SGonglei 4322042cea27SGonglei # qemu-system-x86_64 \ 4323042cea27SGonglei [...] \ 4324042cea27SGonglei -chardev socket,id=chardev0,path=/path/to/socket \ 4325042cea27SGonglei -object cryptodev-vhost-user,id=cryptodev0,chardev=chardev0 \ 4326042cea27SGonglei -device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0 \ 4327042cea27SGonglei [...] 4328042cea27SGonglei@end example 4329042cea27SGonglei 4330ac1d8878SDaniel P. Berrange@item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}] 4331ac1d8878SDaniel P. Berrange@item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}] 4332ac1d8878SDaniel P. Berrange 4333ac1d8878SDaniel P. BerrangeDefines a secret to store a password, encryption key, or some other sensitive 4334ac1d8878SDaniel P. Berrangedata. The sensitive data can either be passed directly via the @var{data} 4335ac1d8878SDaniel P. Berrangeparameter, or indirectly via the @var{file} parameter. Using the @var{data} 4336ac1d8878SDaniel P. Berrangeparameter is insecure unless the sensitive data is encrypted. 4337ac1d8878SDaniel P. Berrange 4338ac1d8878SDaniel P. BerrangeThe sensitive data can be provided in raw format (the default), or base64. 4339ac1d8878SDaniel P. BerrangeWhen encoded as JSON, the raw format only supports valid UTF-8 characters, 4340ac1d8878SDaniel P. Berrangeso base64 is recommended for sending binary data. QEMU will convert from 4341ac1d8878SDaniel P. Berrangewhich ever format is provided to the format it needs internally. eg, an 4342ac1d8878SDaniel P. BerrangeRBD password can be provided in raw format, even though it will be base64 4343ac1d8878SDaniel P. Berrangeencoded when passed onto the RBD sever. 4344ac1d8878SDaniel P. Berrange 4345ac1d8878SDaniel P. BerrangeFor added protection, it is possible to encrypt the data associated with 4346ac1d8878SDaniel P. Berrangea secret using the AES-256-CBC cipher. Use of encryption is indicated 4347ac1d8878SDaniel P. Berrangeby providing the @var{keyid} and @var{iv} parameters. The @var{keyid} 4348ac1d8878SDaniel P. Berrangeparameter provides the ID of a previously defined secret that contains 4349ac1d8878SDaniel P. Berrangethe AES-256 decryption key. This key should be 32-bytes long and be 4350ac1d8878SDaniel P. Berrangebase64 encoded. The @var{iv} parameter provides the random initialization 4351ac1d8878SDaniel P. Berrangevector used for encryption of this particular secret and should be a 435269c0b278SDaniel P. Berrangebase64 encrypted string of the 16-byte IV. 4353ac1d8878SDaniel P. Berrange 4354ac1d8878SDaniel P. BerrangeThe simplest (insecure) usage is to provide the secret inline 4355ac1d8878SDaniel P. Berrange 4356ac1d8878SDaniel P. Berrange@example 4357ac1d8878SDaniel P. Berrange 4358ac1d8878SDaniel P. Berrange # $QEMU -object secret,id=sec0,data=letmein,format=raw 4359ac1d8878SDaniel P. Berrange 4360ac1d8878SDaniel P. Berrange@end example 4361ac1d8878SDaniel P. Berrange 4362ac1d8878SDaniel P. BerrangeThe simplest secure usage is to provide the secret via a file 4363ac1d8878SDaniel P. Berrange 4364b43671f8SEric Blake # printf "letmein" > mypasswd.txt 4365ac1d8878SDaniel P. Berrange # $QEMU -object secret,id=sec0,file=mypasswd.txt,format=raw 4366ac1d8878SDaniel P. Berrange 4367ac1d8878SDaniel P. BerrangeFor greater security, AES-256-CBC should be used. To illustrate usage, 4368ac1d8878SDaniel P. Berrangeconsider the openssl command line tool which can encrypt the data. Note 4369ac1d8878SDaniel P. Berrangethat when encrypting, the plaintext must be padded to the cipher block 4370ac1d8878SDaniel P. Berrangesize (32 bytes) using the standard PKCS#5/6 compatible padding algorithm. 4371ac1d8878SDaniel P. Berrange 4372ac1d8878SDaniel P. BerrangeFirst a master key needs to be created in base64 encoding: 4373ac1d8878SDaniel P. Berrange 4374ac1d8878SDaniel P. Berrange@example 4375ac1d8878SDaniel P. Berrange # openssl rand -base64 32 > key.b64 4376ac1d8878SDaniel P. Berrange # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"') 4377ac1d8878SDaniel P. Berrange@end example 4378ac1d8878SDaniel P. Berrange 4379ac1d8878SDaniel P. BerrangeEach secret to be encrypted needs to have a random initialization vector 4380ac1d8878SDaniel P. Berrangegenerated. These do not need to be kept secret 4381ac1d8878SDaniel P. Berrange 4382ac1d8878SDaniel P. Berrange@example 4383ac1d8878SDaniel P. Berrange # openssl rand -base64 16 > iv.b64 4384ac1d8878SDaniel P. Berrange # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"') 4385ac1d8878SDaniel P. Berrange@end example 4386ac1d8878SDaniel P. Berrange 4387ac1d8878SDaniel P. BerrangeThe secret to be defined can now be encrypted, in this case we're 4388ac1d8878SDaniel P. Berrangetelling openssl to base64 encode the result, but it could be left 4389ac1d8878SDaniel P. Berrangeas raw bytes if desired. 4390ac1d8878SDaniel P. Berrange 4391ac1d8878SDaniel P. Berrange@example 4392b43671f8SEric Blake # SECRET=$(printf "letmein" | 4393ac1d8878SDaniel P. Berrange openssl enc -aes-256-cbc -a -K $KEY -iv $IV) 4394ac1d8878SDaniel P. Berrange@end example 4395ac1d8878SDaniel P. Berrange 4396ac1d8878SDaniel P. BerrangeWhen launching QEMU, create a master secret pointing to @code{key.b64} 4397ac1d8878SDaniel P. Berrangeand specify that to be used to decrypt the user password. Pass the 4398ac1d8878SDaniel P. Berrangecontents of @code{iv.b64} to the second secret 4399ac1d8878SDaniel P. Berrange 4400ac1d8878SDaniel P. Berrange@example 4401ac1d8878SDaniel P. Berrange # $QEMU \ 4402ac1d8878SDaniel P. Berrange -object secret,id=secmaster0,format=base64,file=key.b64 \ 4403ac1d8878SDaniel P. Berrange -object secret,id=sec0,keyid=secmaster0,format=base64,\ 4404ac1d8878SDaniel P. Berrange data=$SECRET,iv=$(<iv.b64) 4405ac1d8878SDaniel P. Berrange@end example 4406ac1d8878SDaniel P. Berrange 4407a9b4942fSBrijesh Singh@item -object sev-guest,id=@var{id},cbitpos=@var{cbitpos},reduced-phys-bits=@var{val},[sev-device=@var{string},policy=@var{policy},handle=@var{handle},dh-cert-file=@var{file},session-file=@var{file}] 4408a9b4942fSBrijesh Singh 4409a9b4942fSBrijesh SinghCreate a Secure Encrypted Virtualization (SEV) guest object, which can be used 4410a9b4942fSBrijesh Singhto provide the guest memory encryption support on AMD processors. 4411a9b4942fSBrijesh Singh 4412a9b4942fSBrijesh SinghWhen memory encryption is enabled, one of the physical address bit (aka the 4413a9b4942fSBrijesh SinghC-bit) is utilized to mark if a memory page is protected. The @option{cbitpos} 4414a9b4942fSBrijesh Singhis used to provide the C-bit position. The C-bit position is Host family dependent 4415a9b4942fSBrijesh Singhhence user must provide this value. On EPYC, the value should be 47. 4416a9b4942fSBrijesh Singh 4417a9b4942fSBrijesh SinghWhen memory encryption is enabled, we loose certain bits in physical address space. 4418a9b4942fSBrijesh SinghThe @option{reduced-phys-bits} is used to provide the number of bits we loose in 4419a9b4942fSBrijesh Singhphysical address space. Similar to C-bit, the value is Host family dependent. 4420a9b4942fSBrijesh SinghOn EPYC, the value should be 5. 4421a9b4942fSBrijesh Singh 4422a9b4942fSBrijesh SinghThe @option{sev-device} provides the device file to use for communicating with 4423a9b4942fSBrijesh Singhthe SEV firmware running inside AMD Secure Processor. The default device is 4424a9b4942fSBrijesh Singh'/dev/sev'. If hardware supports memory encryption then /dev/sev devices are 4425a9b4942fSBrijesh Singhcreated by CCP driver. 4426a9b4942fSBrijesh Singh 4427a9b4942fSBrijesh SinghThe @option{policy} provides the guest policy to be enforced by the SEV firmware 4428a9b4942fSBrijesh Singhand restrict what configuration and operational commands can be performed on this 4429a9b4942fSBrijesh Singhguest by the hypervisor. The policy should be provided by the guest owner and is 4430a9b4942fSBrijesh Singhbound to the guest and cannot be changed throughout the lifetime of the guest. 4431a9b4942fSBrijesh SinghThe default is 0. 4432a9b4942fSBrijesh Singh 4433a9b4942fSBrijesh SinghIf guest @option{policy} allows sharing the key with another SEV guest then 4434a9b4942fSBrijesh Singh@option{handle} can be use to provide handle of the guest from which to share 4435a9b4942fSBrijesh Singhthe key. 4436a9b4942fSBrijesh Singh 4437a9b4942fSBrijesh SinghThe @option{dh-cert-file} and @option{session-file} provides the guest owner's 4438a9b4942fSBrijesh SinghPublic Diffie-Hillman key defined in SEV spec. The PDH and session parameters 4439a9b4942fSBrijesh Singhare used for establishing a cryptographic session with the guest owner to 4440a9b4942fSBrijesh Singhnegotiate keys used for attestation. The file must be encoded in base64. 4441a9b4942fSBrijesh Singh 4442a9b4942fSBrijesh Singhe.g to launch a SEV guest 4443a9b4942fSBrijesh Singh@example 4444a9b4942fSBrijesh Singh # $QEMU \ 4445a9b4942fSBrijesh Singh ...... 4446a9b4942fSBrijesh Singh -object sev-guest,id=sev0,cbitpos=47,reduced-phys-bits=5 \ 4447a9b4942fSBrijesh Singh -machine ...,memory-encryption=sev0 4448a9b4942fSBrijesh Singh ..... 4449a9b4942fSBrijesh Singh 4450a9b4942fSBrijesh Singh@end example 4451b9174d4fSDaniel P. Berrange@end table 4452b9174d4fSDaniel P. Berrange 4453b9174d4fSDaniel P. BerrangeETEXI 4454b9174d4fSDaniel P. Berrange 4455b9174d4fSDaniel P. Berrange 44563dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 44573dbf2c7fSStefan WeilSTEXI 44583dbf2c7fSStefan Weil@end table 44593dbf2c7fSStefan WeilETEXI 4460