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