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