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