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