sysbus: always allow explicit_ofw_unit_address() to override address generation
[qemu.git] / hmp-commands.hx
blobc1fc747403ad87b09fce67ac5bc0c9b4ea07d174
1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5 HXCOMM monitor commands
6 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
8 STEXI
9 @table @option
10 ETEXI
13 .name = "help|?",
14 .args_type = "name:S?",
15 .params = "[cmd]",
16 .help = "show the help",
17 .cmd = do_help_cmd,
18 .flags = "p",
21 STEXI
22 @item help or ? [@var{cmd}]
23 @findex help
24 Show the help for all commands or just for command @var{cmd}.
25 ETEXI
28 .name = "commit",
29 .args_type = "device:B",
30 .params = "device|all",
31 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
32 .cmd = hmp_commit,
35 STEXI
36 @item commit
37 @findex commit
38 Commit changes to the disk images (if -snapshot is used) or backing files.
39 If the backing file is smaller than the snapshot, then the backing file will be
40 resized to be the same size as the snapshot. If the snapshot is smaller than
41 the backing file, the backing file will not be truncated. If you want the
42 backing file to match the size of the smaller snapshot, you can safely truncate
43 it yourself once the commit operation successfully completes.
44 ETEXI
47 .name = "q|quit",
48 .args_type = "",
49 .params = "",
50 .help = "quit the emulator",
51 .cmd = hmp_quit,
54 STEXI
55 @item q or quit
56 @findex quit
57 Quit the emulator.
58 ETEXI
61 .name = "exit_preconfig",
62 .args_type = "",
63 .params = "",
64 .help = "exit the preconfig state",
65 .cmd = hmp_exit_preconfig,
66 .flags = "p",
69 STEXI
70 @item exit_preconfig
71 @findex exit_preconfig
72 This command makes QEMU exit the preconfig state and proceed with
73 VM initialization using configuration data provided on the command line
74 and via the QMP monitor during the preconfig state. The command is only
75 available during the preconfig state (i.e. when the --preconfig command
76 line option was in use).
77 ETEXI
80 .name = "block_resize",
81 .args_type = "device:B,size:o",
82 .params = "device size",
83 .help = "resize a block image",
84 .cmd = hmp_block_resize,
87 STEXI
88 @item block_resize
89 @findex block_resize
90 Resize a block image while a guest is running. Usually requires guest
91 action to see the updated size. Resize to a lower size is supported,
92 but should be used with extreme caution. Note that this command only
93 resizes image files, it can not resize block devices like LVM volumes.
94 ETEXI
97 .name = "block_stream",
98 .args_type = "device:B,speed:o?,base:s?",
99 .params = "device [speed [base]]",
100 .help = "copy data from a backing file into a block device",
101 .cmd = hmp_block_stream,
104 STEXI
105 @item block_stream
106 @findex block_stream
107 Copy data from a backing file into a block device.
108 ETEXI
111 .name = "block_job_set_speed",
112 .args_type = "device:B,speed:o",
113 .params = "device speed",
114 .help = "set maximum speed for a background block operation",
115 .cmd = hmp_block_job_set_speed,
118 STEXI
119 @item block_job_set_speed
120 @findex block_job_set_speed
121 Set maximum speed for a background block operation.
122 ETEXI
125 .name = "block_job_cancel",
126 .args_type = "force:-f,device:B",
127 .params = "[-f] device",
128 .help = "stop an active background block operation (use -f"
129 "\n\t\t\t if you want to abort the operation immediately"
130 "\n\t\t\t instead of keep running until data is in sync)",
131 .cmd = hmp_block_job_cancel,
134 STEXI
135 @item block_job_cancel
136 @findex block_job_cancel
137 Stop an active background block operation (streaming, mirroring).
138 ETEXI
141 .name = "block_job_complete",
142 .args_type = "device:B",
143 .params = "device",
144 .help = "stop an active background block operation",
145 .cmd = hmp_block_job_complete,
148 STEXI
149 @item block_job_complete
150 @findex block_job_complete
151 Manually trigger completion of an active background block operation.
152 For mirroring, this will switch the device to the destination path.
153 ETEXI
156 .name = "block_job_pause",
157 .args_type = "device:B",
158 .params = "device",
159 .help = "pause an active background block operation",
160 .cmd = hmp_block_job_pause,
163 STEXI
164 @item block_job_pause
165 @findex block_job_pause
166 Pause an active block streaming operation.
167 ETEXI
170 .name = "block_job_resume",
171 .args_type = "device:B",
172 .params = "device",
173 .help = "resume a paused background block operation",
174 .cmd = hmp_block_job_resume,
177 STEXI
178 @item block_job_resume
179 @findex block_job_resume
180 Resume a paused block streaming operation.
181 ETEXI
184 .name = "eject",
185 .args_type = "force:-f,device:B",
186 .params = "[-f] device",
187 .help = "eject a removable medium (use -f to force it)",
188 .cmd = hmp_eject,
191 STEXI
192 @item eject [-f] @var{device}
193 @findex eject
194 Eject a removable medium (use -f to force it).
195 ETEXI
198 .name = "drive_del",
199 .args_type = "id:B",
200 .params = "device",
201 .help = "remove host block device",
202 .cmd = hmp_drive_del,
205 STEXI
206 @item drive_del @var{device}
207 @findex drive_del
208 Remove host block device. The result is that guest generated IO is no longer
209 submitted against the host device underlying the disk. Once a drive has
210 been deleted, the QEMU Block layer returns -EIO which results in IO
211 errors in the guest for applications that are reading/writing to the device.
212 These errors are always reported to the guest, regardless of the drive's error
213 actions (drive options rerror, werror).
214 ETEXI
217 .name = "change",
218 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
219 .params = "device filename [format [read-only-mode]]",
220 .help = "change a removable medium, optional format",
221 .cmd = hmp_change,
224 STEXI
225 @item change @var{device} @var{setting}
226 @findex change
227 Change the configuration of a device.
229 @table @option
230 @item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
231 Change the medium for a removable disk device to point to @var{filename}. eg
233 @example
234 (qemu) change ide1-cd0 /path/to/some.iso
235 @end example
237 @var{format} is optional.
239 @var{read-only-mode} may be used to change the read-only status of the device.
240 It accepts the following values:
242 @table @var
243 @item retain
244 Retains the current status; this is the default.
246 @item read-only
247 Makes the device read-only.
249 @item read-write
250 Makes the device writable.
251 @end table
253 @item change vnc @var{display},@var{options}
254 Change the configuration of the VNC server. The valid syntax for @var{display}
255 and @var{options} are described at @ref{sec_invocation}. eg
257 @example
258 (qemu) change vnc localhost:1
259 @end example
261 @item change vnc password [@var{password}]
263 Change the password associated with the VNC server. If the new password is not
264 supplied, the monitor will prompt for it to be entered. VNC passwords are only
265 significant up to 8 letters. eg
267 @example
268 (qemu) change vnc password
269 Password: ********
270 @end example
272 @end table
273 ETEXI
276 .name = "screendump",
277 .args_type = "filename:F,device:s?,head:i?",
278 .params = "filename [device [head]]",
279 .help = "save screen from head 'head' of display device 'device' "
280 "into PPM image 'filename'",
281 .cmd = hmp_screendump,
284 STEXI
285 @item screendump @var{filename}
286 @findex screendump
287 Save screen into PPM image @var{filename}.
288 ETEXI
291 .name = "logfile",
292 .args_type = "filename:F",
293 .params = "filename",
294 .help = "output logs to 'filename'",
295 .cmd = hmp_logfile,
298 STEXI
299 @item logfile @var{filename}
300 @findex logfile
301 Output logs to @var{filename}.
302 ETEXI
305 .name = "trace-event",
306 .args_type = "name:s,option:b,vcpu:i?",
307 .params = "name on|off [vcpu]",
308 .help = "changes status of a specific trace event "
309 "(vcpu: vCPU to set, default is all)",
310 .cmd = hmp_trace_event,
311 .command_completion = trace_event_completion,
314 STEXI
315 @item trace-event
316 @findex trace-event
317 changes status of a trace event
318 ETEXI
320 #if defined(CONFIG_TRACE_SIMPLE)
322 .name = "trace-file",
323 .args_type = "op:s?,arg:F?",
324 .params = "on|off|flush|set [arg]",
325 .help = "open, close, or flush trace file, or set a new file name",
326 .cmd = hmp_trace_file,
329 STEXI
330 @item trace-file on|off|flush
331 @findex trace-file
332 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
333 ETEXI
334 #endif
337 .name = "log",
338 .args_type = "items:s",
339 .params = "item1[,...]",
340 .help = "activate logging of the specified items",
341 .cmd = hmp_log,
344 STEXI
345 @item log @var{item1}[,...]
346 @findex log
347 Activate logging of the specified items.
348 ETEXI
351 .name = "savevm",
352 .args_type = "name:s?",
353 .params = "[tag|id]",
354 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
355 .cmd = hmp_savevm,
358 STEXI
359 @item savevm [@var{tag}|@var{id}]
360 @findex savevm
361 Create a snapshot of the whole virtual machine. If @var{tag} is
362 provided, it is used as human readable identifier. If there is already
363 a snapshot with the same tag or ID, it is replaced. More info at
364 @ref{vm_snapshots}.
365 ETEXI
368 .name = "loadvm",
369 .args_type = "name:s",
370 .params = "tag|id",
371 .help = "restore a VM snapshot from its tag or id",
372 .cmd = hmp_loadvm,
373 .command_completion = loadvm_completion,
376 STEXI
377 @item loadvm @var{tag}|@var{id}
378 @findex loadvm
379 Set the whole virtual machine to the snapshot identified by the tag
380 @var{tag} or the unique snapshot ID @var{id}.
381 ETEXI
384 .name = "delvm",
385 .args_type = "name:s",
386 .params = "tag|id",
387 .help = "delete a VM snapshot from its tag or id",
388 .cmd = hmp_delvm,
389 .command_completion = delvm_completion,
392 STEXI
393 @item delvm @var{tag}|@var{id}
394 @findex delvm
395 Delete the snapshot identified by @var{tag} or @var{id}.
396 ETEXI
399 .name = "singlestep",
400 .args_type = "option:s?",
401 .params = "[on|off]",
402 .help = "run emulation in singlestep mode or switch to normal mode",
403 .cmd = hmp_singlestep,
406 STEXI
407 @item singlestep [off]
408 @findex singlestep
409 Run the emulation in single step mode.
410 If called with option off, the emulation returns to normal mode.
411 ETEXI
414 .name = "stop",
415 .args_type = "",
416 .params = "",
417 .help = "stop emulation",
418 .cmd = hmp_stop,
421 STEXI
422 @item stop
423 @findex stop
424 Stop emulation.
425 ETEXI
428 .name = "c|cont",
429 .args_type = "",
430 .params = "",
431 .help = "resume emulation",
432 .cmd = hmp_cont,
435 STEXI
436 @item c or cont
437 @findex cont
438 Resume emulation.
439 ETEXI
442 .name = "system_wakeup",
443 .args_type = "",
444 .params = "",
445 .help = "wakeup guest from suspend",
446 .cmd = hmp_system_wakeup,
449 STEXI
450 @item system_wakeup
451 @findex system_wakeup
452 Wakeup guest from suspend.
453 ETEXI
456 .name = "gdbserver",
457 .args_type = "device:s?",
458 .params = "[device]",
459 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
460 .cmd = hmp_gdbserver,
463 STEXI
464 @item gdbserver [@var{port}]
465 @findex gdbserver
466 Start gdbserver session (default @var{port}=1234)
467 ETEXI
470 .name = "x",
471 .args_type = "fmt:/,addr:l",
472 .params = "/fmt addr",
473 .help = "virtual memory dump starting at 'addr'",
474 .cmd = hmp_memory_dump,
477 STEXI
478 @item x/fmt @var{addr}
479 @findex x
480 Virtual memory dump starting at @var{addr}.
481 ETEXI
484 .name = "xp",
485 .args_type = "fmt:/,addr:l",
486 .params = "/fmt addr",
487 .help = "physical memory dump starting at 'addr'",
488 .cmd = hmp_physical_memory_dump,
491 STEXI
492 @item xp /@var{fmt} @var{addr}
493 @findex xp
494 Physical memory dump starting at @var{addr}.
496 @var{fmt} is a format which tells the command how to format the
497 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
499 @table @var
500 @item count
501 is the number of items to be dumped.
503 @item format
504 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
505 c (char) or i (asm instruction).
507 @item size
508 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
509 @code{h} or @code{w} can be specified with the @code{i} format to
510 respectively select 16 or 32 bit code instruction size.
512 @end table
514 Examples:
515 @itemize
516 @item
517 Dump 10 instructions at the current instruction pointer:
518 @example
519 (qemu) x/10i $eip
520 0x90107063: ret
521 0x90107064: sti
522 0x90107065: lea 0x0(%esi,1),%esi
523 0x90107069: lea 0x0(%edi,1),%edi
524 0x90107070: ret
525 0x90107071: jmp 0x90107080
526 0x90107073: nop
527 0x90107074: nop
528 0x90107075: nop
529 0x90107076: nop
530 @end example
532 @item
533 Dump 80 16 bit values at the start of the video memory.
534 @smallexample
535 (qemu) xp/80hx 0xb8000
536 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
537 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
538 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
539 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
540 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
541 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
542 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
543 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
544 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
545 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
546 @end smallexample
547 @end itemize
548 ETEXI
551 .name = "gpa2hva",
552 .args_type = "addr:l",
553 .params = "addr",
554 .help = "print the host virtual address corresponding to a guest physical address",
555 .cmd = hmp_gpa2hva,
558 STEXI
559 @item gpa2hva @var{addr}
560 @findex gpa2hva
561 Print the host virtual address at which the guest's physical address @var{addr}
562 is mapped.
563 ETEXI
565 #ifdef CONFIG_LINUX
567 .name = "gpa2hpa",
568 .args_type = "addr:l",
569 .params = "addr",
570 .help = "print the host physical address corresponding to a guest physical address",
571 .cmd = hmp_gpa2hpa,
573 #endif
575 STEXI
576 @item gpa2hpa @var{addr}
577 @findex gpa2hpa
578 Print the host physical address at which the guest's physical address @var{addr}
579 is mapped.
580 ETEXI
583 .name = "p|print",
584 .args_type = "fmt:/,val:l",
585 .params = "/fmt expr",
586 .help = "print expression value (use $reg for CPU register access)",
587 .cmd = do_print,
590 STEXI
591 @item p or print/@var{fmt} @var{expr}
592 @findex print
593 Print expression value. Only the @var{format} part of @var{fmt} is
594 used.
595 ETEXI
598 .name = "i",
599 .args_type = "fmt:/,addr:i,index:i.",
600 .params = "/fmt addr",
601 .help = "I/O port read",
602 .cmd = hmp_ioport_read,
605 STEXI
606 @item i/@var{fmt} @var{addr} [.@var{index}]
607 @findex i
608 Read I/O port.
609 ETEXI
612 .name = "o",
613 .args_type = "fmt:/,addr:i,val:i",
614 .params = "/fmt addr value",
615 .help = "I/O port write",
616 .cmd = hmp_ioport_write,
619 STEXI
620 @item o/@var{fmt} @var{addr} @var{val}
621 @findex o
622 Write to I/O port.
623 ETEXI
626 .name = "sendkey",
627 .args_type = "keys:s,hold-time:i?",
628 .params = "keys [hold_ms]",
629 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
630 .cmd = hmp_sendkey,
631 .command_completion = sendkey_completion,
634 STEXI
635 @item sendkey @var{keys}
636 @findex sendkey
637 Send @var{keys} to the guest. @var{keys} could be the name of the
638 key or the raw value in hexadecimal format. Use @code{-} to press
639 several keys simultaneously. Example:
640 @example
641 sendkey ctrl-alt-f1
642 @end example
644 This command is useful to send keys that your graphical user interface
645 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
646 ETEXI
649 .name = "system_reset",
650 .args_type = "",
651 .params = "",
652 .help = "reset the system",
653 .cmd = hmp_system_reset,
656 STEXI
657 @item system_reset
658 @findex system_reset
659 Reset the system.
660 ETEXI
663 .name = "system_powerdown",
664 .args_type = "",
665 .params = "",
666 .help = "send system power down event",
667 .cmd = hmp_system_powerdown,
670 STEXI
671 @item system_powerdown
672 @findex system_powerdown
673 Power down the system (if supported).
674 ETEXI
677 .name = "sum",
678 .args_type = "start:i,size:i",
679 .params = "addr size",
680 .help = "compute the checksum of a memory region",
681 .cmd = hmp_sum,
684 STEXI
685 @item sum @var{addr} @var{size}
686 @findex sum
687 Compute the checksum of a memory region.
688 ETEXI
691 .name = "device_add",
692 .args_type = "device:O",
693 .params = "driver[,prop=value][,...]",
694 .help = "add device, like -device on the command line",
695 .cmd = hmp_device_add,
696 .command_completion = device_add_completion,
699 STEXI
700 @item device_add @var{config}
701 @findex device_add
702 Add device.
703 ETEXI
706 .name = "device_del",
707 .args_type = "id:s",
708 .params = "device",
709 .help = "remove device",
710 .cmd = hmp_device_del,
711 .command_completion = device_del_completion,
714 STEXI
715 @item device_del @var{id}
716 @findex device_del
717 Remove device @var{id}. @var{id} may be a short ID
718 or a QOM object path.
719 ETEXI
722 .name = "cpu",
723 .args_type = "index:i",
724 .params = "index",
725 .help = "set the default CPU",
726 .cmd = hmp_cpu,
729 STEXI
730 @item cpu @var{index}
731 @findex cpu
732 Set the default CPU.
733 ETEXI
736 .name = "mouse_move",
737 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
738 .params = "dx dy [dz]",
739 .help = "send mouse move events",
740 .cmd = hmp_mouse_move,
743 STEXI
744 @item mouse_move @var{dx} @var{dy} [@var{dz}]
745 @findex mouse_move
746 Move the active mouse to the specified coordinates @var{dx} @var{dy}
747 with optional scroll axis @var{dz}.
748 ETEXI
751 .name = "mouse_button",
752 .args_type = "button_state:i",
753 .params = "state",
754 .help = "change mouse button state (1=L, 2=M, 4=R)",
755 .cmd = hmp_mouse_button,
758 STEXI
759 @item mouse_button @var{val}
760 @findex mouse_button
761 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
762 ETEXI
765 .name = "mouse_set",
766 .args_type = "index:i",
767 .params = "index",
768 .help = "set which mouse device receives events",
769 .cmd = hmp_mouse_set,
772 STEXI
773 @item mouse_set @var{index}
774 @findex mouse_set
775 Set which mouse device receives events at given @var{index}, index
776 can be obtained with
777 @example
778 info mice
779 @end example
780 ETEXI
783 .name = "wavcapture",
784 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
785 .params = "path [frequency [bits [channels]]]",
786 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
787 .cmd = hmp_wavcapture,
789 STEXI
790 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
791 @findex wavcapture
792 Capture audio into @var{filename}. Using sample rate @var{frequency}
793 bits per sample @var{bits} and number of channels @var{channels}.
795 Defaults:
796 @itemize @minus
797 @item Sample rate = 44100 Hz - CD quality
798 @item Bits = 16
799 @item Number of channels = 2 - Stereo
800 @end itemize
801 ETEXI
804 .name = "stopcapture",
805 .args_type = "n:i",
806 .params = "capture index",
807 .help = "stop capture",
808 .cmd = hmp_stopcapture,
810 STEXI
811 @item stopcapture @var{index}
812 @findex stopcapture
813 Stop capture with a given @var{index}, index can be obtained with
814 @example
815 info capture
816 @end example
817 ETEXI
820 .name = "memsave",
821 .args_type = "val:l,size:i,filename:s",
822 .params = "addr size file",
823 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
824 .cmd = hmp_memsave,
827 STEXI
828 @item memsave @var{addr} @var{size} @var{file}
829 @findex memsave
830 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
831 ETEXI
834 .name = "pmemsave",
835 .args_type = "val:l,size:i,filename:s",
836 .params = "addr size file",
837 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
838 .cmd = hmp_pmemsave,
841 STEXI
842 @item pmemsave @var{addr} @var{size} @var{file}
843 @findex pmemsave
844 save to disk physical memory dump starting at @var{addr} of size @var{size}.
845 ETEXI
848 .name = "boot_set",
849 .args_type = "bootdevice:s",
850 .params = "bootdevice",
851 .help = "define new values for the boot device list",
852 .cmd = hmp_boot_set,
855 STEXI
856 @item boot_set @var{bootdevicelist}
857 @findex boot_set
858 Define new values for the boot device list. Those values will override
859 the values specified on the command line through the @code{-boot} option.
861 The values that can be specified here depend on the machine type, but are
862 the same that can be specified in the @code{-boot} command line option.
863 ETEXI
866 .name = "nmi",
867 .args_type = "",
868 .params = "",
869 .help = "inject an NMI",
870 .cmd = hmp_nmi,
872 STEXI
873 @item nmi @var{cpu}
874 @findex nmi
875 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
877 ETEXI
880 .name = "ringbuf_write",
881 .args_type = "device:s,data:s",
882 .params = "device data",
883 .help = "Write to a ring buffer character device",
884 .cmd = hmp_ringbuf_write,
885 .command_completion = ringbuf_write_completion,
888 STEXI
889 @item ringbuf_write @var{device} @var{data}
890 @findex ringbuf_write
891 Write @var{data} to ring buffer character device @var{device}.
892 @var{data} must be a UTF-8 string.
894 ETEXI
897 .name = "ringbuf_read",
898 .args_type = "device:s,size:i",
899 .params = "device size",
900 .help = "Read from a ring buffer character device",
901 .cmd = hmp_ringbuf_read,
902 .command_completion = ringbuf_write_completion,
905 STEXI
906 @item ringbuf_read @var{device}
907 @findex ringbuf_read
908 Read and print up to @var{size} bytes from ring buffer character
909 device @var{device}.
910 Certain non-printable characters are printed \uXXXX, where XXXX is the
911 character code in hexadecimal. Character \ is printed \\.
912 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
913 NUL characters, after the ring buffer lost data, and when reading
914 stops because the size limit is reached.
916 ETEXI
919 .name = "migrate",
920 .args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
921 .params = "[-d] [-b] [-i] [-r] uri",
922 .help = "migrate to URI (using -d to not wait for completion)"
923 "\n\t\t\t -b for migration without shared storage with"
924 " full copy of disk\n\t\t\t -i for migration without "
925 "shared storage with incremental copy of disk "
926 "(base image shared between src and destination)"
927 "\n\t\t\t -r to resume a paused migration",
928 .cmd = hmp_migrate,
932 STEXI
933 @item migrate [-d] [-b] [-i] @var{uri}
934 @findex migrate
935 Migrate to @var{uri} (using -d to not wait for completion).
936 -b for migration with full copy of disk
937 -i for migration with incremental copy of disk (base image is shared)
938 ETEXI
941 .name = "migrate_cancel",
942 .args_type = "",
943 .params = "",
944 .help = "cancel the current VM migration",
945 .cmd = hmp_migrate_cancel,
948 STEXI
949 @item migrate_cancel
950 @findex migrate_cancel
951 Cancel the current VM migration.
952 ETEXI
955 .name = "migrate_continue",
956 .args_type = "state:s",
957 .params = "state",
958 .help = "Continue migration from the given paused state",
959 .cmd = hmp_migrate_continue,
961 STEXI
962 @item migrate_continue @var{state}
963 @findex migrate_continue
964 Continue migration from the paused state @var{state}
965 ETEXI
968 .name = "migrate_incoming",
969 .args_type = "uri:s",
970 .params = "uri",
971 .help = "Continue an incoming migration from an -incoming defer",
972 .cmd = hmp_migrate_incoming,
975 STEXI
976 @item migrate_incoming @var{uri}
977 @findex migrate_incoming
978 Continue an incoming migration using the @var{uri} (that has the same syntax
979 as the -incoming option).
980 ETEXI
983 .name = "migrate_recover",
984 .args_type = "uri:s",
985 .params = "uri",
986 .help = "Continue a paused incoming postcopy migration",
987 .cmd = hmp_migrate_recover,
990 STEXI
991 @item migrate_recover @var{uri}
992 @findex migrate_recover
993 Continue a paused incoming postcopy migration using the @var{uri}.
994 ETEXI
997 .name = "migrate_pause",
998 .args_type = "",
999 .params = "",
1000 .help = "Pause an ongoing migration (postcopy-only)",
1001 .cmd = hmp_migrate_pause,
1004 STEXI
1005 @item migrate_pause
1006 @findex migrate_pause
1007 Pause an ongoing migration. Currently it only supports postcopy.
1008 ETEXI
1011 .name = "migrate_set_cache_size",
1012 .args_type = "value:o",
1013 .params = "value",
1014 .help = "set cache size (in bytes) for XBZRLE migrations,"
1015 "the cache size will be rounded down to the nearest "
1016 "power of 2.\n"
1017 "The cache size affects the number of cache misses."
1018 "In case of a high cache miss ratio you need to increase"
1019 " the cache size",
1020 .cmd = hmp_migrate_set_cache_size,
1023 STEXI
1024 @item migrate_set_cache_size @var{value}
1025 @findex migrate_set_cache_size
1026 Set cache size to @var{value} (in bytes) for xbzrle migrations.
1027 ETEXI
1030 .name = "migrate_set_speed",
1031 .args_type = "value:o",
1032 .params = "value",
1033 .help = "set maximum speed (in bytes) for migrations. "
1034 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1035 .cmd = hmp_migrate_set_speed,
1038 STEXI
1039 @item migrate_set_speed @var{value}
1040 @findex migrate_set_speed
1041 Set maximum speed to @var{value} (in bytes) for migrations.
1042 ETEXI
1045 .name = "migrate_set_downtime",
1046 .args_type = "value:T",
1047 .params = "value",
1048 .help = "set maximum tolerated downtime (in seconds) for migrations",
1049 .cmd = hmp_migrate_set_downtime,
1052 STEXI
1053 @item migrate_set_downtime @var{second}
1054 @findex migrate_set_downtime
1055 Set maximum tolerated downtime (in seconds) for migration.
1056 ETEXI
1059 .name = "migrate_set_capability",
1060 .args_type = "capability:s,state:b",
1061 .params = "capability state",
1062 .help = "Enable/Disable the usage of a capability for migration",
1063 .cmd = hmp_migrate_set_capability,
1064 .command_completion = migrate_set_capability_completion,
1067 STEXI
1068 @item migrate_set_capability @var{capability} @var{state}
1069 @findex migrate_set_capability
1070 Enable/Disable the usage of a capability @var{capability} for migration.
1071 ETEXI
1074 .name = "migrate_set_parameter",
1075 .args_type = "parameter:s,value:s",
1076 .params = "parameter value",
1077 .help = "Set the parameter for migration",
1078 .cmd = hmp_migrate_set_parameter,
1079 .command_completion = migrate_set_parameter_completion,
1082 STEXI
1083 @item migrate_set_parameter @var{parameter} @var{value}
1084 @findex migrate_set_parameter
1085 Set the parameter @var{parameter} for migration.
1086 ETEXI
1089 .name = "migrate_start_postcopy",
1090 .args_type = "",
1091 .params = "",
1092 .help = "Followup to a migration command to switch the migration"
1093 " to postcopy mode. The postcopy-ram capability must "
1094 "be set on both source and destination before the "
1095 "original migration command .",
1096 .cmd = hmp_migrate_start_postcopy,
1099 STEXI
1100 @item migrate_start_postcopy
1101 @findex migrate_start_postcopy
1102 Switch in-progress migration to postcopy mode. Ignored after the end of
1103 migration (or once already in postcopy).
1104 ETEXI
1107 .name = "x_colo_lost_heartbeat",
1108 .args_type = "",
1109 .params = "",
1110 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1111 "a failover or takeover is needed.",
1112 .cmd = hmp_x_colo_lost_heartbeat,
1115 STEXI
1116 @item x_colo_lost_heartbeat
1117 @findex x_colo_lost_heartbeat
1118 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1119 ETEXI
1122 .name = "client_migrate_info",
1123 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1124 .params = "protocol hostname port tls-port cert-subject",
1125 .help = "set migration information for remote display",
1126 .cmd = hmp_client_migrate_info,
1129 STEXI
1130 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1131 @findex client_migrate_info
1132 Set migration information for remote display. This makes the server
1133 ask the client to automatically reconnect using the new parameters
1134 once migration finished successfully. Only implemented for SPICE.
1135 ETEXI
1138 .name = "dump-guest-memory",
1139 .args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
1140 .params = "[-p] [-d] [-z|-l|-s|-w] filename [begin length]",
1141 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1142 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1143 "-d: return immediately (do not wait for completion).\n\t\t\t"
1144 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1145 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1146 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1147 "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
1148 " for Windows x64 guests with vmcoreinfo driver only.\n\t\t\t"
1149 "begin: the starting physical address.\n\t\t\t"
1150 "length: the memory size, in bytes.",
1151 .cmd = hmp_dump_guest_memory,
1154 STEXI
1155 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1156 @item dump-guest-memory [-z|-l|-s|-w] @var{filename}
1157 @findex dump-guest-memory
1158 Dump guest memory to @var{protocol}. The file can be processed with crash or
1159 gdb. Without -z|-l|-s|-w, the dump format is ELF.
1160 -p: do paging to get guest's memory mapping.
1161 -z: dump in kdump-compressed format, with zlib compression.
1162 -l: dump in kdump-compressed format, with lzo compression.
1163 -s: dump in kdump-compressed format, with snappy compression.
1164 -w: dump in Windows crashdump format (can be used instead of ELF-dump converting),
1165 for Windows x64 guests with vmcoreinfo driver only
1166 filename: dump file name.
1167 begin: the starting physical address. It's optional, and should be
1168 specified together with length.
1169 length: the memory size, in bytes. It's optional, and should be specified
1170 together with begin.
1171 ETEXI
1173 #if defined(TARGET_S390X)
1175 .name = "dump-skeys",
1176 .args_type = "filename:F",
1177 .params = "",
1178 .help = "Save guest storage keys into file 'filename'.\n",
1179 .cmd = hmp_dump_skeys,
1181 #endif
1183 STEXI
1184 @item dump-skeys @var{filename}
1185 @findex dump-skeys
1186 Save guest storage keys to a file.
1187 ETEXI
1189 #if defined(TARGET_S390X)
1191 .name = "migration_mode",
1192 .args_type = "mode:i",
1193 .params = "mode",
1194 .help = "Enables or disables migration mode\n",
1195 .cmd = hmp_migrationmode,
1197 #endif
1199 STEXI
1200 @item migration_mode @var{mode}
1201 @findex migration_mode
1202 Enables or disables migration mode.
1203 ETEXI
1206 .name = "snapshot_blkdev",
1207 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1208 .params = "[-n] device [new-image-file] [format]",
1209 .help = "initiates a live snapshot\n\t\t\t"
1210 "of device. If a new image file is specified, the\n\t\t\t"
1211 "new image file will become the new root image.\n\t\t\t"
1212 "If format is specified, the snapshot file will\n\t\t\t"
1213 "be created in that format.\n\t\t\t"
1214 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1215 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1216 "recreating it from scratch.",
1217 .cmd = hmp_snapshot_blkdev,
1220 STEXI
1221 @item snapshot_blkdev
1222 @findex snapshot_blkdev
1223 Snapshot device, using snapshot file as target if provided
1224 ETEXI
1227 .name = "snapshot_blkdev_internal",
1228 .args_type = "device:B,name:s",
1229 .params = "device name",
1230 .help = "take an internal snapshot of device.\n\t\t\t"
1231 "The format of the image used by device must\n\t\t\t"
1232 "support it, such as qcow2.\n\t\t\t",
1233 .cmd = hmp_snapshot_blkdev_internal,
1236 STEXI
1237 @item snapshot_blkdev_internal
1238 @findex snapshot_blkdev_internal
1239 Take an internal snapshot on device if it support
1240 ETEXI
1243 .name = "snapshot_delete_blkdev_internal",
1244 .args_type = "device:B,name:s,id:s?",
1245 .params = "device name [id]",
1246 .help = "delete an internal snapshot of device.\n\t\t\t"
1247 "If id is specified, qemu will try delete\n\t\t\t"
1248 "the snapshot matching both id and name.\n\t\t\t"
1249 "The format of the image used by device must\n\t\t\t"
1250 "support it, such as qcow2.\n\t\t\t",
1251 .cmd = hmp_snapshot_delete_blkdev_internal,
1254 STEXI
1255 @item snapshot_delete_blkdev_internal
1256 @findex snapshot_delete_blkdev_internal
1257 Delete an internal snapshot on device if it support
1258 ETEXI
1261 .name = "drive_mirror",
1262 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1263 .params = "[-n] [-f] device target [format]",
1264 .help = "initiates live storage\n\t\t\t"
1265 "migration for a device. The device's contents are\n\t\t\t"
1266 "copied to the new image file, including data that\n\t\t\t"
1267 "is written after the command is started.\n\t\t\t"
1268 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1269 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1270 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1271 "so that the result does not need a backing file.\n\t\t\t",
1272 .cmd = hmp_drive_mirror,
1274 STEXI
1275 @item drive_mirror
1276 @findex drive_mirror
1277 Start mirroring a block device's writes to a new destination,
1278 using the specified target.
1279 ETEXI
1282 .name = "drive_backup",
1283 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1284 .params = "[-n] [-f] [-c] device target [format]",
1285 .help = "initiates a point-in-time\n\t\t\t"
1286 "copy for a device. The device's contents are\n\t\t\t"
1287 "copied to the new image file, excluding data that\n\t\t\t"
1288 "is written after the command is started.\n\t\t\t"
1289 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1290 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1291 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1292 "so that the result does not need a backing file.\n\t\t\t"
1293 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1294 "(if the target format supports it).\n\t\t\t",
1295 .cmd = hmp_drive_backup,
1297 STEXI
1298 @item drive_backup
1299 @findex drive_backup
1300 Start a point-in-time copy of a block device to a specificed target.
1301 ETEXI
1304 .name = "drive_add",
1305 .args_type = "node:-n,pci_addr:s,opts:s",
1306 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
1307 "[file=file][,if=type][,bus=n]\n"
1308 "[,unit=m][,media=d][,index=i]\n"
1309 "[,snapshot=on|off][,cache=on|off]\n"
1310 "[,readonly=on|off][,copy-on-read=on|off]",
1311 .help = "add drive to PCI storage controller",
1312 .cmd = hmp_drive_add,
1315 STEXI
1316 @item drive_add
1317 @findex drive_add
1318 Add drive to PCI storage controller.
1319 ETEXI
1322 .name = "pcie_aer_inject_error",
1323 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1324 "id:s,error_status:s,"
1325 "header0:i?,header1:i?,header2:i?,header3:i?,"
1326 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1327 .params = "[-a] [-c] id "
1328 "<error_status> [<tlp header> [<tlp header prefix>]]",
1329 .help = "inject pcie aer error\n\t\t\t"
1330 " -a for advisory non fatal error\n\t\t\t"
1331 " -c for correctable error\n\t\t\t"
1332 "<id> = qdev device id\n\t\t\t"
1333 "<error_status> = error string or 32bit\n\t\t\t"
1334 "<tlb header> = 32bit x 4\n\t\t\t"
1335 "<tlb header prefix> = 32bit x 4",
1336 .cmd = hmp_pcie_aer_inject_error,
1339 STEXI
1340 @item pcie_aer_inject_error
1341 @findex pcie_aer_inject_error
1342 Inject PCIe AER error
1343 ETEXI
1346 .name = "netdev_add",
1347 .args_type = "netdev:O",
1348 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1349 .help = "add host network device",
1350 .cmd = hmp_netdev_add,
1351 .command_completion = netdev_add_completion,
1354 STEXI
1355 @item netdev_add
1356 @findex netdev_add
1357 Add host network device.
1358 ETEXI
1361 .name = "netdev_del",
1362 .args_type = "id:s",
1363 .params = "id",
1364 .help = "remove host network device",
1365 .cmd = hmp_netdev_del,
1366 .command_completion = netdev_del_completion,
1369 STEXI
1370 @item netdev_del
1371 @findex netdev_del
1372 Remove host network device.
1373 ETEXI
1376 .name = "object_add",
1377 .args_type = "object:O",
1378 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1379 .help = "create QOM object",
1380 .cmd = hmp_object_add,
1381 .command_completion = object_add_completion,
1384 STEXI
1385 @item object_add
1386 @findex object_add
1387 Create QOM object.
1388 ETEXI
1391 .name = "object_del",
1392 .args_type = "id:s",
1393 .params = "id",
1394 .help = "destroy QOM object",
1395 .cmd = hmp_object_del,
1396 .command_completion = object_del_completion,
1399 STEXI
1400 @item object_del
1401 @findex object_del
1402 Destroy QOM object.
1403 ETEXI
1405 #ifdef CONFIG_SLIRP
1407 .name = "hostfwd_add",
1408 .args_type = "arg1:s,arg2:s?,arg3:s?",
1409 .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1410 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1411 .cmd = hmp_hostfwd_add,
1413 #endif
1414 STEXI
1415 @item hostfwd_add
1416 @findex hostfwd_add
1417 Redirect TCP or UDP connections from host to guest (requires -net user).
1418 ETEXI
1420 #ifdef CONFIG_SLIRP
1422 .name = "hostfwd_remove",
1423 .args_type = "arg1:s,arg2:s?,arg3:s?",
1424 .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1425 .help = "remove host-to-guest TCP or UDP redirection",
1426 .cmd = hmp_hostfwd_remove,
1429 #endif
1430 STEXI
1431 @item hostfwd_remove
1432 @findex hostfwd_remove
1433 Remove host-to-guest TCP or UDP redirection.
1434 ETEXI
1437 .name = "balloon",
1438 .args_type = "value:M",
1439 .params = "target",
1440 .help = "request VM to change its memory allocation (in MB)",
1441 .cmd = hmp_balloon,
1444 STEXI
1445 @item balloon @var{value}
1446 @findex balloon
1447 Request VM to change its memory allocation to @var{value} (in MB).
1448 ETEXI
1451 .name = "set_link",
1452 .args_type = "name:s,up:b",
1453 .params = "name on|off",
1454 .help = "change the link status of a network adapter",
1455 .cmd = hmp_set_link,
1456 .command_completion = set_link_completion,
1459 STEXI
1460 @item set_link @var{name} [on|off]
1461 @findex set_link
1462 Switch link @var{name} on (i.e. up) or off (i.e. down).
1463 ETEXI
1466 .name = "watchdog_action",
1467 .args_type = "action:s",
1468 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1469 .help = "change watchdog action",
1470 .cmd = hmp_watchdog_action,
1471 .command_completion = watchdog_action_completion,
1474 STEXI
1475 @item watchdog_action
1476 @findex watchdog_action
1477 Change watchdog action.
1478 ETEXI
1481 .name = "acl_show",
1482 .args_type = "aclname:s",
1483 .params = "aclname",
1484 .help = "list rules in the access control list",
1485 .cmd = hmp_acl_show,
1488 STEXI
1489 @item acl_show @var{aclname}
1490 @findex acl_show
1491 List all the matching rules in the access control list, and the default
1492 policy. There are currently two named access control lists,
1493 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1494 certificate distinguished name, and SASL username respectively.
1495 ETEXI
1498 .name = "acl_policy",
1499 .args_type = "aclname:s,policy:s",
1500 .params = "aclname allow|deny",
1501 .help = "set default access control list policy",
1502 .cmd = hmp_acl_policy,
1505 STEXI
1506 @item acl_policy @var{aclname} @code{allow|deny}
1507 @findex acl_policy
1508 Set the default access control list policy, used in the event that
1509 none of the explicit rules match. The default policy at startup is
1510 always @code{deny}.
1511 ETEXI
1514 .name = "acl_add",
1515 .args_type = "aclname:s,match:s,policy:s,index:i?",
1516 .params = "aclname match allow|deny [index]",
1517 .help = "add a match rule to the access control list",
1518 .cmd = hmp_acl_add,
1521 STEXI
1522 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1523 @findex acl_add
1524 Add a match rule to the access control list, allowing or denying access.
1525 The match will normally be an exact username or x509 distinguished name,
1526 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1527 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1528 normally be appended to the end of the ACL, but can be inserted
1529 earlier in the list if the optional @var{index} parameter is supplied.
1530 ETEXI
1533 .name = "acl_remove",
1534 .args_type = "aclname:s,match:s",
1535 .params = "aclname match",
1536 .help = "remove a match rule from the access control list",
1537 .cmd = hmp_acl_remove,
1540 STEXI
1541 @item acl_remove @var{aclname} @var{match}
1542 @findex acl_remove
1543 Remove the specified match rule from the access control list.
1544 ETEXI
1547 .name = "acl_reset",
1548 .args_type = "aclname:s",
1549 .params = "aclname",
1550 .help = "reset the access control list",
1551 .cmd = hmp_acl_reset,
1554 STEXI
1555 @item acl_reset @var{aclname}
1556 @findex acl_reset
1557 Remove all matches from the access control list, and set the default
1558 policy back to @code{deny}.
1559 ETEXI
1562 .name = "nbd_server_start",
1563 .args_type = "all:-a,writable:-w,uri:s",
1564 .params = "nbd_server_start [-a] [-w] host:port",
1565 .help = "serve block devices on the given host and port",
1566 .cmd = hmp_nbd_server_start,
1568 STEXI
1569 @item nbd_server_start @var{host}:@var{port}
1570 @findex nbd_server_start
1571 Start an NBD server on the given host and/or port. If the @option{-a}
1572 option is included, all of the virtual machine's block devices that
1573 have an inserted media on them are automatically exported; in this case,
1574 the @option{-w} option makes the devices writable too.
1575 ETEXI
1578 .name = "nbd_server_add",
1579 .args_type = "writable:-w,device:B,name:s?",
1580 .params = "nbd_server_add [-w] device [name]",
1581 .help = "export a block device via NBD",
1582 .cmd = hmp_nbd_server_add,
1584 STEXI
1585 @item nbd_server_add @var{device} [ @var{name} ]
1586 @findex nbd_server_add
1587 Export a block device through QEMU's NBD server, which must be started
1588 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1589 exported device writable too. The export name is controlled by @var{name},
1590 defaulting to @var{device}.
1591 ETEXI
1594 .name = "nbd_server_remove",
1595 .args_type = "force:-f,name:s",
1596 .params = "nbd_server_remove [-f] name",
1597 .help = "remove an export previously exposed via NBD",
1598 .cmd = hmp_nbd_server_remove,
1600 STEXI
1601 @item nbd_server_remove [-f] @var{name}
1602 @findex nbd_server_remove
1603 Stop exporting a block device through QEMU's NBD server, which was
1604 previously started with @command{nbd_server_add}. The @option{-f}
1605 option forces the server to drop the export immediately even if
1606 clients are connected; otherwise the command fails unless there are no
1607 clients.
1608 ETEXI
1611 .name = "nbd_server_stop",
1612 .args_type = "",
1613 .params = "nbd_server_stop",
1614 .help = "stop serving block devices using the NBD protocol",
1615 .cmd = hmp_nbd_server_stop,
1617 STEXI
1618 @item nbd_server_stop
1619 @findex nbd_server_stop
1620 Stop the QEMU embedded NBD server.
1621 ETEXI
1624 #if defined(TARGET_I386)
1627 .name = "mce",
1628 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1629 .params = "[-b] cpu bank status mcgstatus addr misc",
1630 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1631 .cmd = hmp_mce,
1634 #endif
1635 STEXI
1636 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1637 @findex mce (x86)
1638 Inject an MCE on the given CPU (x86 only).
1639 ETEXI
1642 .name = "getfd",
1643 .args_type = "fdname:s",
1644 .params = "getfd name",
1645 .help = "receive a file descriptor via SCM rights and assign it a name",
1646 .cmd = hmp_getfd,
1649 STEXI
1650 @item getfd @var{fdname}
1651 @findex getfd
1652 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1653 mechanism on unix sockets, it is stored using the name @var{fdname} for
1654 later use by other monitor commands.
1655 ETEXI
1658 .name = "closefd",
1659 .args_type = "fdname:s",
1660 .params = "closefd name",
1661 .help = "close a file descriptor previously passed via SCM rights",
1662 .cmd = hmp_closefd,
1665 STEXI
1666 @item closefd @var{fdname}
1667 @findex closefd
1668 Close the file descriptor previously assigned to @var{fdname} using the
1669 @code{getfd} command. This is only needed if the file descriptor was never
1670 used by another monitor command.
1671 ETEXI
1674 .name = "block_passwd",
1675 .args_type = "device:B,password:s",
1676 .params = "block_passwd device password",
1677 .help = "set the password of encrypted block devices",
1678 .cmd = hmp_block_passwd,
1681 STEXI
1682 @item block_passwd @var{device} @var{password}
1683 @findex block_passwd
1684 Set the encrypted device @var{device} password to @var{password}
1686 This command is now obsolete and will always return an error since 2.10
1687 ETEXI
1690 .name = "block_set_io_throttle",
1691 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1692 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1693 .help = "change I/O throttle limits for a block drive",
1694 .cmd = hmp_block_set_io_throttle,
1697 STEXI
1698 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1699 @findex block_set_io_throttle
1700 Change 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}.
1701 @var{device} can be a block device name, a qdev ID or a QOM path.
1702 ETEXI
1705 .name = "set_password",
1706 .args_type = "protocol:s,password:s,connected:s?",
1707 .params = "protocol password action-if-connected",
1708 .help = "set spice/vnc password",
1709 .cmd = hmp_set_password,
1712 STEXI
1713 @item set_password [ vnc | spice ] password [ action-if-connected ]
1714 @findex set_password
1715 Change spice/vnc password. Use zero to make the password stay valid
1716 forever. @var{action-if-connected} specifies what should happen in
1717 case a connection is established: @var{fail} makes the password change
1718 fail. @var{disconnect} changes the password and disconnects the
1719 client. @var{keep} changes the password and keeps the connection up.
1720 @var{keep} is the default.
1721 ETEXI
1724 .name = "expire_password",
1725 .args_type = "protocol:s,time:s",
1726 .params = "protocol time",
1727 .help = "set spice/vnc password expire-time",
1728 .cmd = hmp_expire_password,
1731 STEXI
1732 @item expire_password [ vnc | spice ] expire-time
1733 @findex expire_password
1734 Specify when a password for spice/vnc becomes
1735 invalid. @var{expire-time} accepts:
1737 @table @var
1738 @item now
1739 Invalidate password instantly.
1741 @item never
1742 Password stays valid forever.
1744 @item +nsec
1745 Password stays valid for @var{nsec} seconds starting now.
1747 @item nsec
1748 Password is invalidated at the given time. @var{nsec} are the seconds
1749 passed since 1970, i.e. unix epoch.
1751 @end table
1752 ETEXI
1755 .name = "chardev-add",
1756 .args_type = "args:s",
1757 .params = "args",
1758 .help = "add chardev",
1759 .cmd = hmp_chardev_add,
1760 .command_completion = chardev_add_completion,
1763 STEXI
1764 @item chardev-add args
1765 @findex chardev-add
1766 chardev-add accepts the same parameters as the -chardev command line switch.
1768 ETEXI
1771 .name = "chardev-change",
1772 .args_type = "id:s,args:s",
1773 .params = "id args",
1774 .help = "change chardev",
1775 .cmd = hmp_chardev_change,
1778 STEXI
1779 @item chardev-change args
1780 @findex chardev-change
1781 chardev-change accepts existing chardev @var{id} and then the same arguments
1782 as the -chardev command line switch (except for "id").
1784 ETEXI
1787 .name = "chardev-remove",
1788 .args_type = "id:s",
1789 .params = "id",
1790 .help = "remove chardev",
1791 .cmd = hmp_chardev_remove,
1792 .command_completion = chardev_remove_completion,
1795 STEXI
1796 @item chardev-remove id
1797 @findex chardev-remove
1798 Removes the chardev @var{id}.
1800 ETEXI
1803 .name = "chardev-send-break",
1804 .args_type = "id:s",
1805 .params = "id",
1806 .help = "send a break on chardev",
1807 .cmd = hmp_chardev_send_break,
1808 .command_completion = chardev_remove_completion,
1811 STEXI
1812 @item chardev-send-break id
1813 @findex chardev-send-break
1814 Send a break on the chardev @var{id}.
1816 ETEXI
1819 .name = "qemu-io",
1820 .args_type = "device:B,command:s",
1821 .params = "[device] \"[command]\"",
1822 .help = "run a qemu-io command on a block device",
1823 .cmd = hmp_qemu_io,
1826 STEXI
1827 @item qemu-io @var{device} @var{command}
1828 @findex qemu-io
1829 Executes a qemu-io command on the given block device.
1831 ETEXI
1834 .name = "cpu-add",
1835 .args_type = "id:i",
1836 .params = "id",
1837 .help = "add cpu",
1838 .cmd = hmp_cpu_add,
1841 STEXI
1842 @item cpu-add @var{id}
1843 @findex cpu-add
1844 Add CPU with id @var{id}
1845 ETEXI
1848 .name = "qom-list",
1849 .args_type = "path:s?",
1850 .params = "path",
1851 .help = "list QOM properties",
1852 .cmd = hmp_qom_list,
1853 .flags = "p",
1856 STEXI
1857 @item qom-list [@var{path}]
1858 Print QOM properties of object at location @var{path}
1859 ETEXI
1862 .name = "qom-set",
1863 .args_type = "path:s,property:s,value:s",
1864 .params = "path property value",
1865 .help = "set QOM property",
1866 .cmd = hmp_qom_set,
1867 .flags = "p",
1870 STEXI
1871 @item qom-set @var{path} @var{property} @var{value}
1872 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1873 ETEXI
1876 .name = "info",
1877 .args_type = "item:s?",
1878 .params = "[subcommand]",
1879 .help = "show various information about the system state",
1880 .cmd = hmp_info_help,
1881 .sub_table = info_cmds,
1882 .flags = "p",
1885 STEXI
1886 @end table
1887 ETEXI