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