]>
Commit | Line | Data |
---|---|---|
2313086a 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 | |
4 | HXCOMM DEF(command, args, callback, arg_string, help) is used to construct | |
5 | HXCOMM monitor commands | |
6 | HXCOMM HXCOMM can be used for comments, discarded from both texi and C | |
7 | ||
8 | STEXI | |
9 | @table @option | |
10 | ETEXI | |
11 | ||
d7f9b689 LC |
12 | { |
13 | .name = "help|?", | |
129be006 | 14 | .args_type = "name:S?", |
d7f9b689 LC |
15 | .params = "[cmd]", |
16 | .help = "show the help", | |
af4ce882 | 17 | .mhandler.cmd = do_help_cmd, |
d7f9b689 LC |
18 | }, |
19 | ||
2313086a BS |
20 | STEXI |
21 | @item help or ? [@var{cmd}] | |
70fcbbe7 | 22 | @findex help |
2313086a BS |
23 | Show the help for all commands or just for command @var{cmd}. |
24 | ETEXI | |
25 | ||
d7f9b689 LC |
26 | { |
27 | .name = "commit", | |
28 | .args_type = "device:B", | |
d7f9b689 LC |
29 | .params = "device|all", |
30 | .help = "commit changes to the disk images (if -snapshot is used) or backing files", | |
3e5a50d6 | 31 | .mhandler.cmd = hmp_commit, |
d7f9b689 LC |
32 | }, |
33 | ||
2313086a BS |
34 | STEXI |
35 | @item commit | |
70fcbbe7 | 36 | @findex commit |
2313086a | 37 | Commit changes to the disk images (if -snapshot is used) or backing files. |
37222900 JC |
38 | If the backing file is smaller than the snapshot, then the backing file will be |
39 | resized to be the same size as the snapshot. If the snapshot is smaller than | |
40 | the backing file, the backing file will not be truncated. If you want the | |
41 | backing file to match the size of the smaller snapshot, you can safely truncate | |
42 | it yourself once the commit operation successfully completes. | |
2313086a BS |
43 | ETEXI |
44 | ||
d7f9b689 LC |
45 | { |
46 | .name = "q|quit", | |
47 | .args_type = "", | |
d7f9b689 LC |
48 | .params = "", |
49 | .help = "quit the emulator", | |
7a7f325e | 50 | .mhandler.cmd = hmp_quit, |
d7f9b689 LC |
51 | }, |
52 | ||
2313086a BS |
53 | STEXI |
54 | @item q or quit | |
70fcbbe7 | 55 | @findex quit |
2313086a BS |
56 | Quit the emulator. |
57 | ETEXI | |
58 | ||
6d4a2b3a CH |
59 | { |
60 | .name = "block_resize", | |
61 | .args_type = "device:B,size:o", | |
62 | .params = "device size", | |
63 | .help = "resize a block image", | |
5e7caacb | 64 | .mhandler.cmd = hmp_block_resize, |
6d4a2b3a CH |
65 | }, |
66 | ||
67 | STEXI | |
68 | @item block_resize | |
69 | @findex block_resize | |
70 | Resize a block image while a guest is running. Usually requires guest | |
71 | action to see the updated size. Resize to a lower size is supported, | |
72 | but should be used with extreme caution. Note that this command only | |
73 | resizes image files, it can not resize block devices like LVM volumes. | |
74 | ETEXI | |
75 | ||
12bd451f SH |
76 | { |
77 | .name = "block_stream", | |
c83c66c3 SH |
78 | .args_type = "device:B,speed:o?,base:s?", |
79 | .params = "device [speed [base]]", | |
12bd451f SH |
80 | .help = "copy data from a backing file into a block device", |
81 | .mhandler.cmd = hmp_block_stream, | |
82 | }, | |
83 | ||
84 | STEXI | |
85 | @item block_stream | |
86 | @findex block_stream | |
87 | Copy data from a backing file into a block device. | |
2d47c6e9 SH |
88 | ETEXI |
89 | ||
90 | { | |
91 | .name = "block_job_set_speed", | |
882ec7ce SH |
92 | .args_type = "device:B,speed:o", |
93 | .params = "device speed", | |
2d47c6e9 SH |
94 | .help = "set maximum speed for a background block operation", |
95 | .mhandler.cmd = hmp_block_job_set_speed, | |
96 | }, | |
97 | ||
98 | STEXI | |
4451b799 PB |
99 | @item block_job_set_speed |
100 | @findex block_job_set_speed | |
2d47c6e9 | 101 | Set maximum speed for a background block operation. |
370521a1 SH |
102 | ETEXI |
103 | ||
104 | { | |
105 | .name = "block_job_cancel", | |
6e37fb81 PB |
106 | .args_type = "force:-f,device:B", |
107 | .params = "[-f] device", | |
108 | .help = "stop an active background block operation (use -f" | |
109 | "\n\t\t\t if the operation is currently paused)", | |
370521a1 SH |
110 | .mhandler.cmd = hmp_block_job_cancel, |
111 | }, | |
112 | ||
113 | STEXI | |
114 | @item block_job_cancel | |
115 | @findex block_job_cancel | |
aeae883b PB |
116 | Stop an active background block operation (streaming, mirroring). |
117 | ETEXI | |
118 | ||
119 | { | |
120 | .name = "block_job_complete", | |
121 | .args_type = "device:B", | |
122 | .params = "device", | |
123 | .help = "stop an active background block operation", | |
124 | .mhandler.cmd = hmp_block_job_complete, | |
125 | }, | |
126 | ||
127 | STEXI | |
128 | @item block_job_complete | |
129 | @findex block_job_complete | |
130 | Manually trigger completion of an active background block operation. | |
131 | For mirroring, this will switch the device to the destination path. | |
6e37fb81 PB |
132 | ETEXI |
133 | ||
134 | { | |
135 | .name = "block_job_pause", | |
136 | .args_type = "device:B", | |
137 | .params = "device", | |
138 | .help = "pause an active background block operation", | |
139 | .mhandler.cmd = hmp_block_job_pause, | |
140 | }, | |
141 | ||
142 | STEXI | |
143 | @item block_job_pause | |
144 | @findex block_job_pause | |
145 | Pause an active block streaming operation. | |
146 | ETEXI | |
147 | ||
148 | { | |
149 | .name = "block_job_resume", | |
150 | .args_type = "device:B", | |
151 | .params = "device", | |
152 | .help = "resume a paused background block operation", | |
153 | .mhandler.cmd = hmp_block_job_resume, | |
154 | }, | |
155 | ||
156 | STEXI | |
157 | @item block_job_resume | |
158 | @findex block_job_resume | |
159 | Resume a paused block streaming operation. | |
12bd451f | 160 | ETEXI |
6d4a2b3a | 161 | |
d7f9b689 LC |
162 | { |
163 | .name = "eject", | |
78d714e0 | 164 | .args_type = "force:-f,device:B", |
d7f9b689 LC |
165 | .params = "[-f] device", |
166 | .help = "eject a removable medium (use -f to force it)", | |
c245b6a3 | 167 | .mhandler.cmd = hmp_eject, |
d7f9b689 LC |
168 | }, |
169 | ||
2313086a BS |
170 | STEXI |
171 | @item eject [-f] @var{device} | |
70fcbbe7 | 172 | @findex eject |
2313086a | 173 | Eject a removable medium (use -f to force it). |
9063f814 RH |
174 | ETEXI |
175 | ||
176 | { | |
177 | .name = "drive_del", | |
f7bdc41a | 178 | .args_type = "id:B", |
9063f814 RH |
179 | .params = "device", |
180 | .help = "remove host block device", | |
072ebe6b | 181 | .mhandler.cmd = hmp_drive_del, |
9063f814 RH |
182 | }, |
183 | ||
184 | STEXI | |
185 | @item drive_del @var{device} | |
186 | @findex drive_del | |
187 | Remove host block device. The result is that guest generated IO is no longer | |
188 | submitted against the host device underlying the disk. Once a drive has | |
189 | been deleted, the QEMU Block layer returns -EIO which results in IO | |
190 | errors in the guest for applications that are reading/writing to the device. | |
293c51a6 SH |
191 | These errors are always reported to the guest, regardless of the drive's error |
192 | actions (drive options rerror, werror). | |
2313086a BS |
193 | ETEXI |
194 | ||
d7f9b689 LC |
195 | { |
196 | .name = "change", | |
197 | .args_type = "device:B,target:F,arg:s?", | |
d7f9b689 LC |
198 | .params = "device filename [format]", |
199 | .help = "change a removable medium, optional format", | |
333a96ec | 200 | .mhandler.cmd = hmp_change, |
d7f9b689 LC |
201 | }, |
202 | ||
2313086a BS |
203 | STEXI |
204 | @item change @var{device} @var{setting} | |
70fcbbe7 | 205 | @findex change |
2313086a BS |
206 | Change the configuration of a device. |
207 | ||
208 | @table @option | |
209 | @item change @var{diskdevice} @var{filename} [@var{format}] | |
210 | Change the medium for a removable disk device to point to @var{filename}. eg | |
211 | ||
212 | @example | |
213 | (qemu) change ide1-cd0 /path/to/some.iso | |
214 | @end example | |
215 | ||
216 | @var{format} is optional. | |
217 | ||
218 | @item change vnc @var{display},@var{options} | |
219 | Change the configuration of the VNC server. The valid syntax for @var{display} | |
220 | and @var{options} are described at @ref{sec_invocation}. eg | |
221 | ||
222 | @example | |
223 | (qemu) change vnc localhost:1 | |
224 | @end example | |
225 | ||
226 | @item change vnc password [@var{password}] | |
227 | ||
228 | Change the password associated with the VNC server. If the new password is not | |
229 | supplied, the monitor will prompt for it to be entered. VNC passwords are only | |
230 | significant up to 8 letters. eg | |
231 | ||
232 | @example | |
233 | (qemu) change vnc password | |
234 | Password: ******** | |
235 | @end example | |
236 | ||
237 | @end table | |
238 | ETEXI | |
239 | ||
d7f9b689 LC |
240 | { |
241 | .name = "screendump", | |
242 | .args_type = "filename:F", | |
d7f9b689 LC |
243 | .params = "filename", |
244 | .help = "save screen into PPM image 'filename'", | |
3e5a50d6 | 245 | .mhandler.cmd = hmp_screendump, |
d7f9b689 LC |
246 | }, |
247 | ||
2313086a BS |
248 | STEXI |
249 | @item screendump @var{filename} | |
70fcbbe7 | 250 | @findex screendump |
2313086a BS |
251 | Save screen into PPM image @var{filename}. |
252 | ETEXI | |
253 | ||
d7f9b689 LC |
254 | { |
255 | .name = "logfile", | |
256 | .args_type = "filename:F", | |
d7f9b689 LC |
257 | .params = "filename", |
258 | .help = "output logs to 'filename'", | |
3e5a50d6 | 259 | .mhandler.cmd = hmp_logfile, |
d7f9b689 LC |
260 | }, |
261 | ||
2313086a BS |
262 | STEXI |
263 | @item logfile @var{filename} | |
70fcbbe7 | 264 | @findex logfile |
2313086a BS |
265 | Output logs to @var{filename}. |
266 | ETEXI | |
267 | ||
22890ab5 PS |
268 | { |
269 | .name = "trace-event", | |
270 | .args_type = "name:s,option:b", | |
271 | .params = "name on|off", | |
272 | .help = "changes status of a specific trace event", | |
3e5a50d6 | 273 | .mhandler.cmd = hmp_trace_event, |
22890ab5 PS |
274 | }, |
275 | ||
276 | STEXI | |
277 | @item trace-event | |
278 | @findex trace-event | |
279 | changes status of a trace event | |
c5ceb523 SH |
280 | ETEXI |
281 | ||
c45a8168 | 282 | #if defined(CONFIG_TRACE_SIMPLE) |
c5ceb523 SH |
283 | { |
284 | .name = "trace-file", | |
285 | .args_type = "op:s?,arg:F?", | |
286 | .params = "on|off|flush|set [arg]", | |
287 | .help = "open, close, or flush trace file, or set a new file name", | |
3e5a50d6 | 288 | .mhandler.cmd = hmp_trace_file, |
c5ceb523 SH |
289 | }, |
290 | ||
291 | STEXI | |
292 | @item trace-file on|off|flush | |
293 | @findex trace-file | |
294 | Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed. | |
22890ab5 PS |
295 | ETEXI |
296 | #endif | |
297 | ||
d7f9b689 LC |
298 | { |
299 | .name = "log", | |
300 | .args_type = "items:s", | |
d7f9b689 | 301 | .params = "item1[,...]", |
989b697d | 302 | .help = "activate logging of the specified items", |
3e5a50d6 | 303 | .mhandler.cmd = hmp_log, |
d7f9b689 LC |
304 | }, |
305 | ||
2313086a BS |
306 | STEXI |
307 | @item log @var{item1}[,...] | |
70fcbbe7 | 308 | @findex log |
989b697d | 309 | Activate logging of the specified items. |
2313086a BS |
310 | ETEXI |
311 | ||
d7f9b689 LC |
312 | { |
313 | .name = "savevm", | |
314 | .args_type = "name:s?", | |
d7f9b689 LC |
315 | .params = "[tag|id]", |
316 | .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created", | |
3e5a50d6 | 317 | .mhandler.cmd = hmp_savevm, |
d7f9b689 LC |
318 | }, |
319 | ||
2313086a BS |
320 | STEXI |
321 | @item savevm [@var{tag}|@var{id}] | |
70fcbbe7 | 322 | @findex savevm |
2313086a BS |
323 | Create a snapshot of the whole virtual machine. If @var{tag} is |
324 | provided, it is used as human readable identifier. If there is already | |
325 | a snapshot with the same tag or ID, it is replaced. More info at | |
326 | @ref{vm_snapshots}. | |
327 | ETEXI | |
328 | ||
d7f9b689 LC |
329 | { |
330 | .name = "loadvm", | |
331 | .args_type = "name:s", | |
d7f9b689 LC |
332 | .params = "tag|id", |
333 | .help = "restore a VM snapshot from its tag or id", | |
3e5a50d6 | 334 | .mhandler.cmd = hmp_loadvm, |
b21631f3 | 335 | .command_completion = loadvm_completion, |
d7f9b689 LC |
336 | }, |
337 | ||
2313086a BS |
338 | STEXI |
339 | @item loadvm @var{tag}|@var{id} | |
70fcbbe7 | 340 | @findex loadvm |
2313086a BS |
341 | Set the whole virtual machine to the snapshot identified by the tag |
342 | @var{tag} or the unique snapshot ID @var{id}. | |
343 | ETEXI | |
344 | ||
d7f9b689 LC |
345 | { |
346 | .name = "delvm", | |
347 | .args_type = "name:s", | |
d7f9b689 LC |
348 | .params = "tag|id", |
349 | .help = "delete a VM snapshot from its tag or id", | |
3e5a50d6 | 350 | .mhandler.cmd = hmp_delvm, |
b21631f3 | 351 | .command_completion = delvm_completion, |
d7f9b689 LC |
352 | }, |
353 | ||
2313086a BS |
354 | STEXI |
355 | @item delvm @var{tag}|@var{id} | |
70fcbbe7 | 356 | @findex delvm |
2313086a BS |
357 | Delete the snapshot identified by @var{tag} or @var{id}. |
358 | ETEXI | |
359 | ||
d7f9b689 LC |
360 | { |
361 | .name = "singlestep", | |
362 | .args_type = "option:s?", | |
d7f9b689 LC |
363 | .params = "[on|off]", |
364 | .help = "run emulation in singlestep mode or switch to normal mode", | |
3e5a50d6 | 365 | .mhandler.cmd = hmp_singlestep, |
d7f9b689 LC |
366 | }, |
367 | ||
2313086a BS |
368 | STEXI |
369 | @item singlestep [off] | |
70fcbbe7 | 370 | @findex singlestep |
2313086a BS |
371 | Run the emulation in single step mode. |
372 | If called with option off, the emulation returns to normal mode. | |
373 | ETEXI | |
374 | ||
d7f9b689 LC |
375 | { |
376 | .name = "stop", | |
377 | .args_type = "", | |
d7f9b689 LC |
378 | .params = "", |
379 | .help = "stop emulation", | |
5f158f21 | 380 | .mhandler.cmd = hmp_stop, |
d7f9b689 LC |
381 | }, |
382 | ||
2313086a BS |
383 | STEXI |
384 | @item stop | |
70fcbbe7 | 385 | @findex stop |
2313086a BS |
386 | Stop emulation. |
387 | ETEXI | |
388 | ||
d7f9b689 LC |
389 | { |
390 | .name = "c|cont", | |
391 | .args_type = "", | |
d7f9b689 LC |
392 | .params = "", |
393 | .help = "resume emulation", | |
e42e818b | 394 | .mhandler.cmd = hmp_cont, |
d7f9b689 LC |
395 | }, |
396 | ||
2313086a BS |
397 | STEXI |
398 | @item c or cont | |
70fcbbe7 | 399 | @findex cont |
2313086a | 400 | Resume emulation. |
9b9df25a GH |
401 | ETEXI |
402 | ||
403 | { | |
404 | .name = "system_wakeup", | |
405 | .args_type = "", | |
406 | .params = "", | |
407 | .help = "wakeup guest from suspend", | |
408 | .mhandler.cmd = hmp_system_wakeup, | |
409 | }, | |
410 | ||
411 | STEXI | |
412 | @item system_wakeup | |
413 | @findex system_wakeup | |
414 | Wakeup guest from suspend. | |
2313086a BS |
415 | ETEXI |
416 | ||
d7f9b689 LC |
417 | { |
418 | .name = "gdbserver", | |
419 | .args_type = "device:s?", | |
d7f9b689 LC |
420 | .params = "[device]", |
421 | .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'", | |
3e5a50d6 | 422 | .mhandler.cmd = hmp_gdbserver, |
d7f9b689 LC |
423 | }, |
424 | ||
2313086a BS |
425 | STEXI |
426 | @item gdbserver [@var{port}] | |
70fcbbe7 | 427 | @findex gdbserver |
2313086a BS |
428 | Start gdbserver session (default @var{port}=1234) |
429 | ETEXI | |
430 | ||
d7f9b689 LC |
431 | { |
432 | .name = "x", | |
433 | .args_type = "fmt:/,addr:l", | |
d7f9b689 LC |
434 | .params = "/fmt addr", |
435 | .help = "virtual memory dump starting at 'addr'", | |
3e5a50d6 | 436 | .mhandler.cmd = hmp_memory_dump, |
d7f9b689 LC |
437 | }, |
438 | ||
2313086a BS |
439 | STEXI |
440 | @item x/fmt @var{addr} | |
70fcbbe7 | 441 | @findex x |
2313086a BS |
442 | Virtual memory dump starting at @var{addr}. |
443 | ETEXI | |
444 | ||
d7f9b689 LC |
445 | { |
446 | .name = "xp", | |
447 | .args_type = "fmt:/,addr:l", | |
d7f9b689 LC |
448 | .params = "/fmt addr", |
449 | .help = "physical memory dump starting at 'addr'", | |
3e5a50d6 | 450 | .mhandler.cmd = hmp_physical_memory_dump, |
d7f9b689 LC |
451 | }, |
452 | ||
2313086a BS |
453 | STEXI |
454 | @item xp /@var{fmt} @var{addr} | |
70fcbbe7 | 455 | @findex xp |
2313086a BS |
456 | Physical memory dump starting at @var{addr}. |
457 | ||
458 | @var{fmt} is a format which tells the command how to format the | |
459 | data. Its syntax is: @option{/@{count@}@{format@}@{size@}} | |
460 | ||
461 | @table @var | |
462 | @item count | |
463 | is the number of items to be dumped. | |
464 | ||
465 | @item format | |
466 | can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), | |
467 | c (char) or i (asm instruction). | |
468 | ||
469 | @item size | |
470 | can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, | |
471 | @code{h} or @code{w} can be specified with the @code{i} format to | |
472 | respectively select 16 or 32 bit code instruction size. | |
473 | ||
474 | @end table | |
475 | ||
476 | Examples: | |
477 | @itemize | |
478 | @item | |
479 | Dump 10 instructions at the current instruction pointer: | |
480 | @example | |
481 | (qemu) x/10i $eip | |
482 | 0x90107063: ret | |
483 | 0x90107064: sti | |
484 | 0x90107065: lea 0x0(%esi,1),%esi | |
485 | 0x90107069: lea 0x0(%edi,1),%edi | |
486 | 0x90107070: ret | |
487 | 0x90107071: jmp 0x90107080 | |
488 | 0x90107073: nop | |
489 | 0x90107074: nop | |
490 | 0x90107075: nop | |
491 | 0x90107076: nop | |
492 | @end example | |
493 | ||
494 | @item | |
495 | Dump 80 16 bit values at the start of the video memory. | |
496 | @smallexample | |
497 | (qemu) xp/80hx 0xb8000 | |
498 | 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42 | |
499 | 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41 | |
500 | 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72 | |
501 | 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73 | |
502 | 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20 | |
503 | 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720 | |
504 | 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 | |
505 | 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 | |
506 | 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 | |
507 | 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 | |
508 | @end smallexample | |
509 | @end itemize | |
510 | ETEXI | |
511 | ||
d7f9b689 LC |
512 | { |
513 | .name = "p|print", | |
514 | .args_type = "fmt:/,val:l", | |
d7f9b689 LC |
515 | .params = "/fmt expr", |
516 | .help = "print expression value (use $reg for CPU register access)", | |
af4ce882 | 517 | .mhandler.cmd = do_print, |
d7f9b689 LC |
518 | }, |
519 | ||
2313086a BS |
520 | STEXI |
521 | @item p or print/@var{fmt} @var{expr} | |
70fcbbe7 | 522 | @findex print |
2313086a BS |
523 | Print expression value. Only the @var{format} part of @var{fmt} is |
524 | used. | |
525 | ETEXI | |
526 | ||
d7f9b689 LC |
527 | { |
528 | .name = "i", | |
529 | .args_type = "fmt:/,addr:i,index:i.", | |
d7f9b689 LC |
530 | .params = "/fmt addr", |
531 | .help = "I/O port read", | |
3e5a50d6 | 532 | .mhandler.cmd = hmp_ioport_read, |
d7f9b689 LC |
533 | }, |
534 | ||
2313086a | 535 | STEXI |
b76d799e MA |
536 | @item i/@var{fmt} @var{addr} [.@var{index}] |
537 | @findex i | |
2313086a BS |
538 | Read I/O port. |
539 | ETEXI | |
540 | ||
d7f9b689 LC |
541 | { |
542 | .name = "o", | |
543 | .args_type = "fmt:/,addr:i,val:i", | |
d7f9b689 LC |
544 | .params = "/fmt addr value", |
545 | .help = "I/O port write", | |
3e5a50d6 | 546 | .mhandler.cmd = hmp_ioport_write, |
d7f9b689 LC |
547 | }, |
548 | ||
f114784f | 549 | STEXI |
b76d799e MA |
550 | @item o/@var{fmt} @var{addr} @var{val} |
551 | @findex o | |
f114784f JK |
552 | Write to I/O port. |
553 | ETEXI | |
2313086a | 554 | |
d7f9b689 LC |
555 | { |
556 | .name = "sendkey", | |
2ef20c15 | 557 | .args_type = "keys:s,hold-time:i?", |
d7f9b689 LC |
558 | .params = "keys [hold_ms]", |
559 | .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)", | |
3e5a50d6 | 560 | .mhandler.cmd = hmp_sendkey, |
29136cd8 | 561 | .command_completion = sendkey_completion, |
d7f9b689 LC |
562 | }, |
563 | ||
2313086a BS |
564 | STEXI |
565 | @item sendkey @var{keys} | |
70fcbbe7 | 566 | @findex sendkey |
886cc706 AK |
567 | Send @var{keys} to the guest. @var{keys} could be the name of the |
568 | key or the raw value in hexadecimal format. Use @code{-} to press | |
569 | several keys simultaneously. Example: | |
2313086a BS |
570 | @example |
571 | sendkey ctrl-alt-f1 | |
572 | @end example | |
573 | ||
574 | This command is useful to send keys that your graphical user interface | |
575 | intercepts at low level, such as @code{ctrl-alt-f1} in X Window. | |
576 | ETEXI | |
577 | ||
d7f9b689 LC |
578 | { |
579 | .name = "system_reset", | |
580 | .args_type = "", | |
d7f9b689 LC |
581 | .params = "", |
582 | .help = "reset the system", | |
38d22653 | 583 | .mhandler.cmd = hmp_system_reset, |
d7f9b689 LC |
584 | }, |
585 | ||
2313086a BS |
586 | STEXI |
587 | @item system_reset | |
70fcbbe7 | 588 | @findex system_reset |
2313086a BS |
589 | Reset the system. |
590 | ETEXI | |
591 | ||
d7f9b689 LC |
592 | { |
593 | .name = "system_powerdown", | |
594 | .args_type = "", | |
d7f9b689 LC |
595 | .params = "", |
596 | .help = "send system power down event", | |
5bc465e4 | 597 | .mhandler.cmd = hmp_system_powerdown, |
d7f9b689 LC |
598 | }, |
599 | ||
2313086a BS |
600 | STEXI |
601 | @item system_powerdown | |
70fcbbe7 | 602 | @findex system_powerdown |
2313086a BS |
603 | Power down the system (if supported). |
604 | ETEXI | |
605 | ||
d7f9b689 LC |
606 | { |
607 | .name = "sum", | |
608 | .args_type = "start:i,size:i", | |
d7f9b689 LC |
609 | .params = "addr size", |
610 | .help = "compute the checksum of a memory region", | |
3e5a50d6 | 611 | .mhandler.cmd = hmp_sum, |
d7f9b689 LC |
612 | }, |
613 | ||
2313086a BS |
614 | STEXI |
615 | @item sum @var{addr} @var{size} | |
70fcbbe7 | 616 | @findex sum |
2313086a BS |
617 | Compute the checksum of a memory region. |
618 | ETEXI | |
619 | ||
d7f9b689 LC |
620 | { |
621 | .name = "usb_add", | |
622 | .args_type = "devname:s", | |
d7f9b689 LC |
623 | .params = "device", |
624 | .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')", | |
3e5a50d6 | 625 | .mhandler.cmd = hmp_usb_add, |
d7f9b689 LC |
626 | }, |
627 | ||
2313086a BS |
628 | STEXI |
629 | @item usb_add @var{devname} | |
70fcbbe7 | 630 | @findex usb_add |
2313086a BS |
631 | Add the USB device @var{devname}. For details of available devices see |
632 | @ref{usb_devices} | |
633 | ETEXI | |
634 | ||
d7f9b689 LC |
635 | { |
636 | .name = "usb_del", | |
637 | .args_type = "devname:s", | |
d7f9b689 LC |
638 | .params = "device", |
639 | .help = "remove USB device 'bus.addr'", | |
3e5a50d6 | 640 | .mhandler.cmd = hmp_usb_del, |
d7f9b689 LC |
641 | }, |
642 | ||
2313086a BS |
643 | STEXI |
644 | @item usb_del @var{devname} | |
70fcbbe7 | 645 | @findex usb_del |
2313086a BS |
646 | Remove the USB device @var{devname} from the QEMU virtual USB |
647 | hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor | |
648 | command @code{info usb} to see the devices you can remove. | |
649 | ETEXI | |
650 | ||
d7f9b689 LC |
651 | { |
652 | .name = "device_add", | |
c7e4e8ce MA |
653 | .args_type = "device:O", |
654 | .params = "driver[,prop=value][,...]", | |
d7f9b689 | 655 | .help = "add device, like -device on the command line", |
318660f8 | 656 | .mhandler.cmd = hmp_device_add, |
2da1b3ab | 657 | .command_completion = device_add_completion, |
d7f9b689 LC |
658 | }, |
659 | ||
3418bd25 GH |
660 | STEXI |
661 | @item device_add @var{config} | |
70fcbbe7 | 662 | @findex device_add |
3418bd25 GH |
663 | Add device. |
664 | ETEXI | |
665 | ||
d7f9b689 LC |
666 | { |
667 | .name = "device_del", | |
668 | .args_type = "id:s", | |
d7f9b689 LC |
669 | .params = "device", |
670 | .help = "remove device", | |
a15fef21 | 671 | .mhandler.cmd = hmp_device_del, |
2da1b3ab | 672 | .command_completion = device_del_completion, |
d7f9b689 LC |
673 | }, |
674 | ||
3418bd25 GH |
675 | STEXI |
676 | @item device_del @var{id} | |
70fcbbe7 | 677 | @findex device_del |
3418bd25 GH |
678 | Remove device @var{id}. |
679 | ETEXI | |
680 | ||
d7f9b689 LC |
681 | { |
682 | .name = "cpu", | |
683 | .args_type = "index:i", | |
d7f9b689 LC |
684 | .params = "index", |
685 | .help = "set the default CPU", | |
755f1968 | 686 | .mhandler.cmd = hmp_cpu, |
d7f9b689 | 687 | }, |
3418bd25 | 688 | |
2313086a | 689 | STEXI |
c427ea9c MA |
690 | @item cpu @var{index} |
691 | @findex cpu | |
2313086a BS |
692 | Set the default CPU. |
693 | ETEXI | |
694 | ||
d7f9b689 LC |
695 | { |
696 | .name = "mouse_move", | |
697 | .args_type = "dx_str:s,dy_str:s,dz_str:s?", | |
d7f9b689 LC |
698 | .params = "dx dy [dz]", |
699 | .help = "send mouse move events", | |
3e5a50d6 | 700 | .mhandler.cmd = hmp_mouse_move, |
d7f9b689 LC |
701 | }, |
702 | ||
2313086a BS |
703 | STEXI |
704 | @item mouse_move @var{dx} @var{dy} [@var{dz}] | |
70fcbbe7 | 705 | @findex mouse_move |
2313086a BS |
706 | Move the active mouse to the specified coordinates @var{dx} @var{dy} |
707 | with optional scroll axis @var{dz}. | |
708 | ETEXI | |
709 | ||
d7f9b689 LC |
710 | { |
711 | .name = "mouse_button", | |
712 | .args_type = "button_state:i", | |
d7f9b689 LC |
713 | .params = "state", |
714 | .help = "change mouse button state (1=L, 2=M, 4=R)", | |
3e5a50d6 | 715 | .mhandler.cmd = hmp_mouse_button, |
d7f9b689 LC |
716 | }, |
717 | ||
2313086a BS |
718 | STEXI |
719 | @item mouse_button @var{val} | |
70fcbbe7 | 720 | @findex mouse_button |
2313086a BS |
721 | Change the active mouse button state @var{val} (1=L, 2=M, 4=R). |
722 | ETEXI | |
723 | ||
d7f9b689 LC |
724 | { |
725 | .name = "mouse_set", | |
726 | .args_type = "index:i", | |
d7f9b689 LC |
727 | .params = "index", |
728 | .help = "set which mouse device receives events", | |
3e5a50d6 | 729 | .mhandler.cmd = hmp_mouse_set, |
d7f9b689 LC |
730 | }, |
731 | ||
2313086a BS |
732 | STEXI |
733 | @item mouse_set @var{index} | |
70fcbbe7 | 734 | @findex mouse_set |
2313086a BS |
735 | Set which mouse device receives events at given @var{index}, index |
736 | can be obtained with | |
737 | @example | |
738 | info mice | |
739 | @end example | |
740 | ETEXI | |
741 | ||
d7f9b689 LC |
742 | { |
743 | .name = "wavcapture", | |
744 | .args_type = "path:F,freq:i?,bits:i?,nchannels:i?", | |
d7f9b689 LC |
745 | .params = "path [frequency [bits [channels]]]", |
746 | .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)", | |
3e5a50d6 | 747 | .mhandler.cmd = hmp_wavcapture, |
d7f9b689 | 748 | }, |
2313086a BS |
749 | STEXI |
750 | @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]] | |
70fcbbe7 | 751 | @findex wavcapture |
2313086a BS |
752 | Capture audio into @var{filename}. Using sample rate @var{frequency} |
753 | bits per sample @var{bits} and number of channels @var{channels}. | |
754 | ||
755 | Defaults: | |
756 | @itemize @minus | |
757 | @item Sample rate = 44100 Hz - CD quality | |
758 | @item Bits = 16 | |
759 | @item Number of channels = 2 - Stereo | |
760 | @end itemize | |
761 | ETEXI | |
762 | ||
d7f9b689 LC |
763 | { |
764 | .name = "stopcapture", | |
765 | .args_type = "n:i", | |
d7f9b689 LC |
766 | .params = "capture index", |
767 | .help = "stop capture", | |
3e5a50d6 | 768 | .mhandler.cmd = hmp_stopcapture, |
d7f9b689 | 769 | }, |
2313086a BS |
770 | STEXI |
771 | @item stopcapture @var{index} | |
70fcbbe7 | 772 | @findex stopcapture |
2313086a BS |
773 | Stop capture with a given @var{index}, index can be obtained with |
774 | @example | |
775 | info capture | |
776 | @end example | |
777 | ETEXI | |
778 | ||
d7f9b689 LC |
779 | { |
780 | .name = "memsave", | |
781 | .args_type = "val:l,size:i,filename:s", | |
d7f9b689 LC |
782 | .params = "addr size file", |
783 | .help = "save to disk virtual memory dump starting at 'addr' of size 'size'", | |
0cfd6a9a | 784 | .mhandler.cmd = hmp_memsave, |
d7f9b689 LC |
785 | }, |
786 | ||
2313086a BS |
787 | STEXI |
788 | @item memsave @var{addr} @var{size} @var{file} | |
70fcbbe7 | 789 | @findex memsave |
2313086a BS |
790 | save to disk virtual memory dump starting at @var{addr} of size @var{size}. |
791 | ETEXI | |
792 | ||
d7f9b689 LC |
793 | { |
794 | .name = "pmemsave", | |
795 | .args_type = "val:l,size:i,filename:s", | |
d7f9b689 LC |
796 | .params = "addr size file", |
797 | .help = "save to disk physical memory dump starting at 'addr' of size 'size'", | |
6d3962bf | 798 | .mhandler.cmd = hmp_pmemsave, |
d7f9b689 LC |
799 | }, |
800 | ||
2313086a BS |
801 | STEXI |
802 | @item pmemsave @var{addr} @var{size} @var{file} | |
70fcbbe7 | 803 | @findex pmemsave |
2313086a BS |
804 | save to disk physical memory dump starting at @var{addr} of size @var{size}. |
805 | ETEXI | |
806 | ||
d7f9b689 LC |
807 | { |
808 | .name = "boot_set", | |
809 | .args_type = "bootdevice:s", | |
d7f9b689 LC |
810 | .params = "bootdevice", |
811 | .help = "define new values for the boot device list", | |
3e5a50d6 | 812 | .mhandler.cmd = hmp_boot_set, |
d7f9b689 LC |
813 | }, |
814 | ||
2313086a BS |
815 | STEXI |
816 | @item boot_set @var{bootdevicelist} | |
70fcbbe7 | 817 | @findex boot_set |
2313086a BS |
818 | Define new values for the boot device list. Those values will override |
819 | the values specified on the command line through the @code{-boot} option. | |
820 | ||
821 | The values that can be specified here depend on the machine type, but are | |
822 | the same that can be specified in the @code{-boot} command line option. | |
823 | ETEXI | |
824 | ||
d7f9b689 LC |
825 | { |
826 | .name = "nmi", | |
e9b4b432 LC |
827 | .args_type = "", |
828 | .params = "", | |
9cb805fd | 829 | .help = "inject an NMI", |
3e5a50d6 | 830 | .mhandler.cmd = hmp_nmi, |
d7f9b689 | 831 | }, |
2313086a BS |
832 | STEXI |
833 | @item nmi @var{cpu} | |
70fcbbe7 | 834 | @findex nmi |
9cb805fd | 835 | Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64). |
1f590cf9 LL |
836 | |
837 | ETEXI | |
838 | ||
839 | { | |
3949e594 | 840 | .name = "ringbuf_write", |
1f590cf9 LL |
841 | .args_type = "device:s,data:s", |
842 | .params = "device data", | |
3949e594 MA |
843 | .help = "Write to a ring buffer character device", |
844 | .mhandler.cmd = hmp_ringbuf_write, | |
8e597779 | 845 | .command_completion = ringbuf_write_completion, |
1f590cf9 LL |
846 | }, |
847 | ||
848 | STEXI | |
3949e594 MA |
849 | @item ringbuf_write @var{device} @var{data} |
850 | @findex ringbuf_write | |
851 | Write @var{data} to ring buffer character device @var{device}. | |
852 | @var{data} must be a UTF-8 string. | |
1f590cf9 | 853 | |
49b6d722 LL |
854 | ETEXI |
855 | ||
856 | { | |
3949e594 | 857 | .name = "ringbuf_read", |
49b6d722 LL |
858 | .args_type = "device:s,size:i", |
859 | .params = "device size", | |
3949e594 MA |
860 | .help = "Read from a ring buffer character device", |
861 | .mhandler.cmd = hmp_ringbuf_read, | |
8e597779 | 862 | .command_completion = ringbuf_write_completion, |
49b6d722 LL |
863 | }, |
864 | ||
865 | STEXI | |
3949e594 MA |
866 | @item ringbuf_read @var{device} |
867 | @findex ringbuf_read | |
868 | Read and print up to @var{size} bytes from ring buffer character | |
869 | device @var{device}. | |
543f3412 MA |
870 | Certain non-printable characters are printed \uXXXX, where XXXX is the |
871 | character code in hexadecimal. Character \ is printed \\. | |
3949e594 MA |
872 | Bug: can screw up when the buffer contains invalid UTF-8 sequences, |
873 | NUL characters, after the ring buffer lost data, and when reading | |
874 | stops because the size limit is reached. | |
49b6d722 | 875 | |
2313086a BS |
876 | ETEXI |
877 | ||
d7f9b689 LC |
878 | { |
879 | .name = "migrate", | |
fbc3d96c LS |
880 | .args_type = "detach:-d,blk:-b,inc:-i,uri:s", |
881 | .params = "[-d] [-b] [-i] uri", | |
882 | .help = "migrate to URI (using -d to not wait for completion)" | |
883 | "\n\t\t\t -b for migration without shared storage with" | |
884 | " full copy of disk\n\t\t\t -i for migration without " | |
885 | "shared storage with incremental copy of disk " | |
886 | "(base image shared between src and destination)", | |
e1c37d0e | 887 | .mhandler.cmd = hmp_migrate, |
d7f9b689 LC |
888 | }, |
889 | ||
fbc3d96c | 890 | |
2313086a | 891 | STEXI |
fbc3d96c | 892 | @item migrate [-d] [-b] [-i] @var{uri} |
70fcbbe7 | 893 | @findex migrate |
2313086a | 894 | Migrate to @var{uri} (using -d to not wait for completion). |
fbc3d96c LS |
895 | -b for migration with full copy of disk |
896 | -i for migration with incremental copy of disk (base image is shared) | |
2313086a BS |
897 | ETEXI |
898 | ||
d7f9b689 LC |
899 | { |
900 | .name = "migrate_cancel", | |
901 | .args_type = "", | |
d7f9b689 LC |
902 | .params = "", |
903 | .help = "cancel the current VM migration", | |
6cdedb07 | 904 | .mhandler.cmd = hmp_migrate_cancel, |
d7f9b689 LC |
905 | }, |
906 | ||
2313086a BS |
907 | STEXI |
908 | @item migrate_cancel | |
70fcbbe7 | 909 | @findex migrate_cancel |
2313086a | 910 | Cancel the current VM migration. |
9e1ba4cc | 911 | |
bf1ae1f4 DDAG |
912 | ETEXI |
913 | ||
914 | { | |
915 | .name = "migrate_incoming", | |
916 | .args_type = "uri:s", | |
917 | .params = "uri", | |
918 | .help = "Continue an incoming migration from an -incoming defer", | |
919 | .mhandler.cmd = hmp_migrate_incoming, | |
920 | }, | |
921 | ||
922 | STEXI | |
923 | @item migrate_incoming @var{uri} | |
924 | @findex migrate_incoming | |
925 | Continue an incoming migration using the @var{uri} (that has the same syntax | |
926 | as the -incoming option). | |
927 | ||
9e1ba4cc OW |
928 | ETEXI |
929 | ||
930 | { | |
931 | .name = "migrate_set_cache_size", | |
932 | .args_type = "value:o", | |
933 | .params = "value", | |
934 | .help = "set cache size (in bytes) for XBZRLE migrations," | |
935 | "the cache size will be rounded down to the nearest " | |
936 | "power of 2.\n" | |
937 | "The cache size affects the number of cache misses." | |
938 | "In case of a high cache miss ratio you need to increase" | |
939 | " the cache size", | |
940 | .mhandler.cmd = hmp_migrate_set_cache_size, | |
941 | }, | |
942 | ||
943 | STEXI | |
944 | @item migrate_set_cache_size @var{value} | |
945 | @findex migrate_set_cache_size | |
946 | Set cache size to @var{value} (in bytes) for xbzrle migrations. | |
2313086a BS |
947 | ETEXI |
948 | ||
d7f9b689 LC |
949 | { |
950 | .name = "migrate_set_speed", | |
ed3d4a80 | 951 | .args_type = "value:o", |
d7f9b689 | 952 | .params = "value", |
ed3d4a80 JS |
953 | .help = "set maximum speed (in bytes) for migrations. " |
954 | "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T", | |
3dc85383 | 955 | .mhandler.cmd = hmp_migrate_set_speed, |
d7f9b689 LC |
956 | }, |
957 | ||
2313086a BS |
958 | STEXI |
959 | @item migrate_set_speed @var{value} | |
70fcbbe7 | 960 | @findex migrate_set_speed |
2313086a | 961 | Set maximum speed to @var{value} (in bytes) for migrations. |
2ea42952 GC |
962 | ETEXI |
963 | ||
d7f9b689 LC |
964 | { |
965 | .name = "migrate_set_downtime", | |
b0fbf7d3 | 966 | .args_type = "value:T", |
d7f9b689 LC |
967 | .params = "value", |
968 | .help = "set maximum tolerated downtime (in seconds) for migrations", | |
4f0a993b | 969 | .mhandler.cmd = hmp_migrate_set_downtime, |
d7f9b689 | 970 | }, |
2ea42952 GC |
971 | |
972 | STEXI | |
973 | @item migrate_set_downtime @var{second} | |
70fcbbe7 | 974 | @findex migrate_set_downtime |
2ea42952 | 975 | Set maximum tolerated downtime (in seconds) for migration. |
00458433 OW |
976 | ETEXI |
977 | ||
978 | { | |
979 | .name = "migrate_set_capability", | |
980 | .args_type = "capability:s,state:b", | |
981 | .params = "capability state", | |
982 | .help = "Enable/Disable the usage of a capability for migration", | |
983 | .mhandler.cmd = hmp_migrate_set_capability, | |
c68a0409 | 984 | .command_completion = migrate_set_capability_completion, |
00458433 OW |
985 | }, |
986 | ||
987 | STEXI | |
988 | @item migrate_set_capability @var{capability} @var{state} | |
989 | @findex migrate_set_capability | |
990 | Enable/Disable the usage of a capability @var{capability} for migration. | |
50e9a629 LL |
991 | ETEXI |
992 | ||
993 | { | |
994 | .name = "migrate_set_parameter", | |
995 | .args_type = "parameter:s,value:i", | |
996 | .params = "parameter value", | |
997 | .help = "Set the parameter for migration", | |
998 | .mhandler.cmd = hmp_migrate_set_parameter, | |
999 | .command_completion = migrate_set_parameter_completion, | |
1000 | }, | |
1001 | ||
1002 | STEXI | |
1003 | @item migrate_set_parameter @var{parameter} @var{value} | |
1004 | @findex migrate_set_parameter | |
1005 | Set the parameter @var{parameter} for migration. | |
f8882568 JS |
1006 | ETEXI |
1007 | ||
1008 | { | |
2ea720db JS |
1009 | .name = "client_migrate_info", |
1010 | .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?", | |
1011 | .params = "protocol hostname port tls-port cert-subject", | |
13cadefb | 1012 | .help = "set migration information for remote display", |
b8a185bc | 1013 | .mhandler.cmd = hmp_client_migrate_info, |
f8882568 JS |
1014 | }, |
1015 | ||
e866e239 GH |
1016 | STEXI |
1017 | @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject} | |
1018 | @findex client_migrate_info | |
13cadefb MA |
1019 | Set migration information for remote display. This makes the server |
1020 | ask the client to automatically reconnect using the new parameters | |
1021 | once migration finished successfully. Only implemented for SPICE. | |
e866e239 GH |
1022 | ETEXI |
1023 | ||
783e9b48 WC |
1024 | { |
1025 | .name = "dump-guest-memory", | |
1b7a0f75 QN |
1026 | .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?", |
1027 | .params = "[-p] [-z|-l|-s] filename [begin length]", | |
c20499d9 QN |
1028 | .help = "dump guest memory into file 'filename'.\n\t\t\t" |
1029 | "-p: do paging to get guest's memory mapping.\n\t\t\t" | |
1b7a0f75 QN |
1030 | "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t" |
1031 | "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t" | |
1032 | "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t" | |
c20499d9 QN |
1033 | "begin: the starting physical address.\n\t\t\t" |
1034 | "length: the memory size, in bytes.", | |
783e9b48 WC |
1035 | .mhandler.cmd = hmp_dump_guest_memory, |
1036 | }, | |
1037 | ||
1038 | ||
1039 | STEXI | |
c20499d9 | 1040 | @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length} |
1b7a0f75 | 1041 | @item dump-guest-memory [-z|-l|-s] @var{filename} |
783e9b48 WC |
1042 | @findex dump-guest-memory |
1043 | Dump guest memory to @var{protocol}. The file can be processed with crash or | |
1b7a0f75 | 1044 | gdb. Without -z|-l|-s, the dump format is ELF. |
c20499d9 | 1045 | -p: do paging to get guest's memory mapping. |
1b7a0f75 QN |
1046 | -z: dump in kdump-compressed format, with zlib compression. |
1047 | -l: dump in kdump-compressed format, with lzo compression. | |
1048 | -s: dump in kdump-compressed format, with snappy compression. | |
c20499d9 | 1049 | filename: dump file name. |
783e9b48 | 1050 | begin: the starting physical address. It's optional, and should be |
c20499d9 | 1051 | specified together with length. |
783e9b48 | 1052 | length: the memory size, in bytes. It's optional, and should be specified |
c20499d9 | 1053 | together with begin. |
783e9b48 | 1054 | ETEXI |
783e9b48 | 1055 | |
e866e239 | 1056 | { |
2ea720db | 1057 | .name = "snapshot_blkdev", |
6cc2a415 PB |
1058 | .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?", |
1059 | .params = "[-n] device [new-image-file] [format]", | |
2ea720db JS |
1060 | .help = "initiates a live snapshot\n\t\t\t" |
1061 | "of device. If a new image file is specified, the\n\t\t\t" | |
1062 | "new image file will become the new root image.\n\t\t\t" | |
1063 | "If format is specified, the snapshot file will\n\t\t\t" | |
775ca88e | 1064 | "be created in that format.\n\t\t\t" |
6cc2a415 PB |
1065 | "The default format is qcow2. The -n flag requests QEMU\n\t\t\t" |
1066 | "to reuse the image found in new-image-file, instead of\n\t\t\t" | |
1067 | "recreating it from scratch.", | |
6106e249 | 1068 | .mhandler.cmd = hmp_snapshot_blkdev, |
e866e239 GH |
1069 | }, |
1070 | ||
f8882568 JS |
1071 | STEXI |
1072 | @item snapshot_blkdev | |
1073 | @findex snapshot_blkdev | |
1074 | Snapshot device, using snapshot file as target if provided | |
775ca88e WX |
1075 | ETEXI |
1076 | ||
1077 | { | |
1078 | .name = "snapshot_blkdev_internal", | |
1079 | .args_type = "device:B,name:s", | |
1080 | .params = "device name", | |
1081 | .help = "take an internal snapshot of device.\n\t\t\t" | |
1082 | "The format of the image used by device must\n\t\t\t" | |
1083 | "support it, such as qcow2.\n\t\t\t", | |
1084 | .mhandler.cmd = hmp_snapshot_blkdev_internal, | |
1085 | }, | |
1086 | ||
1087 | STEXI | |
1088 | @item snapshot_blkdev_internal | |
1089 | @findex snapshot_blkdev_internal | |
1090 | Take an internal snapshot on device if it support | |
7a4ed2ee WX |
1091 | ETEXI |
1092 | ||
1093 | { | |
1094 | .name = "snapshot_delete_blkdev_internal", | |
1095 | .args_type = "device:B,name:s,id:s?", | |
1096 | .params = "device name [id]", | |
1097 | .help = "delete an internal snapshot of device.\n\t\t\t" | |
1098 | "If id is specified, qemu will try delete\n\t\t\t" | |
1099 | "the snapshot matching both id and name.\n\t\t\t" | |
1100 | "The format of the image used by device must\n\t\t\t" | |
1101 | "support it, such as qcow2.\n\t\t\t", | |
1102 | .mhandler.cmd = hmp_snapshot_delete_blkdev_internal, | |
1103 | }, | |
1104 | ||
1105 | STEXI | |
1106 | @item snapshot_delete_blkdev_internal | |
1107 | @findex snapshot_delete_blkdev_internal | |
1108 | Delete an internal snapshot on device if it support | |
d9b902db PB |
1109 | ETEXI |
1110 | ||
1111 | { | |
1112 | .name = "drive_mirror", | |
1113 | .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?", | |
1114 | .params = "[-n] [-f] device target [format]", | |
1115 | .help = "initiates live storage\n\t\t\t" | |
1116 | "migration for a device. The device's contents are\n\t\t\t" | |
1117 | "copied to the new image file, including data that\n\t\t\t" | |
1118 | "is written after the command is started.\n\t\t\t" | |
1119 | "The -n flag requests QEMU to reuse the image found\n\t\t\t" | |
1120 | "in new-image-file, instead of recreating it from scratch.\n\t\t\t" | |
1121 | "The -f flag requests QEMU to copy the whole disk,\n\t\t\t" | |
1122 | "so that the result does not need a backing file.\n\t\t\t", | |
1123 | .mhandler.cmd = hmp_drive_mirror, | |
1124 | }, | |
1125 | STEXI | |
1126 | @item drive_mirror | |
1127 | @findex drive_mirror | |
1128 | Start mirroring a block device's writes to a new destination, | |
1129 | using the specified target. | |
de90930a SH |
1130 | ETEXI |
1131 | ||
1132 | { | |
1133 | .name = "drive_backup", | |
1134 | .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?", | |
1135 | .params = "[-n] [-f] device target [format]", | |
1136 | .help = "initiates a point-in-time\n\t\t\t" | |
1137 | "copy for a device. The device's contents are\n\t\t\t" | |
1138 | "copied to the new image file, excluding data that\n\t\t\t" | |
1139 | "is written after the command is started.\n\t\t\t" | |
1140 | "The -n flag requests QEMU to reuse the image found\n\t\t\t" | |
1141 | "in new-image-file, instead of recreating it from scratch.\n\t\t\t" | |
1142 | "The -f flag requests QEMU to copy the whole disk,\n\t\t\t" | |
1143 | "so that the result does not need a backing file.\n\t\t\t", | |
1144 | .mhandler.cmd = hmp_drive_backup, | |
1145 | }, | |
1146 | STEXI | |
1147 | @item drive_backup | |
1148 | @findex drive_backup | |
1149 | Start a point-in-time copy of a block device to a specificed target. | |
2313086a BS |
1150 | ETEXI |
1151 | ||
d7f9b689 LC |
1152 | { |
1153 | .name = "drive_add", | |
1154 | .args_type = "pci_addr:s,opts:s", | |
d7f9b689 LC |
1155 | .params = "[[<domain>:]<bus>:]<slot>\n" |
1156 | "[file=file][,if=type][,bus=n]\n" | |
fb0490f6 | 1157 | "[,unit=m][,media=d][,index=i]\n" |
d7f9b689 | 1158 | "[,cyls=c,heads=h,secs=s[,trans=t]]\n" |
fb0490f6 SH |
1159 | "[,snapshot=on|off][,cache=on|off]\n" |
1160 | "[,readonly=on|off][,copy-on-read=on|off]", | |
d7f9b689 | 1161 | .help = "add drive to PCI storage controller", |
3e5a50d6 | 1162 | .mhandler.cmd = hmp_drive_add, |
d7f9b689 | 1163 | }, |
d7f9b689 | 1164 | |
2313086a BS |
1165 | STEXI |
1166 | @item drive_add | |
70fcbbe7 | 1167 | @findex drive_add |
2313086a | 1168 | Add drive to PCI storage controller. |
2ae63bda IY |
1169 | ETEXI |
1170 | ||
1171 | { | |
1172 | .name = "pcie_aer_inject_error", | |
1173 | .args_type = "advisory_non_fatal:-a,correctable:-c," | |
1174 | "id:s,error_status:s," | |
1175 | "header0:i?,header1:i?,header2:i?,header3:i?," | |
1176 | "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?", | |
1177 | .params = "[-a] [-c] id " | |
1178 | "<error_status> [<tlp header> [<tlp header prefix>]]", | |
1179 | .help = "inject pcie aer error\n\t\t\t" | |
1180 | " -a for advisory non fatal error\n\t\t\t" | |
1181 | " -c for correctable error\n\t\t\t" | |
1182 | "<id> = qdev device id\n\t\t\t" | |
1183 | "<error_status> = error string or 32bit\n\t\t\t" | |
1184 | "<tlb header> = 32bit x 4\n\t\t\t" | |
1185 | "<tlb header prefix> = 32bit x 4", | |
04e00c92 | 1186 | .mhandler.cmd = hmp_pcie_aer_inject_error, |
2ae63bda IY |
1187 | }, |
1188 | ||
1189 | STEXI | |
1190 | @item pcie_aer_inject_error | |
1191 | @findex pcie_aer_inject_error | |
1192 | Inject PCIe AER error | |
2313086a BS |
1193 | ETEXI |
1194 | ||
d7f9b689 LC |
1195 | { |
1196 | .name = "host_net_add", | |
1197 | .args_type = "device:s,opts:s?", | |
03ce5744 | 1198 | .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]", |
d7f9b689 | 1199 | .help = "add host VLAN client", |
3e5a50d6 | 1200 | .mhandler.cmd = hmp_host_net_add, |
e3bb532c | 1201 | .command_completion = host_net_add_completion, |
d7f9b689 LC |
1202 | }, |
1203 | ||
2313086a BS |
1204 | STEXI |
1205 | @item host_net_add | |
70fcbbe7 | 1206 | @findex host_net_add |
2313086a BS |
1207 | Add host VLAN client. |
1208 | ETEXI | |
1209 | ||
d7f9b689 LC |
1210 | { |
1211 | .name = "host_net_remove", | |
1212 | .args_type = "vlan_id:i,device:s", | |
d7f9b689 LC |
1213 | .params = "vlan_id name", |
1214 | .help = "remove host VLAN client", | |
3e5a50d6 | 1215 | .mhandler.cmd = hmp_host_net_remove, |
ddd6b45c | 1216 | .command_completion = host_net_remove_completion, |
d7f9b689 LC |
1217 | }, |
1218 | ||
2313086a BS |
1219 | STEXI |
1220 | @item host_net_remove | |
70fcbbe7 | 1221 | @findex host_net_remove |
2313086a | 1222 | Remove host VLAN client. |
ae82d324 MA |
1223 | ETEXI |
1224 | ||
1225 | { | |
1226 | .name = "netdev_add", | |
1227 | .args_type = "netdev:O", | |
03ce5744 | 1228 | .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]", |
ae82d324 | 1229 | .help = "add host network device", |
928059a3 | 1230 | .mhandler.cmd = hmp_netdev_add, |
b162b49a | 1231 | .command_completion = netdev_add_completion, |
ae82d324 MA |
1232 | }, |
1233 | ||
1234 | STEXI | |
1235 | @item netdev_add | |
1236 | @findex netdev_add | |
1237 | Add host network device. | |
1238 | ETEXI | |
1239 | ||
1240 | { | |
1241 | .name = "netdev_del", | |
1242 | .args_type = "id:s", | |
1243 | .params = "id", | |
1244 | .help = "remove host network device", | |
5f964155 | 1245 | .mhandler.cmd = hmp_netdev_del, |
11b389f2 | 1246 | .command_completion = netdev_del_completion, |
ae82d324 MA |
1247 | }, |
1248 | ||
1249 | STEXI | |
1250 | @item netdev_del | |
1251 | @findex netdev_del | |
1252 | Remove host network device. | |
cff8b2c6 PB |
1253 | ETEXI |
1254 | ||
1255 | { | |
1256 | .name = "object_add", | |
1257 | .args_type = "object:O", | |
1258 | .params = "[qom-type=]type,id=str[,prop=value][,...]", | |
1259 | .help = "create QOM object", | |
1260 | .mhandler.cmd = hmp_object_add, | |
bfa40f77 | 1261 | .command_completion = object_add_completion, |
cff8b2c6 PB |
1262 | }, |
1263 | ||
1264 | STEXI | |
1265 | @item object_add | |
1266 | @findex object_add | |
1267 | Create QOM object. | |
ab2d0531 PB |
1268 | ETEXI |
1269 | ||
1270 | { | |
1271 | .name = "object_del", | |
1272 | .args_type = "id:s", | |
1273 | .params = "id", | |
1274 | .help = "destroy QOM object", | |
1275 | .mhandler.cmd = hmp_object_del, | |
bfa40f77 | 1276 | .command_completion = object_del_completion, |
ab2d0531 PB |
1277 | }, |
1278 | ||
1279 | STEXI | |
1280 | @item object_del | |
1281 | @findex object_del | |
1282 | Destroy QOM object. | |
2313086a BS |
1283 | ETEXI |
1284 | ||
1285 | #ifdef CONFIG_SLIRP | |
d7f9b689 LC |
1286 | { |
1287 | .name = "hostfwd_add", | |
1288 | .args_type = "arg1:s,arg2:s?,arg3:s?", | |
d7f9b689 LC |
1289 | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport", |
1290 | .help = "redirect TCP or UDP connections from host to guest (requires -net user)", | |
3e5a50d6 | 1291 | .mhandler.cmd = hmp_hostfwd_add, |
d7f9b689 | 1292 | }, |
21413d68 MA |
1293 | #endif |
1294 | STEXI | |
1295 | @item hostfwd_add | |
1296 | @findex hostfwd_add | |
1297 | Redirect TCP or UDP connections from host to guest (requires -net user). | |
1298 | ETEXI | |
d7f9b689 | 1299 | |
21413d68 | 1300 | #ifdef CONFIG_SLIRP |
d7f9b689 LC |
1301 | { |
1302 | .name = "hostfwd_remove", | |
1303 | .args_type = "arg1:s,arg2:s?,arg3:s?", | |
d7f9b689 LC |
1304 | .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport", |
1305 | .help = "remove host-to-guest TCP or UDP redirection", | |
3e5a50d6 | 1306 | .mhandler.cmd = hmp_hostfwd_remove, |
d7f9b689 LC |
1307 | }, |
1308 | ||
2313086a BS |
1309 | #endif |
1310 | STEXI | |
21413d68 MA |
1311 | @item hostfwd_remove |
1312 | @findex hostfwd_remove | |
1313 | Remove host-to-guest TCP or UDP redirection. | |
2313086a BS |
1314 | ETEXI |
1315 | ||
d7f9b689 LC |
1316 | { |
1317 | .name = "balloon", | |
3b0bd6ec | 1318 | .args_type = "value:M", |
d7f9b689 | 1319 | .params = "target", |
3c05613a | 1320 | .help = "request VM to change its memory allocation (in MB)", |
d72f3264 | 1321 | .mhandler.cmd = hmp_balloon, |
d7f9b689 LC |
1322 | }, |
1323 | ||
2313086a BS |
1324 | STEXI |
1325 | @item balloon @var{value} | |
70fcbbe7 | 1326 | @findex balloon |
2313086a BS |
1327 | Request VM to change its memory allocation to @var{value} (in MB). |
1328 | ETEXI | |
1329 | ||
d7f9b689 LC |
1330 | { |
1331 | .name = "set_link", | |
c9b26a4c MA |
1332 | .args_type = "name:s,up:b", |
1333 | .params = "name on|off", | |
d7f9b689 | 1334 | .help = "change the link status of a network adapter", |
4b37156c | 1335 | .mhandler.cmd = hmp_set_link, |
40d19394 | 1336 | .command_completion = set_link_completion, |
d7f9b689 LC |
1337 | }, |
1338 | ||
2313086a | 1339 | STEXI |
c9b26a4c | 1340 | @item set_link @var{name} [on|off] |
70fcbbe7 | 1341 | @findex set_link |
c9b26a4c | 1342 | Switch link @var{name} on (i.e. up) or off (i.e. down). |
2313086a BS |
1343 | ETEXI |
1344 | ||
d7f9b689 LC |
1345 | { |
1346 | .name = "watchdog_action", | |
1347 | .args_type = "action:s", | |
d7f9b689 LC |
1348 | .params = "[reset|shutdown|poweroff|pause|debug|none]", |
1349 | .help = "change watchdog action", | |
3e5a50d6 | 1350 | .mhandler.cmd = hmp_watchdog_action, |
d0ece345 | 1351 | .command_completion = watchdog_action_completion, |
d7f9b689 LC |
1352 | }, |
1353 | ||
2313086a BS |
1354 | STEXI |
1355 | @item watchdog_action | |
70fcbbe7 | 1356 | @findex watchdog_action |
2313086a BS |
1357 | Change watchdog action. |
1358 | ETEXI | |
1359 | ||
d7f9b689 LC |
1360 | { |
1361 | .name = "acl_show", | |
1362 | .args_type = "aclname:s", | |
d7f9b689 LC |
1363 | .params = "aclname", |
1364 | .help = "list rules in the access control list", | |
3e5a50d6 | 1365 | .mhandler.cmd = hmp_acl_show, |
d7f9b689 LC |
1366 | }, |
1367 | ||
2313086a | 1368 | STEXI |
15dfcd45 | 1369 | @item acl_show @var{aclname} |
70fcbbe7 | 1370 | @findex acl_show |
15dfcd45 JK |
1371 | List all the matching rules in the access control list, and the default |
1372 | policy. There are currently two named access control lists, | |
1373 | @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client | |
1374 | certificate distinguished name, and SASL username respectively. | |
1375 | ETEXI | |
2313086a | 1376 | |
d7f9b689 LC |
1377 | { |
1378 | .name = "acl_policy", | |
1379 | .args_type = "aclname:s,policy:s", | |
d7f9b689 LC |
1380 | .params = "aclname allow|deny", |
1381 | .help = "set default access control list policy", | |
3e5a50d6 | 1382 | .mhandler.cmd = hmp_acl_policy, |
d7f9b689 LC |
1383 | }, |
1384 | ||
15dfcd45 | 1385 | STEXI |
cbbfacc6 | 1386 | @item acl_policy @var{aclname} @code{allow|deny} |
70fcbbe7 | 1387 | @findex acl_policy |
15dfcd45 | 1388 | Set the default access control list policy, used in the event that |
2313086a | 1389 | none of the explicit rules match. The default policy at startup is |
15dfcd45 JK |
1390 | always @code{deny}. |
1391 | ETEXI | |
1392 | ||
d7f9b689 LC |
1393 | { |
1394 | .name = "acl_add", | |
1395 | .args_type = "aclname:s,match:s,policy:s,index:i?", | |
d7f9b689 LC |
1396 | .params = "aclname match allow|deny [index]", |
1397 | .help = "add a match rule to the access control list", | |
3e5a50d6 | 1398 | .mhandler.cmd = hmp_acl_add, |
d7f9b689 LC |
1399 | }, |
1400 | ||
15dfcd45 | 1401 | STEXI |
0e4aec98 MA |
1402 | @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}] |
1403 | @findex acl_add | |
15dfcd45 JK |
1404 | Add a match rule to the access control list, allowing or denying access. |
1405 | The match will normally be an exact username or x509 distinguished name, | |
1406 | but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to | |
1407 | allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will | |
2313086a | 1408 | normally be appended to the end of the ACL, but can be inserted |
15dfcd45 JK |
1409 | earlier in the list if the optional @var{index} parameter is supplied. |
1410 | ETEXI | |
1411 | ||
d7f9b689 LC |
1412 | { |
1413 | .name = "acl_remove", | |
1414 | .args_type = "aclname:s,match:s", | |
d7f9b689 LC |
1415 | .params = "aclname match", |
1416 | .help = "remove a match rule from the access control list", | |
3e5a50d6 | 1417 | .mhandler.cmd = hmp_acl_remove, |
d7f9b689 LC |
1418 | }, |
1419 | ||
15dfcd45 JK |
1420 | STEXI |
1421 | @item acl_remove @var{aclname} @var{match} | |
70fcbbe7 | 1422 | @findex acl_remove |
15dfcd45 JK |
1423 | Remove the specified match rule from the access control list. |
1424 | ETEXI | |
1425 | ||
d7f9b689 LC |
1426 | { |
1427 | .name = "acl_reset", | |
1428 | .args_type = "aclname:s", | |
d7f9b689 LC |
1429 | .params = "aclname", |
1430 | .help = "reset the access control list", | |
3e5a50d6 | 1431 | .mhandler.cmd = hmp_acl_reset, |
d7f9b689 LC |
1432 | }, |
1433 | ||
15dfcd45 | 1434 | STEXI |
0e4aec98 MA |
1435 | @item acl_reset @var{aclname} |
1436 | @findex acl_reset | |
15dfcd45 | 1437 | Remove all matches from the access control list, and set the default |
2313086a | 1438 | policy back to @code{deny}. |
2313086a BS |
1439 | ETEXI |
1440 | ||
4057725f PB |
1441 | { |
1442 | .name = "nbd_server_start", | |
1443 | .args_type = "all:-a,writable:-w,uri:s", | |
1444 | .params = "nbd_server_start [-a] [-w] host:port", | |
1445 | .help = "serve block devices on the given host and port", | |
1446 | .mhandler.cmd = hmp_nbd_server_start, | |
1447 | }, | |
1448 | STEXI | |
1449 | @item nbd_server_start @var{host}:@var{port} | |
1450 | @findex nbd_server_start | |
1451 | Start an NBD server on the given host and/or port. If the @option{-a} | |
1452 | option is included, all of the virtual machine's block devices that | |
1453 | have an inserted media on them are automatically exported; in this case, | |
1454 | the @option{-w} option makes the devices writable too. | |
1455 | ETEXI | |
1456 | ||
1457 | { | |
1458 | .name = "nbd_server_add", | |
1459 | .args_type = "writable:-w,device:B", | |
1460 | .params = "nbd_server_add [-w] device", | |
1461 | .help = "export a block device via NBD", | |
1462 | .mhandler.cmd = hmp_nbd_server_add, | |
1463 | }, | |
1464 | STEXI | |
1465 | @item nbd_server_add @var{device} | |
1466 | @findex nbd_server_add | |
1467 | Export a block device through QEMU's NBD server, which must be started | |
1468 | beforehand with @command{nbd_server_start}. The @option{-w} option makes the | |
1469 | exported device writable too. | |
1470 | ETEXI | |
1471 | ||
1472 | { | |
1473 | .name = "nbd_server_stop", | |
1474 | .args_type = "", | |
1475 | .params = "nbd_server_stop", | |
1476 | .help = "stop serving block devices using the NBD protocol", | |
1477 | .mhandler.cmd = hmp_nbd_server_stop, | |
1478 | }, | |
1479 | STEXI | |
1480 | @item nbd_server_stop | |
1481 | @findex nbd_server_stop | |
1482 | Stop the QEMU embedded NBD server. | |
1483 | ETEXI | |
1484 | ||
1485 | ||
79c4f6b0 | 1486 | #if defined(TARGET_I386) |
d7f9b689 LC |
1487 | |
1488 | { | |
1489 | .name = "mce", | |
31ce5e0c JD |
1490 | .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l", |
1491 | .params = "[-b] cpu bank status mcgstatus addr misc", | |
1492 | .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]", | |
3e5a50d6 | 1493 | .mhandler.cmd = hmp_mce, |
d7f9b689 LC |
1494 | }, |
1495 | ||
79c4f6b0 HY |
1496 | #endif |
1497 | STEXI | |
1498 | @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc} | |
70fcbbe7 | 1499 | @findex mce (x86) |
79c4f6b0 | 1500 | Inject an MCE on the given CPU (x86 only). |
f07918fd MM |
1501 | ETEXI |
1502 | ||
d7f9b689 LC |
1503 | { |
1504 | .name = "getfd", | |
1505 | .args_type = "fdname:s", | |
d7f9b689 LC |
1506 | .params = "getfd name", |
1507 | .help = "receive a file descriptor via SCM rights and assign it a name", | |
208c9d1b | 1508 | .mhandler.cmd = hmp_getfd, |
d7f9b689 LC |
1509 | }, |
1510 | ||
f07918fd MM |
1511 | STEXI |
1512 | @item getfd @var{fdname} | |
70fcbbe7 | 1513 | @findex getfd |
f07918fd MM |
1514 | If a file descriptor is passed alongside this command using the SCM_RIGHTS |
1515 | mechanism on unix sockets, it is stored using the name @var{fdname} for | |
1516 | later use by other monitor commands. | |
1517 | ETEXI | |
1518 | ||
d7f9b689 LC |
1519 | { |
1520 | .name = "closefd", | |
1521 | .args_type = "fdname:s", | |
d7f9b689 LC |
1522 | .params = "closefd name", |
1523 | .help = "close a file descriptor previously passed via SCM rights", | |
208c9d1b | 1524 | .mhandler.cmd = hmp_closefd, |
d7f9b689 LC |
1525 | }, |
1526 | ||
f07918fd MM |
1527 | STEXI |
1528 | @item closefd @var{fdname} | |
70fcbbe7 | 1529 | @findex closefd |
f07918fd MM |
1530 | Close the file descriptor previously assigned to @var{fdname} using the |
1531 | @code{getfd} command. This is only needed if the file descriptor was never | |
1532 | used by another monitor command. | |
a3a55a2e LC |
1533 | ETEXI |
1534 | ||
1535 | { | |
1536 | .name = "block_passwd", | |
1537 | .args_type = "device:B,password:s", | |
1538 | .params = "block_passwd device password", | |
1539 | .help = "set the password of encrypted block devices", | |
a4dea8a9 | 1540 | .mhandler.cmd = hmp_block_passwd, |
a3a55a2e LC |
1541 | }, |
1542 | ||
727f005e | 1543 | STEXI |
b76d799e MA |
1544 | @item block_passwd @var{device} @var{password} |
1545 | @findex block_passwd | |
1546 | Set the encrypted device @var{device} password to @var{password} | |
727f005e ZYW |
1547 | ETEXI |
1548 | ||
1549 | { | |
1550 | .name = "block_set_io_throttle", | |
1551 | .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l", | |
1552 | .params = "device bps bps_rd bps_wr iops iops_rd iops_wr", | |
1553 | .help = "change I/O throttle limits for a block drive", | |
80047da5 | 1554 | .mhandler.cmd = hmp_block_set_io_throttle, |
727f005e ZYW |
1555 | }, |
1556 | ||
a3a55a2e | 1557 | STEXI |
b76d799e MA |
1558 | @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr} |
1559 | @findex block_set_io_throttle | |
1560 | Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr} | |
7572150c GH |
1561 | ETEXI |
1562 | ||
1563 | { | |
1564 | .name = "set_password", | |
1565 | .args_type = "protocol:s,password:s,connected:s?", | |
1566 | .params = "protocol password action-if-connected", | |
1567 | .help = "set spice/vnc password", | |
fbf796fd | 1568 | .mhandler.cmd = hmp_set_password, |
7572150c GH |
1569 | }, |
1570 | ||
1571 | STEXI | |
1572 | @item set_password [ vnc | spice ] password [ action-if-connected ] | |
1573 | @findex set_password | |
7572150c GH |
1574 | Change spice/vnc password. Use zero to make the password stay valid |
1575 | forever. @var{action-if-connected} specifies what should happen in | |
1576 | case a connection is established: @var{fail} makes the password change | |
1577 | fail. @var{disconnect} changes the password and disconnects the | |
1578 | client. @var{keep} changes the password and keeps the connection up. | |
1579 | @var{keep} is the default. | |
1580 | ETEXI | |
1581 | ||
1582 | { | |
1583 | .name = "expire_password", | |
1584 | .args_type = "protocol:s,time:s", | |
1585 | .params = "protocol time", | |
1586 | .help = "set spice/vnc password expire-time", | |
9ad5372d | 1587 | .mhandler.cmd = hmp_expire_password, |
7572150c GH |
1588 | }, |
1589 | ||
1590 | STEXI | |
1591 | @item expire_password [ vnc | spice ] expire-time | |
1592 | @findex expire_password | |
7572150c GH |
1593 | Specify when a password for spice/vnc becomes |
1594 | invalid. @var{expire-time} accepts: | |
1595 | ||
1596 | @table @var | |
1597 | @item now | |
1598 | Invalidate password instantly. | |
1599 | ||
1600 | @item never | |
1601 | Password stays valid forever. | |
1602 | ||
1603 | @item +nsec | |
1604 | Password stays valid for @var{nsec} seconds starting now. | |
1605 | ||
1606 | @item nsec | |
1607 | Password is invalidated at the given time. @var{nsec} are the seconds | |
1608 | passed since 1970, i.e. unix epoch. | |
1609 | ||
1610 | @end table | |
f1088908 GH |
1611 | ETEXI |
1612 | ||
46920825 GH |
1613 | { |
1614 | .name = "chardev-add", | |
1615 | .args_type = "args:s", | |
1616 | .params = "args", | |
1617 | .help = "add chardev", | |
1618 | .mhandler.cmd = hmp_chardev_add, | |
13e315da | 1619 | .command_completion = chardev_add_completion, |
46920825 GH |
1620 | }, |
1621 | ||
1622 | STEXI | |
b76d799e MA |
1623 | @item chardev-add args |
1624 | @findex chardev-add | |
46920825 GH |
1625 | chardev_add accepts the same parameters as the -chardev command line switch. |
1626 | ||
1627 | ETEXI | |
1628 | ||
1629 | { | |
1630 | .name = "chardev-remove", | |
1631 | .args_type = "id:s", | |
1632 | .params = "id", | |
1633 | .help = "remove chardev", | |
1634 | .mhandler.cmd = hmp_chardev_remove, | |
6297d9a2 | 1635 | .command_completion = chardev_remove_completion, |
46920825 GH |
1636 | }, |
1637 | ||
1638 | STEXI | |
b76d799e MA |
1639 | @item chardev-remove id |
1640 | @findex chardev-remove | |
46920825 GH |
1641 | Removes the chardev @var{id}. |
1642 | ||
587da2c3 KW |
1643 | ETEXI |
1644 | ||
1645 | { | |
1646 | .name = "qemu-io", | |
1647 | .args_type = "device:B,command:s", | |
1648 | .params = "[device] \"[command]\"", | |
1649 | .help = "run a qemu-io command on a block device", | |
1650 | .mhandler.cmd = hmp_qemu_io, | |
1651 | }, | |
1652 | ||
1653 | STEXI | |
1654 | @item qemu-io @var{device} @var{command} | |
1655 | @findex qemu-io | |
587da2c3 KW |
1656 | Executes a qemu-io command on the given block device. |
1657 | ||
abf23329 JH |
1658 | ETEXI |
1659 | ||
1660 | { | |
1661 | .name = "cpu-add", | |
1662 | .args_type = "id:i", | |
1663 | .params = "id", | |
1664 | .help = "add cpu", | |
1665 | .mhandler.cmd = hmp_cpu_add, | |
1666 | }, | |
1667 | ||
1668 | STEXI | |
1669 | @item cpu-add @var{id} | |
b76d799e | 1670 | @findex cpu-add |
abf23329 | 1671 | Add CPU with id @var{id} |
89d7fa9e AF |
1672 | ETEXI |
1673 | ||
1674 | { | |
1675 | .name = "qom-list", | |
1676 | .args_type = "path:s?", | |
1677 | .params = "path", | |
1678 | .help = "list QOM properties", | |
1679 | .mhandler.cmd = hmp_qom_list, | |
1680 | }, | |
1681 | ||
1682 | STEXI | |
1683 | @item qom-list [@var{path}] | |
1684 | Print QOM properties of object at location @var{path} | |
c0e6ee9e AF |
1685 | ETEXI |
1686 | ||
1687 | { | |
1688 | .name = "qom-set", | |
1689 | .args_type = "path:s,property:s,value:s", | |
1690 | .params = "path property value", | |
1691 | .help = "set QOM property", | |
1692 | .mhandler.cmd = hmp_qom_set, | |
1693 | }, | |
1694 | ||
1695 | STEXI | |
1696 | @item qom-set @var{path} @var{property} @var{value} | |
1697 | Set QOM property @var{property} of object at location @var{path} to value @var{value} | |
46920825 | 1698 | ETEXI |
b40292e7 | 1699 | |
33572ece JK |
1700 | { |
1701 | .name = "info", | |
1702 | .args_type = "item:s?", | |
1703 | .params = "[subcommand]", | |
1704 | .help = "show various information about the system state", | |
3e5a50d6 | 1705 | .mhandler.cmd = hmp_info_help, |
84c44613 | 1706 | .sub_table = info_cmds, |
33572ece JK |
1707 | }, |
1708 | ||
1709 | STEXI | |
1710 | @item info @var{subcommand} | |
1711 | @findex info | |
1712 | Show various information about the system state. | |
1713 | ||
1714 | @table @option | |
1715 | @item info version | |
1716 | show the version of QEMU | |
33572ece JK |
1717 | @item info network |
1718 | show the various VLANs and the associated devices | |
1719 | @item info chardev | |
1720 | show the character devices | |
1721 | @item info block | |
1722 | show the block devices | |
1723 | @item info blockstats | |
1724 | show block device statistics | |
1725 | @item info registers | |
1726 | show the cpu registers | |
1727 | @item info cpus | |
1728 | show infos for each CPU | |
1729 | @item info history | |
1730 | show the command line history | |
1731 | @item info irq | |
1732 | show the interrupts statistics (if available) | |
1733 | @item info pic | |
1734 | show i8259 (PIC) state | |
1735 | @item info pci | |
1736 | show emulated PCI device info | |
1737 | @item info tlb | |
692f737c | 1738 | show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only) |
33572ece JK |
1739 | @item info mem |
1740 | show the active virtual memory mappings (i386 only) | |
33572ece JK |
1741 | @item info jit |
1742 | show dynamic compiler info | |
33572ece JK |
1743 | @item info numa |
1744 | show NUMA information | |
b40292e7 JK |
1745 | @item info kvm |
1746 | show KVM information | |
33572ece JK |
1747 | @item info usb |
1748 | show USB devices plugged on the virtual USB hub | |
1749 | @item info usbhost | |
1750 | show all USB host devices | |
1751 | @item info profile | |
1752 | show profiling information | |
1753 | @item info capture | |
1754 | show information about active capturing | |
1755 | @item info snapshots | |
1756 | show list of VM snapshots | |
1757 | @item info status | |
1758 | show the current VM status (running|paused) | |
33572ece JK |
1759 | @item info mice |
1760 | show which guest mouse is receiving events | |
1761 | @item info vnc | |
1762 | show the vnc server status | |
1763 | @item info name | |
1764 | show the current VM name | |
1765 | @item info uuid | |
1766 | show the current VM UUID | |
1767 | @item info cpustats | |
1768 | show CPU statistics | |
1769 | @item info usernet | |
1770 | show user network stack connection states | |
1771 | @item info migrate | |
1772 | show migration status | |
bbf6da32 OW |
1773 | @item info migrate_capabilities |
1774 | show current migration capabilities | |
50e9a629 LL |
1775 | @item info migrate_parameters |
1776 | show current migration parameters | |
9e1ba4cc OW |
1777 | @item info migrate_cache_size |
1778 | show current migration XBZRLE cache size | |
33572ece JK |
1779 | @item info balloon |
1780 | show balloon information | |
1781 | @item info qtree | |
1782 | show device tree | |
1783 | @item info qdm | |
1784 | show qdev device model list | |
a01ff75f AF |
1785 | @item info qom-tree |
1786 | show object composition tree | |
33572ece JK |
1787 | @item info roms |
1788 | show roms | |
d1a0cf73 SB |
1789 | @item info tpm |
1790 | show the TPM device | |
a631892f ZG |
1791 | @item info memory-devices |
1792 | show the memory devices | |
33572ece JK |
1793 | @end table |
1794 | ETEXI | |
1795 | ||
31965ae2 | 1796 | STEXI |
22890ab5 PS |
1797 | @item info trace-events |
1798 | show available trace events and their state | |
1799 | ETEXI | |
22890ab5 | 1800 | |
fafa4d50 SF |
1801 | STEXI |
1802 | @item rocker @var{name} | |
1803 | @findex rocker | |
1804 | Show Rocker(s) | |
1805 | ETEXI | |
1806 | ||
1807 | STEXI | |
1808 | @item rocker_ports @var{name} | |
1809 | @findex rocker_ports | |
1810 | Show Rocker ports | |
1811 | ETEXI | |
1812 | ||
1813 | STEXI | |
1814 | @item rocker_of_dpa_flows @var{name} [@var{tbl_id}] | |
1815 | @findex rocker_of_dpa_flows | |
1816 | Show Rocker OF-DPA flow tables | |
1817 | ETEXI | |
1818 | ||
1819 | STEXI | |
1820 | @item rocker_of_dpa_groups @var{name} [@var{type}] | |
1821 | @findex rocker_of_dpa_groups | |
1822 | Show Rocker OF-DPA groups | |
1823 | ETEXI | |
1824 | ||
2313086a BS |
1825 | STEXI |
1826 | @end table | |
1827 | ETEXI |