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