migration: Add counts of updating the dirty bitmap
[qemu.git] / hmp-commands.hx
blob8971f1b15303b8fe4625968fff4b72937b459a38
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 .mhandler.cmd = do_help_cmd,
20 STEXI
21 @item help or ? [@var{cmd}]
22 @findex help
23 Show the help for all commands or just for command @var{cmd}.
24 ETEXI
27 .name = "commit",
28 .args_type = "device:B",
29 .params = "device|all",
30 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
31 .mhandler.cmd = do_commit,
34 STEXI
35 @item commit
36 @findex commit
37 Commit changes to the disk images (if -snapshot is used) or backing files.
38 If the backing file is smaller than the snapshot, then the backing file will be
39 resized to be the same size as the snapshot. If the snapshot is smaller than
40 the backing file, the backing file will not be truncated. If you want the
41 backing file to match the size of the smaller snapshot, you can safely truncate
42 it yourself once the commit operation successfully completes.
43 ETEXI
46 .name = "q|quit",
47 .args_type = "",
48 .params = "",
49 .help = "quit the emulator",
50 .user_print = monitor_user_noop,
51 .mhandler.cmd = hmp_quit,
54 STEXI
55 @item q or quit
56 @findex quit
57 Quit the emulator.
58 ETEXI
61 .name = "block_resize",
62 .args_type = "device:B,size:o",
63 .params = "device size",
64 .help = "resize a block image",
65 .mhandler.cmd = hmp_block_resize,
68 STEXI
69 @item block_resize
70 @findex block_resize
71 Resize a block image while a guest is running. Usually requires guest
72 action to see the updated size. Resize to a lower size is supported,
73 but should be used with extreme caution. Note that this command only
74 resizes image files, it can not resize block devices like LVM volumes.
75 ETEXI
78 .name = "block_stream",
79 .args_type = "device:B,speed:o?,base:s?",
80 .params = "device [speed [base]]",
81 .help = "copy data from a backing file into a block device",
82 .mhandler.cmd = hmp_block_stream,
85 STEXI
86 @item block_stream
87 @findex block_stream
88 Copy data from a backing file into a block device.
89 ETEXI
92 .name = "block_job_set_speed",
93 .args_type = "device:B,speed:o",
94 .params = "device speed",
95 .help = "set maximum speed for a background block operation",
96 .mhandler.cmd = hmp_block_job_set_speed,
99 STEXI
100 @item block_job_set_speed
101 @findex block_job_set_speed
102 Set maximum speed for a background block operation.
103 ETEXI
106 .name = "block_job_cancel",
107 .args_type = "force:-f,device:B",
108 .params = "[-f] device",
109 .help = "stop an active background block operation (use -f"
110 "\n\t\t\t if the operation is currently paused)",
111 .mhandler.cmd = hmp_block_job_cancel,
114 STEXI
115 @item block_job_cancel
116 @findex block_job_cancel
117 Stop an active background block operation (streaming, mirroring).
118 ETEXI
121 .name = "block_job_complete",
122 .args_type = "device:B",
123 .params = "device",
124 .help = "stop an active background block operation",
125 .mhandler.cmd = hmp_block_job_complete,
128 STEXI
129 @item block_job_complete
130 @findex block_job_complete
131 Manually trigger completion of an active background block operation.
132 For mirroring, this will switch the device to the destination path.
133 ETEXI
136 .name = "block_job_pause",
137 .args_type = "device:B",
138 .params = "device",
139 .help = "pause an active background block operation",
140 .mhandler.cmd = hmp_block_job_pause,
143 STEXI
144 @item block_job_pause
145 @findex block_job_pause
146 Pause an active block streaming operation.
147 ETEXI
150 .name = "block_job_resume",
151 .args_type = "device:B",
152 .params = "device",
153 .help = "resume a paused background block operation",
154 .mhandler.cmd = hmp_block_job_resume,
157 STEXI
158 @item block_job_resume
159 @findex block_job_resume
160 Resume a paused block streaming operation.
161 ETEXI
164 .name = "eject",
165 .args_type = "force:-f,device:B",
166 .params = "[-f] device",
167 .help = "eject a removable medium (use -f to force it)",
168 .mhandler.cmd = hmp_eject,
171 STEXI
172 @item eject [-f] @var{device}
173 @findex eject
174 Eject a removable medium (use -f to force it).
175 ETEXI
178 .name = "drive_del",
179 .args_type = "id:B",
180 .params = "device",
181 .help = "remove host block device",
182 .user_print = monitor_user_noop,
183 .mhandler.cmd_new = do_drive_del,
186 STEXI
187 @item drive_del @var{device}
188 @findex drive_del
189 Remove host block device. The result is that guest generated IO is no longer
190 submitted against the host device underlying the disk. Once a drive has
191 been deleted, the QEMU Block layer returns -EIO which results in IO
192 errors in the guest for applications that are reading/writing to the device.
193 These errors are always reported to the guest, regardless of the drive's error
194 actions (drive options rerror, werror).
195 ETEXI
198 .name = "change",
199 .args_type = "device:B,target:F,arg:s?",
200 .params = "device filename [format]",
201 .help = "change a removable medium, optional format",
202 .mhandler.cmd = hmp_change,
205 STEXI
206 @item change @var{device} @var{setting}
207 @findex change
209 Change the configuration of a device.
211 @table @option
212 @item change @var{diskdevice} @var{filename} [@var{format}]
213 Change the medium for a removable disk device to point to @var{filename}. eg
215 @example
216 (qemu) change ide1-cd0 /path/to/some.iso
217 @end example
219 @var{format} is optional.
221 @item change vnc @var{display},@var{options}
222 Change the configuration of the VNC server. The valid syntax for @var{display}
223 and @var{options} are described at @ref{sec_invocation}. eg
225 @example
226 (qemu) change vnc localhost:1
227 @end example
229 @item change vnc password [@var{password}]
231 Change the password associated with the VNC server. If the new password is not
232 supplied, the monitor will prompt for it to be entered. VNC passwords are only
233 significant up to 8 letters. eg
235 @example
236 (qemu) change vnc password
237 Password: ********
238 @end example
240 @end table
241 ETEXI
244 .name = "screendump",
245 .args_type = "filename:F",
246 .params = "filename",
247 .help = "save screen into PPM image 'filename'",
248 .mhandler.cmd = hmp_screen_dump,
251 STEXI
252 @item screendump @var{filename}
253 @findex screendump
254 Save screen into PPM image @var{filename}.
255 ETEXI
258 .name = "logfile",
259 .args_type = "filename:F",
260 .params = "filename",
261 .help = "output logs to 'filename'",
262 .mhandler.cmd = do_logfile,
265 STEXI
266 @item logfile @var{filename}
267 @findex logfile
268 Output logs to @var{filename}.
269 ETEXI
272 .name = "trace-event",
273 .args_type = "name:s,option:b",
274 .params = "name on|off",
275 .help = "changes status of a specific trace event",
276 .mhandler.cmd = do_trace_event_set_state,
279 STEXI
280 @item trace-event
281 @findex trace-event
282 changes status of a trace event
283 ETEXI
285 #if defined(CONFIG_TRACE_SIMPLE)
287 .name = "trace-file",
288 .args_type = "op:s?,arg:F?",
289 .params = "on|off|flush|set [arg]",
290 .help = "open, close, or flush trace file, or set a new file name",
291 .mhandler.cmd = do_trace_file,
294 STEXI
295 @item trace-file on|off|flush
296 @findex trace-file
297 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
298 ETEXI
299 #endif
302 .name = "log",
303 .args_type = "items:s",
304 .params = "item1[,...]",
305 .help = "activate logging of the specified items",
306 .mhandler.cmd = do_log,
309 STEXI
310 @item log @var{item1}[,...]
311 @findex log
312 Activate logging of the specified items.
313 ETEXI
316 .name = "savevm",
317 .args_type = "name:s?",
318 .params = "[tag|id]",
319 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
320 .mhandler.cmd = do_savevm,
323 STEXI
324 @item savevm [@var{tag}|@var{id}]
325 @findex savevm
326 Create a snapshot of the whole virtual machine. If @var{tag} is
327 provided, it is used as human readable identifier. If there is already
328 a snapshot with the same tag or ID, it is replaced. More info at
329 @ref{vm_snapshots}.
330 ETEXI
333 .name = "loadvm",
334 .args_type = "name:s",
335 .params = "tag|id",
336 .help = "restore a VM snapshot from its tag or id",
337 .mhandler.cmd = do_loadvm,
340 STEXI
341 @item loadvm @var{tag}|@var{id}
342 @findex loadvm
343 Set the whole virtual machine to the snapshot identified by the tag
344 @var{tag} or the unique snapshot ID @var{id}.
345 ETEXI
348 .name = "delvm",
349 .args_type = "name:s",
350 .params = "tag|id",
351 .help = "delete a VM snapshot from its tag or id",
352 .mhandler.cmd = do_delvm,
355 STEXI
356 @item delvm @var{tag}|@var{id}
357 @findex delvm
358 Delete the snapshot identified by @var{tag} or @var{id}.
359 ETEXI
362 .name = "singlestep",
363 .args_type = "option:s?",
364 .params = "[on|off]",
365 .help = "run emulation in singlestep mode or switch to normal mode",
366 .mhandler.cmd = do_singlestep,
369 STEXI
370 @item singlestep [off]
371 @findex singlestep
372 Run the emulation in single step mode.
373 If called with option off, the emulation returns to normal mode.
374 ETEXI
377 .name = "stop",
378 .args_type = "",
379 .params = "",
380 .help = "stop emulation",
381 .mhandler.cmd = hmp_stop,
384 STEXI
385 @item stop
386 @findex stop
387 Stop emulation.
388 ETEXI
391 .name = "c|cont",
392 .args_type = "",
393 .params = "",
394 .help = "resume emulation",
395 .mhandler.cmd = hmp_cont,
398 STEXI
399 @item c or cont
400 @findex cont
401 Resume emulation.
402 ETEXI
405 .name = "system_wakeup",
406 .args_type = "",
407 .params = "",
408 .help = "wakeup guest from suspend",
409 .mhandler.cmd = hmp_system_wakeup,
412 STEXI
413 @item system_wakeup
414 @findex system_wakeup
415 Wakeup guest from suspend.
416 ETEXI
419 .name = "gdbserver",
420 .args_type = "device:s?",
421 .params = "[device]",
422 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
423 .mhandler.cmd = do_gdbserver,
426 STEXI
427 @item gdbserver [@var{port}]
428 @findex gdbserver
429 Start gdbserver session (default @var{port}=1234)
430 ETEXI
433 .name = "x",
434 .args_type = "fmt:/,addr:l",
435 .params = "/fmt addr",
436 .help = "virtual memory dump starting at 'addr'",
437 .mhandler.cmd = do_memory_dump,
440 STEXI
441 @item x/fmt @var{addr}
442 @findex x
443 Virtual memory dump starting at @var{addr}.
444 ETEXI
447 .name = "xp",
448 .args_type = "fmt:/,addr:l",
449 .params = "/fmt addr",
450 .help = "physical memory dump starting at 'addr'",
451 .mhandler.cmd = do_physical_memory_dump,
454 STEXI
455 @item xp /@var{fmt} @var{addr}
456 @findex xp
457 Physical memory dump starting at @var{addr}.
459 @var{fmt} is a format which tells the command how to format the
460 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
462 @table @var
463 @item count
464 is the number of items to be dumped.
466 @item format
467 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
468 c (char) or i (asm instruction).
470 @item size
471 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
472 @code{h} or @code{w} can be specified with the @code{i} format to
473 respectively select 16 or 32 bit code instruction size.
475 @end table
477 Examples:
478 @itemize
479 @item
480 Dump 10 instructions at the current instruction pointer:
481 @example
482 (qemu) x/10i $eip
483 0x90107063: ret
484 0x90107064: sti
485 0x90107065: lea 0x0(%esi,1),%esi
486 0x90107069: lea 0x0(%edi,1),%edi
487 0x90107070: ret
488 0x90107071: jmp 0x90107080
489 0x90107073: nop
490 0x90107074: nop
491 0x90107075: nop
492 0x90107076: nop
493 @end example
495 @item
496 Dump 80 16 bit values at the start of the video memory.
497 @smallexample
498 (qemu) xp/80hx 0xb8000
499 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
500 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
501 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
502 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
503 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
504 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
505 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
506 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
507 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
508 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
509 @end smallexample
510 @end itemize
511 ETEXI
514 .name = "p|print",
515 .args_type = "fmt:/,val:l",
516 .params = "/fmt expr",
517 .help = "print expression value (use $reg for CPU register access)",
518 .mhandler.cmd = do_print,
521 STEXI
522 @item p or print/@var{fmt} @var{expr}
523 @findex print
525 Print expression value. Only the @var{format} part of @var{fmt} is
526 used.
527 ETEXI
530 .name = "i",
531 .args_type = "fmt:/,addr:i,index:i.",
532 .params = "/fmt addr",
533 .help = "I/O port read",
534 .mhandler.cmd = do_ioport_read,
537 STEXI
538 Read I/O port.
539 ETEXI
542 .name = "o",
543 .args_type = "fmt:/,addr:i,val:i",
544 .params = "/fmt addr value",
545 .help = "I/O port write",
546 .mhandler.cmd = do_ioport_write,
549 STEXI
550 Write to I/O port.
551 ETEXI
554 .name = "sendkey",
555 .args_type = "keys:s,hold-time:i?",
556 .params = "keys [hold_ms]",
557 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
558 .mhandler.cmd = hmp_send_key,
561 STEXI
562 @item sendkey @var{keys}
563 @findex sendkey
565 Send @var{keys} to the guest. @var{keys} could be the name of the
566 key or the raw value in hexadecimal format. Use @code{-} to press
567 several keys simultaneously. Example:
568 @example
569 sendkey ctrl-alt-f1
570 @end example
572 This command is useful to send keys that your graphical user interface
573 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
574 ETEXI
577 .name = "system_reset",
578 .args_type = "",
579 .params = "",
580 .help = "reset the system",
581 .mhandler.cmd = hmp_system_reset,
584 STEXI
585 @item system_reset
586 @findex system_reset
588 Reset the system.
589 ETEXI
592 .name = "system_powerdown",
593 .args_type = "",
594 .params = "",
595 .help = "send system power down event",
596 .mhandler.cmd = hmp_system_powerdown,
599 STEXI
600 @item system_powerdown
601 @findex system_powerdown
603 Power down the system (if supported).
604 ETEXI
607 .name = "sum",
608 .args_type = "start:i,size:i",
609 .params = "addr size",
610 .help = "compute the checksum of a memory region",
611 .mhandler.cmd = do_sum,
614 STEXI
615 @item sum @var{addr} @var{size}
616 @findex sum
618 Compute the checksum of a memory region.
619 ETEXI
622 .name = "usb_add",
623 .args_type = "devname:s",
624 .params = "device",
625 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
626 .mhandler.cmd = do_usb_add,
629 STEXI
630 @item usb_add @var{devname}
631 @findex usb_add
633 Add the USB device @var{devname}. For details of available devices see
634 @ref{usb_devices}
635 ETEXI
638 .name = "usb_del",
639 .args_type = "devname:s",
640 .params = "device",
641 .help = "remove USB device 'bus.addr'",
642 .mhandler.cmd = do_usb_del,
645 STEXI
646 @item usb_del @var{devname}
647 @findex usb_del
649 Remove the USB device @var{devname} from the QEMU virtual USB
650 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
651 command @code{info usb} to see the devices you can remove.
652 ETEXI
655 .name = "device_add",
656 .args_type = "device:O",
657 .params = "driver[,prop=value][,...]",
658 .help = "add device, like -device on the command line",
659 .user_print = monitor_user_noop,
660 .mhandler.cmd_new = do_device_add,
661 .command_completion = device_add_completion,
664 STEXI
665 @item device_add @var{config}
666 @findex device_add
668 Add device.
669 ETEXI
672 .name = "device_del",
673 .args_type = "id:s",
674 .params = "device",
675 .help = "remove device",
676 .mhandler.cmd = hmp_device_del,
677 .command_completion = device_del_completion,
680 STEXI
681 @item device_del @var{id}
682 @findex device_del
684 Remove device @var{id}.
685 ETEXI
688 .name = "cpu",
689 .args_type = "index:i",
690 .params = "index",
691 .help = "set the default CPU",
692 .mhandler.cmd = hmp_cpu,
695 STEXI
696 @item cpu @var{index}
697 @findex cpu
698 Set the default CPU.
699 ETEXI
702 .name = "mouse_move",
703 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
704 .params = "dx dy [dz]",
705 .help = "send mouse move events",
706 .mhandler.cmd = do_mouse_move,
709 STEXI
710 @item mouse_move @var{dx} @var{dy} [@var{dz}]
711 @findex mouse_move
712 Move the active mouse to the specified coordinates @var{dx} @var{dy}
713 with optional scroll axis @var{dz}.
714 ETEXI
717 .name = "mouse_button",
718 .args_type = "button_state:i",
719 .params = "state",
720 .help = "change mouse button state (1=L, 2=M, 4=R)",
721 .mhandler.cmd = do_mouse_button,
724 STEXI
725 @item mouse_button @var{val}
726 @findex mouse_button
727 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
728 ETEXI
731 .name = "mouse_set",
732 .args_type = "index:i",
733 .params = "index",
734 .help = "set which mouse device receives events",
735 .mhandler.cmd = do_mouse_set,
738 STEXI
739 @item mouse_set @var{index}
740 @findex mouse_set
741 Set which mouse device receives events at given @var{index}, index
742 can be obtained with
743 @example
744 info mice
745 @end example
746 ETEXI
749 .name = "wavcapture",
750 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
751 .params = "path [frequency [bits [channels]]]",
752 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
753 .mhandler.cmd = do_wav_capture,
755 STEXI
756 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
757 @findex wavcapture
758 Capture audio into @var{filename}. Using sample rate @var{frequency}
759 bits per sample @var{bits} and number of channels @var{channels}.
761 Defaults:
762 @itemize @minus
763 @item Sample rate = 44100 Hz - CD quality
764 @item Bits = 16
765 @item Number of channels = 2 - Stereo
766 @end itemize
767 ETEXI
770 .name = "stopcapture",
771 .args_type = "n:i",
772 .params = "capture index",
773 .help = "stop capture",
774 .mhandler.cmd = do_stop_capture,
776 STEXI
777 @item stopcapture @var{index}
778 @findex stopcapture
779 Stop capture with a given @var{index}, index can be obtained with
780 @example
781 info capture
782 @end example
783 ETEXI
786 .name = "memsave",
787 .args_type = "val:l,size:i,filename:s",
788 .params = "addr size file",
789 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
790 .mhandler.cmd = hmp_memsave,
793 STEXI
794 @item memsave @var{addr} @var{size} @var{file}
795 @findex memsave
796 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
797 ETEXI
800 .name = "pmemsave",
801 .args_type = "val:l,size:i,filename:s",
802 .params = "addr size file",
803 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
804 .mhandler.cmd = hmp_pmemsave,
807 STEXI
808 @item pmemsave @var{addr} @var{size} @var{file}
809 @findex pmemsave
810 save to disk physical memory dump starting at @var{addr} of size @var{size}.
811 ETEXI
814 .name = "boot_set",
815 .args_type = "bootdevice:s",
816 .params = "bootdevice",
817 .help = "define new values for the boot device list",
818 .mhandler.cmd = do_boot_set,
821 STEXI
822 @item boot_set @var{bootdevicelist}
823 @findex boot_set
825 Define new values for the boot device list. Those values will override
826 the values specified on the command line through the @code{-boot} option.
828 The values that can be specified here depend on the machine type, but are
829 the same that can be specified in the @code{-boot} command line option.
830 ETEXI
832 #if defined(TARGET_I386) || defined(TARGET_S390X)
834 .name = "nmi",
835 .args_type = "",
836 .params = "",
837 .help = "inject an NMI on all guest's CPUs",
838 .mhandler.cmd = hmp_inject_nmi,
840 #endif
841 STEXI
842 @item nmi @var{cpu}
843 @findex nmi
844 Inject an NMI (x86) or RESTART (s390x) on the given CPU.
846 ETEXI
849 .name = "ringbuf_write",
850 .args_type = "device:s,data:s",
851 .params = "device data",
852 .help = "Write to a ring buffer character device",
853 .mhandler.cmd = hmp_ringbuf_write,
856 STEXI
857 @item ringbuf_write @var{device} @var{data}
858 @findex ringbuf_write
859 Write @var{data} to ring buffer character device @var{device}.
860 @var{data} must be a UTF-8 string.
862 ETEXI
865 .name = "ringbuf_read",
866 .args_type = "device:s,size:i",
867 .params = "device size",
868 .help = "Read from a ring buffer character device",
869 .mhandler.cmd = hmp_ringbuf_read,
872 STEXI
873 @item ringbuf_read @var{device}
874 @findex ringbuf_read
875 Read and print up to @var{size} bytes from ring buffer character
876 device @var{device}.
877 Certain non-printable characters are printed \uXXXX, where XXXX is the
878 character code in hexadecimal. Character \ is printed \\.
879 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
880 NUL characters, after the ring buffer lost data, and when reading
881 stops because the size limit is reached.
883 ETEXI
886 .name = "migrate",
887 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
888 .params = "[-d] [-b] [-i] uri",
889 .help = "migrate to URI (using -d to not wait for completion)"
890 "\n\t\t\t -b for migration without shared storage with"
891 " full copy of disk\n\t\t\t -i for migration without "
892 "shared storage with incremental copy of disk "
893 "(base image shared between src and destination)",
894 .mhandler.cmd = hmp_migrate,
898 STEXI
899 @item migrate [-d] [-b] [-i] @var{uri}
900 @findex migrate
901 Migrate to @var{uri} (using -d to not wait for completion).
902 -b for migration with full copy of disk
903 -i for migration with incremental copy of disk (base image is shared)
904 ETEXI
907 .name = "migrate_cancel",
908 .args_type = "",
909 .params = "",
910 .help = "cancel the current VM migration",
911 .mhandler.cmd = hmp_migrate_cancel,
914 STEXI
915 @item migrate_cancel
916 @findex migrate_cancel
917 Cancel the current VM migration.
919 ETEXI
922 .name = "migrate_set_cache_size",
923 .args_type = "value:o",
924 .params = "value",
925 .help = "set cache size (in bytes) for XBZRLE migrations,"
926 "the cache size will be rounded down to the nearest "
927 "power of 2.\n"
928 "The cache size affects the number of cache misses."
929 "In case of a high cache miss ratio you need to increase"
930 " the cache size",
931 .mhandler.cmd = hmp_migrate_set_cache_size,
934 STEXI
935 @item migrate_set_cache_size @var{value}
936 @findex migrate_set_cache_size
937 Set cache size to @var{value} (in bytes) for xbzrle migrations.
938 ETEXI
941 .name = "migrate_set_speed",
942 .args_type = "value:o",
943 .params = "value",
944 .help = "set maximum speed (in bytes) for migrations. "
945 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
946 .mhandler.cmd = hmp_migrate_set_speed,
949 STEXI
950 @item migrate_set_speed @var{value}
951 @findex migrate_set_speed
952 Set maximum speed to @var{value} (in bytes) for migrations.
953 ETEXI
956 .name = "migrate_set_downtime",
957 .args_type = "value:T",
958 .params = "value",
959 .help = "set maximum tolerated downtime (in seconds) for migrations",
960 .mhandler.cmd = hmp_migrate_set_downtime,
963 STEXI
964 @item migrate_set_downtime @var{second}
965 @findex migrate_set_downtime
966 Set maximum tolerated downtime (in seconds) for migration.
967 ETEXI
970 .name = "migrate_set_capability",
971 .args_type = "capability:s,state:b",
972 .params = "capability state",
973 .help = "Enable/Disable the usage of a capability for migration",
974 .mhandler.cmd = hmp_migrate_set_capability,
977 STEXI
978 @item migrate_set_capability @var{capability} @var{state}
979 @findex migrate_set_capability
980 Enable/Disable the usage of a capability @var{capability} for migration.
981 ETEXI
984 .name = "client_migrate_info",
985 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
986 .params = "protocol hostname port tls-port cert-subject",
987 .help = "send migration info to spice/vnc client",
988 .user_print = monitor_user_noop,
989 .mhandler.cmd_async = client_migrate_info,
990 .flags = MONITOR_CMD_ASYNC,
993 STEXI
994 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
995 @findex client_migrate_info
996 Set the spice/vnc connection info for the migration target. The spice/vnc
997 server will ask the spice/vnc client to automatically reconnect using the
998 new parameters (if specified) once the vm migration finished successfully.
999 ETEXI
1002 .name = "dump-guest-memory",
1003 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1004 .params = "[-p] [-z|-l|-s] filename [begin length]",
1005 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1006 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1007 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1008 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1009 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1010 "begin: the starting physical address.\n\t\t\t"
1011 "length: the memory size, in bytes.",
1012 .mhandler.cmd = hmp_dump_guest_memory,
1016 STEXI
1017 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1018 @item dump-guest-memory [-z|-l|-s] @var{filename}
1019 @findex dump-guest-memory
1020 Dump guest memory to @var{protocol}. The file can be processed with crash or
1021 gdb. Without -z|-l|-s, the dump format is ELF.
1022 -p: do paging to get guest's memory mapping.
1023 -z: dump in kdump-compressed format, with zlib compression.
1024 -l: dump in kdump-compressed format, with lzo compression.
1025 -s: dump in kdump-compressed format, with snappy compression.
1026 filename: dump file name.
1027 begin: the starting physical address. It's optional, and should be
1028 specified together with length.
1029 length: the memory size, in bytes. It's optional, and should be specified
1030 together with begin.
1031 ETEXI
1034 .name = "snapshot_blkdev",
1035 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1036 .params = "[-n] device [new-image-file] [format]",
1037 .help = "initiates a live snapshot\n\t\t\t"
1038 "of device. If a new image file is specified, the\n\t\t\t"
1039 "new image file will become the new root image.\n\t\t\t"
1040 "If format is specified, the snapshot file will\n\t\t\t"
1041 "be created in that format.\n\t\t\t"
1042 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1043 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1044 "recreating it from scratch.",
1045 .mhandler.cmd = hmp_snapshot_blkdev,
1048 STEXI
1049 @item snapshot_blkdev
1050 @findex snapshot_blkdev
1051 Snapshot device, using snapshot file as target if provided
1052 ETEXI
1055 .name = "snapshot_blkdev_internal",
1056 .args_type = "device:B,name:s",
1057 .params = "device name",
1058 .help = "take an internal snapshot of device.\n\t\t\t"
1059 "The format of the image used by device must\n\t\t\t"
1060 "support it, such as qcow2.\n\t\t\t",
1061 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1064 STEXI
1065 @item snapshot_blkdev_internal
1066 @findex snapshot_blkdev_internal
1067 Take an internal snapshot on device if it support
1068 ETEXI
1071 .name = "snapshot_delete_blkdev_internal",
1072 .args_type = "device:B,name:s,id:s?",
1073 .params = "device name [id]",
1074 .help = "delete an internal snapshot of device.\n\t\t\t"
1075 "If id is specified, qemu will try delete\n\t\t\t"
1076 "the snapshot matching both id and name.\n\t\t\t"
1077 "The format of the image used by device must\n\t\t\t"
1078 "support it, such as qcow2.\n\t\t\t",
1079 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1082 STEXI
1083 @item snapshot_delete_blkdev_internal
1084 @findex snapshot_delete_blkdev_internal
1085 Delete an internal snapshot on device if it support
1086 ETEXI
1089 .name = "drive_mirror",
1090 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1091 .params = "[-n] [-f] device target [format]",
1092 .help = "initiates live storage\n\t\t\t"
1093 "migration for a device. The device's contents are\n\t\t\t"
1094 "copied to the new image file, including data that\n\t\t\t"
1095 "is written after the command is started.\n\t\t\t"
1096 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1097 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1098 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1099 "so that the result does not need a backing file.\n\t\t\t",
1100 .mhandler.cmd = hmp_drive_mirror,
1102 STEXI
1103 @item drive_mirror
1104 @findex drive_mirror
1105 Start mirroring a block device's writes to a new destination,
1106 using the specified target.
1107 ETEXI
1110 .name = "drive_backup",
1111 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1112 .params = "[-n] [-f] device target [format]",
1113 .help = "initiates a point-in-time\n\t\t\t"
1114 "copy for a device. The device's contents are\n\t\t\t"
1115 "copied to the new image file, excluding data that\n\t\t\t"
1116 "is written after the command is started.\n\t\t\t"
1117 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1118 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1119 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1120 "so that the result does not need a backing file.\n\t\t\t",
1121 .mhandler.cmd = hmp_drive_backup,
1123 STEXI
1124 @item drive_backup
1125 @findex drive_backup
1126 Start a point-in-time copy of a block device to a specificed target.
1127 ETEXI
1130 .name = "drive_add",
1131 .args_type = "pci_addr:s,opts:s",
1132 .params = "[[<domain>:]<bus>:]<slot>\n"
1133 "[file=file][,if=type][,bus=n]\n"
1134 "[,unit=m][,media=d][,index=i]\n"
1135 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1136 "[,snapshot=on|off][,cache=on|off]\n"
1137 "[,readonly=on|off][,copy-on-read=on|off]",
1138 .help = "add drive to PCI storage controller",
1139 .mhandler.cmd = drive_hot_add,
1142 STEXI
1143 @item drive_add
1144 @findex drive_add
1145 Add drive to PCI storage controller.
1146 ETEXI
1148 #if defined(CONFIG_PCI_HOTPLUG_OLD)
1150 .name = "pci_add",
1151 .args_type = "pci_addr:s,type:s,opts:s?",
1152 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
1153 .help = "hot-add PCI device",
1154 .mhandler.cmd = pci_device_hot_add,
1156 #endif
1158 STEXI
1159 @item pci_add
1160 @findex pci_add
1161 Hot-add PCI device.
1162 ETEXI
1164 #if defined(CONFIG_PCI_HOTPLUG_OLD)
1166 .name = "pci_del",
1167 .args_type = "pci_addr:s",
1168 .params = "[[<domain>:]<bus>:]<slot>",
1169 .help = "hot remove PCI device",
1170 .mhandler.cmd = do_pci_device_hot_remove,
1172 #endif
1174 STEXI
1175 @item pci_del
1176 @findex pci_del
1177 Hot remove PCI device.
1178 ETEXI
1181 .name = "pcie_aer_inject_error",
1182 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1183 "id:s,error_status:s,"
1184 "header0:i?,header1:i?,header2:i?,header3:i?,"
1185 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1186 .params = "[-a] [-c] id "
1187 "<error_status> [<tlp header> [<tlp header prefix>]]",
1188 .help = "inject pcie aer error\n\t\t\t"
1189 " -a for advisory non fatal error\n\t\t\t"
1190 " -c for correctable error\n\t\t\t"
1191 "<id> = qdev device id\n\t\t\t"
1192 "<error_status> = error string or 32bit\n\t\t\t"
1193 "<tlb header> = 32bit x 4\n\t\t\t"
1194 "<tlb header prefix> = 32bit x 4",
1195 .user_print = pcie_aer_inject_error_print,
1196 .mhandler.cmd_new = do_pcie_aer_inject_error,
1199 STEXI
1200 @item pcie_aer_inject_error
1201 @findex pcie_aer_inject_error
1202 Inject PCIe AER error
1203 ETEXI
1206 .name = "host_net_add",
1207 .args_type = "device:s,opts:s?",
1208 .params = "tap|user|socket|vde|netmap|dump [options]",
1209 .help = "add host VLAN client",
1210 .mhandler.cmd = net_host_device_add,
1213 STEXI
1214 @item host_net_add
1215 @findex host_net_add
1216 Add host VLAN client.
1217 ETEXI
1220 .name = "host_net_remove",
1221 .args_type = "vlan_id:i,device:s",
1222 .params = "vlan_id name",
1223 .help = "remove host VLAN client",
1224 .mhandler.cmd = net_host_device_remove,
1227 STEXI
1228 @item host_net_remove
1229 @findex host_net_remove
1230 Remove host VLAN client.
1231 ETEXI
1234 .name = "netdev_add",
1235 .args_type = "netdev:O",
1236 .params = "[user|tap|socket|hubport|netmap],id=str[,prop=value][,...]",
1237 .help = "add host network device",
1238 .mhandler.cmd = hmp_netdev_add,
1241 STEXI
1242 @item netdev_add
1243 @findex netdev_add
1244 Add host network device.
1245 ETEXI
1248 .name = "netdev_del",
1249 .args_type = "id:s",
1250 .params = "id",
1251 .help = "remove host network device",
1252 .mhandler.cmd = hmp_netdev_del,
1255 STEXI
1256 @item netdev_del
1257 @findex netdev_del
1258 Remove host network device.
1259 ETEXI
1262 .name = "object_add",
1263 .args_type = "object:O",
1264 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1265 .help = "create QOM object",
1266 .mhandler.cmd = hmp_object_add,
1267 .command_completion = object_add_completion,
1270 STEXI
1271 @item object_add
1272 @findex object_add
1273 Create QOM object.
1274 ETEXI
1277 .name = "object_del",
1278 .args_type = "id:s",
1279 .params = "id",
1280 .help = "destroy QOM object",
1281 .mhandler.cmd = hmp_object_del,
1282 .command_completion = object_del_completion,
1285 STEXI
1286 @item object_del
1287 @findex object_del
1288 Destroy QOM object.
1289 ETEXI
1291 #ifdef CONFIG_SLIRP
1293 .name = "hostfwd_add",
1294 .args_type = "arg1:s,arg2:s?,arg3:s?",
1295 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1296 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1297 .mhandler.cmd = net_slirp_hostfwd_add,
1299 #endif
1300 STEXI
1301 @item hostfwd_add
1302 @findex hostfwd_add
1303 Redirect TCP or UDP connections from host to guest (requires -net user).
1304 ETEXI
1306 #ifdef CONFIG_SLIRP
1308 .name = "hostfwd_remove",
1309 .args_type = "arg1:s,arg2:s?,arg3:s?",
1310 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1311 .help = "remove host-to-guest TCP or UDP redirection",
1312 .mhandler.cmd = net_slirp_hostfwd_remove,
1315 #endif
1316 STEXI
1317 @item hostfwd_remove
1318 @findex hostfwd_remove
1319 Remove host-to-guest TCP or UDP redirection.
1320 ETEXI
1323 .name = "balloon",
1324 .args_type = "value:M",
1325 .params = "target",
1326 .help = "request VM to change its memory allocation (in MB)",
1327 .mhandler.cmd = hmp_balloon,
1330 STEXI
1331 @item balloon @var{value}
1332 @findex balloon
1333 Request VM to change its memory allocation to @var{value} (in MB).
1334 ETEXI
1337 .name = "set_link",
1338 .args_type = "name:s,up:b",
1339 .params = "name on|off",
1340 .help = "change the link status of a network adapter",
1341 .mhandler.cmd = hmp_set_link,
1344 STEXI
1345 @item set_link @var{name} [on|off]
1346 @findex set_link
1347 Switch link @var{name} on (i.e. up) or off (i.e. down).
1348 ETEXI
1351 .name = "watchdog_action",
1352 .args_type = "action:s",
1353 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1354 .help = "change watchdog action",
1355 .mhandler.cmd = do_watchdog_action,
1358 STEXI
1359 @item watchdog_action
1360 @findex watchdog_action
1361 Change watchdog action.
1362 ETEXI
1365 .name = "acl_show",
1366 .args_type = "aclname:s",
1367 .params = "aclname",
1368 .help = "list rules in the access control list",
1369 .mhandler.cmd = do_acl_show,
1372 STEXI
1373 @item acl_show @var{aclname}
1374 @findex acl_show
1375 List all the matching rules in the access control list, and the default
1376 policy. There are currently two named access control lists,
1377 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1378 certificate distinguished name, and SASL username respectively.
1379 ETEXI
1382 .name = "acl_policy",
1383 .args_type = "aclname:s,policy:s",
1384 .params = "aclname allow|deny",
1385 .help = "set default access control list policy",
1386 .mhandler.cmd = do_acl_policy,
1389 STEXI
1390 @item acl_policy @var{aclname} @code{allow|deny}
1391 @findex acl_policy
1392 Set the default access control list policy, used in the event that
1393 none of the explicit rules match. The default policy at startup is
1394 always @code{deny}.
1395 ETEXI
1398 .name = "acl_add",
1399 .args_type = "aclname:s,match:s,policy:s,index:i?",
1400 .params = "aclname match allow|deny [index]",
1401 .help = "add a match rule to the access control list",
1402 .mhandler.cmd = do_acl_add,
1405 STEXI
1406 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1407 @findex acl_add
1408 Add a match rule to the access control list, allowing or denying access.
1409 The match will normally be an exact username or x509 distinguished name,
1410 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1411 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1412 normally be appended to the end of the ACL, but can be inserted
1413 earlier in the list if the optional @var{index} parameter is supplied.
1414 ETEXI
1417 .name = "acl_remove",
1418 .args_type = "aclname:s,match:s",
1419 .params = "aclname match",
1420 .help = "remove a match rule from the access control list",
1421 .mhandler.cmd = do_acl_remove,
1424 STEXI
1425 @item acl_remove @var{aclname} @var{match}
1426 @findex acl_remove
1427 Remove the specified match rule from the access control list.
1428 ETEXI
1431 .name = "acl_reset",
1432 .args_type = "aclname:s",
1433 .params = "aclname",
1434 .help = "reset the access control list",
1435 .mhandler.cmd = do_acl_reset,
1438 STEXI
1439 @item acl_reset @var{aclname}
1440 @findex acl_reset
1441 Remove all matches from the access control list, and set the default
1442 policy back to @code{deny}.
1443 ETEXI
1446 .name = "nbd_server_start",
1447 .args_type = "all:-a,writable:-w,uri:s",
1448 .params = "nbd_server_start [-a] [-w] host:port",
1449 .help = "serve block devices on the given host and port",
1450 .mhandler.cmd = hmp_nbd_server_start,
1452 STEXI
1453 @item nbd_server_start @var{host}:@var{port}
1454 @findex nbd_server_start
1455 Start an NBD server on the given host and/or port. If the @option{-a}
1456 option is included, all of the virtual machine's block devices that
1457 have an inserted media on them are automatically exported; in this case,
1458 the @option{-w} option makes the devices writable too.
1459 ETEXI
1462 .name = "nbd_server_add",
1463 .args_type = "writable:-w,device:B",
1464 .params = "nbd_server_add [-w] device",
1465 .help = "export a block device via NBD",
1466 .mhandler.cmd = hmp_nbd_server_add,
1468 STEXI
1469 @item nbd_server_add @var{device}
1470 @findex nbd_server_add
1471 Export a block device through QEMU's NBD server, which must be started
1472 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1473 exported device writable too.
1474 ETEXI
1477 .name = "nbd_server_stop",
1478 .args_type = "",
1479 .params = "nbd_server_stop",
1480 .help = "stop serving block devices using the NBD protocol",
1481 .mhandler.cmd = hmp_nbd_server_stop,
1483 STEXI
1484 @item nbd_server_stop
1485 @findex nbd_server_stop
1486 Stop the QEMU embedded NBD server.
1487 ETEXI
1490 #if defined(TARGET_I386)
1493 .name = "mce",
1494 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1495 .params = "[-b] cpu bank status mcgstatus addr misc",
1496 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1497 .mhandler.cmd = do_inject_mce,
1500 #endif
1501 STEXI
1502 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1503 @findex mce (x86)
1504 Inject an MCE on the given CPU (x86 only).
1505 ETEXI
1508 .name = "getfd",
1509 .args_type = "fdname:s",
1510 .params = "getfd name",
1511 .help = "receive a file descriptor via SCM rights and assign it a name",
1512 .mhandler.cmd = hmp_getfd,
1515 STEXI
1516 @item getfd @var{fdname}
1517 @findex getfd
1518 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1519 mechanism on unix sockets, it is stored using the name @var{fdname} for
1520 later use by other monitor commands.
1521 ETEXI
1524 .name = "closefd",
1525 .args_type = "fdname:s",
1526 .params = "closefd name",
1527 .help = "close a file descriptor previously passed via SCM rights",
1528 .mhandler.cmd = hmp_closefd,
1531 STEXI
1532 @item closefd @var{fdname}
1533 @findex closefd
1534 Close the file descriptor previously assigned to @var{fdname} using the
1535 @code{getfd} command. This is only needed if the file descriptor was never
1536 used by another monitor command.
1537 ETEXI
1540 .name = "block_passwd",
1541 .args_type = "device:B,password:s",
1542 .params = "block_passwd device password",
1543 .help = "set the password of encrypted block devices",
1544 .mhandler.cmd = hmp_block_passwd,
1547 STEXI
1548 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1549 @findex block_set_io_throttle
1550 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}
1551 ETEXI
1554 .name = "block_set_io_throttle",
1555 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1556 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1557 .help = "change I/O throttle limits for a block drive",
1558 .mhandler.cmd = hmp_block_set_io_throttle,
1561 STEXI
1562 @item block_passwd @var{device} @var{password}
1563 @findex block_passwd
1564 Set the encrypted device @var{device} password to @var{password}
1565 ETEXI
1568 .name = "set_password",
1569 .args_type = "protocol:s,password:s,connected:s?",
1570 .params = "protocol password action-if-connected",
1571 .help = "set spice/vnc password",
1572 .mhandler.cmd = hmp_set_password,
1575 STEXI
1576 @item set_password [ vnc | spice ] password [ action-if-connected ]
1577 @findex set_password
1579 Change spice/vnc password. Use zero to make the password stay valid
1580 forever. @var{action-if-connected} specifies what should happen in
1581 case a connection is established: @var{fail} makes the password change
1582 fail. @var{disconnect} changes the password and disconnects the
1583 client. @var{keep} changes the password and keeps the connection up.
1584 @var{keep} is the default.
1585 ETEXI
1588 .name = "expire_password",
1589 .args_type = "protocol:s,time:s",
1590 .params = "protocol time",
1591 .help = "set spice/vnc password expire-time",
1592 .mhandler.cmd = hmp_expire_password,
1595 STEXI
1596 @item expire_password [ vnc | spice ] expire-time
1597 @findex expire_password
1599 Specify when a password for spice/vnc becomes
1600 invalid. @var{expire-time} accepts:
1602 @table @var
1603 @item now
1604 Invalidate password instantly.
1606 @item never
1607 Password stays valid forever.
1609 @item +nsec
1610 Password stays valid for @var{nsec} seconds starting now.
1612 @item nsec
1613 Password is invalidated at the given time. @var{nsec} are the seconds
1614 passed since 1970, i.e. unix epoch.
1616 @end table
1617 ETEXI
1620 .name = "chardev-add",
1621 .args_type = "args:s",
1622 .params = "args",
1623 .help = "add chardev",
1624 .mhandler.cmd = hmp_chardev_add,
1627 STEXI
1628 @item chardev_add args
1629 @findex chardev_add
1631 chardev_add accepts the same parameters as the -chardev command line switch.
1633 ETEXI
1636 .name = "chardev-remove",
1637 .args_type = "id:s",
1638 .params = "id",
1639 .help = "remove chardev",
1640 .mhandler.cmd = hmp_chardev_remove,
1643 STEXI
1644 @item chardev_remove id
1645 @findex chardev_remove
1647 Removes the chardev @var{id}.
1649 ETEXI
1652 .name = "qemu-io",
1653 .args_type = "device:B,command:s",
1654 .params = "[device] \"[command]\"",
1655 .help = "run a qemu-io command on a block device",
1656 .mhandler.cmd = hmp_qemu_io,
1659 STEXI
1660 @item qemu-io @var{device} @var{command}
1661 @findex qemu-io
1663 Executes a qemu-io command on the given block device.
1665 ETEXI
1668 .name = "cpu-add",
1669 .args_type = "id:i",
1670 .params = "id",
1671 .help = "add cpu",
1672 .mhandler.cmd = hmp_cpu_add,
1675 STEXI
1676 @item cpu-add @var{id}
1677 Add CPU with id @var{id}
1678 ETEXI
1681 .name = "info",
1682 .args_type = "item:s?",
1683 .params = "[subcommand]",
1684 .help = "show various information about the system state",
1685 .mhandler.cmd = do_info_help,
1686 .sub_table = info_cmds,
1689 STEXI
1690 @item info @var{subcommand}
1691 @findex info
1692 Show various information about the system state.
1694 @table @option
1695 @item info version
1696 show the version of QEMU
1697 @item info network
1698 show the various VLANs and the associated devices
1699 @item info chardev
1700 show the character devices
1701 @item info block
1702 show the block devices
1703 @item info blockstats
1704 show block device statistics
1705 @item info registers
1706 show the cpu registers
1707 @item info cpus
1708 show infos for each CPU
1709 @item info history
1710 show the command line history
1711 @item info irq
1712 show the interrupts statistics (if available)
1713 @item info pic
1714 show i8259 (PIC) state
1715 @item info pci
1716 show emulated PCI device info
1717 @item info tlb
1718 show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1719 @item info mem
1720 show the active virtual memory mappings (i386 only)
1721 @item info jit
1722 show dynamic compiler info
1723 @item info numa
1724 show NUMA information
1725 @item info kvm
1726 show KVM information
1727 @item info usb
1728 show USB devices plugged on the virtual USB hub
1729 @item info usbhost
1730 show all USB host devices
1731 @item info profile
1732 show profiling information
1733 @item info capture
1734 show information about active capturing
1735 @item info snapshots
1736 show list of VM snapshots
1737 @item info status
1738 show the current VM status (running|paused)
1739 @item info pcmcia
1740 show guest PCMCIA status
1741 @item info mice
1742 show which guest mouse is receiving events
1743 @item info vnc
1744 show the vnc server status
1745 @item info name
1746 show the current VM name
1747 @item info uuid
1748 show the current VM UUID
1749 @item info cpustats
1750 show CPU statistics
1751 @item info usernet
1752 show user network stack connection states
1753 @item info migrate
1754 show migration status
1755 @item info migrate_capabilities
1756 show current migration capabilities
1757 @item info migrate_cache_size
1758 show current migration XBZRLE cache size
1759 @item info balloon
1760 show balloon information
1761 @item info qtree
1762 show device tree
1763 @item info qdm
1764 show qdev device model list
1765 @item info roms
1766 show roms
1767 @item info tpm
1768 show the TPM device
1769 @end table
1770 ETEXI
1772 STEXI
1773 @item info trace-events
1774 show available trace events and their state
1775 ETEXI
1777 STEXI
1778 @end table
1779 ETEXI