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