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