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