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 95824d651Sblueswir1DEFHEADING(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" 346a48ffaaSJan Kiszka " supported accelerators are kvm, xen, tcg (default: tcg)\n" 3539d6960aSJan Kiszka " kernel_irqchip=on|off controls accelerated irqchip support\n" 3632c18a2dSMatt Gingell " kernel_irqchip=on|off|split controls accelerated irqchip support (default=off)\n" 37d1048befSDon Slutz " vmport=on|off|auto controls emulation of vmport (default: auto)\n" 38ddb97f1dSJason Baron " kvm_shadow_mem=size of KVM shadow MMU\n" 398490fc78SLuiz Capitulino " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 40a52a7fdfSLe Tan " mem-merge=on|off controls memory merge support (default: on)\n" 412eb1cd07STony Krowiak " iommu=on|off controls emulated Intel IOMMU (VT-d) support (default=off)\n" 4279814179STiejun Chen " igd-passthru=on|off controls IGD GFX passthrough support (default=off)\n" 432eb1cd07STony Krowiak " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n" 449850c604SAlexander Graf " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n" 4587252e1bSXiao Guangrong " suppress-vmdesc=on|off disables self-describing migration (default=off)\n" 4687252e1bSXiao Guangrong " nvdimm=on|off controls NVDIMM support (default=off)\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 5280f52a66SJan Kiszkaavailable machines. Supported machine properties are: 5380f52a66SJan Kiszka@table @option 5480f52a66SJan Kiszka@item accel=@var{accels1}[:@var{accels2}[:...]] 5580f52a66SJan KiszkaThis is used to enable an accelerator. Depending on the target architecture, 5680f52a66SJan Kiszkakvm, xen, or tcg can be available. By default, tcg is used. If there is more 5780f52a66SJan Kiszkathan one accelerator specified, the next one is used if the previous one fails 5880f52a66SJan Kiszkato initialize. 596a48ffaaSJan Kiszka@item kernel_irqchip=on|off 6032c18a2dSMatt GingellControls in-kernel irqchip support for the chosen accelerator when available. 6179814179STiejun Chen@item gfx_passthru=on|off 6279814179STiejun ChenEnables IGD GFX passthrough support for the chosen machine when available. 63d1048befSDon Slutz@item vmport=on|off|auto 64d1048befSDon SlutzEnables emulation of VMWare IO port, for vmmouse etc. auto says to select the 65d1048befSDon Slutzvalue based on accel. For accel=xen the default is off otherwise the default 66d1048befSDon Slutzis on. 6739d6960aSJan Kiszka@item kvm_shadow_mem=size 6839d6960aSJan KiszkaDefines the size of the KVM shadow MMU. 69ddb97f1dSJason Baron@item dump-guest-core=on|off 70ddb97f1dSJason BaronInclude guest memory in a core dump. The default is on. 718490fc78SLuiz Capitulino@item mem-merge=on|off 728490fc78SLuiz CapitulinoEnables or disables memory merge support. This feature, when supported by 738490fc78SLuiz Capitulinothe host, de-duplicates identical memory pages among VMs instances 748490fc78SLuiz Capitulino(enabled by default). 75a52a7fdfSLe Tan@item iommu=on|off 76a52a7fdfSLe TanEnables or disables emulated Intel IOMMU (VT-d) support. The default is off. 772eb1cd07STony Krowiak@item aes-key-wrap=on|off 782eb1cd07STony KrowiakEnables or disables AES key wrapping support on s390-ccw hosts. This feature 792eb1cd07STony Krowiakcontrols whether AES wrapping keys will be created to allow 802eb1cd07STony Krowiakexecution of AES cryptographic functions. The default is on. 812eb1cd07STony Krowiak@item dea-key-wrap=on|off 822eb1cd07STony KrowiakEnables or disables DEA key wrapping support on s390-ccw hosts. This feature 832eb1cd07STony Krowiakcontrols whether DEA wrapping keys will be created to allow 842eb1cd07STony Krowiakexecution of DEA cryptographic functions. The default is on. 8587252e1bSXiao Guangrong@item nvdimm=on|off 8687252e1bSXiao GuangrongEnables or disables NVDIMM support. The default is off. 8780f52a66SJan Kiszka@end table 885824d651Sblueswir1ETEXI 895824d651Sblueswir1 9080f52a66SJan KiszkaHXCOMM Deprecated by -machine 9180f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 9280f52a66SJan Kiszka 935824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 94585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 955824d651Sblueswir1STEXI 965824d651Sblueswir1@item -cpu @var{model} 976616b2adSStefan Weil@findex -cpu 98585f6036SPeter MaydellSelect CPU model (@code{-cpu help} for list and additional feature selection) 995824d651Sblueswir1ETEXI 1005824d651Sblueswir1 1015824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 10212b7f57eSMichael Tokarev "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 1036be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 1046be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 105ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 10658a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 10758a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 108ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 109ad96090aSBlue Swirl QEMU_ARCH_ALL) 1105824d651Sblueswir1STEXI 11112b7f57eSMichael Tokarev@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 1126616b2adSStefan Weil@findex -smp 1135824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 1145824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 1155824d651Sblueswir1to 4. 11658a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 11758a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 11858a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 11958a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 12058a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 1215824d651Sblueswir1ETEXI 1225824d651Sblueswir1 123268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 1247febe36fSPaolo Bonzini "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n" 1257febe36fSPaolo Bonzini "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 126268a362cSaliguoriSTEXI 1274932b897SLuiz Capitulino@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] 128f9cfd655SMarkus Armbruster@itemx -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] 1296616b2adSStefan Weil@findex -numa 1307febe36fSPaolo BonziniSimulate a multi node NUMA system. If @samp{mem}, @samp{memdev} 1314932b897SLuiz Capitulinoand @samp{cpus} are omitted, resources are split equally. Also, note 1324932b897SLuiz Capitulinothat the -@option{numa} option doesn't allocate any of the specified 1334932b897SLuiz Capitulinoresources. That is, it just assigns existing resources to NUMA nodes. This 1344932b897SLuiz Capitulinomeans that one still has to use the @option{-m}, @option{-smp} options 1357febe36fSPaolo Bonzinito allocate RAM and VCPUs respectively, and possibly @option{-object} 1367febe36fSPaolo Bonzinito specify the memory backend for the @samp{memdev} suboption. 1377febe36fSPaolo Bonzini 1387febe36fSPaolo Bonzini@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one 1397febe36fSPaolo Bonzininode uses @samp{memdev}, all of them have to use it. 140268a362cSaliguoriETEXI 141268a362cSaliguori 14210adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 14310adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 14410adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 14510adb8beSMarkus ArmbrusterSTEXI 14610adb8beSMarkus Armbruster@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 14710adb8beSMarkus Armbruster@findex -add-fd 14810adb8beSMarkus Armbruster 14910adb8beSMarkus ArmbrusterAdd a file descriptor to an fd set. Valid options are: 15010adb8beSMarkus Armbruster 15110adb8beSMarkus Armbruster@table @option 15210adb8beSMarkus Armbruster@item fd=@var{fd} 15310adb8beSMarkus ArmbrusterThis option defines the file descriptor of which a duplicate is added to fd set. 15410adb8beSMarkus ArmbrusterThe file descriptor cannot be stdin, stdout, or stderr. 15510adb8beSMarkus Armbruster@item set=@var{set} 15610adb8beSMarkus ArmbrusterThis option defines the ID of the fd set to add the file descriptor to. 15710adb8beSMarkus Armbruster@item opaque=@var{opaque} 15810adb8beSMarkus ArmbrusterThis option defines a free-form string that can be used to describe @var{fd}. 15910adb8beSMarkus Armbruster@end table 16010adb8beSMarkus Armbruster 16110adb8beSMarkus ArmbrusterYou can open an image using pre-opened file descriptors from an fd set: 16210adb8beSMarkus Armbruster@example 16310adb8beSMarkus Armbrusterqemu-system-i386 16410adb8beSMarkus Armbruster-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 16510adb8beSMarkus Armbruster-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 16610adb8beSMarkus Armbruster-drive file=/dev/fdset/2,index=0,media=disk 16710adb8beSMarkus Armbruster@end example 16810adb8beSMarkus ArmbrusterETEXI 16910adb8beSMarkus Armbruster 17010adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 17110adb8beSMarkus Armbruster "-set group.id.arg=value\n" 17210adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 17310adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 17410adb8beSMarkus ArmbrusterSTEXI 17510adb8beSMarkus Armbruster@item -set @var{group}.@var{id}.@var{arg}=@var{value} 17610adb8beSMarkus Armbruster@findex -set 17710adb8beSMarkus ArmbrusterSet parameter @var{arg} for item @var{id} of type @var{group}\n" 17810adb8beSMarkus ArmbrusterETEXI 17910adb8beSMarkus Armbruster 18010adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 1813751d7c4SPaolo Bonzini "-global driver.property=value\n" 1823751d7c4SPaolo Bonzini "-global driver=driver,property=property,value=value\n" 18310adb8beSMarkus Armbruster " set a global default for a driver property\n", 18410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 18510adb8beSMarkus ArmbrusterSTEXI 18610adb8beSMarkus Armbruster@item -global @var{driver}.@var{prop}=@var{value} 1873751d7c4SPaolo Bonzini@itemx -global driver=@var{driver},property=@var{property},value=@var{value} 18810adb8beSMarkus Armbruster@findex -global 18910adb8beSMarkus ArmbrusterSet default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 19010adb8beSMarkus Armbruster 19110adb8beSMarkus Armbruster@example 19210adb8beSMarkus Armbrusterqemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk 19310adb8beSMarkus Armbruster@end example 19410adb8beSMarkus Armbruster 19510adb8beSMarkus ArmbrusterIn particular, you can use this to set driver properties for devices which are 19610adb8beSMarkus Armbrustercreated automatically by the machine model. To create a device which is not 19710adb8beSMarkus Armbrustercreated automatically and set properties on it, use -@option{device}. 1983751d7c4SPaolo Bonzini 199ae08fd5aSMarkus Armbruster-global @var{driver}.@var{prop}=@var{value} is shorthand for -global 200ae08fd5aSMarkus Armbrusterdriver=@var{driver},property=@var{prop},value=@var{value}. The 201ae08fd5aSMarkus Armbrusterlonghand syntax works even when @var{driver} contains a dot. 20210adb8beSMarkus ArmbrusterETEXI 20310adb8beSMarkus Armbruster 20410adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 20510adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 206c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 20710adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 20810adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 20910adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 21010adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 21110adb8beSMarkus Armbruster QEMU_ARCH_ALL) 21210adb8beSMarkus ArmbrusterSTEXI 213c8a6ae8bSAmos 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] 21410adb8beSMarkus Armbruster@findex -boot 21510adb8beSMarkus ArmbrusterSpecify boot order @var{drives} as a string of drive letters. Valid 216d274e07cSGongleidrive letters depend on the target architecture. The x86 PC uses: a, b 21710adb8beSMarkus Armbruster(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 21810adb8beSMarkus Armbrusterfrom network adapter 1-4), hard disk boot is the default. To apply a 21910adb8beSMarkus Armbrusterparticular boot order only on the first startup, specify it via 22010adb8beSMarkus Armbruster@option{once}. 22110adb8beSMarkus Armbruster 22210adb8beSMarkus ArmbrusterInteractive boot menus/prompts can be enabled via @option{menu=on} as far 22310adb8beSMarkus Armbrusteras firmware/BIOS supports them. The default is non-interactive boot. 22410adb8beSMarkus Armbruster 22510adb8beSMarkus ArmbrusterA splash picture could be passed to bios, enabling user to show it as logo, 22610adb8beSMarkus Armbrusterwhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 22710adb8beSMarkus Armbrustersupports them. Currently Seabios for X86 system support it. 22810adb8beSMarkus Armbrusterlimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 22910adb8beSMarkus Armbrusterformat(true color). The resolution should be supported by the SVGA mode, so 23010adb8beSMarkus Armbrusterthe recommended is 320x240, 640x480, 800x640. 23110adb8beSMarkus Armbruster 23210adb8beSMarkus ArmbrusterA timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 23310adb8beSMarkus Armbrusterwhen boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not 23410adb8beSMarkus Armbrusterreboot, qemu passes '-1' to bios by default. Currently Seabios for X86 23510adb8beSMarkus Armbrustersystem support it. 23610adb8beSMarkus Armbruster 237c8a6ae8bSAmos KongDo strict boot via @option{strict=on} as far as firmware/BIOS 238c8a6ae8bSAmos Kongsupports it. This only effects when boot priority is changed by 239c8a6ae8bSAmos Kongbootindex options. The default is non-strict boot. 240c8a6ae8bSAmos Kong 24110adb8beSMarkus Armbruster@example 24210adb8beSMarkus Armbruster# try to boot from network first, then from hard disk 24310adb8beSMarkus Armbrusterqemu-system-i386 -boot order=nc 24410adb8beSMarkus Armbruster# boot from CD-ROM first, switch back to default order after reboot 24510adb8beSMarkus Armbrusterqemu-system-i386 -boot once=d 24610adb8beSMarkus Armbruster# boot with a splash picture for 5 seconds. 24710adb8beSMarkus Armbrusterqemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 24810adb8beSMarkus Armbruster@end example 24910adb8beSMarkus Armbruster 25010adb8beSMarkus ArmbrusterNote: The legacy format '-boot @var{drives}' is still supported but its 25110adb8beSMarkus Armbrusteruse is discouraged as it may be removed from future versions. 25210adb8beSMarkus ArmbrusterETEXI 25310adb8beSMarkus Armbruster 25410adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 255c270fb9eSIgor Mammedov "-m[emory] [size=]megs[,slots=n,maxmem=size]\n" 2566e1d3c1cSIgor Mammedov " configure guest RAM\n" 2570daba1f0SAlexander Graf " size: initial amount of guest memory\n" 258c270fb9eSIgor Mammedov " slots: number of hotplug slots (default: none)\n" 259b6fe0124SMatthew Rosato " maxmem: maximum amount of guest memory (default: none)\n" 260b6fe0124SMatthew Rosato "NOTE: Some architectures might enforce a specific granularity\n", 2616e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 26210adb8beSMarkus ArmbrusterSTEXI 2639fcc0794SLuiz Capitulino@item -m [size=]@var{megs}[,slots=n,maxmem=size] 26410adb8beSMarkus Armbruster@findex -m 2659fcc0794SLuiz CapitulinoSets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB. 2669fcc0794SLuiz CapitulinoOptionally, a suffix of ``M'' or ``G'' can be used to signify a value in 2679fcc0794SLuiz Capitulinomegabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem} 2689fcc0794SLuiz Capitulinocould be used to set amount of hotpluggable memory slots and maximum amount of 2699fcc0794SLuiz Capitulinomemory. Note that @var{maxmem} must be aligned to the page size. 2709fcc0794SLuiz Capitulino 2719fcc0794SLuiz CapitulinoFor example, the following command-line sets the guest startup RAM size to 2729fcc0794SLuiz Capitulino1GB, creates 3 slots to hotplug additional memory and sets the maximum 2739fcc0794SLuiz Capitulinomemory the guest can reach to 4GB: 2749fcc0794SLuiz Capitulino 2759fcc0794SLuiz Capitulino@example 2769fcc0794SLuiz Capitulinoqemu-system-x86_64 -m 1G,slots=3,maxmem=4G 2779fcc0794SLuiz Capitulino@end example 2789fcc0794SLuiz Capitulino 2799fcc0794SLuiz CapitulinoIf @var{slots} and @var{maxmem} are not specified, memory hotplug won't 2809fcc0794SLuiz Capitulinobe enabled and the guest startup RAM will never increase. 28110adb8beSMarkus ArmbrusterETEXI 28210adb8beSMarkus Armbruster 28310adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 28410adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 28510adb8beSMarkus ArmbrusterSTEXI 28610adb8beSMarkus Armbruster@item -mem-path @var{path} 28710adb8beSMarkus Armbruster@findex -mem-path 28810adb8beSMarkus ArmbrusterAllocate guest RAM from a temporarily created file in @var{path}. 28910adb8beSMarkus ArmbrusterETEXI 29010adb8beSMarkus Armbruster 29110adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 29210adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 29310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 29410adb8beSMarkus ArmbrusterSTEXI 29510adb8beSMarkus Armbruster@item -mem-prealloc 29610adb8beSMarkus Armbruster@findex -mem-prealloc 29710adb8beSMarkus ArmbrusterPreallocate memory when using -mem-path. 29810adb8beSMarkus ArmbrusterETEXI 29910adb8beSMarkus Armbruster 30010adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 30110adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 30210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 30310adb8beSMarkus ArmbrusterSTEXI 30410adb8beSMarkus Armbruster@item -k @var{language} 30510adb8beSMarkus Armbruster@findex -k 30610adb8beSMarkus ArmbrusterUse keyboard layout @var{language} (for example @code{fr} for 30710adb8beSMarkus ArmbrusterFrench). This option is only needed where it is not easy to get raw PC 30810adb8beSMarkus Armbrusterkeycodes (e.g. on Macs, with some X11 servers or with a VNC 30910adb8beSMarkus Armbrusterdisplay). You don't normally need to use it on PC/Linux or PC/Windows 31010adb8beSMarkus Armbrusterhosts. 31110adb8beSMarkus Armbruster 31210adb8beSMarkus ArmbrusterThe available layouts are: 31310adb8beSMarkus Armbruster@example 31410adb8beSMarkus Armbrusterar de-ch es fo fr-ca hu ja mk no pt-br sv 31510adb8beSMarkus Armbrusterda en-gb et fr fr-ch is lt nl pl ru th 31610adb8beSMarkus Armbrusterde en-us fi fr-be hr it lv nl-be pt sl tr 31710adb8beSMarkus Armbruster@end example 31810adb8beSMarkus Armbruster 31910adb8beSMarkus ArmbrusterThe default is @code{en-us}. 32010adb8beSMarkus ArmbrusterETEXI 32110adb8beSMarkus Armbruster 32210adb8beSMarkus Armbruster 32310adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 32410adb8beSMarkus Armbruster "-audio-help print list of audio drivers and their options\n", 32510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 32610adb8beSMarkus ArmbrusterSTEXI 32710adb8beSMarkus Armbruster@item -audio-help 32810adb8beSMarkus Armbruster@findex -audio-help 32910adb8beSMarkus ArmbrusterWill show the audio subsystem help: list of drivers, tunable 33010adb8beSMarkus Armbrusterparameters. 33110adb8beSMarkus ArmbrusterETEXI 33210adb8beSMarkus Armbruster 33310adb8beSMarkus ArmbrusterDEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 33410adb8beSMarkus Armbruster "-soundhw c1,... enable audio support\n" 33510adb8beSMarkus Armbruster " and only specified sound cards (comma separated list)\n" 33610adb8beSMarkus Armbruster " use '-soundhw help' to get the list of supported cards\n" 33710adb8beSMarkus Armbruster " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 33810adb8beSMarkus ArmbrusterSTEXI 33910adb8beSMarkus Armbruster@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 34010adb8beSMarkus Armbruster@findex -soundhw 34110adb8beSMarkus ArmbrusterEnable audio and selected sound hardware. Use 'help' to print all 34210adb8beSMarkus Armbrusteravailable sound hardware. 34310adb8beSMarkus Armbruster 34410adb8beSMarkus Armbruster@example 34510adb8beSMarkus Armbrusterqemu-system-i386 -soundhw sb16,adlib disk.img 34610adb8beSMarkus Armbrusterqemu-system-i386 -soundhw es1370 disk.img 34710adb8beSMarkus Armbrusterqemu-system-i386 -soundhw ac97 disk.img 34810adb8beSMarkus Armbrusterqemu-system-i386 -soundhw hda disk.img 34910adb8beSMarkus Armbrusterqemu-system-i386 -soundhw all disk.img 35010adb8beSMarkus Armbrusterqemu-system-i386 -soundhw help 35110adb8beSMarkus Armbruster@end example 35210adb8beSMarkus Armbruster 35310adb8beSMarkus ArmbrusterNote that Linux's i810_audio OSS kernel (for AC97) module might 35410adb8beSMarkus Armbrusterrequire manually specifying clocking. 35510adb8beSMarkus Armbruster 35610adb8beSMarkus Armbruster@example 35710adb8beSMarkus Armbrustermodprobe i810_audio clocking=48000 35810adb8beSMarkus Armbruster@end example 35910adb8beSMarkus ArmbrusterETEXI 36010adb8beSMarkus Armbruster 36110adb8beSMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 36210adb8beSMarkus Armbruster "-balloon none disable balloon device\n" 36310adb8beSMarkus Armbruster "-balloon virtio[,addr=str]\n" 36410adb8beSMarkus Armbruster " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 36510adb8beSMarkus ArmbrusterSTEXI 36610adb8beSMarkus Armbruster@item -balloon none 36710adb8beSMarkus Armbruster@findex -balloon 36810adb8beSMarkus ArmbrusterDisable balloon device. 36910adb8beSMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 37010adb8beSMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 37110adb8beSMarkus Armbruster@var{addr}. 37210adb8beSMarkus ArmbrusterETEXI 37310adb8beSMarkus Armbruster 37410adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 37510adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 37610adb8beSMarkus Armbruster " add device (based on driver)\n" 37710adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 37810adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 37910adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 38010adb8beSMarkus Armbruster QEMU_ARCH_ALL) 38110adb8beSMarkus ArmbrusterSTEXI 38210adb8beSMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 38310adb8beSMarkus Armbruster@findex -device 38410adb8beSMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 38510adb8beSMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 38610adb8beSMarkus Armbrusterpossible drivers and properties, use @code{-device help} and 38710adb8beSMarkus Armbruster@code{-device @var{driver},help}. 388f8490451SCorey Minyard 389f8490451SCorey MinyardSome drivers are: 390f8490451SCorey Minyard@item -device ipmi-bmc-sim,id=@var{id}[,slave_addr=@var{val}] 391f8490451SCorey Minyard 392f8490451SCorey MinyardAdd an IPMI BMC. This is a simulation of a hardware management 393f8490451SCorey Minyardinterface processor that normally sits on a system. It provides 394f8490451SCorey Minyarda watchdog and the ability to reset and power control the system. 395f8490451SCorey MinyardYou need to connect this to an IPMI interface to make it useful 396f8490451SCorey Minyard 397f8490451SCorey MinyardThe IPMI slave address to use for the BMC. The default is 0x20. 398f8490451SCorey MinyardThis address is the BMC's address on the I2C network of management 399f8490451SCorey Minyardcontrollers. If you don't know what this means, it is safe to ignore 400f8490451SCorey Minyardit. 401f8490451SCorey Minyard 402f8490451SCorey Minyard@item -device ipmi-bmc-extern,id=@var{id},chardev=@var{id}[,slave_addr=@var{val}] 403f8490451SCorey Minyard 404f8490451SCorey MinyardAdd a connection to an external IPMI BMC simulator. Instead of 405f8490451SCorey Minyardlocally emulating the BMC like the above item, instead connect 406f8490451SCorey Minyardto an external entity that provides the IPMI services. 407f8490451SCorey Minyard 408f8490451SCorey MinyardA connection is made to an external BMC simulator. If you do this, it 409f8490451SCorey Minyardis strongly recommended that you use the "reconnect=" chardev option 410f8490451SCorey Minyardto reconnect to the simulator if the connection is lost. Note that if 411f8490451SCorey Minyardthis is not used carefully, it can be a security issue, as the 412f8490451SCorey Minyardinterface has the ability to send resets, NMIs, and power off the VM. 413f8490451SCorey MinyardIt's best if QEMU makes a connection to an external simulator running 414f8490451SCorey Minyardon a secure port on localhost, so neither the simulator nor QEMU is 415f8490451SCorey Minyardexposed to any outside network. 416f8490451SCorey Minyard 417f8490451SCorey MinyardSee the "lanserv/README.vm" file in the OpenIPMI library for more 418f8490451SCorey Minyarddetails on the external interface. 419f8490451SCorey Minyard 420f8490451SCorey Minyard@item -device isa-ipmi-kcs,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}] 421f8490451SCorey Minyard 422f8490451SCorey MinyardAdd a KCS IPMI interafce on the ISA bus. This also adds a 423f8490451SCorey Minyardcorresponding ACPI and SMBIOS entries, if appropriate. 424f8490451SCorey Minyard 425f8490451SCorey Minyard@table @option 426f8490451SCorey Minyard@item bmc=@var{id} 427f8490451SCorey MinyardThe BMC to connect to, one of ipmi-bmc-sim or ipmi-bmc-extern above. 428f8490451SCorey Minyard@item ioport=@var{val} 429f8490451SCorey MinyardDefine the I/O address of the interface. The default is 0xca0 for KCS. 430f8490451SCorey Minyard@item irq=@var{val} 431f8490451SCorey MinyardDefine the interrupt to use. The default is 5. To disable interrupts, 432f8490451SCorey Minyardset this to 0. 433f8490451SCorey Minyard@end table 434f8490451SCorey Minyard 435f8490451SCorey Minyard@item -device isa-ipmi-bt,bmc=@var{id}[,ioport=@var{val}][,irq=@var{val}] 436f8490451SCorey Minyard 437f8490451SCorey MinyardLike the KCS interface, but defines a BT interface. The default port is 438f8490451SCorey Minyard0xe4 and the default interrupt is 5. 439f8490451SCorey Minyard 44010adb8beSMarkus ArmbrusterETEXI 44110adb8beSMarkus Armbruster 44210adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 4438f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 44410adb8beSMarkus Armbruster " set the name of the guest\n" 4458f480de0SDr. David Alan Gilbert " string1 sets the window title and string2 the process name (on Linux)\n" 4468f480de0SDr. David Alan Gilbert " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" 4478f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 44810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 44910adb8beSMarkus ArmbrusterSTEXI 45010adb8beSMarkus Armbruster@item -name @var{name} 45110adb8beSMarkus Armbruster@findex -name 45210adb8beSMarkus ArmbrusterSets the @var{name} of the guest. 45310adb8beSMarkus ArmbrusterThis name will be displayed in the SDL window caption. 45410adb8beSMarkus ArmbrusterThe @var{name} will also be used for the VNC server. 45510adb8beSMarkus ArmbrusterAlso optionally set the top visible process name in Linux. 4568f480de0SDr. David Alan GilbertNaming of individual threads can also be enabled on Linux to aid debugging. 45710adb8beSMarkus ArmbrusterETEXI 45810adb8beSMarkus Armbruster 45910adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 46010adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 46110adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 46210adb8beSMarkus ArmbrusterSTEXI 46310adb8beSMarkus Armbruster@item -uuid @var{uuid} 46410adb8beSMarkus Armbruster@findex -uuid 46510adb8beSMarkus ArmbrusterSet system UUID. 46610adb8beSMarkus ArmbrusterETEXI 46710adb8beSMarkus Armbruster 46810adb8beSMarkus ArmbrusterSTEXI 46910adb8beSMarkus Armbruster@end table 47010adb8beSMarkus ArmbrusterETEXI 47110adb8beSMarkus ArmbrusterDEFHEADING() 47210adb8beSMarkus Armbruster 47310adb8beSMarkus ArmbrusterDEFHEADING(Block device options:) 47410adb8beSMarkus ArmbrusterSTEXI 47510adb8beSMarkus Armbruster@table @option 47610adb8beSMarkus ArmbrusterETEXI 47710adb8beSMarkus Armbruster 4785824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 479ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 480ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 4815824d651Sblueswir1STEXI 4825824d651Sblueswir1@item -fda @var{file} 483f9cfd655SMarkus Armbruster@itemx -fdb @var{file} 4846616b2adSStefan Weil@findex -fda 4856616b2adSStefan Weil@findex -fdb 48692a539d2SMarkus ArmbrusterUse @var{file} as floppy disk 0/1 image (@pxref{disk_images}). 4875824d651Sblueswir1ETEXI 4885824d651Sblueswir1 4895824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 490ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 491ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 4925824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 493ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 494ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 4955824d651Sblueswir1STEXI 4965824d651Sblueswir1@item -hda @var{file} 497f9cfd655SMarkus Armbruster@itemx -hdb @var{file} 498f9cfd655SMarkus Armbruster@itemx -hdc @var{file} 499f9cfd655SMarkus Armbruster@itemx -hdd @var{file} 5006616b2adSStefan Weil@findex -hda 5016616b2adSStefan Weil@findex -hdb 5026616b2adSStefan Weil@findex -hdc 5036616b2adSStefan Weil@findex -hdd 5045824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 5055824d651Sblueswir1ETEXI 5065824d651Sblueswir1 5075824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 508ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 509ad96090aSBlue Swirl QEMU_ARCH_ALL) 5105824d651Sblueswir1STEXI 5115824d651Sblueswir1@item -cdrom @var{file} 5126616b2adSStefan Weil@findex -cdrom 5135824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 5145824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 5155824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 5165824d651Sblueswir1ETEXI 5175824d651Sblueswir1 5185824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 5195824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 5205824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 52192196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 522d1db760dSStefan Hajnoczi " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" 523d1db760dSStefan Hajnoczi " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 524fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 5252f7133b2SPeter Lieven " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 5263e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 5273e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 5283e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 5293e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 5302024c1dfSBenoît Canet " [[,iops_size=is]]\n" 53176f4afb4SAlberto Garcia " [[,group=g]]\n" 532ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 5335824d651Sblueswir1STEXI 5345824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 5356616b2adSStefan Weil@findex -drive 5365824d651Sblueswir1 5375824d651Sblueswir1Define a new drive. Valid options are: 5385824d651Sblueswir1 539b3f046c2SKevin Wolf@table @option 5405824d651Sblueswir1@item file=@var{file} 5415824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 5425824d651Sblueswir1this drive. If the filename contains comma, you must double it 5435824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 5440f5314a2SRonnie Sahlberg 5450f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 5460f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 5475824d651Sblueswir1@item if=@var{interface} 5485824d651Sblueswir1This option defines on which type on interface the drive is connected. 5495824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 5505824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 5515824d651Sblueswir1These options define where is connected the drive by defining the bus number and 5525824d651Sblueswir1the unit id. 5535824d651Sblueswir1@item index=@var{index} 5545824d651Sblueswir1This option defines where is connected the drive by using an index in the list 5555824d651Sblueswir1of available connectors of a given interface type. 5565824d651Sblueswir1@item media=@var{media} 5575824d651Sblueswir1This option defines the type of the media: disk or cdrom. 5585824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 5595824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 5605824d651Sblueswir1@item snapshot=@var{snapshot} 5619d85d557SMichael Tokarev@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive 5629d85d557SMichael Tokarev(see @option{-snapshot}). 5635824d651Sblueswir1@item cache=@var{cache} 56492196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 5655c6c3a6cSChristoph Hellwig@item aio=@var{aio} 5665c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 567a9384affSPaolo Bonzini@item discard=@var{discard} 568a9384affSPaolo Bonzini@var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) requests are ignored or passed to the filesystem. Some machine types may not support discard requests. 5695824d651Sblueswir1@item format=@var{format} 5705824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 5715824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 5725824d651Sblueswir1an untrusted format header. 5735824d651Sblueswir1@item serial=@var{serial} 5745824d651Sblueswir1This option specifies the serial number to assign to the device. 575c2cc47a4SMarkus Armbruster@item addr=@var{addr} 576c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 577ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 578ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 579ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 580ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 581ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 582ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 583ae73e591SLuiz Capitulino@item readonly 584ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 585fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 586fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 587fb0490f6SStefan Hajnoczifile sectors into the image file. 588465bee1dSPeter Lieven@item detect-zeroes=@var{detect-zeroes} 589465bee1dSPeter Lieven@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic 590465bee1dSPeter Lievenconversion of plain zero writes by the OS to driver specific optimized 591465bee1dSPeter Lievenzero write commands. You may even choose "unmap" if @var{discard} is set 592465bee1dSPeter Lievento "unmap" to allow a zero write to be converted to an UNMAP operation. 5935824d651Sblueswir1@end table 5945824d651Sblueswir1 595a13e5e05SKevin WolfBy default, the @option{cache=writeback} mode is used. It will report data 596a13e5e05SKevin Wolfwrites as completed as soon as the data is present in the host page cache. 597a13e5e05SKevin WolfThis is safe as long as your guest OS makes sure to correctly flush disk caches 598a13e5e05SKevin Wolfwhere needed. If your guest OS does not handle volatile disk write caches 599a13e5e05SKevin Wolfcorrectly and your host crashes or loses power, then the guest may experience 600a13e5e05SKevin Wolfdata corruption. 6015824d651Sblueswir1 602a13e5e05SKevin WolfFor such guests, you should consider using @option{cache=writethrough}. This 603a13e5e05SKevin Wolfmeans that the host page cache will be used to read and write data, but write 604a13e5e05SKevin Wolfnotification will be sent to the guest only after QEMU has made sure to flush 605a13e5e05SKevin Wolfeach write to the disk. Be aware that this has a major impact on performance. 6065824d651Sblueswir1 607c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 608a13e5e05SKevin Wolfattempt to do disk IO directly to the guest's memory. QEMU may still perform 609a13e5e05SKevin Wolfan internal copy of the data. Note that this is considered a writeback mode and 610a13e5e05SKevin Wolfthe guest OS must handle the disk write cache correctly in order to avoid data 611a13e5e05SKevin Wolfcorruption on host crashes. 6125824d651Sblueswir1 61392196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 614a13e5e05SKevin Wolfthe guest when the data has been flushed to the disk using 615a13e5e05SKevin Wolf@option{cache=directsync}. 6165824d651Sblueswir1 617016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 618a13e5e05SKevin Wolf@option{cache=unsafe}. This option tells QEMU that it never needs to write any 619a13e5e05SKevin Wolfdata to the disk but can instead keep things in cache. If anything goes wrong, 620e7d81004SStefan Weillike your host losing power, the disk storage getting disconnected accidentally, 621a13e5e05SKevin Wolfetc. your image will most probably be rendered unusable. When using 622c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 623016f5cf6SAlexander Graf 624fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 625fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 626fb0490f6SStefan Hajnocziis off. 627fb0490f6SStefan Hajnoczi 6285824d651Sblueswir1Instead of @option{-cdrom} you can use: 6295824d651Sblueswir1@example 6303804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=cdrom 6315824d651Sblueswir1@end example 6325824d651Sblueswir1 6335824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 6345824d651Sblueswir1use: 6355824d651Sblueswir1@example 6363804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,media=disk 6373804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,media=disk 6383804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=disk 6393804da9dSStefan Weilqemu-system-i386 -drive file=file,index=3,media=disk 6405824d651Sblueswir1@end example 6415824d651Sblueswir1 642587ed6beSCorey BryantYou can open an image using pre-opened file descriptors from an fd set: 643587ed6beSCorey Bryant@example 644587ed6beSCorey Bryantqemu-system-i386 645587ed6beSCorey Bryant-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 646587ed6beSCorey Bryant-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 647587ed6beSCorey Bryant-drive file=/dev/fdset/2,index=0,media=disk 648587ed6beSCorey Bryant@end example 649587ed6beSCorey Bryant 6505824d651Sblueswir1You can connect a CDROM to the slave of ide0: 6515824d651Sblueswir1@example 6523804da9dSStefan Weilqemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 6535824d651Sblueswir1@end example 6545824d651Sblueswir1 6555824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 6565824d651Sblueswir1@example 6573804da9dSStefan Weilqemu-system-i386 -drive if=ide,index=1,media=cdrom 6585824d651Sblueswir1@end example 6595824d651Sblueswir1 6605824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 6615824d651Sblueswir1@example 6623804da9dSStefan Weilqemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 6635824d651Sblueswir1@end example 6645824d651Sblueswir1 6655824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 6665824d651Sblueswir1@example 6673804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,if=floppy 6683804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,if=floppy 6695824d651Sblueswir1@end example 6705824d651Sblueswir1 6715824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 6725824d651Sblueswir1incremented: 6735824d651Sblueswir1@example 6743804da9dSStefan Weilqemu-system-i386 -drive file=a -drive file=b" 6755824d651Sblueswir1@end example 6765824d651Sblueswir1is interpreted like: 6775824d651Sblueswir1@example 6783804da9dSStefan Weilqemu-system-i386 -hda a -hdb b 6795824d651Sblueswir1@end example 6805824d651Sblueswir1ETEXI 6815824d651Sblueswir1 6825824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 683ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 684ad96090aSBlue Swirl QEMU_ARCH_ALL) 6855824d651Sblueswir1STEXI 6864e257e5eSKevin Wolf@item -mtdblock @var{file} 6876616b2adSStefan Weil@findex -mtdblock 6884e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 6895824d651Sblueswir1ETEXI 6905824d651Sblueswir1 6915824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 692ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 6935824d651Sblueswir1STEXI 6944e257e5eSKevin Wolf@item -sd @var{file} 6956616b2adSStefan Weil@findex -sd 6964e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 6975824d651Sblueswir1ETEXI 6985824d651Sblueswir1 6995824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 700ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 7015824d651Sblueswir1STEXI 7024e257e5eSKevin Wolf@item -pflash @var{file} 7036616b2adSStefan Weil@findex -pflash 7044e257e5eSKevin WolfUse @var{file} as a parallel flash image. 7055824d651Sblueswir1ETEXI 7065824d651Sblueswir1 7075824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 708ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 709ad96090aSBlue Swirl QEMU_ARCH_ALL) 7105824d651Sblueswir1STEXI 7115824d651Sblueswir1@item -snapshot 7126616b2adSStefan Weil@findex -snapshot 7135824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 7145824d651Sblueswir1the raw disk image you use is not written back. You can however force 7155824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 7165824d651Sblueswir1ETEXI 7175824d651Sblueswir1 71810adb8beSMarkus ArmbrusterDEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 71910adb8beSMarkus Armbruster "-hdachs c,h,s[,t]\n" \ 72010adb8beSMarkus Armbruster " force hard disk 0 physical geometry and the optional BIOS\n" \ 72110adb8beSMarkus Armbruster " translation (t=none or lba) (usually QEMU can guess them)\n", 722ad96090aSBlue Swirl QEMU_ARCH_ALL) 723c902760fSMarcelo TosattiSTEXI 72410adb8beSMarkus Armbruster@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 72510adb8beSMarkus Armbruster@findex -hdachs 72610adb8beSMarkus ArmbrusterForce hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 72710adb8beSMarkus Armbruster@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 72810adb8beSMarkus Armbrustertranslation mode (@var{t}=none, lba or auto). Usually QEMU can guess 72910adb8beSMarkus Armbrusterall those parameters. This option is useful for old MS-DOS disk 73010adb8beSMarkus Armbrusterimages. 731c70a01e4SMarkus ArmbrusterETEXI 73274db920cSGautham R Shenoy 73374db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 7342c30dd74SAneesh Kumar K.V "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 73584a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 73674db920cSGautham R Shenoy QEMU_ARCH_ALL) 73774db920cSGautham R Shenoy 73874db920cSGautham R ShenoySTEXI 73974db920cSGautham R Shenoy 74084a87cc4SM. Mohan Kumar@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}] 74174db920cSGautham R Shenoy@findex -fsdev 7427c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 7437c92a3d2SAneesh Kumar K.V@table @option 7447c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 7457c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 746f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 7477c92a3d2SAneesh Kumar K.V@item id=@var{id} 7487c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 7497c92a3d2SAneesh Kumar K.V@item path=@var{path} 7507c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 7517c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 7527c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 7537c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 7542c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 7557c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 756b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 7572c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 7587c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 7592c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 7602c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 7617c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 7627c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 763d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 764f67e3ffdSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle, proxy) don't take 765d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 7667c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 7677c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 7687c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 7697c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 7707c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 7712c74c2cbSM. Mohan Kumar@item readonly 7722c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 7732c74c2cbSM. Mohan Kumarread-write access is given. 77484a87cc4SM. Mohan Kumar@item socket=@var{socket} 77584a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for communicating 77684a87cc4SM. Mohan Kumarwith virtfs-proxy-helper 777f67e3ffdSM. Mohan Kumar@item sock_fd=@var{sock_fd} 778f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed socket descriptor for 779f67e3ffdSM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 780f67e3ffdSM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 78174db920cSGautham R Shenoy@end table 7827c92a3d2SAneesh Kumar K.V 7837c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 7847c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 7857c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 7867c92a3d2SAneesh Kumar K.V@table @option 7877c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 7887c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 7897c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 7907c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 7917c92a3d2SAneesh Kumar K.V@end table 7927c92a3d2SAneesh Kumar K.V 79374db920cSGautham R ShenoyETEXI 79474db920cSGautham R Shenoy 7953d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 7962c30dd74SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 79784a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 7983d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 7993d54abc7SGautham R Shenoy 8003d54abc7SGautham R ShenoySTEXI 8013d54abc7SGautham R Shenoy 80284a87cc4SM. Mohan Kumar@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}] 8033d54abc7SGautham R Shenoy@findex -virtfs 8043d54abc7SGautham R Shenoy 8057c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 8067c92a3d2SAneesh Kumar K.V@table @option 8077c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 8087c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 809f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 8107c92a3d2SAneesh Kumar K.V@item id=@var{id} 8117c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 8127c92a3d2SAneesh Kumar K.V@item path=@var{path} 8137c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 8147c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 8157c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 8167c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 8172c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 8187c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 819b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 8202c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 8217c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 8222c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 8232c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 8247c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 8257c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 826d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 827f67e3ffdSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle, proxy) don't take security 828d9b36a6eSM. Mohan Kumarmodel as a parameter. 8297c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 8307c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 8317c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 8327c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 8337c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 8342c74c2cbSM. Mohan Kumar@item readonly 8352c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 8362c74c2cbSM. Mohan Kumarread-write access is given. 83784a87cc4SM. Mohan Kumar@item socket=@var{socket} 83884a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for 83984a87cc4SM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 84084a87cc4SM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 841f67e3ffdSM. Mohan Kumar@item sock_fd 842f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed 'sock_fd' as the socket 843f67e3ffdSM. Mohan Kumardescriptor for interfacing with virtfs-proxy-helper 8443d54abc7SGautham R Shenoy@end table 8453d54abc7SGautham R ShenoyETEXI 8463d54abc7SGautham R Shenoy 8479db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 8489db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 8499db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 8509db221aeSAneesh Kumar K.VSTEXI 8519db221aeSAneesh Kumar K.V@item -virtfs_synth 8529db221aeSAneesh Kumar K.V@findex -virtfs_synth 8539db221aeSAneesh Kumar K.VCreate synthetic file system image 8549db221aeSAneesh Kumar K.VETEXI 8559db221aeSAneesh Kumar K.V 8565824d651Sblueswir1STEXI 8575824d651Sblueswir1@end table 8585824d651Sblueswir1ETEXI 8595824d651Sblueswir1DEFHEADING() 8605824d651Sblueswir1 86110adb8beSMarkus ArmbrusterDEFHEADING(USB options:) 86210adb8beSMarkus ArmbrusterSTEXI 86310adb8beSMarkus Armbruster@table @option 86410adb8beSMarkus ArmbrusterETEXI 86510adb8beSMarkus Armbruster 86610adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 86710adb8beSMarkus Armbruster "-usb enable the USB driver (will be the default soon)\n", 86810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 86910adb8beSMarkus ArmbrusterSTEXI 87010adb8beSMarkus Armbruster@item -usb 87110adb8beSMarkus Armbruster@findex -usb 87210adb8beSMarkus ArmbrusterEnable the USB driver (will be the default soon) 87310adb8beSMarkus ArmbrusterETEXI 87410adb8beSMarkus Armbruster 87510adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 87610adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 87710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 87810adb8beSMarkus ArmbrusterSTEXI 87910adb8beSMarkus Armbruster 88010adb8beSMarkus Armbruster@item -usbdevice @var{devname} 88110adb8beSMarkus Armbruster@findex -usbdevice 88210adb8beSMarkus ArmbrusterAdd the USB device @var{devname}. @xref{usb_devices}. 88310adb8beSMarkus Armbruster 88410adb8beSMarkus Armbruster@table @option 88510adb8beSMarkus Armbruster 88610adb8beSMarkus Armbruster@item mouse 88710adb8beSMarkus ArmbrusterVirtual Mouse. This will override the PS/2 mouse emulation when activated. 88810adb8beSMarkus Armbruster 88910adb8beSMarkus Armbruster@item tablet 89010adb8beSMarkus ArmbrusterPointer device that uses absolute coordinates (like a touchscreen). This 89110adb8beSMarkus Armbrustermeans QEMU is able to report the mouse position without having to grab the 89210adb8beSMarkus Armbrustermouse. Also overrides the PS/2 mouse emulation when activated. 89310adb8beSMarkus Armbruster 89410adb8beSMarkus Armbruster@item disk:[format=@var{format}]:@var{file} 89510adb8beSMarkus ArmbrusterMass storage device based on file. The optional @var{format} argument 89610adb8beSMarkus Armbrusterwill be used rather than detecting the format. Can be used to specifiy 89710adb8beSMarkus Armbruster@code{format=raw} to avoid interpreting an untrusted format header. 89810adb8beSMarkus Armbruster 89910adb8beSMarkus Armbruster@item host:@var{bus}.@var{addr} 90010adb8beSMarkus ArmbrusterPass through the host device identified by @var{bus}.@var{addr} (Linux only). 90110adb8beSMarkus Armbruster 90210adb8beSMarkus Armbruster@item host:@var{vendor_id}:@var{product_id} 90310adb8beSMarkus ArmbrusterPass through the host device identified by @var{vendor_id}:@var{product_id} 90410adb8beSMarkus Armbruster(Linux only). 90510adb8beSMarkus Armbruster 90610adb8beSMarkus Armbruster@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 90710adb8beSMarkus ArmbrusterSerial converter to host character device @var{dev}, see @code{-serial} for the 90810adb8beSMarkus Armbrusteravailable devices. 90910adb8beSMarkus Armbruster 91010adb8beSMarkus Armbruster@item braille 91110adb8beSMarkus ArmbrusterBraille device. This will use BrlAPI to display the braille output on a real 91210adb8beSMarkus Armbrusteror fake device. 91310adb8beSMarkus Armbruster 91410adb8beSMarkus Armbruster@item net:@var{options} 91510adb8beSMarkus ArmbrusterNetwork adapter that supports CDC ethernet and RNDIS protocols. 91610adb8beSMarkus Armbruster 91710adb8beSMarkus Armbruster@end table 91810adb8beSMarkus ArmbrusterETEXI 91910adb8beSMarkus Armbruster 92010adb8beSMarkus ArmbrusterSTEXI 92110adb8beSMarkus Armbruster@end table 92210adb8beSMarkus ArmbrusterETEXI 92310adb8beSMarkus ArmbrusterDEFHEADING() 92410adb8beSMarkus Armbruster 9255824d651Sblueswir1DEFHEADING(Display options:) 9265824d651Sblueswir1STEXI 9275824d651Sblueswir1@table @option 9285824d651Sblueswir1ETEXI 9295824d651Sblueswir1 9301472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 9311472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 9323264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 933881249c7SJan Kiszka " gtk[,grab_on_hover=on|off]|\n" 9343264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 9351472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 9361472a95bSJes SorensenSTEXI 9371472a95bSJes Sorensen@item -display @var{type} 9381472a95bSJes Sorensen@findex -display 9391472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 9401472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 9411472a95bSJes Sorensen@table @option 9421472a95bSJes Sorensen@item sdl 9431472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 9441472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 9451472a95bSJes Sorensen@item curses 9461472a95bSJes SorensenDisplay video output via curses. For graphics device models which 9471472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 9481472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 9491472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 9501472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 9514171d32eSJes Sorensen@item none 9524171d32eSJes SorensenDo not display video output. The guest will still see an emulated 9534171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 9544171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 9554171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 9564171d32eSJes Sorensenthe destination of the serial and parallel port data. 957881249c7SJan Kiszka@item gtk 958881249c7SJan KiszkaDisplay video output in a GTK window. This interface provides drop-down 959881249c7SJan Kiszkamenus and other UI elements to configure and control the VM during 960881249c7SJan Kiszkaruntime. 9613264ff12SJes Sorensen@item vnc 9623264ff12SJes SorensenStart a VNC server on display <arg> 9631472a95bSJes Sorensen@end table 9641472a95bSJes SorensenETEXI 9651472a95bSJes Sorensen 9665824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 967ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 968ad96090aSBlue Swirl QEMU_ARCH_ALL) 9695824d651Sblueswir1STEXI 9705824d651Sblueswir1@item -nographic 9716616b2adSStefan Weil@findex -nographic 9725824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 9735824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 9745824d651Sblueswir1command line application. The emulated serial port is redirected on 97502c4bdf1SPaolo Bonzinithe console and muxed with the monitor (unless redirected elsewhere 97602c4bdf1SPaolo Bonziniexplicitly). Therefore, you can still use QEMU to debug a Linux kernel 977b031f413SRamkumar Ramachandrawith a serial console. Use @key{C-a h} for help on switching between 978b031f413SRamkumar Ramachandrathe console and monitor. 9795824d651Sblueswir1ETEXI 9805824d651Sblueswir1 9815824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 982ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 983ad96090aSBlue Swirl QEMU_ARCH_ALL) 9845824d651Sblueswir1STEXI 9855824d651Sblueswir1@item -curses 986b8f490ebSMarkus Armbruster@findex -curses 9875824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 9885824d651Sblueswir1QEMU can display the VGA output when in text mode using a 9895824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 9905824d651Sblueswir1ETEXI 9915824d651Sblueswir1 9925824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 993ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 994ad96090aSBlue Swirl QEMU_ARCH_ALL) 9955824d651Sblueswir1STEXI 9965824d651Sblueswir1@item -no-frame 9976616b2adSStefan Weil@findex -no-frame 9985824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 9995824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 10005824d651Sblueswir1workspace more convenient. 10015824d651Sblueswir1ETEXI 10025824d651Sblueswir1 10035824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 1004ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 1005ad96090aSBlue Swirl QEMU_ARCH_ALL) 10065824d651Sblueswir1STEXI 10075824d651Sblueswir1@item -alt-grab 10086616b2adSStefan Weil@findex -alt-grab 1009de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 1010de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 10115824d651Sblueswir1ETEXI 10125824d651Sblueswir1 10130ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 1014ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 1015ad96090aSBlue Swirl QEMU_ARCH_ALL) 10160ca9f8a4SDustin KirklandSTEXI 10170ca9f8a4SDustin Kirkland@item -ctrl-grab 10186616b2adSStefan Weil@findex -ctrl-grab 1019de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 1020de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 10210ca9f8a4SDustin KirklandETEXI 10220ca9f8a4SDustin Kirkland 10235824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 1024ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 10255824d651Sblueswir1STEXI 10265824d651Sblueswir1@item -no-quit 10276616b2adSStefan Weil@findex -no-quit 10285824d651Sblueswir1Disable SDL window close capability. 10295824d651Sblueswir1ETEXI 10305824d651Sblueswir1 10315824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 1032ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 10335824d651Sblueswir1STEXI 10345824d651Sblueswir1@item -sdl 10356616b2adSStefan Weil@findex -sdl 10365824d651Sblueswir1Enable SDL. 10375824d651Sblueswir1ETEXI 10385824d651Sblueswir1 103929b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 104027af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 104127af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 104227af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 1043fe4831b1SMarc-André Lureau " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n" 104427af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 104527af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 104627af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 104727af7788SYonit Halperin " [,sasl][,password=<secret>][,disable-ticketing]\n" 104827af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 104927af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 105027af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 105127af7788SYonit Halperin " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 10525ad24e5fSHans de Goede " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" 10535ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 105427af7788SYonit Halperin " enable spice\n" 105527af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 105627af7788SYonit Halperin QEMU_ARCH_ALL) 105729b0040bSGerd HoffmannSTEXI 105829b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 105929b0040bSGerd Hoffmann@findex -spice 106029b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 106129b0040bSGerd Hoffmann 106229b0040bSGerd Hoffmann@table @option 106329b0040bSGerd Hoffmann 106429b0040bSGerd Hoffmann@item port=<nr> 1065c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 106629b0040bSGerd Hoffmann 1067333b0eebSGerd Hoffmann@item addr=<addr> 1068333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 1069333b0eebSGerd Hoffmann 1070333b0eebSGerd Hoffmann@item ipv4 1071f9cfd655SMarkus Armbruster@itemx ipv6 1072f9cfd655SMarkus Armbruster@itemx unix 1073333b0eebSGerd HoffmannForce using the specified IP version. 1074333b0eebSGerd Hoffmann 107529b0040bSGerd Hoffmann@item password=<secret> 107629b0040bSGerd HoffmannSet the password you need to authenticate. 107729b0040bSGerd Hoffmann 107848b3ed0aSMarc-André Lureau@item sasl 107948b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 108048b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 108148b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 108248b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 108348b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 108448b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 108548b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 108648b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 108748b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 108848b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 108948b3ed0aSMarc-André Lureaucredentials. 109048b3ed0aSMarc-André Lureau 109129b0040bSGerd Hoffmann@item disable-ticketing 109229b0040bSGerd HoffmannAllow client connects without authentication. 109329b0040bSGerd Hoffmann 1094d4970b07SHans de Goede@item disable-copy-paste 1095d4970b07SHans de GoedeDisable copy paste between the client and the guest. 1096d4970b07SHans de Goede 10975ad24e5fSHans de Goede@item disable-agent-file-xfer 10985ad24e5fSHans de GoedeDisable spice-vdagent based file-xfer between the client and the guest. 10995ad24e5fSHans de Goede 1100c448e855SGerd Hoffmann@item tls-port=<nr> 1101c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 1102c448e855SGerd Hoffmann 1103c448e855SGerd Hoffmann@item x509-dir=<dir> 1104c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 1105c448e855SGerd Hoffmann 1106c448e855SGerd Hoffmann@item x509-key-file=<file> 1107f9cfd655SMarkus Armbruster@itemx x509-key-password=<file> 1108f9cfd655SMarkus Armbruster@itemx x509-cert-file=<file> 1109f9cfd655SMarkus Armbruster@itemx x509-cacert-file=<file> 1110f9cfd655SMarkus Armbruster@itemx x509-dh-key-file=<file> 1111c448e855SGerd HoffmannThe x509 file names can also be configured individually. 1112c448e855SGerd Hoffmann 1113c448e855SGerd Hoffmann@item tls-ciphers=<list> 1114c448e855SGerd HoffmannSpecify which ciphers to use. 1115c448e855SGerd Hoffmann 1116d70d6b31SAlon Levy@item tls-channel=[main|display|cursor|inputs|record|playback] 1117f9cfd655SMarkus Armbruster@itemx plaintext-channel=[main|display|cursor|inputs|record|playback] 111817b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 111917b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 112017b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 112117b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 112217b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 112317b6dea0SGerd Hoffmann 11249f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 11259f04e09eSYonit HalperinConfigure image compression (lossless). 11269f04e09eSYonit HalperinDefault is auto_glz. 11279f04e09eSYonit Halperin 11289f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 1129f9cfd655SMarkus Armbruster@itemx zlib-glz-wan-compression=[auto|never|always] 11309f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 11319f04e09eSYonit HalperinDefault is auto. 11329f04e09eSYonit Halperin 113384a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 113484a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 113584a23f25SGerd Hoffmann 113684a23f25SGerd Hoffmann@item agent-mouse=[on|off] 113784a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 113884a23f25SGerd Hoffmann 113984a23f25SGerd Hoffmann@item playback-compression=[on|off] 114084a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 114184a23f25SGerd Hoffmann 11428c957053SYonit Halperin@item seamless-migration=[on|off] 11438c957053SYonit HalperinEnable/disable spice seamless migration. Default is off. 11448c957053SYonit Halperin 114529b0040bSGerd Hoffmann@end table 114629b0040bSGerd HoffmannETEXI 114729b0040bSGerd Hoffmann 11485824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 1149ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1150ad96090aSBlue Swirl QEMU_ARCH_ALL) 11515824d651Sblueswir1STEXI 11525824d651Sblueswir1@item -portrait 11536616b2adSStefan Weil@findex -portrait 11545824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 11555824d651Sblueswir1ETEXI 11565824d651Sblueswir1 11579312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 11589312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 11599312805dSVasily Khoruzhick QEMU_ARCH_ALL) 11609312805dSVasily KhoruzhickSTEXI 11616265c43bSMarkus Armbruster@item -rotate @var{deg} 11629312805dSVasily Khoruzhick@findex -rotate 11639312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 11649312805dSVasily KhoruzhickETEXI 11659312805dSVasily Khoruzhick 11665824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 1167a94f0c5cSGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n" 1168ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 11695824d651Sblueswir1STEXI 1170e4558dcaSmalc@item -vga @var{type} 11716616b2adSStefan Weil@findex -vga 11725824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 1173b3f046c2SKevin Wolf@table @option 11745824d651Sblueswir1@item cirrus 11755824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 11765824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 11775824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 11785824d651Sblueswir1(This one is the default) 11795824d651Sblueswir1@item std 11805824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 11815824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 11825824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 11835824d651Sblueswir1this option. 11845824d651Sblueswir1@item vmware 11855824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 11865824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 11875824d651Sblueswir1card. 1188a19cbfb3SGerd Hoffmann@item qxl 1189a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 1190a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 1191a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 119233632788SMark Cave-Ayland@item tcx 119333632788SMark Cave-Ayland(sun4m only) Sun TCX framebuffer. This is the default framebuffer for 119433632788SMark Cave-Aylandsun4m machines and offers both 8-bit and 24-bit colour depths at a 119533632788SMark Cave-Aylandfixed resolution of 1024x768. 119633632788SMark Cave-Ayland@item cg3 119733632788SMark Cave-Ayland(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer 119833632788SMark Cave-Aylandfor sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) 119933632788SMark Cave-Aylandresolutions aimed at people wishing to run older Solaris versions. 1200a94f0c5cSGerd Hoffmann@item virtio 1201a94f0c5cSGerd HoffmannVirtio VGA card. 12025824d651Sblueswir1@item none 12035824d651Sblueswir1Disable VGA card. 12045824d651Sblueswir1@end table 12055824d651Sblueswir1ETEXI 12065824d651Sblueswir1 12075824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 1208ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 12095824d651Sblueswir1STEXI 12105824d651Sblueswir1@item -full-screen 12116616b2adSStefan Weil@findex -full-screen 12125824d651Sblueswir1Start in full screen. 12135824d651Sblueswir1ETEXI 12145824d651Sblueswir1 12155824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 1216ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1217ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 12185824d651Sblueswir1STEXI 121995d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 12206616b2adSStefan Weil@findex -g 122195d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 12225824d651Sblueswir1ETEXI 12235824d651Sblueswir1 12245824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1225ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 12265824d651Sblueswir1STEXI 12275824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 12286616b2adSStefan Weil@findex -vnc 12295824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 12305824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 12315824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 12325824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 12335824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 12345824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 12355824d651Sblueswir1syntax for the @var{display} is 12365824d651Sblueswir1 1237b3f046c2SKevin Wolf@table @option 12385824d651Sblueswir1 12395824d651Sblueswir1@item @var{host}:@var{d} 12405824d651Sblueswir1 12415824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 12425824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 12435824d651Sblueswir1be omitted in which case the server will accept connections from any host. 12445824d651Sblueswir1 12454e257e5eSKevin Wolf@item unix:@var{path} 12465824d651Sblueswir1 12475824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 12485824d651Sblueswir1location of a unix socket to listen for connections on. 12495824d651Sblueswir1 12505824d651Sblueswir1@item none 12515824d651Sblueswir1 12525824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 12535824d651Sblueswir1can be used to later start the VNC server. 12545824d651Sblueswir1 12555824d651Sblueswir1@end table 12565824d651Sblueswir1 12575824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 12585824d651Sblueswir1separated by commas. Valid options are 12595824d651Sblueswir1 1260b3f046c2SKevin Wolf@table @option 12615824d651Sblueswir1 12625824d651Sblueswir1@item reverse 12635824d651Sblueswir1 12645824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 12655824d651Sblueswir1client is specified by the @var{display}. For reverse network 12665824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 12675824d651Sblueswir1is a TCP port number, not a display number. 12685824d651Sblueswir1 12697536ee4bSTim Hardeck@item websocket 12707536ee4bSTim Hardeck 12717536ee4bSTim HardeckOpens an additional TCP listening port dedicated to VNC Websocket connections. 1272085d8134SPeter MaydellBy definition the Websocket port is 5700+@var{display}. If @var{host} is 12737536ee4bSTim Hardeckspecified connections will only be allowed from this host. 12747536ee4bSTim HardeckAs an alternative the Websocket port could be specified by using 12757536ee4bSTim Hardeck@code{websocket}=@var{port}. 12763e305e4aSDaniel P. BerrangeIf no TLS credentials are provided, the websocket connection runs in 12773e305e4aSDaniel P. Berrangeunencrypted mode. If TLS credentials are provided, the websocket connection 12783e305e4aSDaniel P. Berrangerequires encrypted client connections. 12797536ee4bSTim Hardeck 12805824d651Sblueswir1@item password 12815824d651Sblueswir1 12825824d651Sblueswir1Require that password based authentication is used for client connections. 128386ee5bc3SMichal Novotny 128486ee5bc3SMichal NovotnyThe password must be set separately using the @code{set_password} command in 128586ee5bc3SMichal Novotnythe @ref{pcsys_monitor}. The syntax to change your password is: 128686ee5bc3SMichal Novotny@code{set_password <protocol> <password>} where <protocol> could be either 128786ee5bc3SMichal Novotny"vnc" or "spice". 128886ee5bc3SMichal Novotny 128986ee5bc3SMichal NovotnyIf you would like to change <protocol> password expiration, you should use 129086ee5bc3SMichal Novotny@code{expire_password <protocol> <expiration-time>} where expiration time could 129186ee5bc3SMichal Novotnybe one of the following options: now, never, +seconds or UNIX time of 129286ee5bc3SMichal Novotnyexpiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 129386ee5bc3SMichal Novotnyto make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 129486ee5bc3SMichal Novotnydate and time). 129586ee5bc3SMichal Novotny 129686ee5bc3SMichal NovotnyYou can also use keywords "now" or "never" for the expiration time to 129786ee5bc3SMichal Novotnyallow <protocol> password to expire immediately or never expire. 12985824d651Sblueswir1 12993e305e4aSDaniel P. Berrange@item tls-creds=@var{ID} 13003e305e4aSDaniel P. Berrange 13013e305e4aSDaniel P. BerrangeProvides the ID of a set of TLS credentials to use to secure the 13023e305e4aSDaniel P. BerrangeVNC server. They will apply to both the normal VNC server socket 13033e305e4aSDaniel P. Berrangeand the websocket socket (if enabled). Setting TLS credentials 13043e305e4aSDaniel P. Berrangewill cause the VNC server socket to enable the VeNCrypt auth 13053e305e4aSDaniel P. Berrangemechanism. The credentials should have been previously created 13063e305e4aSDaniel P. Berrangeusing the @option{-object tls-creds} argument. 13073e305e4aSDaniel P. Berrange 13083e305e4aSDaniel P. BerrangeThe @option{tls-creds} parameter obsoletes the @option{tls}, 13093e305e4aSDaniel P. Berrange@option{x509}, and @option{x509verify} options, and as such 13103e305e4aSDaniel P. Berrangeit is not permitted to set both new and old type options at 13113e305e4aSDaniel P. Berrangethe same time. 13123e305e4aSDaniel P. Berrange 13135824d651Sblueswir1@item tls 13145824d651Sblueswir1 13155824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 13165824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 13175824d651Sblueswir1attack. It is recommended that this option be combined with either the 13184e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 13195824d651Sblueswir1 13203e305e4aSDaniel P. BerrangeThis option is now deprecated in favor of using the @option{tls-creds} 13213e305e4aSDaniel P. Berrangeargument. 13223e305e4aSDaniel P. Berrange 13235824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 13245824d651Sblueswir1 13255824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 13265824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 13275824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 13285824d651Sblueswir1to provide authentication of the client when this is used. The path following 13295824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 13305824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 13315824d651Sblueswir1 13323e305e4aSDaniel P. BerrangeThis option is now deprecated in favour of using the @option{tls-creds} 13333e305e4aSDaniel P. Berrangeargument. 13343e305e4aSDaniel P. Berrange 13355824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 13365824d651Sblueswir1 13375824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 13385824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 13395824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 13405824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 13415824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 13425824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 13435824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 13445824d651Sblueswir1path following this option specifies where the x509 certificates are to 13455824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 13465824d651Sblueswir1certificates. 13475824d651Sblueswir1 13483e305e4aSDaniel P. BerrangeThis option is now deprecated in favour of using the @option{tls-creds} 13493e305e4aSDaniel P. Berrangeargument. 13503e305e4aSDaniel P. Berrange 13515824d651Sblueswir1@item sasl 13525824d651Sblueswir1 13535824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 13545824d651Sblueswir1The exact choice of authentication method used is controlled from the 13555824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 13565824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 13575824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 13585824d651Sblueswir1to make it search alternate locations for the service config. 13595824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 13605824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 13615824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 13625824d651Sblueswir1ensures a data encryption preventing compromise of authentication 13635824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 13645824d651Sblueswir1SASL authentication. 13655824d651Sblueswir1 13665824d651Sblueswir1@item acl 13675824d651Sblueswir1 13685824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 13695824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 13705824d651Sblueswir1certificate's distinguished name. This is something that looks like 13715824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 13725824d651Sblueswir1made against the username, which depending on the SASL plugin, may 13735824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 13745824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 13755824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 13765824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 13775824d651Sblueswir1achieved using the @code{acl} monitor command. 13785824d651Sblueswir1 13796f9c78c1SCorentin Chary@item lossy 13806f9c78c1SCorentin Chary 13816f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 13826f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 13836f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 13846f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 13856f9c78c1SCorentin Chary 138680e0c8c3SCorentin Chary@item non-adaptive 138780e0c8c3SCorentin Chary 138880e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 138980e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 139080e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 139161cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 13929d85d557SMichael Tokarevadaptive encodings restores the original static behavior of encodings 139380e0c8c3SCorentin Charylike Tight. 139480e0c8c3SCorentin Chary 13958cf36489SGerd Hoffmann@item share=[allow-exclusive|force-shared|ignore] 13968cf36489SGerd Hoffmann 13978cf36489SGerd HoffmannSet display sharing policy. 'allow-exclusive' allows clients to ask 13988cf36489SGerd Hoffmannfor exclusive access. As suggested by the rfb spec this is 13998cf36489SGerd Hoffmannimplemented by dropping other connections. Connecting multiple 14008cf36489SGerd Hoffmannclients in parallel requires all clients asking for a shared session 14018cf36489SGerd Hoffmann(vncviewer: -shared switch). This is the default. 'force-shared' 14028cf36489SGerd Hoffmanndisables exclusive client access. Useful for shared desktop sessions, 14038cf36489SGerd Hoffmannwhere you don't want someone forgetting specify -shared disconnect 14048cf36489SGerd Hoffmanneverybody else. 'ignore' completely ignores the shared flag and 14058cf36489SGerd Hoffmannallows everybody connect unconditionally. Doesn't conform to the rfb 1406b65ee4faSStefan Weilspec but is traditional QEMU behavior. 14078cf36489SGerd Hoffmann 14085824d651Sblueswir1@end table 14095824d651Sblueswir1ETEXI 14105824d651Sblueswir1 14115824d651Sblueswir1STEXI 14125824d651Sblueswir1@end table 14135824d651Sblueswir1ETEXI 1414a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 14155824d651Sblueswir1 1416a3adb7adSMichael EllermanARCHHEADING(i386 target only:, QEMU_ARCH_I386) 14175824d651Sblueswir1STEXI 14185824d651Sblueswir1@table @option 14195824d651Sblueswir1ETEXI 14205824d651Sblueswir1 14215824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1422ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1423ad96090aSBlue Swirl QEMU_ARCH_I386) 14245824d651Sblueswir1STEXI 14255824d651Sblueswir1@item -win2k-hack 14266616b2adSStefan Weil@findex -win2k-hack 14275824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 14285824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 14295824d651Sblueswir1slows down the IDE transfers). 14305824d651Sblueswir1ETEXI 14315824d651Sblueswir1 14321ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1433ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 14345824d651Sblueswir1 14355824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1436ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1437ad96090aSBlue Swirl QEMU_ARCH_I386) 14385824d651Sblueswir1STEXI 14395824d651Sblueswir1@item -no-fd-bootchk 14406616b2adSStefan Weil@findex -no-fd-bootchk 14414eda32f5SMarkus ArmbrusterDisable boot signature checking for floppy disks in BIOS. May 14425824d651Sblueswir1be needed to boot from old floppy disks. 14435824d651Sblueswir1ETEXI 14445824d651Sblueswir1 14455824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1446f5d8c8cdSShannon Zhao "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 14475824d651Sblueswir1STEXI 14485824d651Sblueswir1@item -no-acpi 14496616b2adSStefan Weil@findex -no-acpi 14505824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 14515824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 14525824d651Sblueswir1only). 14535824d651Sblueswir1ETEXI 14545824d651Sblueswir1 14555824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1456ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 14575824d651Sblueswir1STEXI 14585824d651Sblueswir1@item -no-hpet 14596616b2adSStefan Weil@findex -no-hpet 14605824d651Sblueswir1Disable HPET support. 14615824d651Sblueswir1ETEXI 14625824d651Sblueswir1 14635824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1464104bf02eSMichael 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" 1465ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 14665824d651Sblueswir1STEXI 14675824d651Sblueswir1@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}]...] 14686616b2adSStefan Weil@findex -acpitable 14695824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1470104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1471104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1472104bf02eSMichael TokarevFor data=, only data 1473104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1474104bf02eSMichael Tokarevcommand line. 1475ae123749SLaszlo ErsekIf a SLIC table is supplied to QEMU, then the SLIC's oem_id and oem_table_id 1476ae123749SLaszlo Ersekfields will override the same in the RSDT and the FADT (a.k.a. FACP), in order 1477ae123749SLaszlo Ersekto ensure the field matches required by the Microsoft SLIC spec and the ACPI 1478ae123749SLaszlo Ersekspec. 14795824d651Sblueswir1ETEXI 14805824d651Sblueswir1 1481b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1482b6f6e3d3Saliguori "-smbios file=binary\n" 1483ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1484b155eb1dSGabriel L. Somlo "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1485b155eb1dSGabriel L. Somlo " [,uefi=on|off]\n" 1486ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1487b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1488b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1489b155eb1dSGabriel L. Somlo " specify SMBIOS type 1 fields\n" 1490b155eb1dSGabriel L. Somlo "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1491b155eb1dSGabriel L. Somlo " [,asset=str][,location=str]\n" 1492b155eb1dSGabriel L. Somlo " specify SMBIOS type 2 fields\n" 1493b155eb1dSGabriel L. Somlo "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 1494b155eb1dSGabriel L. Somlo " [,sku=str]\n" 1495b155eb1dSGabriel L. Somlo " specify SMBIOS type 3 fields\n" 1496b155eb1dSGabriel L. Somlo "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 1497b155eb1dSGabriel L. Somlo " [,asset=str][,part=str]\n" 1498b155eb1dSGabriel L. Somlo " specify SMBIOS type 4 fields\n" 1499b155eb1dSGabriel L. Somlo "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 15003ebd6cc8SGabriel L. Somlo " [,asset=str][,part=str][,speed=%d]\n" 1501b155eb1dSGabriel L. Somlo " specify SMBIOS type 17 fields\n", 1502c30e1565SWei Huang QEMU_ARCH_I386 | QEMU_ARCH_ARM) 1503b6f6e3d3SaliguoriSTEXI 1504b6f6e3d3Saliguori@item -smbios file=@var{binary} 15056616b2adSStefan Weil@findex -smbios 1506b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1507b6f6e3d3Saliguori 150884351843SGabriel L. Somlo@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] 1509b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1510b6f6e3d3Saliguori 1511b6f6e3d3Saliguori@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}] 1512b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1513b155eb1dSGabriel L. Somlo 1514b155eb1dSGabriel 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}] 1515b155eb1dSGabriel L. SomloSpecify SMBIOS type 2 fields 1516b155eb1dSGabriel L. Somlo 1517b155eb1dSGabriel L. Somlo@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}] 1518b155eb1dSGabriel L. SomloSpecify SMBIOS type 3 fields 1519b155eb1dSGabriel L. Somlo 1520b155eb1dSGabriel 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}] 1521b155eb1dSGabriel L. SomloSpecify SMBIOS type 4 fields 1522b155eb1dSGabriel L. Somlo 15233ebd6cc8SGabriel 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}] 1524b155eb1dSGabriel L. SomloSpecify SMBIOS type 17 fields 1525b6f6e3d3SaliguoriETEXI 1526b6f6e3d3Saliguori 15275824d651Sblueswir1STEXI 15285824d651Sblueswir1@end table 15295824d651Sblueswir1ETEXI 1530c70a01e4SMarkus ArmbrusterDEFHEADING() 15315824d651Sblueswir1 15325824d651Sblueswir1DEFHEADING(Network options:) 15335824d651Sblueswir1STEXI 15345824d651Sblueswir1@table @option 15355824d651Sblueswir1ETEXI 15365824d651Sblueswir1 1537ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1538ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1539ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1540ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1541ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1542ad196a9dSJan Kiszka#ifndef _WIN32 1543ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1544ad196a9dSJan Kiszka#endif 1545ad196a9dSJan Kiszka#endif 1546ad196a9dSJan Kiszka 15476a8b4a5bSThomas HuthDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 15485824d651Sblueswir1#ifdef CONFIG_SLIRP 15496a8b4a5bSThomas Huth "-netdev user,id=str[,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 155063d2960bSKlaus Stengel " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 155163d2960bSKlaus Stengel " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1552ad196a9dSJan Kiszka#ifndef _WIN32 1553c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1554ad196a9dSJan Kiszka#endif 15556a8b4a5bSThomas Huth " configure a user mode network backend with ID 'str',\n" 15566a8b4a5bSThomas Huth " its DHCP server and optional services\n" 15575824d651Sblueswir1#endif 15585824d651Sblueswir1#ifdef _WIN32 15596a8b4a5bSThomas Huth "-netdev tap,id=str,ifname=name\n" 15606a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 15615824d651Sblueswir1#else 15626a8b4a5bSThomas Huth "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 15636a8b4a5bSThomas Huth " [,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 15646a8b4a5bSThomas Huth " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 15656a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 1566a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1567a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1568a7c36ee4SCorey Bryant " to deconfigure it\n" 1569ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 1570a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1571a7c36ee4SCorey Bryant " configure it\n" 15725824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 15732ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1574ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1575f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1576ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1577ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 157882b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 15795430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 15805430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 158182b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 15822ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1583ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 15846a8b4a5bSThomas Huth "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 15856a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str' that is\n" 15866a8b4a5bSThomas Huth " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 15876a8b4a5bSThomas Huth " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 15880df0ff6dSMark McLoughlin#endif 15893fb69aa1SAnton Ivanov#ifdef __linux__ 15906a8b4a5bSThomas Huth "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 15916a8b4a5bSThomas Huth " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n" 15926a8b4a5bSThomas Huth " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n" 15936a8b4a5bSThomas Huth " [,rxcookie=rxcookie][,offset=offset]\n" 15946a8b4a5bSThomas Huth " configure a network backend with ID 'str' connected to\n" 15956a8b4a5bSThomas Huth " an Ethernet over L2TPv3 pseudowire.\n" 15963fb69aa1SAnton Ivanov " Linux kernel 3.3+ as well as most routers can talk\n" 15972f47b403SMichael Tokarev " L2TPv3. This transport allows connecting a VM to a VM,\n" 15983fb69aa1SAnton Ivanov " VM to a router and even VM to Host. It is a nearly-universal\n" 15993fb69aa1SAnton Ivanov " standard (RFC3391). Note - this implementation uses static\n" 16003fb69aa1SAnton Ivanov " pre-configured tunnels (same as the Linux kernel).\n" 16013fb69aa1SAnton Ivanov " use 'src=' to specify source address\n" 16023fb69aa1SAnton Ivanov " use 'dst=' to specify destination address\n" 16033fb69aa1SAnton Ivanov " use 'udp=on' to specify udp encapsulation\n" 16043952651aSGonglei " use 'srcport=' to specify source udp port\n" 16053fb69aa1SAnton Ivanov " use 'dstport=' to specify destination udp port\n" 16063fb69aa1SAnton Ivanov " use 'ipv6=on' to force v6\n" 16073fb69aa1SAnton Ivanov " L2TPv3 uses cookies to prevent misconfiguration as\n" 16083fb69aa1SAnton Ivanov " well as a weak security measure\n" 16093fb69aa1SAnton Ivanov " use 'rxcookie=0x012345678' to specify a rxcookie\n" 16103fb69aa1SAnton Ivanov " use 'txcookie=0x012345678' to specify a txcookie\n" 16113fb69aa1SAnton Ivanov " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 16123fb69aa1SAnton Ivanov " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 16133fb69aa1SAnton Ivanov " use 'pincounter=on' to work around broken counter handling in peer\n" 16143fb69aa1SAnton Ivanov " use 'offset=X' to add an extra offset between header and data\n" 16153fb69aa1SAnton Ivanov#endif 16166a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 16176a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 16186a8b4a5bSThomas Huth " using a socket connection\n" 16196a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 16206a8b4a5bSThomas Huth " configure a network backend to connect to a multicast maddr and port\n" 16213a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 16226a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 16236a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 16246a8b4a5bSThomas Huth " using an UDP tunnel\n" 16255824d651Sblueswir1#ifdef CONFIG_VDE 16266a8b4a5bSThomas Huth "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 16276a8b4a5bSThomas Huth " configure a network backend to connect to port 'n' of a vde switch\n" 16286a8b4a5bSThomas Huth " running on host and listening for incoming connections on 'socketpath'.\n" 16295824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 16305824d651Sblueswir1 " ownership and permissions for communication port.\n" 16315824d651Sblueswir1#endif 163258952137SVincenzo Maffione#ifdef CONFIG_NETMAP 16336a8b4a5bSThomas Huth "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 163458952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 163558952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 163658952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 163758952137SVincenzo Maffione#endif 16386a8b4a5bSThomas Huth "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 16396a8b4a5bSThomas Huth " configure a vhost-user network, backed by a chardev 'dev'\n" 16406a8b4a5bSThomas Huth "-netdev hubport,id=str,hubid=n\n" 16416a8b4a5bSThomas Huth " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL) 16426a8b4a5bSThomas HuthDEF("net", HAS_ARG, QEMU_OPTION_net, 16436a8b4a5bSThomas Huth "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 16446a8b4a5bSThomas Huth " old way to create a new NIC and connect it to VLAN 'n'\n" 16456a8b4a5bSThomas Huth " (use the '-device devtype,netdev=str' option if possible instead)\n" 1646bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1647bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1648ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 16496a8b4a5bSThomas Huth " is provided, the default is '-net nic -net user'\n" 16506a8b4a5bSThomas Huth "-net [" 1651a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1652a1ea458fSMark McLoughlin "user|" 1653a1ea458fSMark McLoughlin#endif 1654a1ea458fSMark McLoughlin "tap|" 1655a7c36ee4SCorey Bryant "bridge|" 1656a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1657a1ea458fSMark McLoughlin "vde|" 1658a1ea458fSMark McLoughlin#endif 165958952137SVincenzo Maffione#ifdef CONFIG_NETMAP 166058952137SVincenzo Maffione "netmap|" 166158952137SVincenzo Maffione#endif 16626a8b4a5bSThomas Huth "socket][,vlan=n][,option][,option][,...]\n" 16636a8b4a5bSThomas Huth " old way to initialize a host network interface\n" 16646a8b4a5bSThomas Huth " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 16655824d651Sblueswir1STEXI 1666ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 16676616b2adSStefan Weil@findex -net 16685824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 16690d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 16705607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 16715607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1672ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1673ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1674ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1675ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1676071c9394SStefan WeilNIC is created. QEMU can emulate several different models of network card. 16775824d651Sblueswir1Valid values for @var{type} are 1678ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 16795824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 16805824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1681585f6036SPeter MaydellNot all devices are supported on all targets. Use @code{-net nic,model=help} 16825824d651Sblueswir1for a list of available devices for your target. 16835824d651Sblueswir1 168408d12022SStefan Hajnoczi@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1685b8f490ebSMarkus Armbruster@findex -netdev 1686ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 16875824d651Sblueswir1Use the user mode network stack which requires no administrator 1688ad196a9dSJan Kiszkaprivilege to run. Valid options are: 16895824d651Sblueswir1 1690b3f046c2SKevin Wolf@table @option 1691ad196a9dSJan Kiszka@item vlan=@var{n} 1692ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1693ad196a9dSJan Kiszka 169408d12022SStefan Hajnoczi@item id=@var{id} 1695f9cfd655SMarkus Armbruster@itemx name=@var{name} 1696ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1697ad196a9dSJan Kiszka 1698c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1699c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1700c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1701b0b36e5dSBrad Hards10.0.2.0/24. 1702c92ef6a2SJan Kiszka 1703c92ef6a2SJan Kiszka@item host=@var{addr} 1704c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1705c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1706ad196a9dSJan Kiszka 1707c54ed5bcSJan Kiszka@item restrict=on|off 1708caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1709ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1710caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1711ad196a9dSJan Kiszka 1712ad196a9dSJan Kiszka@item hostname=@var{name} 171363d2960bSKlaus StengelSpecifies the client hostname reported by the built-in DHCP server. 1714ad196a9dSJan Kiszka 1715c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1716c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1717b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1718c92ef6a2SJan Kiszka 1719c92ef6a2SJan Kiszka@item dns=@var{addr} 1720c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1721c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1722c92ef6a2SJan Kiszkai.e. x.x.x.3. 1723c92ef6a2SJan Kiszka 172463d2960bSKlaus Stengel@item dnssearch=@var{domain} 172563d2960bSKlaus StengelProvides an entry for the domain-search list sent by the built-in 172663d2960bSKlaus StengelDHCP server. More than one domain suffix can be transmitted by specifying 172763d2960bSKlaus Stengelthis option multiple times. If supported, this will cause the guest to 172863d2960bSKlaus Stengelautomatically try to append the given domain suffix(es) in case a domain name 172963d2960bSKlaus Stengelcan not be resolved. 173063d2960bSKlaus Stengel 173163d2960bSKlaus StengelExample: 173263d2960bSKlaus Stengel@example 173363d2960bSKlaus Stengelqemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 173463d2960bSKlaus Stengel@end example 173563d2960bSKlaus Stengel 1736ad196a9dSJan Kiszka@item tftp=@var{dir} 1737ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1738ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1739ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1740c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1741ad196a9dSJan Kiszka 1742ad196a9dSJan Kiszka@item bootfile=@var{file} 1743ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1744ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1745ad196a9dSJan Kiszkaa guest from a local directory. 1746ad196a9dSJan Kiszka 1747ad196a9dSJan KiszkaExample (using pxelinux): 1748ad196a9dSJan Kiszka@example 17493804da9dSStefan Weilqemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1750ad196a9dSJan Kiszka@end example 1751ad196a9dSJan Kiszka 1752c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1753ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1754ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1755c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1756c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1757ad196a9dSJan Kiszka 1758ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1759ad196a9dSJan Kiszka@example 1760ad196a9dSJan Kiszka10.0.2.4 smbserver 1761ad196a9dSJan Kiszka@end example 1762ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1763ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1764ad196a9dSJan Kiszka 1765ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1766ad196a9dSJan Kiszka 1767e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1768e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1769e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1770ad196a9dSJan Kiszka 17713c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1772c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1773c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1774c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 17753c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 17763c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1777c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1778ad196a9dSJan Kiszka 1779ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1780ad196a9dSJan Kiszkascreen 0, use the following: 1781ad196a9dSJan Kiszka 1782ad196a9dSJan Kiszka@example 1783ad196a9dSJan Kiszka# on the host 17843804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1785ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1786ad196a9dSJan Kiszkaxterm -display :1 1787ad196a9dSJan Kiszka@end example 1788ad196a9dSJan Kiszka 1789ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1790ad196a9dSJan Kiszkathe guest, use the following: 1791ad196a9dSJan Kiszka 1792ad196a9dSJan Kiszka@example 1793ad196a9dSJan Kiszka# on the host 17943804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1795ad196a9dSJan Kiszkatelnet localhost 5555 1796ad196a9dSJan Kiszka@end example 1797ad196a9dSJan Kiszka 1798ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1799ad196a9dSJan Kiszkaconnect to the guest telnet server. 1800ad196a9dSJan Kiszka 1801c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1802f9cfd655SMarkus Armbruster@itemx guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 18033c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 1804b412eb61SAlexander Grafto the character device @var{dev} or to a program executed by @var{cmd:command} 1805b412eb61SAlexander Grafwhich gets spawned for each connection. This option can be given multiple times. 1806b412eb61SAlexander Graf 180743ffe61fSStefan WeilYou can either use a chardev directly and have that one used throughout QEMU's 1808b412eb61SAlexander Graflifetime, like in the following example: 1809b412eb61SAlexander Graf 1810b412eb61SAlexander Graf@example 1811b412eb61SAlexander Graf# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1812b412eb61SAlexander Graf# the guest accesses it 1813b412eb61SAlexander Grafqemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1814b412eb61SAlexander Graf@end example 1815b412eb61SAlexander Graf 1816b412eb61SAlexander GrafOr you can execute a command on every TCP connection established by the guest, 181743ffe61fSStefan Weilso that QEMU behaves similar to an inetd process for that virtual server: 1818b412eb61SAlexander Graf 1819b412eb61SAlexander Graf@example 1820b412eb61SAlexander Graf# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1821b412eb61SAlexander Graf# and connect the TCP stream to its stdin/stdout 1822b412eb61SAlexander Grafqemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1823b412eb61SAlexander Graf@end example 1824ad196a9dSJan Kiszka 1825ad196a9dSJan Kiszka@end table 1826ad196a9dSJan Kiszka 1827ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1828ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1829ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1830ad196a9dSJan Kiszkaas they will be removed from future versions. 18315824d651Sblueswir1 183208d12022SStefan Hajnoczi@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1833f9cfd655SMarkus Armbruster@itemx -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1834a7c36ee4SCorey BryantConnect the host TAP network interface @var{name} to VLAN @var{n}. 1835a7c36ee4SCorey Bryant 1836a7c36ee4SCorey BryantUse the network script @var{file} to configure it and the network script 18375824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1838a7c36ee4SCorey Bryantautomatically provides one. The default network configure script is 1839a7c36ee4SCorey Bryant@file{/etc/qemu-ifup} and the default network deconfigure script is 1840a7c36ee4SCorey Bryant@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1841a7c36ee4SCorey Bryantto disable script execution. 1842a7c36ee4SCorey Bryant 1843a7c36ee4SCorey BryantIf running QEMU as an unprivileged user, use the network helper 1844a7c36ee4SCorey Bryant@var{helper} to configure the TAP interface. The default network 1845420508fbSAmos Konghelper executable is @file{/path/to/qemu-bridge-helper}. 1846a7c36ee4SCorey Bryant 1847a7c36ee4SCorey Bryant@option{fd}=@var{h} can be used to specify the handle of an already 1848a7c36ee4SCorey Bryantopened host TAP interface. 1849a7c36ee4SCorey Bryant 1850a7c36ee4SCorey BryantExamples: 18515824d651Sblueswir1 18525824d651Sblueswir1@example 1853a7c36ee4SCorey Bryant#launch a QEMU instance with the default network script 18543804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net tap 18555824d651Sblueswir1@end example 18565824d651Sblueswir1 18575824d651Sblueswir1@example 1858a7c36ee4SCorey Bryant#launch a QEMU instance with two NICs, each one connected 1859a7c36ee4SCorey Bryant#to a TAP device 18603804da9dSStefan Weilqemu-system-i386 linux.img \ 18613804da9dSStefan Weil -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 18625824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 18635824d651Sblueswir1@end example 18645824d651Sblueswir1 1865a7c36ee4SCorey Bryant@example 1866a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1867a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 18683804da9dSStefan Weilqemu-system-i386 linux.img \ 1869420508fbSAmos Kong -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1870a7c36ee4SCorey Bryant@end example 1871a7c36ee4SCorey Bryant 187208d12022SStefan Hajnoczi@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1873f9cfd655SMarkus Armbruster@itemx -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1874a7c36ee4SCorey BryantConnect a host TAP network interface to a host bridge device. 1875a7c36ee4SCorey Bryant 1876a7c36ee4SCorey BryantUse the network helper @var{helper} to configure the TAP interface and 1877a7c36ee4SCorey Bryantattach it to the bridge. The default network helper executable is 1878420508fbSAmos Kong@file{/path/to/qemu-bridge-helper} and the default bridge 1879a7c36ee4SCorey Bryantdevice is @file{br0}. 1880a7c36ee4SCorey Bryant 1881a7c36ee4SCorey BryantExamples: 1882a7c36ee4SCorey Bryant 1883a7c36ee4SCorey Bryant@example 1884a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1885a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 18863804da9dSStefan Weilqemu-system-i386 linux.img -net bridge -net nic,model=virtio 1887a7c36ee4SCorey Bryant@end example 1888a7c36ee4SCorey Bryant 1889a7c36ee4SCorey Bryant@example 1890a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1891a7c36ee4SCorey Bryant#connect a TAP device to bridge qemubr0 18923804da9dSStefan Weilqemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1893a7c36ee4SCorey Bryant@end example 1894a7c36ee4SCorey Bryant 189508d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1896f9cfd655SMarkus Armbruster@itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 18975824d651Sblueswir1 18985824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 18995824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 19005824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 19015824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 19025824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 19035824d651Sblueswir1specifies an already opened TCP socket. 19045824d651Sblueswir1 19055824d651Sblueswir1Example: 19065824d651Sblueswir1@example 19075824d651Sblueswir1# launch a first QEMU instance 19083804da9dSStefan Weilqemu-system-i386 linux.img \ 19093804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 19105824d651Sblueswir1 -net socket,listen=:1234 19115824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 19125824d651Sblueswir1# of the first instance 19133804da9dSStefan Weilqemu-system-i386 linux.img \ 19143804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 19155824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 19165824d651Sblueswir1@end example 19175824d651Sblueswir1 191808d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1919f9cfd655SMarkus Armbruster@itemx -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 19205824d651Sblueswir1 19215824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 19225824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 19235824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 19245824d651Sblueswir1NOTES: 19255824d651Sblueswir1@enumerate 19265824d651Sblueswir1@item 19275824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 19285824d651Sblueswir1correct multicast setup for these hosts). 19295824d651Sblueswir1@item 19305824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 19315824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 19325824d651Sblueswir1@item 19335824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 19345824d651Sblueswir1@end enumerate 19355824d651Sblueswir1 19365824d651Sblueswir1Example: 19375824d651Sblueswir1@example 19385824d651Sblueswir1# launch one QEMU instance 19393804da9dSStefan Weilqemu-system-i386 linux.img \ 19403804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 19415824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 19425824d651Sblueswir1# launch another QEMU instance on same "bus" 19433804da9dSStefan Weilqemu-system-i386 linux.img \ 19443804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 19455824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 19465824d651Sblueswir1# launch yet another QEMU instance on same "bus" 19473804da9dSStefan Weilqemu-system-i386 linux.img \ 19483804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:58 \ 19495824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 19505824d651Sblueswir1@end example 19515824d651Sblueswir1 19525824d651Sblueswir1Example (User Mode Linux compat.): 19535824d651Sblueswir1@example 19545824d651Sblueswir1# launch QEMU instance (note mcast address selected 19555824d651Sblueswir1# is UML's default) 19563804da9dSStefan Weilqemu-system-i386 linux.img \ 19573804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 19585824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 19595824d651Sblueswir1# launch UML 19605824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 19615824d651Sblueswir1@end example 19625824d651Sblueswir1 19633a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 19643a75e74cSMike Ryan@example 19653804da9dSStefan Weilqemu-system-i386 linux.img \ 19663804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 19673a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 19683a75e74cSMike Ryan@end example 19693a75e74cSMike Ryan 19703fb69aa1SAnton 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}] 1971f9cfd655SMarkus Armbruster@itemx -net l2tpv3[,vlan=@var{n}][,name=@var{name}],src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}] 19723fb69aa1SAnton IvanovConnect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular 19733fb69aa1SAnton Ivanovprotocol to transport Ethernet (and other Layer 2) data frames between 19743fb69aa1SAnton Ivanovtwo systems. It is present in routers, firewalls and the Linux kernel 19753fb69aa1SAnton Ivanov(from version 3.3 onwards). 19763fb69aa1SAnton Ivanov 19773fb69aa1SAnton IvanovThis transport allows a VM to communicate to another VM, router or firewall directly. 19783fb69aa1SAnton Ivanov 19793fb69aa1SAnton Ivanov@item src=@var{srcaddr} 19803fb69aa1SAnton Ivanov source address (mandatory) 19813fb69aa1SAnton Ivanov@item dst=@var{dstaddr} 19823fb69aa1SAnton Ivanov destination address (mandatory) 19833fb69aa1SAnton Ivanov@item udp 19843fb69aa1SAnton Ivanov select udp encapsulation (default is ip). 19853fb69aa1SAnton Ivanov@item srcport=@var{srcport} 19863fb69aa1SAnton Ivanov source udp port. 19873fb69aa1SAnton Ivanov@item dstport=@var{dstport} 19883fb69aa1SAnton Ivanov destination udp port. 19893fb69aa1SAnton Ivanov@item ipv6 19903fb69aa1SAnton Ivanov force v6, otherwise defaults to v4. 19913fb69aa1SAnton Ivanov@item rxcookie=@var{rxcookie} 1992f9cfd655SMarkus Armbruster@itemx txcookie=@var{txcookie} 19933fb69aa1SAnton Ivanov Cookies are a weak form of security in the l2tpv3 specification. 19943fb69aa1SAnton IvanovTheir function is mostly to prevent misconfiguration. By default they are 32 19953fb69aa1SAnton Ivanovbit. 19963fb69aa1SAnton Ivanov@item cookie64 19973fb69aa1SAnton Ivanov Set cookie size to 64 bit instead of the default 32 19983fb69aa1SAnton Ivanov@item counter=off 19993fb69aa1SAnton Ivanov Force a 'cut-down' L2TPv3 with no counter as in 20003fb69aa1SAnton Ivanovdraft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 20013fb69aa1SAnton Ivanov@item pincounter=on 20023fb69aa1SAnton Ivanov Work around broken counter handling in peer. This may also help on 20033fb69aa1SAnton Ivanovnetworks which have packet reorder. 20043fb69aa1SAnton Ivanov@item offset=@var{offset} 20053fb69aa1SAnton Ivanov Add an extra offset between header and data 20063fb69aa1SAnton Ivanov 20073fb69aa1SAnton IvanovFor example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan 20083fb69aa1SAnton Ivanovon the remote Linux host 1.2.3.4: 20093fb69aa1SAnton Ivanov@example 20103fb69aa1SAnton Ivanov# Setup tunnel on linux host using raw ip as encapsulation 20113fb69aa1SAnton Ivanov# on 1.2.3.4 20123fb69aa1SAnton Ivanovip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ 20133fb69aa1SAnton Ivanov encap udp udp_sport 16384 udp_dport 16384 20143fb69aa1SAnton Ivanovip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ 20153fb69aa1SAnton Ivanov 0xFFFFFFFF peer_session_id 0xFFFFFFFF 20163fb69aa1SAnton Ivanovifconfig vmtunnel0 mtu 1500 20173fb69aa1SAnton Ivanovifconfig vmtunnel0 up 20183fb69aa1SAnton Ivanovbrctl addif br-lan vmtunnel0 20193fb69aa1SAnton Ivanov 20203fb69aa1SAnton Ivanov 20213fb69aa1SAnton Ivanov# on 4.3.2.1 20223fb69aa1SAnton Ivanov# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 20233fb69aa1SAnton Ivanov 20243fb69aa1SAnton Ivanovqemu-system-i386 linux.img -net nic -net l2tpv3,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter 20253fb69aa1SAnton Ivanov 20263fb69aa1SAnton Ivanov 20273fb69aa1SAnton Ivanov@end example 20283fb69aa1SAnton Ivanov 202908d12022SStefan Hajnoczi@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 2030f9cfd655SMarkus Armbruster@itemx -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 20315824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 20325824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 20335824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 2034c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 20355824d651Sblueswir1with vde support enabled. 20365824d651Sblueswir1 20375824d651Sblueswir1Example: 20385824d651Sblueswir1@example 20395824d651Sblueswir1# launch vde switch 20405824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 20415824d651Sblueswir1# launch QEMU instance 20423804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 20435824d651Sblueswir1@end example 20445824d651Sblueswir1 204540e8c26dSStefan Hajnoczi@item -netdev hubport,id=@var{id},hubid=@var{hubid} 204640e8c26dSStefan Hajnoczi 204740e8c26dSStefan HajnocziCreate a hub port on QEMU "vlan" @var{hubid}. 204840e8c26dSStefan Hajnoczi 204940e8c26dSStefan HajnocziThe hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 205040e8c26dSStefan Hajnoczinetdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 205140e8c26dSStefan Hajnoczirequired hub automatically. 205240e8c26dSStefan Hajnoczi 2053b931bfbfSChangchun Ouyang@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n] 205403ce5744SNikolay Nikolaev 205503ce5744SNikolay NikolaevEstablish a vhost-user netdev, backed by a chardev @var{id}. The chardev should 205603ce5744SNikolay Nikolaevbe a unix domain socket backed one. The vhost-user uses a specifically defined 205703ce5744SNikolay Nikolaevprotocol to pass vhost ioctl replacement messages to an application on the other 205803ce5744SNikolay Nikolaevend of the socket. On non-MSIX guests, the feature can be forced with 2059b931bfbfSChangchun Ouyang@var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to 2060b931bfbfSChangchun Ouyangbe created for multiqueue vhost-user. 206103ce5744SNikolay Nikolaev 206203ce5744SNikolay NikolaevExample: 206303ce5744SNikolay Nikolaev@example 206403ce5744SNikolay Nikolaevqemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 206503ce5744SNikolay Nikolaev -numa node,memdev=mem \ 206603ce5744SNikolay Nikolaev -chardev socket,path=/path/to/socket \ 206703ce5744SNikolay Nikolaev -netdev type=vhost-user,id=net0,chardev=chr0 \ 206803ce5744SNikolay Nikolaev -device virtio-net-pci,netdev=net0 206903ce5744SNikolay Nikolaev@end example 207003ce5744SNikolay Nikolaev 2071bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 2072bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 2073bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 2074bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 2075d3e0c032SThomas HuthNote: For devices created with '-netdev', use '-object filter-dump,...' instead. 2076bb9ea79eSaliguori 20775824d651Sblueswir1@item -net none 20785824d651Sblueswir1Indicate that no network devices should be configured. It is used to 20795824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 20805824d651Sblueswir1is activated if no @option{-net} options are provided. 20815824d651Sblueswir1ETEXI 20825824d651Sblueswir1 2083c70a01e4SMarkus ArmbrusterSTEXI 2084c70a01e4SMarkus Armbruster@end table 2085c70a01e4SMarkus ArmbrusterETEXI 20867273a2dbSMatthew BoothDEFHEADING() 20877273a2dbSMatthew Booth 20887273a2dbSMatthew BoothDEFHEADING(Character device options:) 2089c70a01e4SMarkus ArmbrusterSTEXI 2090c70a01e4SMarkus Armbruster 2091c70a01e4SMarkus ArmbrusterThe general form of a character device option is: 2092c70a01e4SMarkus Armbruster@table @option 2093c70a01e4SMarkus ArmbrusterETEXI 20947273a2dbSMatthew Booth 20957273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 2096d0d7708bSDaniel P. Berrange "-chardev null,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 20975dd1f02bSCorey Minyard "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" 2098d0d7708bSDaniel P. Berrange " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off]\n" 2099a8fb5427SDaniel P. Berrange " [,logfile=PATH][,logappend=on|off][,tls-creds=ID] (tcp)\n" 2100d0d7708bSDaniel P. Berrange "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds]\n" 2101d0d7708bSDaniel P. Berrange " [,mux=on|off][,logfile=PATH][,logappend=on|off] (unix)\n" 21027273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 210397331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 2104d0d7708bSDaniel P. Berrange " [,logfile=PATH][,logappend=on|off]\n" 2105d0d7708bSDaniel P. Berrange "-chardev msmouse,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 21067273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 2107d0d7708bSDaniel P. Berrange " [,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2108d0d7708bSDaniel P. Berrange "-chardev ringbuf,id=id[,size=size][,logfile=PATH][,logappend=on|off]\n" 2109d0d7708bSDaniel P. Berrange "-chardev file,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2110d0d7708bSDaniel P. Berrange "-chardev pipe,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 21117273a2dbSMatthew Booth#ifdef _WIN32 2112d0d7708bSDaniel P. Berrange "-chardev console,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2113d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 21147273a2dbSMatthew Booth#else 2115d0d7708bSDaniel P. Berrange "-chardev pty,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2116d0d7708bSDaniel P. Berrange "-chardev stdio,id=id[,mux=on|off][,signal=on|off][,logfile=PATH][,logappend=on|off]\n" 21177273a2dbSMatthew Booth#endif 21187273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 2119d0d7708bSDaniel P. Berrange "-chardev braille,id=id[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 21207273a2dbSMatthew Booth#endif 21217273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 21227273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 2123d0d7708bSDaniel P. Berrange "-chardev serial,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2124d0d7708bSDaniel P. Berrange "-chardev tty,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 21257273a2dbSMatthew Booth#endif 21267273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 2127d0d7708bSDaniel P. Berrange "-chardev parallel,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 2128d0d7708bSDaniel P. Berrange "-chardev parport,id=id,path=path[,mux=on|off][,logfile=PATH][,logappend=on|off]\n" 21297273a2dbSMatthew Booth#endif 2130cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 2131d0d7708bSDaniel P. Berrange "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 2132d0d7708bSDaniel P. Berrange "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n" 2133cbcc6336SAlon Levy#endif 2134ad96090aSBlue Swirl , QEMU_ARCH_ALL 21357273a2dbSMatthew Booth) 21367273a2dbSMatthew Booth 21377273a2dbSMatthew BoothSTEXI 213897331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 21396616b2adSStefan Weil@findex -chardev 21407273a2dbSMatthew BoothBackend is one of: 21417273a2dbSMatthew Booth@option{null}, 21427273a2dbSMatthew Booth@option{socket}, 21437273a2dbSMatthew Booth@option{udp}, 21447273a2dbSMatthew Booth@option{msmouse}, 21457273a2dbSMatthew Booth@option{vc}, 21464f57378fSMarkus Armbruster@option{ringbuf}, 21477273a2dbSMatthew Booth@option{file}, 21487273a2dbSMatthew Booth@option{pipe}, 21497273a2dbSMatthew Booth@option{console}, 21507273a2dbSMatthew Booth@option{serial}, 21517273a2dbSMatthew Booth@option{pty}, 21527273a2dbSMatthew Booth@option{stdio}, 21537273a2dbSMatthew Booth@option{braille}, 21547273a2dbSMatthew Booth@option{tty}, 215588a946d3SGerd Hoffmann@option{parallel}, 2156cbcc6336SAlon Levy@option{parport}, 2157cbcc6336SAlon Levy@option{spicevmc}. 21585a49d3e9SMarc-André Lureau@option{spiceport}. 21597273a2dbSMatthew BoothThe specific backend will determine the applicable options. 21607273a2dbSMatthew Booth 21617273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 21627273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 21637273a2dbSMatthew Booth 216497331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 2165*a40db1b3SPeter MaydellSpecify @option{mux=on} to enable this mode. 2166*a40db1b3SPeter MaydellA multiplexer is a "1:N" device, and here the "1" end is your specified chardev 2167*a40db1b3SPeter Maydellbackend, and the "N" end is the various parts of QEMU that can talk to a chardev. 2168*a40db1b3SPeter MaydellIf you create a chardev with @option{id=myid} and @option{mux=on}, QEMU will 2169*a40db1b3SPeter Maydellcreate a multiplexer with your specified ID, and you can then configure multiple 2170*a40db1b3SPeter Maydellfront ends to use that chardev ID for their input/output. Up to four different 2171*a40db1b3SPeter Maydellfront ends can be connected to a single multiplexed chardev. (Without 2172*a40db1b3SPeter Maydellmultiplexing enabled, a chardev can only be used by a single front end.) 2173*a40db1b3SPeter MaydellFor instance you could use this to allow a single stdio chardev to be used by 2174*a40db1b3SPeter Maydelltwo serial ports and the QEMU monitor: 2175*a40db1b3SPeter Maydell 2176*a40db1b3SPeter Maydell@example 2177*a40db1b3SPeter Maydell-chardev stdio,mux=on,id=char0 \ 2178*a40db1b3SPeter Maydell-mon chardev=char0,mode=readline,default \ 2179*a40db1b3SPeter Maydell-serial chardev:char0 \ 2180*a40db1b3SPeter Maydell-serial chardev:char0 2181*a40db1b3SPeter Maydell@end example 2182*a40db1b3SPeter Maydell 2183*a40db1b3SPeter MaydellYou can have more than one multiplexer in a system configuration; for instance 2184*a40db1b3SPeter Maydellyou could have a TCP port multiplexed between UART 0 and UART 1, and stdio 2185*a40db1b3SPeter Maydellmultiplexed between the QEMU monitor and a parallel port: 2186*a40db1b3SPeter Maydell 2187*a40db1b3SPeter Maydell@example 2188*a40db1b3SPeter Maydell-chardev stdio,mux=on,id=char0 \ 2189*a40db1b3SPeter Maydell-mon chardev=char0,mode=readline,default \ 2190*a40db1b3SPeter Maydell-parallel chardev:char0 \ 2191*a40db1b3SPeter Maydell-chardev tcp,...,mux=on,id=char1 \ 2192*a40db1b3SPeter Maydell-serial chardev:char1 \ 2193*a40db1b3SPeter Maydell-serial chardev:char1 2194*a40db1b3SPeter Maydell@end example 2195*a40db1b3SPeter Maydell 2196*a40db1b3SPeter MaydellWhen you're using a multiplexed character device, some escape sequences are 2197*a40db1b3SPeter Maydellinterpreted in the input. @xref{mux_keys, Keys in the character backend 2198*a40db1b3SPeter Maydellmultiplexer}. 2199*a40db1b3SPeter Maydell 2200*a40db1b3SPeter MaydellNote that some other command line options may implicitly create multiplexed 2201*a40db1b3SPeter Maydellcharacter backends; for instance @option{-serial mon:stdio} creates a 2202*a40db1b3SPeter Maydellmultiplexed stdio backend connected to the serial port and the QEMU monitor, 2203*a40db1b3SPeter Maydelland @option{-nographic} also multiplexes the console and the monitor to 2204*a40db1b3SPeter Maydellstdio. 2205*a40db1b3SPeter Maydell 2206*a40db1b3SPeter MaydellThere is currently no support for multiplexing in the other direction 2207*a40db1b3SPeter Maydell(where a single QEMU front end takes input and output from multiple chardevs). 220897331287SJan Kiszka 2209d0d7708bSDaniel P. BerrangeEvery backend supports the @option{logfile} option, which supplies the path 2210d0d7708bSDaniel P. Berrangeto a file to record all data transmitted via the backend. The @option{logappend} 2211d0d7708bSDaniel P. Berrangeoption controls whether the log file will be truncated or appended to when 2212d0d7708bSDaniel P. Berrangeopened. 2213d0d7708bSDaniel P. Berrange 2214d0d7708bSDaniel P. BerrangeFurther options to each backend are described below. 22157273a2dbSMatthew Booth 22167273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 22177273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 22187273a2dbSMatthew Boothreceives. The null backend does not take any options. 22197273a2dbSMatthew Booth 2220a8fb5427SDaniel P. Berrange@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] [,tls-creds=@var{id}] 22217273a2dbSMatthew Booth 22227273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 22237273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 22247273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 22257273a2dbSMatthew Booth 22267273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 22277273a2dbSMatthew Booth 22287273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 22297273a2dbSMatthew Boothconnect to a listening socket. 22307273a2dbSMatthew Booth 22317273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 22327273a2dbSMatthew Boothescape sequences. 22337273a2dbSMatthew Booth 22345dd1f02bSCorey Minyard@option{reconnect} sets the timeout for reconnecting on non-server sockets when 22355dd1f02bSCorey Minyardthe remote end goes away. qemu will delay this many seconds and then attempt 22365dd1f02bSCorey Minyardto reconnect. Zero disables reconnecting, and is the default. 22375dd1f02bSCorey Minyard 2238a8fb5427SDaniel P. Berrange@option{tls-creds} requests enablement of the TLS protocol for encryption, 2239a8fb5427SDaniel P. Berrangeand specifies the id of the TLS credentials to use for the handshake. The 2240a8fb5427SDaniel P. Berrangecredentials must be previously created with the @option{-object tls-creds} 2241a8fb5427SDaniel P. Berrangeargument. 2242a8fb5427SDaniel P. Berrange 22437273a2dbSMatthew BoothTCP and unix socket options are given below: 22447273a2dbSMatthew Booth 22457273a2dbSMatthew Booth@table @option 22467273a2dbSMatthew Booth 22478d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 22487273a2dbSMatthew Booth 22497273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 22507273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 22517273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 22527273a2dbSMatthew Booth 22537273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 22547273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 22557273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 22567273a2dbSMatthew Booth@option{port} is required. 22577273a2dbSMatthew Booth 22587273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 22597273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 22607273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 22617273a2dbSMatthew Boothas a port number. 22627273a2dbSMatthew Booth 22637273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 22647273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 22657273a2dbSMatthew Booth 22667273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 22677273a2dbSMatthew Booth 22687273a2dbSMatthew Booth@item unix options: path=@var{path} 22697273a2dbSMatthew Booth 22707273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 22717273a2dbSMatthew Boothrequired. 22727273a2dbSMatthew Booth 22737273a2dbSMatthew Booth@end table 22747273a2dbSMatthew Booth 22757273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 22767273a2dbSMatthew Booth 22777273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 22787273a2dbSMatthew Booth 22797273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 22807273a2dbSMatthew Boothdefaults to @code{localhost}. 22817273a2dbSMatthew Booth 22827273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 22837273a2dbSMatthew Boothis required. 22847273a2dbSMatthew Booth 22857273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 22867273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 22877273a2dbSMatthew Booth 22887273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 22897273a2dbSMatthew Boothavailable local port will be used. 22907273a2dbSMatthew Booth 22917273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 22927273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 22937273a2dbSMatthew Booth 22947273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 22957273a2dbSMatthew Booth 22967273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 22977273a2dbSMatthew Boothtake any options. 22987273a2dbSMatthew Booth 22997273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 23007273a2dbSMatthew Booth 23017273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 23027273a2dbSMatthew Boothsize. 23037273a2dbSMatthew Booth 23047273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 23057273a2dbSMatthew Booththe console, in pixels. 23067273a2dbSMatthew Booth 23077273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 23087273a2dbSMatthew Boothconsole with the given dimensions. 23097273a2dbSMatthew Booth 23104f57378fSMarkus Armbruster@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 231151767e7cSLei Li 23123949e594SMarkus ArmbrusterCreate a ring buffer with fixed size @option{size}. 23133949e594SMarkus Armbruster@var{size} must be a power of two, and defaults to @code{64K}). 231451767e7cSLei Li 23157273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 23167273a2dbSMatthew Booth 23177273a2dbSMatthew BoothLog all traffic received from the guest to a file. 23187273a2dbSMatthew Booth 23197273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 23207273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 23217273a2dbSMatthew Boothis required. 23227273a2dbSMatthew Booth 23237273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 23247273a2dbSMatthew Booth 23257273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 23267273a2dbSMatthew BoothWindows hosts and other hosts: 23277273a2dbSMatthew Booth 23287273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 23297273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 23307273a2dbSMatthew Booth 23317273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 23327273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 23337273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 23347273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 23357273a2dbSMatthew Boothbe present. 23367273a2dbSMatthew Booth 23377273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 23387273a2dbSMatthew Boothrequired. 23397273a2dbSMatthew Booth 23407273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 23417273a2dbSMatthew Booth 23427273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 23437273a2dbSMatthew Boothtake any options. 23447273a2dbSMatthew Booth 23457273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 23467273a2dbSMatthew Booth 23477273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 23487273a2dbSMatthew Booth 23497273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 23507273a2dbSMatthew Booth 2351d59044efSGerd HoffmannOn Unix hosts serial will actually accept any tty device, 2352d59044efSGerd Hoffmannnot only serial lines. 23537273a2dbSMatthew Booth 23547273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 23557273a2dbSMatthew Booth 23567273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 23577273a2dbSMatthew Booth 23587273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 23597273a2dbSMatthew Boothnot take any options. 23607273a2dbSMatthew Booth 23617273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 23627273a2dbSMatthew Booth 2363b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 2364b65ee4faSStefan WeilConnect to standard input and standard output of the QEMU process. 2365b7fdb3abSAurelien Jarno 2366b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 2367b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2368b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 2369b7fdb3abSAurelien Jarno 2370b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 23717273a2dbSMatthew Booth 23727273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 23737273a2dbSMatthew Booth 23747273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 23757273a2dbSMatthew Booth 23767273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 23777273a2dbSMatthew Booth 23787273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2379d037d6bbSMarkus ArmbrusterDragonFlyBSD hosts. It is an alias for @option{serial}. 23807273a2dbSMatthew Booth 23817273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 23827273a2dbSMatthew Booth 238388a946d3SGerd Hoffmann@item -chardev parallel ,id=@var{id} ,path=@var{path} 2384f9cfd655SMarkus Armbruster@itemx -chardev parport ,id=@var{id} ,path=@var{path} 23857273a2dbSMatthew Booth 238688a946d3SGerd Hoffmann@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 23877273a2dbSMatthew Booth 23887273a2dbSMatthew BoothConnect to a local parallel port. 23897273a2dbSMatthew Booth 23907273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 23917273a2dbSMatthew Boothrequired. 23927273a2dbSMatthew Booth 2393cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2394cbcc6336SAlon Levy 23953a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 23963a846906SStefan Hajnoczi 2397cbcc6336SAlon Levy@option{debug} debug level for spicevmc 2398cbcc6336SAlon Levy 2399cbcc6336SAlon Levy@option{name} name of spice channel to connect to 2400cbcc6336SAlon Levy 2401cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 2402cbcc6336SAlon Levy 24035a49d3e9SMarc-André Lureau@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 24045a49d3e9SMarc-André Lureau 24055a49d3e9SMarc-André Lureau@option{spiceport} is only available when spice support is built in. 24065a49d3e9SMarc-André Lureau 24075a49d3e9SMarc-André Lureau@option{debug} debug level for spicevmc 24085a49d3e9SMarc-André Lureau 24095a49d3e9SMarc-André Lureau@option{name} name of spice port to connect to 24105a49d3e9SMarc-André Lureau 24115a49d3e9SMarc-André LureauConnect to a spice port, allowing a Spice client to handle the traffic 24125a49d3e9SMarc-André Lureauidentified by a name (preferably a fqdn). 24137273a2dbSMatthew BoothETEXI 24147273a2dbSMatthew Booth 2415c70a01e4SMarkus ArmbrusterSTEXI 2416c70a01e4SMarkus Armbruster@end table 2417c70a01e4SMarkus ArmbrusterETEXI 24187273a2dbSMatthew BoothDEFHEADING() 24197273a2dbSMatthew Booth 24200f5314a2SRonnie SahlbergDEFHEADING(Device URL Syntax:) 2421c70a01e4SMarkus ArmbrusterSTEXI 24220f5314a2SRonnie Sahlberg 24230f5314a2SRonnie SahlbergIn addition to using normal file images for the emulated storage devices, 24240f5314a2SRonnie SahlbergQEMU can also use networked resources such as iSCSI devices. These are 24250f5314a2SRonnie Sahlbergspecified using a special URL syntax. 24260f5314a2SRonnie Sahlberg 24270f5314a2SRonnie Sahlberg@table @option 24280f5314a2SRonnie Sahlberg@item iSCSI 24290f5314a2SRonnie SahlbergiSCSI support allows QEMU to access iSCSI resources directly and use as 24300f5314a2SRonnie Sahlbergimages for the guest storage. Both disk and cdrom images are supported. 24310f5314a2SRonnie Sahlberg 24320f5314a2SRonnie SahlbergSyntax for specifying iSCSI LUNs is 24330f5314a2SRonnie Sahlberg``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 24340f5314a2SRonnie Sahlberg 243531459f46SRonnie SahlbergBy default qemu will use the iSCSI initiator-name 243631459f46SRonnie Sahlberg'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 243731459f46SRonnie Sahlbergline or a configuration file. 243831459f46SRonnie Sahlberg 24395dd7a535SPeter LievenSince version Qemu 2.4 it is possible to specify a iSCSI request timeout to detect 24405dd7a535SPeter Lievenstalled requests and force a reestablishment of the session. The timeout 24419049736eSPeter Lievenis specified in seconds. The default is 0 which means no timeout. Libiscsi 24429049736eSPeter Lieven1.15.0 or greater is required for this feature. 244331459f46SRonnie Sahlberg 24440f5314a2SRonnie SahlbergExample (without authentication): 24450f5314a2SRonnie Sahlberg@example 24463804da9dSStefan Weilqemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2447f9dadc98SRonnie Sahlberg -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2448f9dadc98SRonnie Sahlberg -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 24490f5314a2SRonnie Sahlberg@end example 24500f5314a2SRonnie Sahlberg 24510f5314a2SRonnie SahlbergExample (CHAP username/password via URL): 24520f5314a2SRonnie Sahlberg@example 24533804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 24540f5314a2SRonnie Sahlberg@end example 24550f5314a2SRonnie Sahlberg 24560f5314a2SRonnie SahlbergExample (CHAP username/password via environment variables): 24570f5314a2SRonnie Sahlberg@example 24580f5314a2SRonnie SahlbergLIBISCSI_CHAP_USERNAME="user" \ 24590f5314a2SRonnie SahlbergLIBISCSI_CHAP_PASSWORD="password" \ 24603804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 24610f5314a2SRonnie Sahlberg@end example 24620f5314a2SRonnie Sahlberg 24630f5314a2SRonnie SahlbergiSCSI support is an optional feature of QEMU and only available when 24640f5314a2SRonnie Sahlbergcompiled and linked against libiscsi. 2465f9dadc98SRonnie SahlbergETEXI 2466f9dadc98SRonnie SahlbergDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2467f9dadc98SRonnie Sahlberg "-iscsi [user=user][,password=password]\n" 2468f9dadc98SRonnie Sahlberg " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 24692fe3798cSPaolo Bonzini " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 24705dd7a535SPeter Lieven " [,timeout=timeout]\n" 2471f9dadc98SRonnie Sahlberg " iSCSI session parameters\n", QEMU_ARCH_ALL) 2472f9dadc98SRonnie SahlbergSTEXI 24730f5314a2SRonnie Sahlberg 247431459f46SRonnie SahlbergiSCSI parameters such as username and password can also be specified via 247531459f46SRonnie Sahlberga configuration file. See qemu-doc for more information and examples. 247631459f46SRonnie Sahlberg 247708ae330eSRonnie Sahlberg@item NBD 247808ae330eSRonnie SahlbergQEMU supports NBD (Network Block Devices) both using TCP protocol as well 247908ae330eSRonnie Sahlbergas Unix Domain Sockets. 248008ae330eSRonnie Sahlberg 248108ae330eSRonnie SahlbergSyntax for specifying a NBD device using TCP 248208ae330eSRonnie Sahlberg``nbd:<server-ip>:<port>[:exportname=<export>]'' 248308ae330eSRonnie Sahlberg 248408ae330eSRonnie SahlbergSyntax for specifying a NBD device using Unix Domain Sockets 248508ae330eSRonnie Sahlberg``nbd:unix:<domain-socket>[:exportname=<export>]'' 248608ae330eSRonnie Sahlberg 248708ae330eSRonnie Sahlberg 248808ae330eSRonnie SahlbergExample for TCP 248908ae330eSRonnie Sahlberg@example 24903804da9dSStefan Weilqemu-system-i386 --drive file=nbd:192.0.2.1:30000 249108ae330eSRonnie Sahlberg@end example 249208ae330eSRonnie Sahlberg 249308ae330eSRonnie SahlbergExample for Unix Domain Sockets 249408ae330eSRonnie Sahlberg@example 24953804da9dSStefan Weilqemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 249608ae330eSRonnie Sahlberg@end example 249708ae330eSRonnie Sahlberg 24980a12ec87SRichard W.M. Jones@item SSH 24990a12ec87SRichard W.M. JonesQEMU supports SSH (Secure Shell) access to remote disks. 25000a12ec87SRichard W.M. Jones 25010a12ec87SRichard W.M. JonesExamples: 25020a12ec87SRichard W.M. Jones@example 25030a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 25040a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 25050a12ec87SRichard W.M. Jones@end example 25060a12ec87SRichard W.M. Jones 25070a12ec87SRichard W.M. JonesCurrently authentication must be done using ssh-agent. Other 25080a12ec87SRichard W.M. Jonesauthentication methods may be supported in future. 25090a12ec87SRichard W.M. Jones 2510d9990228SRonnie Sahlberg@item Sheepdog 2511d9990228SRonnie SahlbergSheepdog is a distributed storage system for QEMU. 2512d9990228SRonnie SahlbergQEMU supports using either local sheepdog devices or remote networked 2513d9990228SRonnie Sahlbergdevices. 2514d9990228SRonnie Sahlberg 2515d9990228SRonnie SahlbergSyntax for specifying a sheepdog device 25165d6768e3SMORITA Kazutaka@example 25171b8bbb46SMORITA Kazutakasheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 25185d6768e3SMORITA Kazutaka@end example 2519d9990228SRonnie Sahlberg 2520d9990228SRonnie SahlbergExample 2521d9990228SRonnie Sahlberg@example 25225d6768e3SMORITA Kazutakaqemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2523d9990228SRonnie Sahlberg@end example 2524d9990228SRonnie Sahlberg 2525d9990228SRonnie SahlbergSee also @url{http://http://www.osrg.net/sheepdog/}. 2526d9990228SRonnie Sahlberg 25278809e289SBharata B Rao@item GlusterFS 25288809e289SBharata B RaoGlusterFS is an user space distributed file system. 25298809e289SBharata B RaoQEMU supports the use of GlusterFS volumes for hosting VM disk images using 25308809e289SBharata B RaoTCP, Unix Domain Sockets and RDMA transport protocols. 25318809e289SBharata B Rao 25328809e289SBharata B RaoSyntax for specifying a VM disk image on GlusterFS volume is 25338809e289SBharata B Rao@example 25348809e289SBharata B Raogluster[+transport]://[server[:port]]/volname/image[?socket=...] 25358809e289SBharata B Rao@end example 25368809e289SBharata B Rao 25378809e289SBharata B Rao 25388809e289SBharata B RaoExample 25398809e289SBharata B Rao@example 2540db2d5ebaSLei Liqemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 25418809e289SBharata B Rao@end example 25428809e289SBharata B Rao 25438809e289SBharata B RaoSee also @url{http://www.gluster.org}. 25440a86cb73SMatthew Booth 25450a86cb73SMatthew Booth@item HTTP/HTTPS/FTP/FTPS/TFTP 25460a86cb73SMatthew BoothQEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. 25470a86cb73SMatthew Booth 25480a86cb73SMatthew BoothSyntax using a single filename: 25490a86cb73SMatthew Booth@example 25500a86cb73SMatthew Booth<protocol>://[<username>[:<password>]@@]<host>/<path> 25510a86cb73SMatthew Booth@end example 25520a86cb73SMatthew Booth 25530a86cb73SMatthew Boothwhere: 25540a86cb73SMatthew Booth@table @option 25550a86cb73SMatthew Booth@item protocol 25560a86cb73SMatthew Booth'http', 'https', 'ftp', 'ftps', or 'tftp'. 25570a86cb73SMatthew Booth 25580a86cb73SMatthew Booth@item username 25590a86cb73SMatthew BoothOptional username for authentication to the remote server. 25600a86cb73SMatthew Booth 25610a86cb73SMatthew Booth@item password 25620a86cb73SMatthew BoothOptional password for authentication to the remote server. 25630a86cb73SMatthew Booth 25640a86cb73SMatthew Booth@item host 25650a86cb73SMatthew BoothAddress of the remote server. 25660a86cb73SMatthew Booth 25670a86cb73SMatthew Booth@item path 25680a86cb73SMatthew BoothPath on the remote server, including any query string. 25690a86cb73SMatthew Booth@end table 25700a86cb73SMatthew Booth 25710a86cb73SMatthew BoothThe following options are also supported: 25720a86cb73SMatthew Booth@table @option 25730a86cb73SMatthew Booth@item url 25740a86cb73SMatthew BoothThe full URL when passing options to the driver explicitly. 25750a86cb73SMatthew Booth 25760a86cb73SMatthew Booth@item readahead 25770a86cb73SMatthew BoothThe amount of data to read ahead with each range request to the remote server. 25780a86cb73SMatthew BoothThis value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it 25790a86cb73SMatthew Boothdoes not have a suffix, it will be assumed to be in bytes. The value must be a 25800a86cb73SMatthew Boothmultiple of 512 bytes. It defaults to 256k. 25810a86cb73SMatthew Booth 25820a86cb73SMatthew Booth@item sslverify 25830a86cb73SMatthew BoothWhether to verify the remote server's certificate when connecting over SSL. It 25840a86cb73SMatthew Boothcan have the value 'on' or 'off'. It defaults to 'on'. 2585212aefaaSDaniel Henrique Barboza 2586a94f83d9SRichard W.M. Jones@item cookie 2587a94f83d9SRichard W.M. JonesSend this cookie (it can also be a list of cookies separated by ';') with 2588a94f83d9SRichard W.M. Joneseach outgoing request. Only supported when using protocols such as HTTP 2589a94f83d9SRichard W.M. Joneswhich support cookies, otherwise ignored. 2590a94f83d9SRichard W.M. Jones 2591212aefaaSDaniel Henrique Barboza@item timeout 2592212aefaaSDaniel Henrique BarbozaSet the timeout in seconds of the CURL connection. This timeout is the time 2593212aefaaSDaniel Henrique Barbozathat CURL waits for a response from the remote server to get the size of the 2594212aefaaSDaniel Henrique Barbozaimage to be downloaded. If not set, the default timeout of 5 seconds is used. 25950a86cb73SMatthew Booth@end table 25960a86cb73SMatthew Booth 25970a86cb73SMatthew BoothNote that when passing options to qemu explicitly, @option{driver} is the value 25980a86cb73SMatthew Boothof <protocol>. 25990a86cb73SMatthew Booth 26000a86cb73SMatthew BoothExample: boot from a remote Fedora 20 live ISO image 26010a86cb73SMatthew Booth@example 26020a86cb73SMatthew Boothqemu-system-x86_64 --drive media=cdrom,file=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly 26030a86cb73SMatthew Booth 26040a86cb73SMatthew Boothqemu-system-x86_64 --drive media=cdrom,file.driver=http,file.url=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly 26050a86cb73SMatthew Booth@end example 26060a86cb73SMatthew Booth 26070a86cb73SMatthew BoothExample: boot from a remote Fedora 20 cloud image using a local overlay for 26080a86cb73SMatthew Boothwrites, copy-on-read, and a readahead of 64k 26090a86cb73SMatthew Booth@example 26100a86cb73SMatthew Boothqemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, "file.url":"https://dl.fedoraproject.org/pub/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2 26110a86cb73SMatthew Booth 26120a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on 26130a86cb73SMatthew Booth@end example 26140a86cb73SMatthew Booth 26150a86cb73SMatthew BoothExample: boot from an image stored on a VMware vSphere server with a self-signed 2616212aefaaSDaniel Henrique Barbozacertificate using a local overlay for writes, a readahead of 64k and a timeout 2617212aefaaSDaniel Henrique Barbozaof 10 seconds. 26180a86cb73SMatthew Booth@example 2619212aefaaSDaniel Henrique Barbozaqemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10@}' /tmp/test.qcow2 26200a86cb73SMatthew Booth 26210a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/test.qcow2 26220a86cb73SMatthew Booth@end example 2623c70a01e4SMarkus ArmbrusterETEXI 2624c70a01e4SMarkus Armbruster 2625c70a01e4SMarkus ArmbrusterSTEXI 26260f5314a2SRonnie Sahlberg@end table 26270f5314a2SRonnie SahlbergETEXI 26280f5314a2SRonnie Sahlberg 26297273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 2630c70a01e4SMarkus ArmbrusterSTEXI 2631c70a01e4SMarkus Armbruster@table @option 2632c70a01e4SMarkus ArmbrusterETEXI 26337273a2dbSMatthew Booth 26345824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 26355824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 26365824d651Sblueswir1 "-bt hci,host[:id]\n" \ 26375824d651Sblueswir1 " use host's HCI with the given name\n" \ 26385824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 26395824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 26405824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 26415824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 26425824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 2643ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2644ad96090aSBlue Swirl QEMU_ARCH_ALL) 26455824d651Sblueswir1STEXI 26465824d651Sblueswir1@item -bt hci[...] 26476616b2adSStefan Weil@findex -bt 26485824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 26495824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 26505824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 26515824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 26525824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 26535824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 26545824d651Sblueswir1machines have none. 26555824d651Sblueswir1 26565824d651Sblueswir1@anchor{bt-hcis} 26575824d651Sblueswir1The following three types are recognized: 26585824d651Sblueswir1 2659b3f046c2SKevin Wolf@table @option 26605824d651Sblueswir1@item -bt hci,null 26615824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 26625824d651Sblueswir1and will not respond to any HCI commands or emit events. 26635824d651Sblueswir1 26645824d651Sblueswir1@item -bt hci,host[:@var{id}] 26655824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 26665824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 26675824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 26685824d651Sblueswir1capable systems like Linux. 26695824d651Sblueswir1 26705824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 26715824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 26725824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 26735824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 26745824d651Sblueswir1with other devices in the same network (scatternet). 26755824d651Sblueswir1@end table 26765824d651Sblueswir1 26775824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 26785824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 26795824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 26805824d651Sblueswir1allows the host and target machines to participate in a common scatternet 26815824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 26825824d651Sblueswir1be used as following: 26835824d651Sblueswir1 26845824d651Sblueswir1@example 26853804da9dSStefan Weilqemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 26865824d651Sblueswir1@end example 26875824d651Sblueswir1 26885824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 26895824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 26905824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 26915824d651Sblueswir1currently: 26925824d651Sblueswir1 2693b3f046c2SKevin Wolf@table @option 26945824d651Sblueswir1@item keyboard 26955824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 26965824d651Sblueswir1@end table 26975824d651Sblueswir1ETEXI 26985824d651Sblueswir1 2699c70a01e4SMarkus ArmbrusterSTEXI 2700c70a01e4SMarkus Armbruster@end table 2701c70a01e4SMarkus ArmbrusterETEXI 27025824d651Sblueswir1DEFHEADING() 27035824d651Sblueswir1 2704d1a0cf73SStefan Berger#ifdef CONFIG_TPM 2705d1a0cf73SStefan BergerDEFHEADING(TPM device options:) 2706d1a0cf73SStefan Berger 2707d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 270892dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 270992dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 271092dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 271192dcc234SStefan Berger " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2712d1a0cf73SStefan Berger QEMU_ARCH_ALL) 2713d1a0cf73SStefan BergerSTEXI 2714d1a0cf73SStefan Berger 2715d1a0cf73SStefan BergerThe general form of a TPM device option is: 2716d1a0cf73SStefan Berger@table @option 2717d1a0cf73SStefan Berger 2718d1a0cf73SStefan Berger@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2719d1a0cf73SStefan Berger@findex -tpmdev 2720d1a0cf73SStefan BergerBackend type must be: 27214549a8b7SStefan Berger@option{passthrough}. 2722d1a0cf73SStefan Berger 2723d1a0cf73SStefan BergerThe specific backend type will determine the applicable options. 272428c4fa32SCorey BryantThe @code{-tpmdev} option creates the TPM backend and requires a 272528c4fa32SCorey Bryant@code{-device} option that specifies the TPM frontend interface model. 2726d1a0cf73SStefan Berger 2727d1a0cf73SStefan BergerOptions to each backend are described below. 2728d1a0cf73SStefan Berger 2729d1a0cf73SStefan BergerUse 'help' to print all available TPM backend types. 2730d1a0cf73SStefan Berger@example 2731d1a0cf73SStefan Bergerqemu -tpmdev help 2732d1a0cf73SStefan Berger@end example 2733d1a0cf73SStefan Berger 273492dcc234SStefan Berger@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 27354549a8b7SStefan Berger 27364549a8b7SStefan Berger(Linux-host only) Enable access to the host's TPM using the passthrough 27374549a8b7SStefan Bergerdriver. 27384549a8b7SStefan Berger 27394549a8b7SStefan Berger@option{path} specifies the path to the host's TPM device, i.e., on 27404549a8b7SStefan Bergera Linux host this would be @code{/dev/tpm0}. 27414549a8b7SStefan Berger@option{path} is optional and by default @code{/dev/tpm0} is used. 27424549a8b7SStefan Berger 274392dcc234SStefan Berger@option{cancel-path} specifies the path to the host TPM device's sysfs 274492dcc234SStefan Bergerentry allowing for cancellation of an ongoing TPM command. 274592dcc234SStefan Berger@option{cancel-path} is optional and by default QEMU will search for the 274692dcc234SStefan Bergersysfs entry to use. 274792dcc234SStefan Berger 27484549a8b7SStefan BergerSome notes about using the host's TPM with the passthrough driver: 27494549a8b7SStefan Berger 27504549a8b7SStefan BergerThe TPM device accessed by the passthrough driver must not be 27514549a8b7SStefan Bergerused by any other application on the host. 27524549a8b7SStefan Berger 27534549a8b7SStefan BergerSince the host's firmware (BIOS/UEFI) has already initialized the TPM, 27544549a8b7SStefan Bergerthe VM's firmware (BIOS/UEFI) will not be able to initialize the 27554549a8b7SStefan BergerTPM again and may therefore not show a TPM-specific menu that would 27564549a8b7SStefan Bergerotherwise allow the user to configure the TPM, e.g., allow the user to 27574549a8b7SStefan Bergerenable/disable or activate/deactivate the TPM. 27584549a8b7SStefan BergerFurther, if TPM ownership is released from within a VM then the host's TPM 27594549a8b7SStefan Bergerwill get disabled and deactivated. To enable and activate the 27604549a8b7SStefan BergerTPM again afterwards, the host has to be rebooted and the user is 27614549a8b7SStefan Bergerrequired to enter the firmware's menu to enable and activate the TPM. 27624549a8b7SStefan BergerIf the TPM is left disabled and/or deactivated most TPM commands will fail. 27634549a8b7SStefan Berger 27644549a8b7SStefan BergerTo create a passthrough TPM use the following two options: 27654549a8b7SStefan Berger@example 27664549a8b7SStefan Berger-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 27674549a8b7SStefan Berger@end example 27684549a8b7SStefan BergerNote that the @code{-tpmdev} id is @code{tpm0} and is referenced by 27694549a8b7SStefan Berger@code{tpmdev=tpm0} in the device option. 27704549a8b7SStefan Berger 2771d1a0cf73SStefan Berger@end table 2772d1a0cf73SStefan Berger 2773d1a0cf73SStefan BergerETEXI 2774d1a0cf73SStefan Berger 2775d1a0cf73SStefan BergerDEFHEADING() 2776d1a0cf73SStefan Berger 2777d1a0cf73SStefan Berger#endif 2778d1a0cf73SStefan Berger 27797677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 27805824d651Sblueswir1STEXI 27817677f05dSAlexander Graf 27827677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 27837677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 27845824d651Sblueswir1for easier testing of various kernels. 27855824d651Sblueswir1 27865824d651Sblueswir1@table @option 27875824d651Sblueswir1ETEXI 27885824d651Sblueswir1 27895824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2790ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 27915824d651Sblueswir1STEXI 27925824d651Sblueswir1@item -kernel @var{bzImage} 27936616b2adSStefan Weil@findex -kernel 27947677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 27957677f05dSAlexander Grafor in multiboot format. 27965824d651Sblueswir1ETEXI 27975824d651Sblueswir1 27985824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2799ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 28005824d651Sblueswir1STEXI 28015824d651Sblueswir1@item -append @var{cmdline} 28026616b2adSStefan Weil@findex -append 28035824d651Sblueswir1Use @var{cmdline} as kernel command line 28045824d651Sblueswir1ETEXI 28055824d651Sblueswir1 28065824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2807ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 28085824d651Sblueswir1STEXI 28095824d651Sblueswir1@item -initrd @var{file} 28106616b2adSStefan Weil@findex -initrd 28115824d651Sblueswir1Use @var{file} as initial ram disk. 28127677f05dSAlexander Graf 28137677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 28147677f05dSAlexander Graf 28157677f05dSAlexander GrafThis syntax is only available with multiboot. 28167677f05dSAlexander Graf 28177677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 28187677f05dSAlexander Graffirst module. 28195824d651Sblueswir1ETEXI 28205824d651Sblueswir1 2821412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2822379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2823412beee6SGrant LikelySTEXI 2824412beee6SGrant Likely@item -dtb @var{file} 2825412beee6SGrant Likely@findex -dtb 2826412beee6SGrant LikelyUse @var{file} as a device tree binary (dtb) image and pass it to the kernel 2827412beee6SGrant Likelyon boot. 2828412beee6SGrant LikelyETEXI 2829412beee6SGrant Likely 28305824d651Sblueswir1STEXI 28315824d651Sblueswir1@end table 28325824d651Sblueswir1ETEXI 28335824d651Sblueswir1DEFHEADING() 28345824d651Sblueswir1 28355824d651Sblueswir1DEFHEADING(Debug/Expert options:) 28365824d651Sblueswir1STEXI 28375824d651Sblueswir1@table @option 28385824d651Sblueswir1ETEXI 28395824d651Sblueswir1 284081b2b810SGabriel L. SomloDEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 284181b2b810SGabriel L. Somlo "-fw_cfg [name=]<name>,file=<file>\n" 28426407d76eSGabriel L. Somlo " add named fw_cfg entry from file\n" 28436407d76eSGabriel L. Somlo "-fw_cfg [name=]<name>,string=<str>\n" 28446407d76eSGabriel L. Somlo " add named fw_cfg entry from string\n", 284581b2b810SGabriel L. Somlo QEMU_ARCH_ALL) 284681b2b810SGabriel L. SomloSTEXI 284781b2b810SGabriel L. Somlo@item -fw_cfg [name=]@var{name},file=@var{file} 284881b2b810SGabriel L. Somlo@findex -fw_cfg 284981b2b810SGabriel L. SomloAdd named fw_cfg entry from file. @var{name} determines the name of 285081b2b810SGabriel L. Somlothe entry in the fw_cfg file directory exposed to the guest. 28516407d76eSGabriel L. Somlo 28526407d76eSGabriel L. Somlo@item -fw_cfg [name=]@var{name},string=@var{str} 28536407d76eSGabriel L. SomloAdd named fw_cfg entry from string. 285481b2b810SGabriel L. SomloETEXI 285581b2b810SGabriel L. Somlo 28565824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2857ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 2858ad96090aSBlue Swirl QEMU_ARCH_ALL) 28595824d651Sblueswir1STEXI 28605824d651Sblueswir1@item -serial @var{dev} 28616616b2adSStefan Weil@findex -serial 28625824d651Sblueswir1Redirect the virtual serial port to host character device 28635824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 28645824d651Sblueswir1@code{stdio} in non graphical mode. 28655824d651Sblueswir1 28665824d651Sblueswir1This option can be used several times to simulate up to 4 serial 28675824d651Sblueswir1ports. 28685824d651Sblueswir1 28695824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 28705824d651Sblueswir1 28715824d651Sblueswir1Available character devices are: 2872b3f046c2SKevin Wolf@table @option 28734e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 28745824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 28755824d651Sblueswir1@example 28765824d651Sblueswir1vc:800x600 28775824d651Sblueswir1@end example 28785824d651Sblueswir1It is also possible to specify width or height in characters: 28795824d651Sblueswir1@example 28805824d651Sblueswir1vc:80Cx24C 28815824d651Sblueswir1@end example 28825824d651Sblueswir1@item pty 28835824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 28845824d651Sblueswir1@item none 28855824d651Sblueswir1No device is allocated. 28865824d651Sblueswir1@item null 28875824d651Sblueswir1void device 288888e020e5SIngo van Lil@item chardev:@var{id} 288988e020e5SIngo van LilUse a named character device defined with the @code{-chardev} option. 28905824d651Sblueswir1@item /dev/XXX 28915824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 28925824d651Sblueswir1parameters are set according to the emulated ones. 28935824d651Sblueswir1@item /dev/parport@var{N} 28945824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 28955824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 28965824d651Sblueswir1@item file:@var{filename} 28975824d651Sblueswir1Write output to @var{filename}. No character can be read. 28985824d651Sblueswir1@item stdio 28995824d651Sblueswir1[Unix only] standard input/output 29005824d651Sblueswir1@item pipe:@var{filename} 29015824d651Sblueswir1name pipe @var{filename} 29025824d651Sblueswir1@item COM@var{n} 29035824d651Sblueswir1[Windows only] Use host serial port @var{n} 29045824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 29055824d651Sblueswir1This implements UDP Net Console. 29065824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 29075824d651Sblueswir1they default to @code{0.0.0.0}. 29085824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 29095824d651Sblueswir1 29105824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 2911b65ee4faSStefan Weil@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2912b65ee4faSStefan Weil@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 29135824d651Sblueswir1will appear in the netconsole session. 29145824d651Sblueswir1 29155824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 2916b65ee4faSStefan Weiland start QEMU a lot of times, you should have QEMU use the same 29175824d651Sblueswir1source port each time by using something like @code{-serial 2918b65ee4faSStefan Weiludp::4555@@:4556} to QEMU. Another approach is to use a patched 29195824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 29205824d651Sblueswir1characters via udp. If you have a patched version of netcat which 29215824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 29225824d651Sblueswir1use the following options to step up a netcat redirector to allow 2923b65ee4faSStefan Weiltelnet on port 5555 to access the QEMU port. 29245824d651Sblueswir1@table @code 2925071c9394SStefan Weil@item QEMU Options: 29265824d651Sblueswir1-serial udp::4555@@:4556 29275824d651Sblueswir1@item netcat options: 29285824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 29295824d651Sblueswir1@item telnet options: 29305824d651Sblueswir1localhost 5555 29315824d651Sblueswir1@end table 29325824d651Sblueswir1 29335dd1f02bSCorey Minyard@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] 29345824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 29355824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 29365824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 29375824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 29385824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 29395824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 29405dd1f02bSCorey Minyardalgorithm. The @code{reconnect} option only applies if @var{noserver} is 29415dd1f02bSCorey Minyardset, if the connection goes down it will attempt to reconnect at the 29425dd1f02bSCorey Minyardgiven interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only 29435824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 29445824d651Sblueswir1connect to the corresponding character device. 29455824d651Sblueswir1@table @code 29465824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 29475824d651Sblueswir1-serial tcp:192.168.0.2:4444 29485824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 29495824d651Sblueswir1-serial tcp::4444,server 29505824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 29515824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 29525824d651Sblueswir1@end table 29535824d651Sblueswir1 29545824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 29555824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 29565824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 29575824d651Sblueswir1difference is that the port acts like a telnet server or client using 29585824d651Sblueswir1telnet option negotiation. This will also allow you to send the 29595824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 29605824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 29615824d651Sblueswir1type "send break" followed by pressing the enter key. 29625824d651Sblueswir1 29635dd1f02bSCorey Minyard@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] 29645824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 29655824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 29665824d651Sblueswir1@var{path} is used for connections. 29675824d651Sblueswir1 29685824d651Sblueswir1@item mon:@var{dev_string} 29695824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 29705824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 297102c4bdf1SPaolo Bonzini@key{Control-a} and then pressing @key{c}. 29725824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 29735824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 29745824d651Sblueswir1listening on port 4444 would be: 29755824d651Sblueswir1@table @code 29765824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 29775824d651Sblueswir1@end table 2978be022d61SMichael TokarevWhen the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 297902c4bdf1SPaolo BonziniQEMU any more but will be passed to the guest instead. 29805824d651Sblueswir1 29815824d651Sblueswir1@item braille 29825824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 29835824d651Sblueswir1or fake device. 29845824d651Sblueswir1 2985be8b28a9SKevin Wolf@item msmouse 2986be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 29875824d651Sblueswir1@end table 29885824d651Sblueswir1ETEXI 29895824d651Sblueswir1 29905824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2991ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 2992ad96090aSBlue Swirl QEMU_ARCH_ALL) 29935824d651Sblueswir1STEXI 29945824d651Sblueswir1@item -parallel @var{dev} 29956616b2adSStefan Weil@findex -parallel 29965824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 29975824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 29985824d651Sblueswir1be used to use hardware devices connected on the corresponding host 29995824d651Sblueswir1parallel port. 30005824d651Sblueswir1 30015824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 30025824d651Sblueswir1ports. 30035824d651Sblueswir1 30045824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 30055824d651Sblueswir1ETEXI 30065824d651Sblueswir1 30075824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 3008ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 3009ad96090aSBlue Swirl QEMU_ARCH_ALL) 30105824d651Sblueswir1STEXI 30114e307fc8SGerd Hoffmann@item -monitor @var{dev} 30126616b2adSStefan Weil@findex -monitor 30135824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 30145824d651Sblueswir1serial port). 30155824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 30165824d651Sblueswir1non graphical mode. 301770e098afSLuiz CapitulinoUse @code{-monitor none} to disable the default monitor. 30185824d651Sblueswir1ETEXI 30196ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 3020ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 3021ad96090aSBlue Swirl QEMU_ARCH_ALL) 302295d5f08bSStefan WeilSTEXI 302395d5f08bSStefan Weil@item -qmp @var{dev} 30246616b2adSStefan Weil@findex -qmp 302595d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 302695d5f08bSStefan WeilETEXI 30274821cd4cSMax ReitzDEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 30284821cd4cSMax Reitz "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 30294821cd4cSMax Reitz QEMU_ARCH_ALL) 30304821cd4cSMax ReitzSTEXI 30314821cd4cSMax Reitz@item -qmp-pretty @var{dev} 30324821cd4cSMax Reitz@findex -qmp-pretty 30334821cd4cSMax ReitzLike -qmp but uses pretty JSON formatting. 30344821cd4cSMax ReitzETEXI 30355824d651Sblueswir1 303622a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 3037f17e4eaaSMichael Tokarev "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 303822a0e04bSGerd HoffmannSTEXI 3039f17e4eaaSMichael Tokarev@item -mon [chardev=]name[,mode=readline|control][,default] 30406616b2adSStefan Weil@findex -mon 304122a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 304222a0e04bSGerd HoffmannETEXI 304322a0e04bSGerd Hoffmann 3044c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 3045ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 3046ad96090aSBlue Swirl QEMU_ARCH_ALL) 3047c9f398e5SH. Peter AnvinSTEXI 3048c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 30496616b2adSStefan Weil@findex -debugcon 3050c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 3051c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 3052c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 3053c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 3054c9f398e5SH. Peter Anvinnon graphical mode. 3055c9f398e5SH. Peter AnvinETEXI 3056c9f398e5SH. Peter Anvin 30575824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 3058ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 30595824d651Sblueswir1STEXI 30605824d651Sblueswir1@item -pidfile @var{file} 30616616b2adSStefan Weil@findex -pidfile 30625824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 30635824d651Sblueswir1from a script. 30645824d651Sblueswir1ETEXI 30655824d651Sblueswir1 30661b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 3067ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 30681b530a6dSaurel32STEXI 30691b530a6dSaurel32@item -singlestep 30706616b2adSStefan Weil@findex -singlestep 30711b530a6dSaurel32Run the emulation in single step mode. 30721b530a6dSaurel32ETEXI 30731b530a6dSaurel32 30745824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 3075ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 3076ad96090aSBlue Swirl QEMU_ARCH_ALL) 30775824d651Sblueswir1STEXI 30785824d651Sblueswir1@item -S 30796616b2adSStefan Weil@findex -S 30805824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 30815824d651Sblueswir1ETEXI 30825824d651Sblueswir1 3083888a6bc6SSatoru MoriyaDEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 3084888a6bc6SSatoru Moriya "-realtime [mlock=on|off]\n" 3085888a6bc6SSatoru Moriya " run qemu with realtime features\n" 3086888a6bc6SSatoru Moriya " mlock=on|off controls mlock support (default: on)\n", 3087888a6bc6SSatoru Moriya QEMU_ARCH_ALL) 3088888a6bc6SSatoru MoriyaSTEXI 3089888a6bc6SSatoru Moriya@item -realtime mlock=on|off 3090888a6bc6SSatoru Moriya@findex -realtime 3091888a6bc6SSatoru MoriyaRun qemu with realtime features. 3092888a6bc6SSatoru Moriyamlocking qemu and guest memory can be enabled via @option{mlock=on} 3093888a6bc6SSatoru Moriya(enabled by default). 3094888a6bc6SSatoru MoriyaETEXI 3095888a6bc6SSatoru Moriya 309659030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 3097ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 30985824d651Sblueswir1STEXI 309959030a8cSaliguori@item -gdb @var{dev} 31006616b2adSStefan Weil@findex -gdb 310159030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 310259030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 3103b65ee4faSStefan Weilstdio are reasonable use case. The latter is allowing to start QEMU from 310459030a8cSaliguoriwithin gdb and establish the connection via a pipe: 310559030a8cSaliguori@example 31063804da9dSStefan Weil(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 310759030a8cSaliguori@end example 31085824d651Sblueswir1ETEXI 31095824d651Sblueswir1 311059030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 3111ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 3112ad96090aSBlue Swirl QEMU_ARCH_ALL) 31135824d651Sblueswir1STEXI 311459030a8cSaliguori@item -s 31156616b2adSStefan Weil@findex -s 311659030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 311759030a8cSaliguori(@pxref{gdb_usage}). 31185824d651Sblueswir1ETEXI 31195824d651Sblueswir1 31205824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 3121989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 3122ad96090aSBlue Swirl QEMU_ARCH_ALL) 31235824d651Sblueswir1STEXI 3124989b697dSPeter Maydell@item -d @var{item1}[,...] 31256616b2adSStefan Weil@findex -d 3126989b697dSPeter MaydellEnable logging of specified items. Use '-d help' for a list of log items. 31275824d651Sblueswir1ETEXI 31285824d651Sblueswir1 3129c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 3130989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 3131c235d738SMatthew Fernandez QEMU_ARCH_ALL) 3132c235d738SMatthew FernandezSTEXI 31338bd383b4SStefan Weil@item -D @var{logfile} 3134c235d738SMatthew Fernandez@findex -D 3135989b697dSPeter MaydellOutput log in @var{logfile} instead of to stderr 3136c235d738SMatthew FernandezETEXI 3137c235d738SMatthew Fernandez 31385824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 3139ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 3140ad96090aSBlue Swirl QEMU_ARCH_ALL) 31415824d651Sblueswir1STEXI 31425824d651Sblueswir1@item -L @var{path} 31436616b2adSStefan Weil@findex -L 31445824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 31455824d651Sblueswir1ETEXI 31465824d651Sblueswir1 31475824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 3148ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 31495824d651Sblueswir1STEXI 31505824d651Sblueswir1@item -bios @var{file} 31516616b2adSStefan Weil@findex -bios 31525824d651Sblueswir1Set the filename for the BIOS. 31535824d651Sblueswir1ETEXI 31545824d651Sblueswir1 31555824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 3156ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 31575824d651Sblueswir1STEXI 31585824d651Sblueswir1@item -enable-kvm 31596616b2adSStefan Weil@findex -enable-kvm 31605824d651Sblueswir1Enable KVM full virtualization support. This option is only available 31615824d651Sblueswir1if KVM support is enabled when compiling. 31625824d651Sblueswir1ETEXI 31635824d651Sblueswir1 3164e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 3165ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 3166e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 3167e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 3168ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 3169ad96090aSBlue Swirl QEMU_ARCH_ALL) 3170e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 3171e37630caSaliguori "-xen-attach attach to existing xen domain\n" 3172b65ee4faSStefan Weil " xend will use this when starting QEMU\n", 3173ad96090aSBlue Swirl QEMU_ARCH_ALL) 317495d5f08bSStefan WeilSTEXI 317595d5f08bSStefan Weil@item -xen-domid @var{id} 31766616b2adSStefan Weil@findex -xen-domid 317795d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 317895d5f08bSStefan Weil@item -xen-create 31796616b2adSStefan Weil@findex -xen-create 318095d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 318195d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 318295d5f08bSStefan Weil@item -xen-attach 31836616b2adSStefan Weil@findex -xen-attach 318495d5f08bSStefan WeilAttach to existing xen domain. 3185b65ee4faSStefan Weilxend will use this when starting QEMU (XEN only). 318695d5f08bSStefan WeilETEXI 3187e37630caSaliguori 31885824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 3189ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 31905824d651Sblueswir1STEXI 31915824d651Sblueswir1@item -no-reboot 31926616b2adSStefan Weil@findex -no-reboot 31935824d651Sblueswir1Exit instead of rebooting. 31945824d651Sblueswir1ETEXI 31955824d651Sblueswir1 31965824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 3197ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 31985824d651Sblueswir1STEXI 31995824d651Sblueswir1@item -no-shutdown 32006616b2adSStefan Weil@findex -no-shutdown 32015824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 32025824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 32035824d651Sblueswir1disk image. 32045824d651Sblueswir1ETEXI 32055824d651Sblueswir1 32065824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 32075824d651Sblueswir1 "-loadvm [tag|id]\n" \ 3208ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 3209ad96090aSBlue Swirl QEMU_ARCH_ALL) 32105824d651Sblueswir1STEXI 32115824d651Sblueswir1@item -loadvm @var{file} 32126616b2adSStefan Weil@findex -loadvm 32135824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 32145824d651Sblueswir1ETEXI 32155824d651Sblueswir1 32165824d651Sblueswir1#ifndef _WIN32 32175824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 3218ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 32195824d651Sblueswir1#endif 32205824d651Sblueswir1STEXI 32215824d651Sblueswir1@item -daemonize 32226616b2adSStefan Weil@findex -daemonize 32235824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 32245824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 32255824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 32265824d651Sblueswir1to cope with initialization race conditions. 32275824d651Sblueswir1ETEXI 32285824d651Sblueswir1 32295824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 3230ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 3231ad96090aSBlue Swirl QEMU_ARCH_ALL) 32325824d651Sblueswir1STEXI 32335824d651Sblueswir1@item -option-rom @var{file} 32346616b2adSStefan Weil@findex -option-rom 32355824d651Sblueswir1Load the contents of @var{file} as an option ROM. 32365824d651Sblueswir1This option is useful to load things like EtherBoot. 32375824d651Sblueswir1ETEXI 32385824d651Sblueswir1 3239e218052fSMarkus ArmbrusterHXCOMM Silently ignored for compatibility 3240e218052fSMarkus ArmbrusterDEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL) 32415824d651Sblueswir1 32421ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 3243ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 3244ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 32455824d651Sblueswir1 32461ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 324778808141SPaolo Bonzini "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 3248ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 3249ad96090aSBlue Swirl QEMU_ARCH_ALL) 32501ed2fc1fSJan Kiszka 32515824d651Sblueswir1STEXI 32525824d651Sblueswir1 32536875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 32546616b2adSStefan Weil@findex -rtc 32551ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 32561ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 32571ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 32581ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 32591ed2fc1fSJan Kiszka 32609d85d557SMichael TokarevBy default the RTC is driven by the host system time. This allows using of the 32616875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 32626875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 326378808141SPaolo BonziniIf you want to isolate the guest time from the host, you can set @option{clock} 326478808141SPaolo Bonzinito @code{rt} instead. To even prevent it from progressing during suspension, 326578808141SPaolo Bonziniyou can set it to @code{vm}. 32666875204cSJan Kiszka 32671ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 32681ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 32691ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 32701ed2fc1fSJan Kiszkare-inject them. 32715824d651Sblueswir1ETEXI 32725824d651Sblueswir1 32735824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 32744c27b859SPavel Dovgalyuk "-icount [shift=N|auto][,align=on|off][,sleep=no,rr=record|replay,rrfile=<filename>]\n" \ 3275bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 3276f1f4b57eSVictor CLEMENT " instruction, enable aligning the host and virtual clocks\n" \ 3277f1f4b57eSVictor CLEMENT " or disable real time cpu sleeping\n", QEMU_ARCH_ALL) 32785824d651Sblueswir1STEXI 32794c27b859SPavel Dovgalyuk@item -icount [shift=@var{N}|auto][,rr=record|replay,rrfile=@var{filename}] 32806616b2adSStefan Weil@findex -icount 32815824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 32824e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 32835824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 32845824d651Sblueswir1time within a few seconds of real time. 32855824d651Sblueswir1 3286f1f4b57eSVictor CLEMENTWhen the virtual cpu is sleeping, the virtual time will advance at default 3287f1f4b57eSVictor CLEMENTspeed unless @option{sleep=no} is specified. 3288f1f4b57eSVictor CLEMENTWith @option{sleep=no}, the virtual time will jump to the next timer deadline 3289f1f4b57eSVictor CLEMENTinstantly whenever the virtual cpu goes to sleep mode and will not advance 3290f1f4b57eSVictor CLEMENTif no timer is enabled. This behavior give deterministic execution times from 3291f1f4b57eSVictor CLEMENTthe guest point of view. 3292f1f4b57eSVictor CLEMENT 32935824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 32945824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 32955824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 32965824d651Sblueswir1executed often has little or no correlation with actual performance. 3297a8bfac37SSebastian Tanase 3298b6af0975SDaniel P. Berrange@option{align=on} will activate the delay algorithm which will try 3299a8bfac37SSebastian Tanaseto synchronise the host clock and the virtual clock. The goal is to 3300a8bfac37SSebastian Tanasehave a guest running at the real frequency imposed by the shift option. 3301a8bfac37SSebastian TanaseWhenever the guest clock is behind the host clock and if 330282597615SMichael Tokarev@option{align=on} is specified then we print a message to the user 3303a8bfac37SSebastian Tanaseto inform about the delay. 3304a8bfac37SSebastian TanaseCurrently this option does not work when @option{shift} is @code{auto}. 3305a8bfac37SSebastian TanaseNote: The sync algorithm will work for those shift values for which 3306a8bfac37SSebastian Tanasethe guest clock runs ahead of the host clock. Typically this happens 3307a8bfac37SSebastian Tanasewhen the shift value is high (how high depends on the host machine). 33084c27b859SPavel Dovgalyuk 33094c27b859SPavel DovgalyukWhen @option{rr} option is specified deterministic record/replay is enabled. 33104c27b859SPavel DovgalyukReplay log is written into @var{filename} file in record mode and 33114c27b859SPavel Dovgalyukread from this file in replay mode. 33125824d651Sblueswir1ETEXI 33135824d651Sblueswir1 33149dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 3315d7933ef3SXu Wang "-watchdog model\n" \ 3316ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 3317ad96090aSBlue Swirl QEMU_ARCH_ALL) 33189dd986ccSRichard W.M. JonesSTEXI 33199dd986ccSRichard W.M. Jones@item -watchdog @var{model} 33206616b2adSStefan Weil@findex -watchdog 33219dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 33229dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 3323d7933ef3SXu Wangthe guest or else the guest will be restarted. Choose a model for 3324d7933ef3SXu Wangwhich your guest has drivers. 33259dd986ccSRichard W.M. Jones 3326d7933ef3SXu WangThe @var{model} is the model of hardware watchdog to emulate. Use 3327d7933ef3SXu Wang@code{-watchdog help} to list available hardware models. Only one 33289dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 3329d7933ef3SXu Wang 3330d7933ef3SXu WangThe following models may be available: 3331d7933ef3SXu Wang@table @option 3332d7933ef3SXu Wang@item ib700 3333d7933ef3SXu WangiBASE 700 is a very simple ISA watchdog with a single timer. 3334d7933ef3SXu Wang@item i6300esb 3335d7933ef3SXu WangIntel 6300ESB I/O controller hub is a much more featureful PCI-based 3336d7933ef3SXu Wangdual-timer watchdog. 3337188f24c2SXu Wang@item diag288 3338188f24c2SXu WangA virtual watchdog for s390x backed by the diagnose 288 hypercall 3339188f24c2SXu Wang(currently KVM only). 3340d7933ef3SXu Wang@end table 33419dd986ccSRichard W.M. JonesETEXI 33429dd986ccSRichard W.M. Jones 33439dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 33449dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 3345ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 3346ad96090aSBlue Swirl QEMU_ARCH_ALL) 33479dd986ccSRichard W.M. JonesSTEXI 33489dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 3349b8f490ebSMarkus Armbruster@findex -watchdog-action 33509dd986ccSRichard W.M. Jones 33519dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 33529dd986ccSRichard W.M. Jonesexpires. 33539dd986ccSRichard W.M. JonesThe default is 33549dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 33559dd986ccSRichard W.M. JonesOther possible actions are: 33569dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 33579dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 33589dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 33599dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 33609dd986ccSRichard W.M. Jones@code{none} (do nothing). 33619dd986ccSRichard W.M. Jones 33629dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 33639dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 33649dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 33659dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 33669dd986ccSRichard W.M. Jones 33679dd986ccSRichard W.M. JonesExamples: 33689dd986ccSRichard W.M. Jones 33699dd986ccSRichard W.M. Jones@table @code 33709dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 3371f9cfd655SMarkus Armbruster@itemx -watchdog ib700 33729dd986ccSRichard W.M. Jones@end table 33739dd986ccSRichard W.M. JonesETEXI 33749dd986ccSRichard W.M. Jones 33755824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 3376ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 3377ad96090aSBlue Swirl QEMU_ARCH_ALL) 33785824d651Sblueswir1STEXI 33795824d651Sblueswir1 33804e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 33816616b2adSStefan Weil@findex -echr 33825824d651Sblueswir1Change the escape character used for switching to the monitor when using 33835824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 33845824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 33855824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 33865824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 33875824d651Sblueswir1instance you could use the either of the following to change the escape 33885824d651Sblueswir1character to Control-t. 33895824d651Sblueswir1@table @code 33905824d651Sblueswir1@item -echr 0x14 3391f9cfd655SMarkus Armbruster@itemx -echr 20 33925824d651Sblueswir1@end table 33935824d651Sblueswir1ETEXI 33945824d651Sblueswir1 33955824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 33965824d651Sblueswir1 "-virtioconsole c\n" \ 3397ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 33985824d651Sblueswir1STEXI 33995824d651Sblueswir1@item -virtioconsole @var{c} 34006616b2adSStefan Weil@findex -virtioconsole 34015824d651Sblueswir1Set virtio console. 340298b19252SAmit Shah 340398b19252SAmit ShahThis option is maintained for backward compatibility. 340498b19252SAmit Shah 340598b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 34065824d651Sblueswir1ETEXI 34075824d651Sblueswir1 34085824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3409ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 34105824d651Sblueswir1STEXI 341195d5f08bSStefan Weil@item -show-cursor 34126616b2adSStefan Weil@findex -show-cursor 341395d5f08bSStefan WeilShow cursor. 34145824d651Sblueswir1ETEXI 34155824d651Sblueswir1 34165824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3417ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 34185824d651Sblueswir1STEXI 341995d5f08bSStefan Weil@item -tb-size @var{n} 34206616b2adSStefan Weil@findex -tb-size 342195d5f08bSStefan WeilSet TB size. 34225824d651Sblueswir1ETEXI 34235824d651Sblueswir1 34245824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 34257c601803SMichael Tokarev "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \ 34267c601803SMichael Tokarev "-incoming rdma:host:port[,ipv4][,ipv6]\n" \ 34277c601803SMichael Tokarev "-incoming unix:socketpath\n" \ 34287c601803SMichael Tokarev " prepare for incoming migration, listen on\n" \ 34297c601803SMichael Tokarev " specified protocol and socket address\n" \ 34307c601803SMichael Tokarev "-incoming fd:fd\n" \ 34317c601803SMichael Tokarev "-incoming exec:cmdline\n" \ 34327c601803SMichael Tokarev " accept incoming migration on given file descriptor\n" \ 34331597051bSDr. David Alan Gilbert " or from given external command\n" \ 34341597051bSDr. David Alan Gilbert "-incoming defer\n" \ 34351597051bSDr. David Alan Gilbert " wait for the URI to be specified via migrate_incoming\n", 3436ad96090aSBlue Swirl QEMU_ARCH_ALL) 34375824d651Sblueswir1STEXI 34387c601803SMichael Tokarev@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6] 3439f9cfd655SMarkus Armbruster@itemx -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6] 34406616b2adSStefan Weil@findex -incoming 34417c601803SMichael TokarevPrepare for incoming migration, listen on a given tcp port. 34427c601803SMichael Tokarev 34437c601803SMichael Tokarev@item -incoming unix:@var{socketpath} 34447c601803SMichael TokarevPrepare for incoming migration, listen on a given unix socket. 34457c601803SMichael Tokarev 34467c601803SMichael Tokarev@item -incoming fd:@var{fd} 34477c601803SMichael TokarevAccept incoming migration from a given filedescriptor. 34487c601803SMichael Tokarev 34497c601803SMichael Tokarev@item -incoming exec:@var{cmdline} 34507c601803SMichael TokarevAccept incoming migration as an output from specified external command. 34511597051bSDr. David Alan Gilbert 34521597051bSDr. David Alan Gilbert@item -incoming defer 34531597051bSDr. David Alan GilbertWait for the URI to be specified via migrate_incoming. The monitor can 34541597051bSDr. David Alan Gilbertbe used to change settings (such as migration parameters) prior to issuing 34551597051bSDr. David Alan Gilbertthe migrate_incoming to allow the migration to begin. 34565824d651Sblueswir1ETEXI 34575824d651Sblueswir1 3458d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3459ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3460d8c208ddSGerd HoffmannSTEXI 34613dbf2c7fSStefan Weil@item -nodefaults 34626616b2adSStefan Weil@findex -nodefaults 346366c19bf1SMichal NovotnyDon't create default devices. Normally, QEMU sets the default devices like serial 346466c19bf1SMichal Novotnyport, parallel port, virtual console, monitor device, VGA adapter, floppy and 346566c19bf1SMichal NovotnyCD-ROM drive and others. The @code{-nodefaults} option will disable all those 346666c19bf1SMichal Novotnydefault devices. 3467d8c208ddSGerd HoffmannETEXI 3468d8c208ddSGerd Hoffmann 34695824d651Sblueswir1#ifndef _WIN32 34705824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3471ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 3472ad96090aSBlue Swirl QEMU_ARCH_ALL) 34735824d651Sblueswir1#endif 34745824d651Sblueswir1STEXI 34754e257e5eSKevin Wolf@item -chroot @var{dir} 34766616b2adSStefan Weil@findex -chroot 34775824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 34785824d651Sblueswir1directory. Especially useful in combination with -runas. 34795824d651Sblueswir1ETEXI 34805824d651Sblueswir1 34815824d651Sblueswir1#ifndef _WIN32 34825824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 3483ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 3484ad96090aSBlue Swirl QEMU_ARCH_ALL) 34855824d651Sblueswir1#endif 34865824d651Sblueswir1STEXI 34874e257e5eSKevin Wolf@item -runas @var{user} 34886616b2adSStefan Weil@findex -runas 34895824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 34905824d651Sblueswir1to the specified user. 34915824d651Sblueswir1ETEXI 34925824d651Sblueswir1 34935824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 34945824d651Sblueswir1 "-prom-env variable=value\n" 3495ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 3496ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 349795d5f08bSStefan WeilSTEXI 349895d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 34996616b2adSStefan Weil@findex -prom-env 350095d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 350195d5f08bSStefan WeilETEXI 35025824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 3503f7bbcfb5SMichael Walle "-semihosting semihosting mode\n", 35043b3c1694SLeon Alrae QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 35053b3c1694SLeon Alrae QEMU_ARCH_MIPS) 350695d5f08bSStefan WeilSTEXI 350795d5f08bSStefan Weil@item -semihosting 35086616b2adSStefan Weil@findex -semihosting 35093b3c1694SLeon AlraeEnable semihosting mode (ARM, M68K, Xtensa, MIPS only). 3510a38bb079SLiviu IonescuETEXI 3511a38bb079SLiviu IonescuDEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 3512a59d31a1SLeon Alrae "-semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]]\n" \ 3513a59d31a1SLeon Alrae " semihosting configuration\n", 35143b3c1694SLeon AlraeQEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32 | 35153b3c1694SLeon AlraeQEMU_ARCH_MIPS) 3516a38bb079SLiviu IonescuSTEXI 3517a59d31a1SLeon Alrae@item -semihosting-config [enable=on|off][,target=native|gdb|auto][,arg=str[,...]] 3518a38bb079SLiviu Ionescu@findex -semihosting-config 35193b3c1694SLeon AlraeEnable and configure semihosting (ARM, M68K, Xtensa, MIPS only). 3520a59d31a1SLeon Alrae@table @option 3521a59d31a1SLeon Alrae@item target=@code{native|gdb|auto} 3522a59d31a1SLeon AlraeDefines where the semihosting calls will be addressed, to QEMU (@code{native}) 3523a59d31a1SLeon Alraeor to GDB (@code{gdb}). The default is @code{auto}, which means @code{gdb} 3524a59d31a1SLeon Alraeduring debug sessions and @code{native} otherwise. 3525a59d31a1SLeon Alrae@item arg=@var{str1},arg=@var{str2},... 3526a59d31a1SLeon AlraeAllows the user to pass input arguments, and can be used multiple times to build 3527a59d31a1SLeon Alraeup a list. The old-style @code{-kernel}/@code{-append} method of passing a 3528a59d31a1SLeon Alraecommand line is still supported for backward compatibility. If both the 3529a59d31a1SLeon Alrae@code{--semihosting-config arg} and the @code{-kernel}/@code{-append} are 3530a59d31a1SLeon Alraespecified, the former is passed to semihosting as it always takes precedence. 3531a59d31a1SLeon Alrae@end table 353295d5f08bSStefan WeilETEXI 35335824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 3534ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 353595d5f08bSStefan WeilSTEXI 353695d5f08bSStefan Weil@item -old-param 35376616b2adSStefan Weil@findex -old-param (ARM) 353895d5f08bSStefan WeilOld param mode (ARM only). 353995d5f08bSStefan WeilETEXI 354095d5f08bSStefan Weil 35417d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 35427d76ad4fSEduardo Otubo "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 35437d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 35447d76ad4fSEduardo OtuboSTEXI 35456265c43bSMarkus Armbruster@item -sandbox @var{arg} 35467d76ad4fSEduardo Otubo@findex -sandbox 35477d76ad4fSEduardo OtuboEnable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 35487d76ad4fSEduardo Otubodisable it. The default is 'off'. 35497d76ad4fSEduardo OtuboETEXI 35507d76ad4fSEduardo Otubo 3551715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3552ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 35533dbf2c7fSStefan WeilSTEXI 35543dbf2c7fSStefan Weil@item -readconfig @var{file} 35556616b2adSStefan Weil@findex -readconfig 3556ed24cfacSMichal NovotnyRead device configuration from @var{file}. This approach is useful when you want to spawn 3557ed24cfacSMichal NovotnyQEMU process with many command line options but you don't want to exceed the command line 3558ed24cfacSMichal Novotnycharacter limit. 35593dbf2c7fSStefan WeilETEXI 3560715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3561715a664aSGerd Hoffmann "-writeconfig <file>\n" 3562ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 35633dbf2c7fSStefan WeilSTEXI 35643dbf2c7fSStefan Weil@item -writeconfig @var{file} 35656616b2adSStefan Weil@findex -writeconfig 3566ed24cfacSMichal NovotnyWrite device configuration to @var{file}. The @var{file} can be either filename to save 3567ed24cfacSMichal Novotnycommand line and device configuration into file or dash @code{-}) character to print the 3568ed24cfacSMichal Novotnyoutput to stdout. This can be later used as input file for @code{-readconfig} option. 35693dbf2c7fSStefan WeilETEXI 3570292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3571292444cbSAnthony Liguori "-nodefconfig\n" 3572ad96090aSBlue Swirl " do not load default config files at startup\n", 3573ad96090aSBlue Swirl QEMU_ARCH_ALL) 3574292444cbSAnthony LiguoriSTEXI 3575292444cbSAnthony Liguori@item -nodefconfig 35766616b2adSStefan Weil@findex -nodefconfig 3577f29a5614SEduardo HabkostNormally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3578f29a5614SEduardo HabkostThe @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3579f29a5614SEduardo HabkostETEXI 3580f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3581f29a5614SEduardo Habkost "-no-user-config\n" 3582f29a5614SEduardo Habkost " do not load user-provided config files at startup\n", 3583f29a5614SEduardo Habkost QEMU_ARCH_ALL) 3584f29a5614SEduardo HabkostSTEXI 3585f29a5614SEduardo Habkost@item -no-user-config 3586f29a5614SEduardo Habkost@findex -no-user-config 3587f29a5614SEduardo HabkostThe @code{-no-user-config} option makes QEMU not load any of the user-provided 3588f29a5614SEduardo Habkostconfig files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3589f29a5614SEduardo Habkostfiles from @var{datadir}. 3590292444cbSAnthony LiguoriETEXI 3591ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 359210578a25SPaolo Bonzini "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 359323d15e86SLluís " specify tracing options\n", 3594ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 3595ab6540d5SPrerna SaxenaSTEXI 359623d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 359723d15e86SLluísHXCOMM HX does not support conditional compilation of text. 359823d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 3599ab6540d5SPrerna Saxena@findex -trace 3600e4858974SLluís 360123d15e86SLluísSpecify tracing options. 360223d15e86SLluís 360323d15e86SLluís@table @option 360410578a25SPaolo Bonzini@item [enable=]@var{pattern} 360510578a25SPaolo BonziniImmediately enable events matching @var{pattern}. 360610578a25SPaolo BonziniThe file must contain one event name (as listed in the @file{trace-events} file) 360710578a25SPaolo Bonziniper line; globbing patterns are accepted too. This option is only 360810578a25SPaolo Bonziniavailable if QEMU has been compiled with the @var{simple}, @var{stderr} 360910578a25SPaolo Bonzinior @var{ftrace} tracing backend. To specify multiple events or patterns, 361010578a25SPaolo Bonzinispecify the @option{-trace} option multiple times. 361110578a25SPaolo Bonzini 3612e9527dd3SPaolo BonziniUse @code{-trace help} to print a list of names of trace points. 3613e9527dd3SPaolo Bonzini 361423d15e86SLluís@item events=@var{file} 361523d15e86SLluísImmediately enable events listed in @var{file}. 361652449a31SPaolo BonziniThe file must contain one event name (as listed in the @file{trace-events} file) 361752449a31SPaolo Bonziniper line; globbing patterns are accepted too. This option is only 361852449a31SPaolo Bonziniavailable if QEMU has been compiled with the @var{simple}, @var{stderr} or 361952449a31SPaolo Bonzini@var{ftrace} tracing backend. 362052449a31SPaolo Bonzini 362123d15e86SLluís@item file=@var{file} 362223d15e86SLluísLog output traces to @var{file}. 3623c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3624c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 362523d15e86SLluís@end table 3626ab6540d5SPrerna SaxenaETEXI 36273dbf2c7fSStefan Weil 362831e70d6cSMarkus ArmbrusterHXCOMM Internal use 362931e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 363031e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3631c7f0f3b1SAnthony Liguori 36320f66998fSPaul Moore#ifdef __linux__ 36330f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 36340f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 36350f66998fSPaul Moore QEMU_ARCH_ALL) 36360f66998fSPaul Moore#endif 36370f66998fSPaul MooreSTEXI 36380f66998fSPaul Moore@item -enable-fips 36390f66998fSPaul Moore@findex -enable-fips 36400f66998fSPaul MooreEnable FIPS 140-2 compliance mode. 36410f66998fSPaul MooreETEXI 36420f66998fSPaul Moore 3643a0dac021SJan KiszkaHXCOMM Deprecated by -machine accel=tcg property 3644c6e88b3bSBruce RogersDEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3645a0dac021SJan Kiszka 3646c21fb4f8SJan KiszkaHXCOMM Deprecated by kvm-pit driver properties 3647c6e88b3bSBruce RogersDEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3648c21fb4f8SJan Kiszka "", QEMU_ARCH_I386) 3649c21fb4f8SJan Kiszka 36504086bde8SJan KiszkaHXCOMM Deprecated (ignored) 3651c6e88b3bSBruce RogersDEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 36524086bde8SJan Kiszka 3653e43d594eSJan KiszkaHXCOMM Deprecated by -machine kernel_irqchip=on|off property 3654c6e88b3bSBruce RogersDEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3655e43d594eSJan Kiszka 365688eed34aSJan KiszkaHXCOMM Deprecated (ignored) 365788eed34aSJan KiszkaDEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 365888eed34aSJan Kiszka 36595e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 36605e2ac519SSeiji Aguchi "-msg timestamp[=on|off]\n" 36615e2ac519SSeiji Aguchi " change the format of messages\n" 36625e2ac519SSeiji Aguchi " on|off controls leading timestamps (default:on)\n", 36635e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 36645e2ac519SSeiji AguchiSTEXI 36655e2ac519SSeiji Aguchi@item -msg timestamp[=on|off] 36665e2ac519SSeiji Aguchi@findex -msg 36675e2ac519SSeiji Aguchiprepend a timestamp to each log message.(default:on) 36685e2ac519SSeiji AguchiETEXI 36695e2ac519SSeiji Aguchi 3670abfd9ce3SAmit ShahDEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 3671abfd9ce3SAmit Shah "-dump-vmstate <file>\n" 3672abfd9ce3SAmit Shah " Output vmstate information in JSON format to file.\n" 3673abfd9ce3SAmit Shah " Use the scripts/vmstate-static-checker.py file to\n" 3674abfd9ce3SAmit Shah " check for possible regressions in migration code\n" 36752382053fSLaurent Vivier " by comparing two such vmstate dumps.\n", 3676abfd9ce3SAmit Shah QEMU_ARCH_ALL) 3677abfd9ce3SAmit ShahSTEXI 3678abfd9ce3SAmit Shah@item -dump-vmstate @var{file} 3679abfd9ce3SAmit Shah@findex -dump-vmstate 3680abfd9ce3SAmit ShahDump json-encoded vmstate information for current machine type to file 3681abfd9ce3SAmit Shahin @var{file} 3682abfd9ce3SAmit ShahETEXI 3683abfd9ce3SAmit Shah 3684b9174d4fSDaniel P. BerrangeDEFHEADING(Generic object creation) 3685b9174d4fSDaniel P. Berrange 3686b9174d4fSDaniel P. BerrangeDEF("object", HAS_ARG, QEMU_OPTION_object, 3687b9174d4fSDaniel P. Berrange "-object TYPENAME[,PROP1=VALUE1,...]\n" 3688b9174d4fSDaniel P. Berrange " create a new object of type TYPENAME setting properties\n" 3689b9174d4fSDaniel P. Berrange " in the order they are specified. Note that the 'id'\n" 3690b9174d4fSDaniel P. Berrange " property must be set. These objects are placed in the\n" 3691b9174d4fSDaniel P. Berrange " '/objects' path.\n", 3692b9174d4fSDaniel P. Berrange QEMU_ARCH_ALL) 3693b9174d4fSDaniel P. BerrangeSTEXI 3694b9174d4fSDaniel P. Berrange@item -object @var{typename}[,@var{prop1}=@var{value1},...] 3695b9174d4fSDaniel P. Berrange@findex -object 3696b9174d4fSDaniel P. BerrangeCreate a new object of type @var{typename} setting properties 3697b9174d4fSDaniel P. Berrangein the order they are specified. Note that the 'id' 3698b9174d4fSDaniel P. Berrangeproperty must be set. These objects are placed in the 3699b9174d4fSDaniel P. Berrange'/objects' path. 3700b9174d4fSDaniel P. Berrange 3701b9174d4fSDaniel P. Berrange@table @option 3702b9174d4fSDaniel P. Berrange 3703b9174d4fSDaniel P. Berrange@item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|off} 3704b9174d4fSDaniel P. Berrange 3705b9174d4fSDaniel P. BerrangeCreates a memory file backend object, which can be used to back 3706b9174d4fSDaniel P. Berrangethe guest RAM with huge pages. The @option{id} parameter is a 3707b9174d4fSDaniel P. Berrangeunique ID that will be used to reference this memory region 3708b9174d4fSDaniel P. Berrangewhen configuring the @option{-numa} argument. The @option{size} 3709b9174d4fSDaniel P. Berrangeoption provides the size of the memory region, and accepts 3710b9174d4fSDaniel P. Berrangecommon suffixes, eg @option{500M}. The @option{mem-path} provides 3711b9174d4fSDaniel P. Berrangethe path to either a shared memory or huge page filesystem mount. 3712b9174d4fSDaniel P. BerrangeThe @option{share} boolean option determines whether the memory 3713b9174d4fSDaniel P. Berrangeregion is marked as private to QEMU, or shared. The latter allows 3714b9174d4fSDaniel P. Berrangea co-operating external process to access the QEMU memory region. 3715b9174d4fSDaniel P. Berrange 3716b9174d4fSDaniel P. Berrange@item -object rng-random,id=@var{id},filename=@var{/dev/random} 3717b9174d4fSDaniel P. Berrange 3718b9174d4fSDaniel P. BerrangeCreates a random number generator backend which obtains entropy from 3719b9174d4fSDaniel P. Berrangea device on the host. The @option{id} parameter is a unique ID that 3720b9174d4fSDaniel P. Berrangewill be used to reference this entropy backend from the @option{virtio-rng} 3721b9174d4fSDaniel P. Berrangedevice. The @option{filename} parameter specifies which file to obtain 3722b9174d4fSDaniel P. Berrangeentropy from and if omitted defaults to @option{/dev/random}. 3723b9174d4fSDaniel P. Berrange 3724b9174d4fSDaniel P. Berrange@item -object rng-egd,id=@var{id},chardev=@var{chardevid} 3725b9174d4fSDaniel P. Berrange 3726b9174d4fSDaniel P. BerrangeCreates a random number generator backend which obtains entropy from 3727b9174d4fSDaniel P. Berrangean external daemon running on the host. The @option{id} parameter is 3728b9174d4fSDaniel P. Berrangea unique ID that will be used to reference this entropy backend from 3729b9174d4fSDaniel P. Berrangethe @option{virtio-rng} device. The @option{chardev} parameter is 3730b9174d4fSDaniel P. Berrangethe unique ID of a character device backend that provides the connection 3731b9174d4fSDaniel P. Berrangeto the RNG daemon. 3732b9174d4fSDaniel P. Berrange 3733e00adf6cSDaniel P. Berrange@item -object tls-creds-anon,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off} 3734e00adf6cSDaniel P. Berrange 3735e00adf6cSDaniel P. BerrangeCreates a TLS anonymous credentials object, which can be used to provide 3736e00adf6cSDaniel P. BerrangeTLS support on network backends. The @option{id} parameter is a unique 3737e00adf6cSDaniel P. BerrangeID which network backends will use to access the credentials. The 3738e00adf6cSDaniel P. Berrange@option{endpoint} is either @option{server} or @option{client} depending 3739e00adf6cSDaniel P. Berrangeon whether the QEMU network backend that uses the credentials will be 3740e00adf6cSDaniel P. Berrangeacting as a client or as a server. If @option{verify-peer} is enabled 3741e00adf6cSDaniel P. Berrange(the default) then once the handshake is completed, the peer credentials 3742e00adf6cSDaniel P. Berrangewill be verified, though this is a no-op for anonymous credentials. 3743e00adf6cSDaniel P. Berrange 3744e00adf6cSDaniel P. BerrangeThe @var{dir} parameter tells QEMU where to find the credential 3745e00adf6cSDaniel P. Berrangefiles. For server endpoints, this directory may contain a file 3746e00adf6cSDaniel P. Berrange@var{dh-params.pem} providing diffie-hellman parameters to use 3747e00adf6cSDaniel P. Berrangefor the TLS server. If the file is missing, QEMU will generate 3748e00adf6cSDaniel P. Berrangea set of DH parameters at startup. This is a computationally 3749e00adf6cSDaniel P. Berrangeexpensive operation that consumes random pool entropy, so it is 3750e00adf6cSDaniel P. Berrangerecommended that a persistent set of parameters be generated 3751e00adf6cSDaniel P. Berrangeupfront and saved. 3752e00adf6cSDaniel P. Berrange 37531d7b5b4aSDaniel P. Berrange@item -object tls-creds-x509,id=@var{id},endpoint=@var{endpoint},dir=@var{/path/to/cred/dir},verify-peer=@var{on|off},passwordid=@var{id} 375485bcbc78SDaniel P. Berrange 375585bcbc78SDaniel P. BerrangeCreates a TLS anonymous credentials object, which can be used to provide 375685bcbc78SDaniel P. BerrangeTLS support on network backends. The @option{id} parameter is a unique 375785bcbc78SDaniel P. BerrangeID which network backends will use to access the credentials. The 375885bcbc78SDaniel P. Berrange@option{endpoint} is either @option{server} or @option{client} depending 375985bcbc78SDaniel P. Berrangeon whether the QEMU network backend that uses the credentials will be 376085bcbc78SDaniel P. Berrangeacting as a client or as a server. If @option{verify-peer} is enabled 376185bcbc78SDaniel P. Berrange(the default) then once the handshake is completed, the peer credentials 376285bcbc78SDaniel P. Berrangewill be verified. With x509 certificates, this implies that the clients 376385bcbc78SDaniel P. Berrangemust be provided with valid client certificates too. 376485bcbc78SDaniel P. Berrange 376585bcbc78SDaniel P. BerrangeThe @var{dir} parameter tells QEMU where to find the credential 376685bcbc78SDaniel P. Berrangefiles. For server endpoints, this directory may contain a file 376785bcbc78SDaniel P. Berrange@var{dh-params.pem} providing diffie-hellman parameters to use 376885bcbc78SDaniel P. Berrangefor the TLS server. If the file is missing, QEMU will generate 376985bcbc78SDaniel P. Berrangea set of DH parameters at startup. This is a computationally 377085bcbc78SDaniel P. Berrangeexpensive operation that consumes random pool entropy, so it is 377185bcbc78SDaniel P. Berrangerecommended that a persistent set of parameters be generated 377285bcbc78SDaniel P. Berrangeupfront and saved. 377385bcbc78SDaniel P. Berrange 377485bcbc78SDaniel P. BerrangeFor x509 certificate credentials the directory will contain further files 377585bcbc78SDaniel P. Berrangeproviding the x509 certificates. The certificates must be stored 377685bcbc78SDaniel P. Berrangein PEM format, in filenames @var{ca-cert.pem}, @var{ca-crl.pem} (optional), 377785bcbc78SDaniel P. Berrange@var{server-cert.pem} (only servers), @var{server-key.pem} (only servers), 377885bcbc78SDaniel P. Berrange@var{client-cert.pem} (only clients), and @var{client-key.pem} (only clients). 377985bcbc78SDaniel P. Berrange 37801d7b5b4aSDaniel P. BerrangeFor the @var{server-key.pem} and @var{client-key.pem} files which 37811d7b5b4aSDaniel P. Berrangecontain sensitive private keys, it is possible to use an encrypted 37821d7b5b4aSDaniel P. Berrangeversion by providing the @var{passwordid} parameter. This provides 37831d7b5b4aSDaniel P. Berrangethe ID of a previously created @code{secret} object containing the 37841d7b5b4aSDaniel P. Berrangepassword for decryption. 37851d7b5b4aSDaniel P. Berrange 37867dbb11c8SYang Hongyang@item -object filter-buffer,id=@var{id},netdev=@var{netdevid},interval=@var{t}[,queue=@var{all|rx|tx}] 37877dbb11c8SYang Hongyang 37887dbb11c8SYang HongyangInterval @var{t} can't be 0, this filter batches the packet delivery: all 37897dbb11c8SYang Hongyangpackets arriving in a given interval on netdev @var{netdevid} are delayed 37907dbb11c8SYang Hongyanguntil the end of the interval. Interval is in microseconds. 37917dbb11c8SYang Hongyang 37927dbb11c8SYang Hongyangqueue @var{all|rx|tx} is an option that can be applied to any netfilter. 37937dbb11c8SYang Hongyang 37947dbb11c8SYang Hongyang@option{all}: the filter is attached both to the receive and the transmit 37957dbb11c8SYang Hongyang queue of the netdev (default). 37967dbb11c8SYang Hongyang 37977dbb11c8SYang Hongyang@option{rx}: the filter is attached to the receive queue of the netdev, 37987dbb11c8SYang Hongyang where it will receive packets sent to the netdev. 37997dbb11c8SYang Hongyang 38007dbb11c8SYang Hongyang@option{tx}: the filter is attached to the transmit queue of the netdev, 38017dbb11c8SYang Hongyang where it will receive packets sent by the netdev. 38027dbb11c8SYang Hongyang 3803d3e0c032SThomas Huth@item -object filter-dump,id=@var{id},netdev=@var{dev},file=@var{filename}][,maxlen=@var{len}] 3804d3e0c032SThomas Huth 3805d3e0c032SThomas HuthDump the network traffic on netdev @var{dev} to the file specified by 3806d3e0c032SThomas Huth@var{filename}. At most @var{len} bytes (64k by default) per packet are stored. 3807d3e0c032SThomas HuthThe file format is libpcap, so it can be analyzed with tools such as tcpdump 3808d3e0c032SThomas Huthor Wireshark. 3809d3e0c032SThomas Huth 3810ac1d8878SDaniel P. Berrange@item -object secret,id=@var{id},data=@var{string},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}] 3811ac1d8878SDaniel P. Berrange@item -object secret,id=@var{id},file=@var{filename},format=@var{raw|base64}[,keyid=@var{secretid},iv=@var{string}] 3812ac1d8878SDaniel P. Berrange 3813ac1d8878SDaniel P. BerrangeDefines a secret to store a password, encryption key, or some other sensitive 3814ac1d8878SDaniel P. Berrangedata. The sensitive data can either be passed directly via the @var{data} 3815ac1d8878SDaniel P. Berrangeparameter, or indirectly via the @var{file} parameter. Using the @var{data} 3816ac1d8878SDaniel P. Berrangeparameter is insecure unless the sensitive data is encrypted. 3817ac1d8878SDaniel P. Berrange 3818ac1d8878SDaniel P. BerrangeThe sensitive data can be provided in raw format (the default), or base64. 3819ac1d8878SDaniel P. BerrangeWhen encoded as JSON, the raw format only supports valid UTF-8 characters, 3820ac1d8878SDaniel P. Berrangeso base64 is recommended for sending binary data. QEMU will convert from 3821ac1d8878SDaniel P. Berrangewhich ever format is provided to the format it needs internally. eg, an 3822ac1d8878SDaniel P. BerrangeRBD password can be provided in raw format, even though it will be base64 3823ac1d8878SDaniel P. Berrangeencoded when passed onto the RBD sever. 3824ac1d8878SDaniel P. Berrange 3825ac1d8878SDaniel P. BerrangeFor added protection, it is possible to encrypt the data associated with 3826ac1d8878SDaniel P. Berrangea secret using the AES-256-CBC cipher. Use of encryption is indicated 3827ac1d8878SDaniel P. Berrangeby providing the @var{keyid} and @var{iv} parameters. The @var{keyid} 3828ac1d8878SDaniel P. Berrangeparameter provides the ID of a previously defined secret that contains 3829ac1d8878SDaniel P. Berrangethe AES-256 decryption key. This key should be 32-bytes long and be 3830ac1d8878SDaniel P. Berrangebase64 encoded. The @var{iv} parameter provides the random initialization 3831ac1d8878SDaniel P. Berrangevector used for encryption of this particular secret and should be a 3832ac1d8878SDaniel P. Berrangebase64 encrypted string of the 32-byte IV. 3833ac1d8878SDaniel P. Berrange 3834ac1d8878SDaniel P. BerrangeThe simplest (insecure) usage is to provide the secret inline 3835ac1d8878SDaniel P. Berrange 3836ac1d8878SDaniel P. Berrange@example 3837ac1d8878SDaniel P. Berrange 3838ac1d8878SDaniel P. Berrange # $QEMU -object secret,id=sec0,data=letmein,format=raw 3839ac1d8878SDaniel P. Berrange 3840ac1d8878SDaniel P. Berrange@end example 3841ac1d8878SDaniel P. Berrange 3842ac1d8878SDaniel P. BerrangeThe simplest secure usage is to provide the secret via a file 3843ac1d8878SDaniel P. Berrange 3844ac1d8878SDaniel P. Berrange # echo -n "letmein" > mypasswd.txt 3845ac1d8878SDaniel P. Berrange # $QEMU -object secret,id=sec0,file=mypasswd.txt,format=raw 3846ac1d8878SDaniel P. Berrange 3847ac1d8878SDaniel P. BerrangeFor greater security, AES-256-CBC should be used. To illustrate usage, 3848ac1d8878SDaniel P. Berrangeconsider the openssl command line tool which can encrypt the data. Note 3849ac1d8878SDaniel P. Berrangethat when encrypting, the plaintext must be padded to the cipher block 3850ac1d8878SDaniel P. Berrangesize (32 bytes) using the standard PKCS#5/6 compatible padding algorithm. 3851ac1d8878SDaniel P. Berrange 3852ac1d8878SDaniel P. BerrangeFirst a master key needs to be created in base64 encoding: 3853ac1d8878SDaniel P. Berrange 3854ac1d8878SDaniel P. Berrange@example 3855ac1d8878SDaniel P. Berrange # openssl rand -base64 32 > key.b64 3856ac1d8878SDaniel P. Berrange # KEY=$(base64 -d key.b64 | hexdump -v -e '/1 "%02X"') 3857ac1d8878SDaniel P. Berrange@end example 3858ac1d8878SDaniel P. Berrange 3859ac1d8878SDaniel P. BerrangeEach secret to be encrypted needs to have a random initialization vector 3860ac1d8878SDaniel P. Berrangegenerated. These do not need to be kept secret 3861ac1d8878SDaniel P. Berrange 3862ac1d8878SDaniel P. Berrange@example 3863ac1d8878SDaniel P. Berrange # openssl rand -base64 16 > iv.b64 3864ac1d8878SDaniel P. Berrange # IV=$(base64 -d iv.b64 | hexdump -v -e '/1 "%02X"') 3865ac1d8878SDaniel P. Berrange@end example 3866ac1d8878SDaniel P. Berrange 3867ac1d8878SDaniel P. BerrangeThe secret to be defined can now be encrypted, in this case we're 3868ac1d8878SDaniel P. Berrangetelling openssl to base64 encode the result, but it could be left 3869ac1d8878SDaniel P. Berrangeas raw bytes if desired. 3870ac1d8878SDaniel P. Berrange 3871ac1d8878SDaniel P. Berrange@example 3872ac1d8878SDaniel P. Berrange # SECRET=$(echo -n "letmein" | 3873ac1d8878SDaniel P. Berrange openssl enc -aes-256-cbc -a -K $KEY -iv $IV) 3874ac1d8878SDaniel P. Berrange@end example 3875ac1d8878SDaniel P. Berrange 3876ac1d8878SDaniel P. BerrangeWhen launching QEMU, create a master secret pointing to @code{key.b64} 3877ac1d8878SDaniel P. Berrangeand specify that to be used to decrypt the user password. Pass the 3878ac1d8878SDaniel P. Berrangecontents of @code{iv.b64} to the second secret 3879ac1d8878SDaniel P. Berrange 3880ac1d8878SDaniel P. Berrange@example 3881ac1d8878SDaniel P. Berrange # $QEMU \ 3882ac1d8878SDaniel P. Berrange -object secret,id=secmaster0,format=base64,file=key.b64 \ 3883ac1d8878SDaniel P. Berrange -object secret,id=sec0,keyid=secmaster0,format=base64,\ 3884ac1d8878SDaniel P. Berrange data=$SECRET,iv=$(<iv.b64) 3885ac1d8878SDaniel P. Berrange@end example 3886ac1d8878SDaniel P. Berrange 3887b9174d4fSDaniel P. Berrange@end table 3888b9174d4fSDaniel P. Berrange 3889b9174d4fSDaniel P. BerrangeETEXI 3890b9174d4fSDaniel P. Berrange 3891b9174d4fSDaniel P. Berrange 38923dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 38933dbf2c7fSStefan WeilSTEXI 38943dbf2c7fSStefan Weil@end table 38953dbf2c7fSStefan WeilETEXI 3896