]> git.proxmox.com Git - mirror_qemu.git/blame - hmp-commands.hx
block/parallels: improve image reading performance
[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",
181 .user_print = monitor_user_noop,
3e5a50d6 182 .mhandler.cmd_new = hmp_drive_del,
9063f814
RH
183 },
184
185STEXI
186@item drive_del @var{device}
187@findex drive_del
188Remove host block device. The result is that guest generated IO is no longer
189submitted against the host device underlying the disk. Once a drive has
190been deleted, the QEMU Block layer returns -EIO which results in IO
191errors in the guest for applications that are reading/writing to the device.
293c51a6
SH
192These errors are always reported to the guest, regardless of the drive's error
193actions (drive options rerror, werror).
2313086a
BS
194ETEXI
195
d7f9b689
LC
196 {
197 .name = "change",
198 .args_type = "device:B,target:F,arg:s?",
d7f9b689
LC
199 .params = "device filename [format]",
200 .help = "change a removable medium, optional format",
333a96ec 201 .mhandler.cmd = hmp_change,
d7f9b689
LC
202 },
203
2313086a
BS
204STEXI
205@item change @var{device} @var{setting}
70fcbbe7 206@findex change
2313086a
BS
207Change the configuration of a device.
208
209@table @option
210@item change @var{diskdevice} @var{filename} [@var{format}]
211Change 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
219@item change vnc @var{display},@var{options}
220Change the configuration of the VNC server. The valid syntax for @var{display}
221and @var{options} are described at @ref{sec_invocation}. eg
222
223@example
224(qemu) change vnc localhost:1
225@end example
226
227@item change vnc password [@var{password}]
228
229Change the password associated with the VNC server. If the new password is not
230supplied, the monitor will prompt for it to be entered. VNC passwords are only
231significant up to 8 letters. eg
232
233@example
234(qemu) change vnc password
235Password: ********
236@end example
237
238@end table
239ETEXI
240
d7f9b689
LC
241 {
242 .name = "screendump",
243 .args_type = "filename:F",
d7f9b689
LC
244 .params = "filename",
245 .help = "save screen into PPM image 'filename'",
3e5a50d6 246 .mhandler.cmd = hmp_screendump,
d7f9b689
LC
247 },
248
2313086a
BS
249STEXI
250@item screendump @var{filename}
70fcbbe7 251@findex screendump
2313086a
BS
252Save screen into PPM image @var{filename}.
253ETEXI
254
d7f9b689
LC
255 {
256 .name = "logfile",
257 .args_type = "filename:F",
d7f9b689
LC
258 .params = "filename",
259 .help = "output logs to 'filename'",
3e5a50d6 260 .mhandler.cmd = hmp_logfile,
d7f9b689
LC
261 },
262
2313086a
BS
263STEXI
264@item logfile @var{filename}
70fcbbe7 265@findex logfile
2313086a
BS
266Output logs to @var{filename}.
267ETEXI
268
22890ab5
PS
269 {
270 .name = "trace-event",
271 .args_type = "name:s,option:b",
272 .params = "name on|off",
273 .help = "changes status of a specific trace event",
3e5a50d6 274 .mhandler.cmd = hmp_trace_event,
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",
8bc27249
MA
657 .user_print = monitor_user_noop,
658 .mhandler.cmd_new = do_device_add,
2da1b3ab 659 .command_completion = device_add_completion,
d7f9b689
LC
660 },
661
3418bd25
GH
662STEXI
663@item device_add @var{config}
70fcbbe7 664@findex device_add
3418bd25
GH
665Add device.
666ETEXI
667
d7f9b689
LC
668 {
669 .name = "device_del",
670 .args_type = "id:s",
d7f9b689
LC
671 .params = "device",
672 .help = "remove device",
a15fef21 673 .mhandler.cmd = hmp_device_del,
2da1b3ab 674 .command_completion = device_del_completion,
d7f9b689
LC
675 },
676
3418bd25
GH
677STEXI
678@item device_del @var{id}
70fcbbe7 679@findex device_del
3418bd25
GH
680Remove device @var{id}.
681ETEXI
682
d7f9b689
LC
683 {
684 .name = "cpu",
685 .args_type = "index:i",
d7f9b689
LC
686 .params = "index",
687 .help = "set the default CPU",
755f1968 688 .mhandler.cmd = hmp_cpu,
d7f9b689 689 },
3418bd25 690
2313086a 691STEXI
c427ea9c
MA
692@item cpu @var{index}
693@findex cpu
2313086a
BS
694Set the default CPU.
695ETEXI
696
d7f9b689
LC
697 {
698 .name = "mouse_move",
699 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
d7f9b689
LC
700 .params = "dx dy [dz]",
701 .help = "send mouse move events",
3e5a50d6 702 .mhandler.cmd = hmp_mouse_move,
d7f9b689
LC
703 },
704
2313086a
BS
705STEXI
706@item mouse_move @var{dx} @var{dy} [@var{dz}]
70fcbbe7 707@findex mouse_move
2313086a
BS
708Move the active mouse to the specified coordinates @var{dx} @var{dy}
709with optional scroll axis @var{dz}.
710ETEXI
711
d7f9b689
LC
712 {
713 .name = "mouse_button",
714 .args_type = "button_state:i",
d7f9b689
LC
715 .params = "state",
716 .help = "change mouse button state (1=L, 2=M, 4=R)",
3e5a50d6 717 .mhandler.cmd = hmp_mouse_button,
d7f9b689
LC
718 },
719
2313086a
BS
720STEXI
721@item mouse_button @var{val}
70fcbbe7 722@findex mouse_button
2313086a
BS
723Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
724ETEXI
725
d7f9b689
LC
726 {
727 .name = "mouse_set",
728 .args_type = "index:i",
d7f9b689
LC
729 .params = "index",
730 .help = "set which mouse device receives events",
3e5a50d6 731 .mhandler.cmd = hmp_mouse_set,
d7f9b689
LC
732 },
733
2313086a
BS
734STEXI
735@item mouse_set @var{index}
70fcbbe7 736@findex mouse_set
2313086a
BS
737Set which mouse device receives events at given @var{index}, index
738can be obtained with
739@example
740info mice
741@end example
742ETEXI
743
d7f9b689
LC
744 {
745 .name = "wavcapture",
746 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
d7f9b689
LC
747 .params = "path [frequency [bits [channels]]]",
748 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
3e5a50d6 749 .mhandler.cmd = hmp_wavcapture,
d7f9b689 750 },
2313086a
BS
751STEXI
752@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
70fcbbe7 753@findex wavcapture
2313086a
BS
754Capture audio into @var{filename}. Using sample rate @var{frequency}
755bits per sample @var{bits} and number of channels @var{channels}.
756
757Defaults:
758@itemize @minus
759@item Sample rate = 44100 Hz - CD quality
760@item Bits = 16
761@item Number of channels = 2 - Stereo
762@end itemize
763ETEXI
764
d7f9b689
LC
765 {
766 .name = "stopcapture",
767 .args_type = "n:i",
d7f9b689
LC
768 .params = "capture index",
769 .help = "stop capture",
3e5a50d6 770 .mhandler.cmd = hmp_stopcapture,
d7f9b689 771 },
2313086a
BS
772STEXI
773@item stopcapture @var{index}
70fcbbe7 774@findex stopcapture
2313086a
BS
775Stop capture with a given @var{index}, index can be obtained with
776@example
777info capture
778@end example
779ETEXI
780
d7f9b689
LC
781 {
782 .name = "memsave",
783 .args_type = "val:l,size:i,filename:s",
d7f9b689
LC
784 .params = "addr size file",
785 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
0cfd6a9a 786 .mhandler.cmd = hmp_memsave,
d7f9b689
LC
787 },
788
2313086a
BS
789STEXI
790@item memsave @var{addr} @var{size} @var{file}
70fcbbe7 791@findex memsave
2313086a
BS
792save to disk virtual memory dump starting at @var{addr} of size @var{size}.
793ETEXI
794
d7f9b689
LC
795 {
796 .name = "pmemsave",
797 .args_type = "val:l,size:i,filename:s",
d7f9b689
LC
798 .params = "addr size file",
799 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
6d3962bf 800 .mhandler.cmd = hmp_pmemsave,
d7f9b689
LC
801 },
802
2313086a
BS
803STEXI
804@item pmemsave @var{addr} @var{size} @var{file}
70fcbbe7 805@findex pmemsave
2313086a
BS
806save to disk physical memory dump starting at @var{addr} of size @var{size}.
807ETEXI
808
d7f9b689
LC
809 {
810 .name = "boot_set",
811 .args_type = "bootdevice:s",
d7f9b689
LC
812 .params = "bootdevice",
813 .help = "define new values for the boot device list",
3e5a50d6 814 .mhandler.cmd = hmp_boot_set,
d7f9b689
LC
815 },
816
2313086a
BS
817STEXI
818@item boot_set @var{bootdevicelist}
70fcbbe7 819@findex boot_set
2313086a
BS
820Define new values for the boot device list. Those values will override
821the values specified on the command line through the @code{-boot} option.
822
823The values that can be specified here depend on the machine type, but are
824the same that can be specified in the @code{-boot} command line option.
825ETEXI
826
d7f9b689
LC
827 {
828 .name = "nmi",
e9b4b432
LC
829 .args_type = "",
830 .params = "",
9cb805fd 831 .help = "inject an NMI",
3e5a50d6 832 .mhandler.cmd = hmp_nmi,
d7f9b689 833 },
2313086a
BS
834STEXI
835@item nmi @var{cpu}
70fcbbe7 836@findex nmi
9cb805fd 837Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
1f590cf9
LL
838
839ETEXI
840
841 {
3949e594 842 .name = "ringbuf_write",
1f590cf9
LL
843 .args_type = "device:s,data:s",
844 .params = "device data",
3949e594
MA
845 .help = "Write to a ring buffer character device",
846 .mhandler.cmd = hmp_ringbuf_write,
8e597779 847 .command_completion = ringbuf_write_completion,
1f590cf9
LL
848 },
849
850STEXI
3949e594
MA
851@item ringbuf_write @var{device} @var{data}
852@findex ringbuf_write
853Write @var{data} to ring buffer character device @var{device}.
854@var{data} must be a UTF-8 string.
1f590cf9 855
49b6d722
LL
856ETEXI
857
858 {
3949e594 859 .name = "ringbuf_read",
49b6d722
LL
860 .args_type = "device:s,size:i",
861 .params = "device size",
3949e594
MA
862 .help = "Read from a ring buffer character device",
863 .mhandler.cmd = hmp_ringbuf_read,
8e597779 864 .command_completion = ringbuf_write_completion,
49b6d722
LL
865 },
866
867STEXI
3949e594
MA
868@item ringbuf_read @var{device}
869@findex ringbuf_read
870Read and print up to @var{size} bytes from ring buffer character
871device @var{device}.
543f3412
MA
872Certain non-printable characters are printed \uXXXX, where XXXX is the
873character code in hexadecimal. Character \ is printed \\.
3949e594
MA
874Bug: can screw up when the buffer contains invalid UTF-8 sequences,
875NUL characters, after the ring buffer lost data, and when reading
876stops because the size limit is reached.
49b6d722 877
2313086a
BS
878ETEXI
879
d7f9b689
LC
880 {
881 .name = "migrate",
fbc3d96c
LS
882 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
883 .params = "[-d] [-b] [-i] uri",
884 .help = "migrate to URI (using -d to not wait for completion)"
885 "\n\t\t\t -b for migration without shared storage with"
886 " full copy of disk\n\t\t\t -i for migration without "
887 "shared storage with incremental copy of disk "
888 "(base image shared between src and destination)",
e1c37d0e 889 .mhandler.cmd = hmp_migrate,
d7f9b689
LC
890 },
891
fbc3d96c 892
2313086a 893STEXI
fbc3d96c 894@item migrate [-d] [-b] [-i] @var{uri}
70fcbbe7 895@findex migrate
2313086a 896Migrate to @var{uri} (using -d to not wait for completion).
fbc3d96c
LS
897 -b for migration with full copy of disk
898 -i for migration with incremental copy of disk (base image is shared)
2313086a
BS
899ETEXI
900
d7f9b689
LC
901 {
902 .name = "migrate_cancel",
903 .args_type = "",
d7f9b689
LC
904 .params = "",
905 .help = "cancel the current VM migration",
6cdedb07 906 .mhandler.cmd = hmp_migrate_cancel,
d7f9b689
LC
907 },
908
2313086a
BS
909STEXI
910@item migrate_cancel
70fcbbe7 911@findex migrate_cancel
2313086a 912Cancel the current VM migration.
9e1ba4cc 913
bf1ae1f4
DDAG
914ETEXI
915
916 {
917 .name = "migrate_incoming",
918 .args_type = "uri:s",
919 .params = "uri",
920 .help = "Continue an incoming migration from an -incoming defer",
921 .mhandler.cmd = hmp_migrate_incoming,
922 },
923
924STEXI
925@item migrate_incoming @var{uri}
926@findex migrate_incoming
927Continue an incoming migration using the @var{uri} (that has the same syntax
928as the -incoming option).
929
9e1ba4cc
OW
930ETEXI
931
932 {
933 .name = "migrate_set_cache_size",
934 .args_type = "value:o",
935 .params = "value",
936 .help = "set cache size (in bytes) for XBZRLE migrations,"
937 "the cache size will be rounded down to the nearest "
938 "power of 2.\n"
939 "The cache size affects the number of cache misses."
940 "In case of a high cache miss ratio you need to increase"
941 " the cache size",
942 .mhandler.cmd = hmp_migrate_set_cache_size,
943 },
944
945STEXI
946@item migrate_set_cache_size @var{value}
947@findex migrate_set_cache_size
948Set cache size to @var{value} (in bytes) for xbzrle migrations.
2313086a
BS
949ETEXI
950
d7f9b689
LC
951 {
952 .name = "migrate_set_speed",
ed3d4a80 953 .args_type = "value:o",
d7f9b689 954 .params = "value",
ed3d4a80
JS
955 .help = "set maximum speed (in bytes) for migrations. "
956 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
3dc85383 957 .mhandler.cmd = hmp_migrate_set_speed,
d7f9b689
LC
958 },
959
2313086a
BS
960STEXI
961@item migrate_set_speed @var{value}
70fcbbe7 962@findex migrate_set_speed
2313086a 963Set maximum speed to @var{value} (in bytes) for migrations.
2ea42952
GC
964ETEXI
965
d7f9b689
LC
966 {
967 .name = "migrate_set_downtime",
b0fbf7d3 968 .args_type = "value:T",
d7f9b689
LC
969 .params = "value",
970 .help = "set maximum tolerated downtime (in seconds) for migrations",
4f0a993b 971 .mhandler.cmd = hmp_migrate_set_downtime,
d7f9b689 972 },
2ea42952
GC
973
974STEXI
975@item migrate_set_downtime @var{second}
70fcbbe7 976@findex migrate_set_downtime
2ea42952 977Set maximum tolerated downtime (in seconds) for migration.
00458433
OW
978ETEXI
979
980 {
981 .name = "migrate_set_capability",
982 .args_type = "capability:s,state:b",
983 .params = "capability state",
984 .help = "Enable/Disable the usage of a capability for migration",
985 .mhandler.cmd = hmp_migrate_set_capability,
c68a0409 986 .command_completion = migrate_set_capability_completion,
00458433
OW
987 },
988
989STEXI
990@item migrate_set_capability @var{capability} @var{state}
991@findex migrate_set_capability
992Enable/Disable the usage of a capability @var{capability} for migration.
50e9a629
LL
993ETEXI
994
995 {
996 .name = "migrate_set_parameter",
997 .args_type = "parameter:s,value:i",
998 .params = "parameter value",
999 .help = "Set the parameter for migration",
1000 .mhandler.cmd = hmp_migrate_set_parameter,
1001 .command_completion = migrate_set_parameter_completion,
1002 },
1003
1004STEXI
1005@item migrate_set_parameter @var{parameter} @var{value}
1006@findex migrate_set_parameter
1007Set the parameter @var{parameter} for migration.
f8882568
JS
1008ETEXI
1009
1010 {
2ea720db
JS
1011 .name = "client_migrate_info",
1012 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1013 .params = "protocol hostname port tls-port cert-subject",
1014 .help = "send migration info to spice/vnc client",
1015 .user_print = monitor_user_noop,
3b5704b2 1016 .mhandler.cmd_new = client_migrate_info,
f8882568
JS
1017 },
1018
e866e239
GH
1019STEXI
1020@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1021@findex client_migrate_info
1022Set the spice/vnc connection info for the migration target. The spice/vnc
1023server will ask the spice/vnc client to automatically reconnect using the
1024new parameters (if specified) once the vm migration finished successfully.
1025ETEXI
1026
783e9b48
WC
1027 {
1028 .name = "dump-guest-memory",
1b7a0f75
QN
1029 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1030 .params = "[-p] [-z|-l|-s] filename [begin length]",
c20499d9
QN
1031 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1032 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1b7a0f75
QN
1033 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1034 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1035 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
c20499d9
QN
1036 "begin: the starting physical address.\n\t\t\t"
1037 "length: the memory size, in bytes.",
783e9b48
WC
1038 .mhandler.cmd = hmp_dump_guest_memory,
1039 },
1040
1041
1042STEXI
c20499d9 1043@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1b7a0f75 1044@item dump-guest-memory [-z|-l|-s] @var{filename}
783e9b48
WC
1045@findex dump-guest-memory
1046Dump guest memory to @var{protocol}. The file can be processed with crash or
1b7a0f75 1047gdb. Without -z|-l|-s, the dump format is ELF.
c20499d9 1048 -p: do paging to get guest's memory mapping.
1b7a0f75
QN
1049 -z: dump in kdump-compressed format, with zlib compression.
1050 -l: dump in kdump-compressed format, with lzo compression.
1051 -s: dump in kdump-compressed format, with snappy compression.
c20499d9 1052 filename: dump file name.
783e9b48 1053 begin: the starting physical address. It's optional, and should be
c20499d9 1054 specified together with length.
783e9b48 1055 length: the memory size, in bytes. It's optional, and should be specified
c20499d9 1056 together with begin.
783e9b48 1057ETEXI
783e9b48 1058
e866e239 1059 {
2ea720db 1060 .name = "snapshot_blkdev",
6cc2a415
PB
1061 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1062 .params = "[-n] device [new-image-file] [format]",
2ea720db
JS
1063 .help = "initiates a live snapshot\n\t\t\t"
1064 "of device. If a new image file is specified, the\n\t\t\t"
1065 "new image file will become the new root image.\n\t\t\t"
1066 "If format is specified, the snapshot file will\n\t\t\t"
775ca88e 1067 "be created in that format.\n\t\t\t"
6cc2a415
PB
1068 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1069 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1070 "recreating it from scratch.",
6106e249 1071 .mhandler.cmd = hmp_snapshot_blkdev,
e866e239
GH
1072 },
1073
f8882568
JS
1074STEXI
1075@item snapshot_blkdev
1076@findex snapshot_blkdev
1077Snapshot device, using snapshot file as target if provided
775ca88e
WX
1078ETEXI
1079
1080 {
1081 .name = "snapshot_blkdev_internal",
1082 .args_type = "device:B,name:s",
1083 .params = "device name",
1084 .help = "take an internal snapshot of device.\n\t\t\t"
1085 "The format of the image used by device must\n\t\t\t"
1086 "support it, such as qcow2.\n\t\t\t",
1087 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1088 },
1089
1090STEXI
1091@item snapshot_blkdev_internal
1092@findex snapshot_blkdev_internal
1093Take an internal snapshot on device if it support
7a4ed2ee
WX
1094ETEXI
1095
1096 {
1097 .name = "snapshot_delete_blkdev_internal",
1098 .args_type = "device:B,name:s,id:s?",
1099 .params = "device name [id]",
1100 .help = "delete an internal snapshot of device.\n\t\t\t"
1101 "If id is specified, qemu will try delete\n\t\t\t"
1102 "the snapshot matching both id and name.\n\t\t\t"
1103 "The format of the image used by device must\n\t\t\t"
1104 "support it, such as qcow2.\n\t\t\t",
1105 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1106 },
1107
1108STEXI
1109@item snapshot_delete_blkdev_internal
1110@findex snapshot_delete_blkdev_internal
1111Delete an internal snapshot on device if it support
d9b902db
PB
1112ETEXI
1113
1114 {
1115 .name = "drive_mirror",
1116 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1117 .params = "[-n] [-f] device target [format]",
1118 .help = "initiates live storage\n\t\t\t"
1119 "migration for a device. The device's contents are\n\t\t\t"
1120 "copied to the new image file, including data that\n\t\t\t"
1121 "is written after the command is started.\n\t\t\t"
1122 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1123 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1124 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1125 "so that the result does not need a backing file.\n\t\t\t",
1126 .mhandler.cmd = hmp_drive_mirror,
1127 },
1128STEXI
1129@item drive_mirror
1130@findex drive_mirror
1131Start mirroring a block device's writes to a new destination,
1132using the specified target.
de90930a
SH
1133ETEXI
1134
1135 {
1136 .name = "drive_backup",
1137 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1138 .params = "[-n] [-f] device target [format]",
1139 .help = "initiates a point-in-time\n\t\t\t"
1140 "copy for a device. The device's contents are\n\t\t\t"
1141 "copied to the new image file, excluding data that\n\t\t\t"
1142 "is written after the command is started.\n\t\t\t"
1143 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1144 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1145 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1146 "so that the result does not need a backing file.\n\t\t\t",
1147 .mhandler.cmd = hmp_drive_backup,
1148 },
1149STEXI
1150@item drive_backup
1151@findex drive_backup
1152Start a point-in-time copy of a block device to a specificed target.
2313086a
BS
1153ETEXI
1154
d7f9b689
LC
1155 {
1156 .name = "drive_add",
1157 .args_type = "pci_addr:s,opts:s",
d7f9b689
LC
1158 .params = "[[<domain>:]<bus>:]<slot>\n"
1159 "[file=file][,if=type][,bus=n]\n"
fb0490f6 1160 "[,unit=m][,media=d][,index=i]\n"
d7f9b689 1161 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
fb0490f6
SH
1162 "[,snapshot=on|off][,cache=on|off]\n"
1163 "[,readonly=on|off][,copy-on-read=on|off]",
d7f9b689 1164 .help = "add drive to PCI storage controller",
3e5a50d6 1165 .mhandler.cmd = hmp_drive_add,
d7f9b689 1166 },
d7f9b689 1167
2313086a
BS
1168STEXI
1169@item drive_add
70fcbbe7 1170@findex drive_add
2313086a 1171Add drive to PCI storage controller.
2ae63bda
IY
1172ETEXI
1173
1174 {
1175 .name = "pcie_aer_inject_error",
1176 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1177 "id:s,error_status:s,"
1178 "header0:i?,header1:i?,header2:i?,header3:i?,"
1179 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1180 .params = "[-a] [-c] id "
1181 "<error_status> [<tlp header> [<tlp header prefix>]]",
1182 .help = "inject pcie aer error\n\t\t\t"
1183 " -a for advisory non fatal error\n\t\t\t"
1184 " -c for correctable error\n\t\t\t"
1185 "<id> = qdev device id\n\t\t\t"
1186 "<error_status> = error string or 32bit\n\t\t\t"
1187 "<tlb header> = 32bit x 4\n\t\t\t"
1188 "<tlb header prefix> = 32bit x 4",
1189 .user_print = pcie_aer_inject_error_print,
3e5a50d6 1190 .mhandler.cmd_new = hmp_pcie_aer_inject_error,
2ae63bda
IY
1191 },
1192
1193STEXI
1194@item pcie_aer_inject_error
1195@findex pcie_aer_inject_error
1196Inject PCIe AER error
2313086a
BS
1197ETEXI
1198
d7f9b689
LC
1199 {
1200 .name = "host_net_add",
1201 .args_type = "device:s,opts:s?",
03ce5744 1202 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
d7f9b689 1203 .help = "add host VLAN client",
3e5a50d6 1204 .mhandler.cmd = hmp_host_net_add,
e3bb532c 1205 .command_completion = host_net_add_completion,
d7f9b689
LC
1206 },
1207
2313086a
BS
1208STEXI
1209@item host_net_add
70fcbbe7 1210@findex host_net_add
2313086a
BS
1211Add host VLAN client.
1212ETEXI
1213
d7f9b689
LC
1214 {
1215 .name = "host_net_remove",
1216 .args_type = "vlan_id:i,device:s",
d7f9b689
LC
1217 .params = "vlan_id name",
1218 .help = "remove host VLAN client",
3e5a50d6 1219 .mhandler.cmd = hmp_host_net_remove,
ddd6b45c 1220 .command_completion = host_net_remove_completion,
d7f9b689
LC
1221 },
1222
2313086a
BS
1223STEXI
1224@item host_net_remove
70fcbbe7 1225@findex host_net_remove
2313086a 1226Remove host VLAN client.
ae82d324
MA
1227ETEXI
1228
1229 {
1230 .name = "netdev_add",
1231 .args_type = "netdev:O",
03ce5744 1232 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
ae82d324 1233 .help = "add host network device",
928059a3 1234 .mhandler.cmd = hmp_netdev_add,
b162b49a 1235 .command_completion = netdev_add_completion,
ae82d324
MA
1236 },
1237
1238STEXI
1239@item netdev_add
1240@findex netdev_add
1241Add host network device.
1242ETEXI
1243
1244 {
1245 .name = "netdev_del",
1246 .args_type = "id:s",
1247 .params = "id",
1248 .help = "remove host network device",
5f964155 1249 .mhandler.cmd = hmp_netdev_del,
11b389f2 1250 .command_completion = netdev_del_completion,
ae82d324
MA
1251 },
1252
1253STEXI
1254@item netdev_del
1255@findex netdev_del
1256Remove host network device.
cff8b2c6
PB
1257ETEXI
1258
1259 {
1260 .name = "object_add",
1261 .args_type = "object:O",
1262 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1263 .help = "create QOM object",
1264 .mhandler.cmd = hmp_object_add,
bfa40f77 1265 .command_completion = object_add_completion,
cff8b2c6
PB
1266 },
1267
1268STEXI
1269@item object_add
1270@findex object_add
1271Create QOM object.
ab2d0531
PB
1272ETEXI
1273
1274 {
1275 .name = "object_del",
1276 .args_type = "id:s",
1277 .params = "id",
1278 .help = "destroy QOM object",
1279 .mhandler.cmd = hmp_object_del,
bfa40f77 1280 .command_completion = object_del_completion,
ab2d0531
PB
1281 },
1282
1283STEXI
1284@item object_del
1285@findex object_del
1286Destroy QOM object.
2313086a
BS
1287ETEXI
1288
1289#ifdef CONFIG_SLIRP
d7f9b689
LC
1290 {
1291 .name = "hostfwd_add",
1292 .args_type = "arg1:s,arg2:s?,arg3:s?",
d7f9b689
LC
1293 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1294 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
3e5a50d6 1295 .mhandler.cmd = hmp_hostfwd_add,
d7f9b689 1296 },
21413d68
MA
1297#endif
1298STEXI
1299@item hostfwd_add
1300@findex hostfwd_add
1301Redirect TCP or UDP connections from host to guest (requires -net user).
1302ETEXI
d7f9b689 1303
21413d68 1304#ifdef CONFIG_SLIRP
d7f9b689
LC
1305 {
1306 .name = "hostfwd_remove",
1307 .args_type = "arg1:s,arg2:s?,arg3:s?",
d7f9b689
LC
1308 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1309 .help = "remove host-to-guest TCP or UDP redirection",
3e5a50d6 1310 .mhandler.cmd = hmp_hostfwd_remove,
d7f9b689
LC
1311 },
1312
2313086a
BS
1313#endif
1314STEXI
21413d68
MA
1315@item hostfwd_remove
1316@findex hostfwd_remove
1317Remove host-to-guest TCP or UDP redirection.
2313086a
BS
1318ETEXI
1319
d7f9b689
LC
1320 {
1321 .name = "balloon",
3b0bd6ec 1322 .args_type = "value:M",
d7f9b689 1323 .params = "target",
3c05613a 1324 .help = "request VM to change its memory allocation (in MB)",
d72f3264 1325 .mhandler.cmd = hmp_balloon,
d7f9b689
LC
1326 },
1327
2313086a
BS
1328STEXI
1329@item balloon @var{value}
70fcbbe7 1330@findex balloon
2313086a
BS
1331Request VM to change its memory allocation to @var{value} (in MB).
1332ETEXI
1333
d7f9b689
LC
1334 {
1335 .name = "set_link",
c9b26a4c
MA
1336 .args_type = "name:s,up:b",
1337 .params = "name on|off",
d7f9b689 1338 .help = "change the link status of a network adapter",
4b37156c 1339 .mhandler.cmd = hmp_set_link,
40d19394 1340 .command_completion = set_link_completion,
d7f9b689
LC
1341 },
1342
2313086a 1343STEXI
c9b26a4c 1344@item set_link @var{name} [on|off]
70fcbbe7 1345@findex set_link
c9b26a4c 1346Switch link @var{name} on (i.e. up) or off (i.e. down).
2313086a
BS
1347ETEXI
1348
d7f9b689
LC
1349 {
1350 .name = "watchdog_action",
1351 .args_type = "action:s",
d7f9b689
LC
1352 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1353 .help = "change watchdog action",
3e5a50d6 1354 .mhandler.cmd = hmp_watchdog_action,
d0ece345 1355 .command_completion = watchdog_action_completion,
d7f9b689
LC
1356 },
1357
2313086a
BS
1358STEXI
1359@item watchdog_action
70fcbbe7 1360@findex watchdog_action
2313086a
BS
1361Change watchdog action.
1362ETEXI
1363
d7f9b689
LC
1364 {
1365 .name = "acl_show",
1366 .args_type = "aclname:s",
d7f9b689
LC
1367 .params = "aclname",
1368 .help = "list rules in the access control list",
3e5a50d6 1369 .mhandler.cmd = hmp_acl_show,
d7f9b689
LC
1370 },
1371
2313086a 1372STEXI
15dfcd45 1373@item acl_show @var{aclname}
70fcbbe7 1374@findex acl_show
15dfcd45
JK
1375List all the matching rules in the access control list, and the default
1376policy. There are currently two named access control lists,
1377@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1378certificate distinguished name, and SASL username respectively.
1379ETEXI
2313086a 1380
d7f9b689
LC
1381 {
1382 .name = "acl_policy",
1383 .args_type = "aclname:s,policy:s",
d7f9b689
LC
1384 .params = "aclname allow|deny",
1385 .help = "set default access control list policy",
3e5a50d6 1386 .mhandler.cmd = hmp_acl_policy,
d7f9b689
LC
1387 },
1388
15dfcd45 1389STEXI
cbbfacc6 1390@item acl_policy @var{aclname} @code{allow|deny}
70fcbbe7 1391@findex acl_policy
15dfcd45 1392Set the default access control list policy, used in the event that
2313086a 1393none of the explicit rules match. The default policy at startup is
15dfcd45
JK
1394always @code{deny}.
1395ETEXI
1396
d7f9b689
LC
1397 {
1398 .name = "acl_add",
1399 .args_type = "aclname:s,match:s,policy:s,index:i?",
d7f9b689
LC
1400 .params = "aclname match allow|deny [index]",
1401 .help = "add a match rule to the access control list",
3e5a50d6 1402 .mhandler.cmd = hmp_acl_add,
d7f9b689
LC
1403 },
1404
15dfcd45 1405STEXI
0e4aec98
MA
1406@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1407@findex acl_add
15dfcd45
JK
1408Add a match rule to the access control list, allowing or denying access.
1409The match will normally be an exact username or x509 distinguished name,
1410but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1411allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
2313086a 1412normally be appended to the end of the ACL, but can be inserted
15dfcd45
JK
1413earlier in the list if the optional @var{index} parameter is supplied.
1414ETEXI
1415
d7f9b689
LC
1416 {
1417 .name = "acl_remove",
1418 .args_type = "aclname:s,match:s",
d7f9b689
LC
1419 .params = "aclname match",
1420 .help = "remove a match rule from the access control list",
3e5a50d6 1421 .mhandler.cmd = hmp_acl_remove,
d7f9b689
LC
1422 },
1423
15dfcd45
JK
1424STEXI
1425@item acl_remove @var{aclname} @var{match}
70fcbbe7 1426@findex acl_remove
15dfcd45
JK
1427Remove the specified match rule from the access control list.
1428ETEXI
1429
d7f9b689
LC
1430 {
1431 .name = "acl_reset",
1432 .args_type = "aclname:s",
d7f9b689
LC
1433 .params = "aclname",
1434 .help = "reset the access control list",
3e5a50d6 1435 .mhandler.cmd = hmp_acl_reset,
d7f9b689
LC
1436 },
1437
15dfcd45 1438STEXI
0e4aec98
MA
1439@item acl_reset @var{aclname}
1440@findex acl_reset
15dfcd45 1441Remove all matches from the access control list, and set the default
2313086a 1442policy back to @code{deny}.
2313086a
BS
1443ETEXI
1444
4057725f
PB
1445 {
1446 .name = "nbd_server_start",
1447 .args_type = "all:-a,writable:-w,uri:s",
1448 .params = "nbd_server_start [-a] [-w] host:port",
1449 .help = "serve block devices on the given host and port",
1450 .mhandler.cmd = hmp_nbd_server_start,
1451 },
1452STEXI
1453@item nbd_server_start @var{host}:@var{port}
1454@findex nbd_server_start
1455Start an NBD server on the given host and/or port. If the @option{-a}
1456option is included, all of the virtual machine's block devices that
1457have an inserted media on them are automatically exported; in this case,
1458the @option{-w} option makes the devices writable too.
1459ETEXI
1460
1461 {
1462 .name = "nbd_server_add",
1463 .args_type = "writable:-w,device:B",
1464 .params = "nbd_server_add [-w] device",
1465 .help = "export a block device via NBD",
1466 .mhandler.cmd = hmp_nbd_server_add,
1467 },
1468STEXI
1469@item nbd_server_add @var{device}
1470@findex nbd_server_add
1471Export a block device through QEMU's NBD server, which must be started
1472beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1473exported device writable too.
1474ETEXI
1475
1476 {
1477 .name = "nbd_server_stop",
1478 .args_type = "",
1479 .params = "nbd_server_stop",
1480 .help = "stop serving block devices using the NBD protocol",
1481 .mhandler.cmd = hmp_nbd_server_stop,
1482 },
1483STEXI
1484@item nbd_server_stop
1485@findex nbd_server_stop
1486Stop the QEMU embedded NBD server.
1487ETEXI
1488
1489
79c4f6b0 1490#if defined(TARGET_I386)
d7f9b689
LC
1491
1492 {
1493 .name = "mce",
31ce5e0c
JD
1494 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1495 .params = "[-b] cpu bank status mcgstatus addr misc",
1496 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
3e5a50d6 1497 .mhandler.cmd = hmp_mce,
d7f9b689
LC
1498 },
1499
79c4f6b0
HY
1500#endif
1501STEXI
1502@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
70fcbbe7 1503@findex mce (x86)
79c4f6b0 1504Inject an MCE on the given CPU (x86 only).
f07918fd
MM
1505ETEXI
1506
d7f9b689
LC
1507 {
1508 .name = "getfd",
1509 .args_type = "fdname:s",
d7f9b689
LC
1510 .params = "getfd name",
1511 .help = "receive a file descriptor via SCM rights and assign it a name",
208c9d1b 1512 .mhandler.cmd = hmp_getfd,
d7f9b689
LC
1513 },
1514
f07918fd
MM
1515STEXI
1516@item getfd @var{fdname}
70fcbbe7 1517@findex getfd
f07918fd
MM
1518If a file descriptor is passed alongside this command using the SCM_RIGHTS
1519mechanism on unix sockets, it is stored using the name @var{fdname} for
1520later use by other monitor commands.
1521ETEXI
1522
d7f9b689
LC
1523 {
1524 .name = "closefd",
1525 .args_type = "fdname:s",
d7f9b689
LC
1526 .params = "closefd name",
1527 .help = "close a file descriptor previously passed via SCM rights",
208c9d1b 1528 .mhandler.cmd = hmp_closefd,
d7f9b689
LC
1529 },
1530
f07918fd
MM
1531STEXI
1532@item closefd @var{fdname}
70fcbbe7 1533@findex closefd
f07918fd
MM
1534Close the file descriptor previously assigned to @var{fdname} using the
1535@code{getfd} command. This is only needed if the file descriptor was never
1536used by another monitor command.
a3a55a2e
LC
1537ETEXI
1538
1539 {
1540 .name = "block_passwd",
1541 .args_type = "device:B,password:s",
1542 .params = "block_passwd device password",
1543 .help = "set the password of encrypted block devices",
a4dea8a9 1544 .mhandler.cmd = hmp_block_passwd,
a3a55a2e
LC
1545 },
1546
727f005e 1547STEXI
b76d799e
MA
1548@item block_passwd @var{device} @var{password}
1549@findex block_passwd
1550Set the encrypted device @var{device} password to @var{password}
727f005e
ZYW
1551ETEXI
1552
1553 {
1554 .name = "block_set_io_throttle",
1555 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1556 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1557 .help = "change I/O throttle limits for a block drive",
80047da5 1558 .mhandler.cmd = hmp_block_set_io_throttle,
727f005e
ZYW
1559 },
1560
a3a55a2e 1561STEXI
b76d799e
MA
1562@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1563@findex block_set_io_throttle
1564Change 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
1565ETEXI
1566
1567 {
1568 .name = "set_password",
1569 .args_type = "protocol:s,password:s,connected:s?",
1570 .params = "protocol password action-if-connected",
1571 .help = "set spice/vnc password",
fbf796fd 1572 .mhandler.cmd = hmp_set_password,
7572150c
GH
1573 },
1574
1575STEXI
1576@item set_password [ vnc | spice ] password [ action-if-connected ]
1577@findex set_password
7572150c
GH
1578Change spice/vnc password. Use zero to make the password stay valid
1579forever. @var{action-if-connected} specifies what should happen in
1580case a connection is established: @var{fail} makes the password change
1581fail. @var{disconnect} changes the password and disconnects the
1582client. @var{keep} changes the password and keeps the connection up.
1583@var{keep} is the default.
1584ETEXI
1585
1586 {
1587 .name = "expire_password",
1588 .args_type = "protocol:s,time:s",
1589 .params = "protocol time",
1590 .help = "set spice/vnc password expire-time",
9ad5372d 1591 .mhandler.cmd = hmp_expire_password,
7572150c
GH
1592 },
1593
1594STEXI
1595@item expire_password [ vnc | spice ] expire-time
1596@findex expire_password
7572150c
GH
1597Specify when a password for spice/vnc becomes
1598invalid. @var{expire-time} accepts:
1599
1600@table @var
1601@item now
1602Invalidate password instantly.
1603
1604@item never
1605Password stays valid forever.
1606
1607@item +nsec
1608Password stays valid for @var{nsec} seconds starting now.
1609
1610@item nsec
1611Password is invalidated at the given time. @var{nsec} are the seconds
1612passed since 1970, i.e. unix epoch.
1613
1614@end table
f1088908
GH
1615ETEXI
1616
46920825
GH
1617 {
1618 .name = "chardev-add",
1619 .args_type = "args:s",
1620 .params = "args",
1621 .help = "add chardev",
1622 .mhandler.cmd = hmp_chardev_add,
13e315da 1623 .command_completion = chardev_add_completion,
46920825
GH
1624 },
1625
1626STEXI
b76d799e
MA
1627@item chardev-add args
1628@findex chardev-add
46920825
GH
1629chardev_add accepts the same parameters as the -chardev command line switch.
1630
1631ETEXI
1632
1633 {
1634 .name = "chardev-remove",
1635 .args_type = "id:s",
1636 .params = "id",
1637 .help = "remove chardev",
1638 .mhandler.cmd = hmp_chardev_remove,
6297d9a2 1639 .command_completion = chardev_remove_completion,
46920825
GH
1640 },
1641
1642STEXI
b76d799e
MA
1643@item chardev-remove id
1644@findex chardev-remove
46920825
GH
1645Removes the chardev @var{id}.
1646
587da2c3
KW
1647ETEXI
1648
1649 {
1650 .name = "qemu-io",
1651 .args_type = "device:B,command:s",
1652 .params = "[device] \"[command]\"",
1653 .help = "run a qemu-io command on a block device",
1654 .mhandler.cmd = hmp_qemu_io,
1655 },
1656
1657STEXI
1658@item qemu-io @var{device} @var{command}
1659@findex qemu-io
587da2c3
KW
1660Executes a qemu-io command on the given block device.
1661
abf23329
JH
1662ETEXI
1663
1664 {
1665 .name = "cpu-add",
1666 .args_type = "id:i",
1667 .params = "id",
1668 .help = "add cpu",
1669 .mhandler.cmd = hmp_cpu_add,
1670 },
1671
1672STEXI
1673@item cpu-add @var{id}
b76d799e 1674@findex cpu-add
abf23329 1675Add CPU with id @var{id}
89d7fa9e
AF
1676ETEXI
1677
1678 {
1679 .name = "qom-list",
1680 .args_type = "path:s?",
1681 .params = "path",
1682 .help = "list QOM properties",
1683 .mhandler.cmd = hmp_qom_list,
1684 },
1685
1686STEXI
1687@item qom-list [@var{path}]
1688Print QOM properties of object at location @var{path}
c0e6ee9e
AF
1689ETEXI
1690
1691 {
1692 .name = "qom-set",
1693 .args_type = "path:s,property:s,value:s",
1694 .params = "path property value",
1695 .help = "set QOM property",
1696 .mhandler.cmd = hmp_qom_set,
1697 },
1698
1699STEXI
1700@item qom-set @var{path} @var{property} @var{value}
1701Set QOM property @var{property} of object at location @var{path} to value @var{value}
46920825 1702ETEXI
b40292e7 1703
33572ece
JK
1704 {
1705 .name = "info",
1706 .args_type = "item:s?",
1707 .params = "[subcommand]",
1708 .help = "show various information about the system state",
3e5a50d6 1709 .mhandler.cmd = hmp_info_help,
84c44613 1710 .sub_table = info_cmds,
33572ece
JK
1711 },
1712
1713STEXI
1714@item info @var{subcommand}
1715@findex info
1716Show various information about the system state.
1717
1718@table @option
1719@item info version
1720show the version of QEMU
33572ece
JK
1721@item info network
1722show the various VLANs and the associated devices
1723@item info chardev
1724show the character devices
1725@item info block
1726show the block devices
1727@item info blockstats
1728show block device statistics
1729@item info registers
1730show the cpu registers
1731@item info cpus
1732show infos for each CPU
1733@item info history
1734show the command line history
1735@item info irq
1736show the interrupts statistics (if available)
1737@item info pic
1738show i8259 (PIC) state
1739@item info pci
1740show emulated PCI device info
1741@item info tlb
692f737c 1742show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
33572ece
JK
1743@item info mem
1744show the active virtual memory mappings (i386 only)
33572ece
JK
1745@item info jit
1746show dynamic compiler info
33572ece
JK
1747@item info numa
1748show NUMA information
b40292e7
JK
1749@item info kvm
1750show KVM information
33572ece
JK
1751@item info usb
1752show USB devices plugged on the virtual USB hub
1753@item info usbhost
1754show all USB host devices
1755@item info profile
1756show profiling information
1757@item info capture
1758show information about active capturing
1759@item info snapshots
1760show list of VM snapshots
1761@item info status
1762show the current VM status (running|paused)
33572ece
JK
1763@item info mice
1764show which guest mouse is receiving events
1765@item info vnc
1766show the vnc server status
1767@item info name
1768show the current VM name
1769@item info uuid
1770show the current VM UUID
1771@item info cpustats
1772show CPU statistics
1773@item info usernet
1774show user network stack connection states
1775@item info migrate
1776show migration status
bbf6da32
OW
1777@item info migrate_capabilities
1778show current migration capabilities
50e9a629
LL
1779@item info migrate_parameters
1780show current migration parameters
9e1ba4cc
OW
1781@item info migrate_cache_size
1782show current migration XBZRLE cache size
33572ece
JK
1783@item info balloon
1784show balloon information
1785@item info qtree
1786show device tree
1787@item info qdm
1788show qdev device model list
a01ff75f
AF
1789@item info qom-tree
1790show object composition tree
33572ece
JK
1791@item info roms
1792show roms
d1a0cf73
SB
1793@item info tpm
1794show the TPM device
a631892f
ZG
1795@item info memory-devices
1796show the memory devices
33572ece
JK
1797@end table
1798ETEXI
1799
31965ae2 1800STEXI
22890ab5
PS
1801@item info trace-events
1802show available trace events and their state
1803ETEXI
22890ab5 1804
2313086a
BS
1805STEXI
1806@end table
1807ETEXI