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