gtk: VirtualConsole restruction
[qemu.git] / hmp-commands.hx
blob2e462c04aaa1c6310565b19393ea8de678ebe8b6
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,
559 .command_completion = sendkey_completion,
562 STEXI
563 @item sendkey @var{keys}
564 @findex sendkey
566 Send @var{keys} to the guest. @var{keys} could be the name of the
567 key or the raw value in hexadecimal format. Use @code{-} to press
568 several keys simultaneously. Example:
569 @example
570 sendkey ctrl-alt-f1
571 @end example
573 This command is useful to send keys that your graphical user interface
574 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
575 ETEXI
578 .name = "system_reset",
579 .args_type = "",
580 .params = "",
581 .help = "reset the system",
582 .mhandler.cmd = hmp_system_reset,
585 STEXI
586 @item system_reset
587 @findex system_reset
589 Reset the system.
590 ETEXI
593 .name = "system_powerdown",
594 .args_type = "",
595 .params = "",
596 .help = "send system power down event",
597 .mhandler.cmd = hmp_system_powerdown,
600 STEXI
601 @item system_powerdown
602 @findex system_powerdown
604 Power down the system (if supported).
605 ETEXI
608 .name = "sum",
609 .args_type = "start:i,size:i",
610 .params = "addr size",
611 .help = "compute the checksum of a memory region",
612 .mhandler.cmd = do_sum,
615 STEXI
616 @item sum @var{addr} @var{size}
617 @findex sum
619 Compute the checksum of a memory region.
620 ETEXI
623 .name = "usb_add",
624 .args_type = "devname:s",
625 .params = "device",
626 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
627 .mhandler.cmd = do_usb_add,
630 STEXI
631 @item usb_add @var{devname}
632 @findex usb_add
634 Add the USB device @var{devname}. For details of available devices see
635 @ref{usb_devices}
636 ETEXI
639 .name = "usb_del",
640 .args_type = "devname:s",
641 .params = "device",
642 .help = "remove USB device 'bus.addr'",
643 .mhandler.cmd = do_usb_del,
646 STEXI
647 @item usb_del @var{devname}
648 @findex usb_del
650 Remove the USB device @var{devname} from the QEMU virtual USB
651 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
652 command @code{info usb} to see the devices you can remove.
653 ETEXI
656 .name = "device_add",
657 .args_type = "device:O",
658 .params = "driver[,prop=value][,...]",
659 .help = "add device, like -device on the command line",
660 .user_print = monitor_user_noop,
661 .mhandler.cmd_new = do_device_add,
662 .command_completion = device_add_completion,
665 STEXI
666 @item device_add @var{config}
667 @findex device_add
669 Add device.
670 ETEXI
673 .name = "device_del",
674 .args_type = "id:s",
675 .params = "device",
676 .help = "remove device",
677 .mhandler.cmd = hmp_device_del,
678 .command_completion = device_del_completion,
681 STEXI
682 @item device_del @var{id}
683 @findex device_del
685 Remove device @var{id}.
686 ETEXI
689 .name = "cpu",
690 .args_type = "index:i",
691 .params = "index",
692 .help = "set the default CPU",
693 .mhandler.cmd = hmp_cpu,
696 STEXI
697 @item cpu @var{index}
698 @findex cpu
699 Set the default CPU.
700 ETEXI
703 .name = "mouse_move",
704 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
705 .params = "dx dy [dz]",
706 .help = "send mouse move events",
707 .mhandler.cmd = do_mouse_move,
710 STEXI
711 @item mouse_move @var{dx} @var{dy} [@var{dz}]
712 @findex mouse_move
713 Move the active mouse to the specified coordinates @var{dx} @var{dy}
714 with optional scroll axis @var{dz}.
715 ETEXI
718 .name = "mouse_button",
719 .args_type = "button_state:i",
720 .params = "state",
721 .help = "change mouse button state (1=L, 2=M, 4=R)",
722 .mhandler.cmd = do_mouse_button,
725 STEXI
726 @item mouse_button @var{val}
727 @findex mouse_button
728 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
729 ETEXI
732 .name = "mouse_set",
733 .args_type = "index:i",
734 .params = "index",
735 .help = "set which mouse device receives events",
736 .mhandler.cmd = do_mouse_set,
739 STEXI
740 @item mouse_set @var{index}
741 @findex mouse_set
742 Set which mouse device receives events at given @var{index}, index
743 can be obtained with
744 @example
745 info mice
746 @end example
747 ETEXI
750 .name = "wavcapture",
751 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
752 .params = "path [frequency [bits [channels]]]",
753 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
754 .mhandler.cmd = do_wav_capture,
756 STEXI
757 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
758 @findex wavcapture
759 Capture audio into @var{filename}. Using sample rate @var{frequency}
760 bits per sample @var{bits} and number of channels @var{channels}.
762 Defaults:
763 @itemize @minus
764 @item Sample rate = 44100 Hz - CD quality
765 @item Bits = 16
766 @item Number of channels = 2 - Stereo
767 @end itemize
768 ETEXI
771 .name = "stopcapture",
772 .args_type = "n:i",
773 .params = "capture index",
774 .help = "stop capture",
775 .mhandler.cmd = do_stop_capture,
777 STEXI
778 @item stopcapture @var{index}
779 @findex stopcapture
780 Stop capture with a given @var{index}, index can be obtained with
781 @example
782 info capture
783 @end example
784 ETEXI
787 .name = "memsave",
788 .args_type = "val:l,size:i,filename:s",
789 .params = "addr size file",
790 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
791 .mhandler.cmd = hmp_memsave,
794 STEXI
795 @item memsave @var{addr} @var{size} @var{file}
796 @findex memsave
797 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
798 ETEXI
801 .name = "pmemsave",
802 .args_type = "val:l,size:i,filename:s",
803 .params = "addr size file",
804 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
805 .mhandler.cmd = hmp_pmemsave,
808 STEXI
809 @item pmemsave @var{addr} @var{size} @var{file}
810 @findex pmemsave
811 save to disk physical memory dump starting at @var{addr} of size @var{size}.
812 ETEXI
815 .name = "boot_set",
816 .args_type = "bootdevice:s",
817 .params = "bootdevice",
818 .help = "define new values for the boot device list",
819 .mhandler.cmd = do_boot_set,
822 STEXI
823 @item boot_set @var{bootdevicelist}
824 @findex boot_set
826 Define new values for the boot device list. Those values will override
827 the values specified on the command line through the @code{-boot} option.
829 The values that can be specified here depend on the machine type, but are
830 the same that can be specified in the @code{-boot} command line option.
831 ETEXI
833 #if defined(TARGET_I386) || defined(TARGET_S390X)
835 .name = "nmi",
836 .args_type = "",
837 .params = "",
838 .help = "inject an NMI on all guest's CPUs",
839 .mhandler.cmd = hmp_inject_nmi,
841 #endif
842 STEXI
843 @item nmi @var{cpu}
844 @findex nmi
845 Inject an NMI (x86) or RESTART (s390x) on the given CPU.
847 ETEXI
850 .name = "ringbuf_write",
851 .args_type = "device:s,data:s",
852 .params = "device data",
853 .help = "Write to a ring buffer character device",
854 .mhandler.cmd = hmp_ringbuf_write,
857 STEXI
858 @item ringbuf_write @var{device} @var{data}
859 @findex ringbuf_write
860 Write @var{data} to ring buffer character device @var{device}.
861 @var{data} must be a UTF-8 string.
863 ETEXI
866 .name = "ringbuf_read",
867 .args_type = "device:s,size:i",
868 .params = "device size",
869 .help = "Read from a ring buffer character device",
870 .mhandler.cmd = hmp_ringbuf_read,
873 STEXI
874 @item ringbuf_read @var{device}
875 @findex ringbuf_read
876 Read and print up to @var{size} bytes from ring buffer character
877 device @var{device}.
878 Certain non-printable characters are printed \uXXXX, where XXXX is the
879 character code in hexadecimal. Character \ is printed \\.
880 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
881 NUL characters, after the ring buffer lost data, and when reading
882 stops because the size limit is reached.
884 ETEXI
887 .name = "migrate",
888 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
889 .params = "[-d] [-b] [-i] uri",
890 .help = "migrate to URI (using -d to not wait for completion)"
891 "\n\t\t\t -b for migration without shared storage with"
892 " full copy of disk\n\t\t\t -i for migration without "
893 "shared storage with incremental copy of disk "
894 "(base image shared between src and destination)",
895 .mhandler.cmd = hmp_migrate,
899 STEXI
900 @item migrate [-d] [-b] [-i] @var{uri}
901 @findex migrate
902 Migrate to @var{uri} (using -d to not wait for completion).
903 -b for migration with full copy of disk
904 -i for migration with incremental copy of disk (base image is shared)
905 ETEXI
908 .name = "migrate_cancel",
909 .args_type = "",
910 .params = "",
911 .help = "cancel the current VM migration",
912 .mhandler.cmd = hmp_migrate_cancel,
915 STEXI
916 @item migrate_cancel
917 @findex migrate_cancel
918 Cancel the current VM migration.
920 ETEXI
923 .name = "migrate_set_cache_size",
924 .args_type = "value:o",
925 .params = "value",
926 .help = "set cache size (in bytes) for XBZRLE migrations,"
927 "the cache size will be rounded down to the nearest "
928 "power of 2.\n"
929 "The cache size affects the number of cache misses."
930 "In case of a high cache miss ratio you need to increase"
931 " the cache size",
932 .mhandler.cmd = hmp_migrate_set_cache_size,
935 STEXI
936 @item migrate_set_cache_size @var{value}
937 @findex migrate_set_cache_size
938 Set cache size to @var{value} (in bytes) for xbzrle migrations.
939 ETEXI
942 .name = "migrate_set_speed",
943 .args_type = "value:o",
944 .params = "value",
945 .help = "set maximum speed (in bytes) for migrations. "
946 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
947 .mhandler.cmd = hmp_migrate_set_speed,
950 STEXI
951 @item migrate_set_speed @var{value}
952 @findex migrate_set_speed
953 Set maximum speed to @var{value} (in bytes) for migrations.
954 ETEXI
957 .name = "migrate_set_downtime",
958 .args_type = "value:T",
959 .params = "value",
960 .help = "set maximum tolerated downtime (in seconds) for migrations",
961 .mhandler.cmd = hmp_migrate_set_downtime,
964 STEXI
965 @item migrate_set_downtime @var{second}
966 @findex migrate_set_downtime
967 Set maximum tolerated downtime (in seconds) for migration.
968 ETEXI
971 .name = "migrate_set_capability",
972 .args_type = "capability:s,state:b",
973 .params = "capability state",
974 .help = "Enable/Disable the usage of a capability for migration",
975 .mhandler.cmd = hmp_migrate_set_capability,
978 STEXI
979 @item migrate_set_capability @var{capability} @var{state}
980 @findex migrate_set_capability
981 Enable/Disable the usage of a capability @var{capability} for migration.
982 ETEXI
985 .name = "client_migrate_info",
986 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
987 .params = "protocol hostname port tls-port cert-subject",
988 .help = "send migration info to spice/vnc client",
989 .user_print = monitor_user_noop,
990 .mhandler.cmd_async = client_migrate_info,
991 .flags = MONITOR_CMD_ASYNC,
994 STEXI
995 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
996 @findex client_migrate_info
997 Set the spice/vnc connection info for the migration target. The spice/vnc
998 server will ask the spice/vnc client to automatically reconnect using the
999 new parameters (if specified) once the vm migration finished successfully.
1000 ETEXI
1003 .name = "dump-guest-memory",
1004 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1005 .params = "[-p] [-z|-l|-s] filename [begin length]",
1006 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1007 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1008 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1009 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1010 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1011 "begin: the starting physical address.\n\t\t\t"
1012 "length: the memory size, in bytes.",
1013 .mhandler.cmd = hmp_dump_guest_memory,
1017 STEXI
1018 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1019 @item dump-guest-memory [-z|-l|-s] @var{filename}
1020 @findex dump-guest-memory
1021 Dump guest memory to @var{protocol}. The file can be processed with crash or
1022 gdb. Without -z|-l|-s, the dump format is ELF.
1023 -p: do paging to get guest's memory mapping.
1024 -z: dump in kdump-compressed format, with zlib compression.
1025 -l: dump in kdump-compressed format, with lzo compression.
1026 -s: dump in kdump-compressed format, with snappy compression.
1027 filename: dump file name.
1028 begin: the starting physical address. It's optional, and should be
1029 specified together with length.
1030 length: the memory size, in bytes. It's optional, and should be specified
1031 together with begin.
1032 ETEXI
1035 .name = "snapshot_blkdev",
1036 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1037 .params = "[-n] device [new-image-file] [format]",
1038 .help = "initiates a live snapshot\n\t\t\t"
1039 "of device. If a new image file is specified, the\n\t\t\t"
1040 "new image file will become the new root image.\n\t\t\t"
1041 "If format is specified, the snapshot file will\n\t\t\t"
1042 "be created in that format.\n\t\t\t"
1043 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1044 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1045 "recreating it from scratch.",
1046 .mhandler.cmd = hmp_snapshot_blkdev,
1049 STEXI
1050 @item snapshot_blkdev
1051 @findex snapshot_blkdev
1052 Snapshot device, using snapshot file as target if provided
1053 ETEXI
1056 .name = "snapshot_blkdev_internal",
1057 .args_type = "device:B,name:s",
1058 .params = "device name",
1059 .help = "take an internal snapshot of device.\n\t\t\t"
1060 "The format of the image used by device must\n\t\t\t"
1061 "support it, such as qcow2.\n\t\t\t",
1062 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1065 STEXI
1066 @item snapshot_blkdev_internal
1067 @findex snapshot_blkdev_internal
1068 Take an internal snapshot on device if it support
1069 ETEXI
1072 .name = "snapshot_delete_blkdev_internal",
1073 .args_type = "device:B,name:s,id:s?",
1074 .params = "device name [id]",
1075 .help = "delete an internal snapshot of device.\n\t\t\t"
1076 "If id is specified, qemu will try delete\n\t\t\t"
1077 "the snapshot matching both id and name.\n\t\t\t"
1078 "The format of the image used by device must\n\t\t\t"
1079 "support it, such as qcow2.\n\t\t\t",
1080 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1083 STEXI
1084 @item snapshot_delete_blkdev_internal
1085 @findex snapshot_delete_blkdev_internal
1086 Delete an internal snapshot on device if it support
1087 ETEXI
1090 .name = "drive_mirror",
1091 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1092 .params = "[-n] [-f] device target [format]",
1093 .help = "initiates live storage\n\t\t\t"
1094 "migration for a device. The device's contents are\n\t\t\t"
1095 "copied to the new image file, including data that\n\t\t\t"
1096 "is written after the command is started.\n\t\t\t"
1097 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1098 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1099 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1100 "so that the result does not need a backing file.\n\t\t\t",
1101 .mhandler.cmd = hmp_drive_mirror,
1103 STEXI
1104 @item drive_mirror
1105 @findex drive_mirror
1106 Start mirroring a block device's writes to a new destination,
1107 using the specified target.
1108 ETEXI
1111 .name = "drive_backup",
1112 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1113 .params = "[-n] [-f] device target [format]",
1114 .help = "initiates a point-in-time\n\t\t\t"
1115 "copy for a device. The device's contents are\n\t\t\t"
1116 "copied to the new image file, excluding data that\n\t\t\t"
1117 "is written after the command is started.\n\t\t\t"
1118 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1119 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1120 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1121 "so that the result does not need a backing file.\n\t\t\t",
1122 .mhandler.cmd = hmp_drive_backup,
1124 STEXI
1125 @item drive_backup
1126 @findex drive_backup
1127 Start a point-in-time copy of a block device to a specificed target.
1128 ETEXI
1131 .name = "drive_add",
1132 .args_type = "pci_addr:s,opts:s",
1133 .params = "[[<domain>:]<bus>:]<slot>\n"
1134 "[file=file][,if=type][,bus=n]\n"
1135 "[,unit=m][,media=d][,index=i]\n"
1136 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1137 "[,snapshot=on|off][,cache=on|off]\n"
1138 "[,readonly=on|off][,copy-on-read=on|off]",
1139 .help = "add drive to PCI storage controller",
1140 .mhandler.cmd = drive_hot_add,
1143 STEXI
1144 @item drive_add
1145 @findex drive_add
1146 Add drive to PCI storage controller.
1147 ETEXI
1149 #if defined(CONFIG_PCI_HOTPLUG_OLD)
1151 .name = "pci_add",
1152 .args_type = "pci_addr:s,type:s,opts:s?",
1153 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
1154 .help = "hot-add PCI device",
1155 .mhandler.cmd = pci_device_hot_add,
1157 #endif
1159 STEXI
1160 @item pci_add
1161 @findex pci_add
1162 Hot-add PCI device.
1163 ETEXI
1165 #if defined(CONFIG_PCI_HOTPLUG_OLD)
1167 .name = "pci_del",
1168 .args_type = "pci_addr:s",
1169 .params = "[[<domain>:]<bus>:]<slot>",
1170 .help = "hot remove PCI device",
1171 .mhandler.cmd = do_pci_device_hot_remove,
1173 #endif
1175 STEXI
1176 @item pci_del
1177 @findex pci_del
1178 Hot remove PCI device.
1179 ETEXI
1182 .name = "pcie_aer_inject_error",
1183 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1184 "id:s,error_status:s,"
1185 "header0:i?,header1:i?,header2:i?,header3:i?,"
1186 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1187 .params = "[-a] [-c] id "
1188 "<error_status> [<tlp header> [<tlp header prefix>]]",
1189 .help = "inject pcie aer error\n\t\t\t"
1190 " -a for advisory non fatal error\n\t\t\t"
1191 " -c for correctable error\n\t\t\t"
1192 "<id> = qdev device id\n\t\t\t"
1193 "<error_status> = error string or 32bit\n\t\t\t"
1194 "<tlb header> = 32bit x 4\n\t\t\t"
1195 "<tlb header prefix> = 32bit x 4",
1196 .user_print = pcie_aer_inject_error_print,
1197 .mhandler.cmd_new = do_pcie_aer_inject_error,
1200 STEXI
1201 @item pcie_aer_inject_error
1202 @findex pcie_aer_inject_error
1203 Inject PCIe AER error
1204 ETEXI
1207 .name = "host_net_add",
1208 .args_type = "device:s,opts:s?",
1209 .params = "tap|user|socket|vde|netmap|dump [options]",
1210 .help = "add host VLAN client",
1211 .mhandler.cmd = net_host_device_add,
1214 STEXI
1215 @item host_net_add
1216 @findex host_net_add
1217 Add host VLAN client.
1218 ETEXI
1221 .name = "host_net_remove",
1222 .args_type = "vlan_id:i,device:s",
1223 .params = "vlan_id name",
1224 .help = "remove host VLAN client",
1225 .mhandler.cmd = net_host_device_remove,
1228 STEXI
1229 @item host_net_remove
1230 @findex host_net_remove
1231 Remove host VLAN client.
1232 ETEXI
1235 .name = "netdev_add",
1236 .args_type = "netdev:O",
1237 .params = "[user|tap|socket|vde|bridge|hubport|netmap],id=str[,prop=value][,...]",
1238 .help = "add host network device",
1239 .mhandler.cmd = hmp_netdev_add,
1240 .command_completion = netdev_add_completion,
1243 STEXI
1244 @item netdev_add
1245 @findex netdev_add
1246 Add host network device.
1247 ETEXI
1250 .name = "netdev_del",
1251 .args_type = "id:s",
1252 .params = "id",
1253 .help = "remove host network device",
1254 .mhandler.cmd = hmp_netdev_del,
1255 .command_completion = netdev_del_completion,
1258 STEXI
1259 @item netdev_del
1260 @findex netdev_del
1261 Remove host network device.
1262 ETEXI
1265 .name = "object_add",
1266 .args_type = "object:O",
1267 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1268 .help = "create QOM object",
1269 .mhandler.cmd = hmp_object_add,
1270 .command_completion = object_add_completion,
1273 STEXI
1274 @item object_add
1275 @findex object_add
1276 Create QOM object.
1277 ETEXI
1280 .name = "object_del",
1281 .args_type = "id:s",
1282 .params = "id",
1283 .help = "destroy QOM object",
1284 .mhandler.cmd = hmp_object_del,
1285 .command_completion = object_del_completion,
1288 STEXI
1289 @item object_del
1290 @findex object_del
1291 Destroy QOM object.
1292 ETEXI
1294 #ifdef CONFIG_SLIRP
1296 .name = "hostfwd_add",
1297 .args_type = "arg1:s,arg2:s?,arg3:s?",
1298 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1299 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1300 .mhandler.cmd = net_slirp_hostfwd_add,
1302 #endif
1303 STEXI
1304 @item hostfwd_add
1305 @findex hostfwd_add
1306 Redirect TCP or UDP connections from host to guest (requires -net user).
1307 ETEXI
1309 #ifdef CONFIG_SLIRP
1311 .name = "hostfwd_remove",
1312 .args_type = "arg1:s,arg2:s?,arg3:s?",
1313 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1314 .help = "remove host-to-guest TCP or UDP redirection",
1315 .mhandler.cmd = net_slirp_hostfwd_remove,
1318 #endif
1319 STEXI
1320 @item hostfwd_remove
1321 @findex hostfwd_remove
1322 Remove host-to-guest TCP or UDP redirection.
1323 ETEXI
1326 .name = "balloon",
1327 .args_type = "value:M",
1328 .params = "target",
1329 .help = "request VM to change its memory allocation (in MB)",
1330 .mhandler.cmd = hmp_balloon,
1333 STEXI
1334 @item balloon @var{value}
1335 @findex balloon
1336 Request VM to change its memory allocation to @var{value} (in MB).
1337 ETEXI
1340 .name = "set_link",
1341 .args_type = "name:s,up:b",
1342 .params = "name on|off",
1343 .help = "change the link status of a network adapter",
1344 .mhandler.cmd = hmp_set_link,
1345 .command_completion = set_link_completion,
1348 STEXI
1349 @item set_link @var{name} [on|off]
1350 @findex set_link
1351 Switch link @var{name} on (i.e. up) or off (i.e. down).
1352 ETEXI
1355 .name = "watchdog_action",
1356 .args_type = "action:s",
1357 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1358 .help = "change watchdog action",
1359 .mhandler.cmd = do_watchdog_action,
1362 STEXI
1363 @item watchdog_action
1364 @findex watchdog_action
1365 Change watchdog action.
1366 ETEXI
1369 .name = "acl_show",
1370 .args_type = "aclname:s",
1371 .params = "aclname",
1372 .help = "list rules in the access control list",
1373 .mhandler.cmd = do_acl_show,
1376 STEXI
1377 @item acl_show @var{aclname}
1378 @findex acl_show
1379 List all the matching rules in the access control list, and the default
1380 policy. There are currently two named access control lists,
1381 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1382 certificate distinguished name, and SASL username respectively.
1383 ETEXI
1386 .name = "acl_policy",
1387 .args_type = "aclname:s,policy:s",
1388 .params = "aclname allow|deny",
1389 .help = "set default access control list policy",
1390 .mhandler.cmd = do_acl_policy,
1393 STEXI
1394 @item acl_policy @var{aclname} @code{allow|deny}
1395 @findex acl_policy
1396 Set the default access control list policy, used in the event that
1397 none of the explicit rules match. The default policy at startup is
1398 always @code{deny}.
1399 ETEXI
1402 .name = "acl_add",
1403 .args_type = "aclname:s,match:s,policy:s,index:i?",
1404 .params = "aclname match allow|deny [index]",
1405 .help = "add a match rule to the access control list",
1406 .mhandler.cmd = do_acl_add,
1409 STEXI
1410 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1411 @findex acl_add
1412 Add a match rule to the access control list, allowing or denying access.
1413 The match will normally be an exact username or x509 distinguished name,
1414 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1415 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1416 normally be appended to the end of the ACL, but can be inserted
1417 earlier in the list if the optional @var{index} parameter is supplied.
1418 ETEXI
1421 .name = "acl_remove",
1422 .args_type = "aclname:s,match:s",
1423 .params = "aclname match",
1424 .help = "remove a match rule from the access control list",
1425 .mhandler.cmd = do_acl_remove,
1428 STEXI
1429 @item acl_remove @var{aclname} @var{match}
1430 @findex acl_remove
1431 Remove the specified match rule from the access control list.
1432 ETEXI
1435 .name = "acl_reset",
1436 .args_type = "aclname:s",
1437 .params = "aclname",
1438 .help = "reset the access control list",
1439 .mhandler.cmd = do_acl_reset,
1442 STEXI
1443 @item acl_reset @var{aclname}
1444 @findex acl_reset
1445 Remove all matches from the access control list, and set the default
1446 policy back to @code{deny}.
1447 ETEXI
1450 .name = "nbd_server_start",
1451 .args_type = "all:-a,writable:-w,uri:s",
1452 .params = "nbd_server_start [-a] [-w] host:port",
1453 .help = "serve block devices on the given host and port",
1454 .mhandler.cmd = hmp_nbd_server_start,
1456 STEXI
1457 @item nbd_server_start @var{host}:@var{port}
1458 @findex nbd_server_start
1459 Start an NBD server on the given host and/or port. If the @option{-a}
1460 option is included, all of the virtual machine's block devices that
1461 have an inserted media on them are automatically exported; in this case,
1462 the @option{-w} option makes the devices writable too.
1463 ETEXI
1466 .name = "nbd_server_add",
1467 .args_type = "writable:-w,device:B",
1468 .params = "nbd_server_add [-w] device",
1469 .help = "export a block device via NBD",
1470 .mhandler.cmd = hmp_nbd_server_add,
1472 STEXI
1473 @item nbd_server_add @var{device}
1474 @findex nbd_server_add
1475 Export a block device through QEMU's NBD server, which must be started
1476 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1477 exported device writable too.
1478 ETEXI
1481 .name = "nbd_server_stop",
1482 .args_type = "",
1483 .params = "nbd_server_stop",
1484 .help = "stop serving block devices using the NBD protocol",
1485 .mhandler.cmd = hmp_nbd_server_stop,
1487 STEXI
1488 @item nbd_server_stop
1489 @findex nbd_server_stop
1490 Stop the QEMU embedded NBD server.
1491 ETEXI
1494 #if defined(TARGET_I386)
1497 .name = "mce",
1498 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1499 .params = "[-b] cpu bank status mcgstatus addr misc",
1500 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1501 .mhandler.cmd = do_inject_mce,
1504 #endif
1505 STEXI
1506 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1507 @findex mce (x86)
1508 Inject an MCE on the given CPU (x86 only).
1509 ETEXI
1512 .name = "getfd",
1513 .args_type = "fdname:s",
1514 .params = "getfd name",
1515 .help = "receive a file descriptor via SCM rights and assign it a name",
1516 .mhandler.cmd = hmp_getfd,
1519 STEXI
1520 @item getfd @var{fdname}
1521 @findex getfd
1522 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1523 mechanism on unix sockets, it is stored using the name @var{fdname} for
1524 later use by other monitor commands.
1525 ETEXI
1528 .name = "closefd",
1529 .args_type = "fdname:s",
1530 .params = "closefd name",
1531 .help = "close a file descriptor previously passed via SCM rights",
1532 .mhandler.cmd = hmp_closefd,
1535 STEXI
1536 @item closefd @var{fdname}
1537 @findex closefd
1538 Close the file descriptor previously assigned to @var{fdname} using the
1539 @code{getfd} command. This is only needed if the file descriptor was never
1540 used by another monitor command.
1541 ETEXI
1544 .name = "block_passwd",
1545 .args_type = "device:B,password:s",
1546 .params = "block_passwd device password",
1547 .help = "set the password of encrypted block devices",
1548 .mhandler.cmd = hmp_block_passwd,
1551 STEXI
1552 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1553 @findex block_set_io_throttle
1554 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}
1555 ETEXI
1558 .name = "block_set_io_throttle",
1559 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1560 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1561 .help = "change I/O throttle limits for a block drive",
1562 .mhandler.cmd = hmp_block_set_io_throttle,
1565 STEXI
1566 @item block_passwd @var{device} @var{password}
1567 @findex block_passwd
1568 Set the encrypted device @var{device} password to @var{password}
1569 ETEXI
1572 .name = "set_password",
1573 .args_type = "protocol:s,password:s,connected:s?",
1574 .params = "protocol password action-if-connected",
1575 .help = "set spice/vnc password",
1576 .mhandler.cmd = hmp_set_password,
1579 STEXI
1580 @item set_password [ vnc | spice ] password [ action-if-connected ]
1581 @findex set_password
1583 Change spice/vnc password. Use zero to make the password stay valid
1584 forever. @var{action-if-connected} specifies what should happen in
1585 case a connection is established: @var{fail} makes the password change
1586 fail. @var{disconnect} changes the password and disconnects the
1587 client. @var{keep} changes the password and keeps the connection up.
1588 @var{keep} is the default.
1589 ETEXI
1592 .name = "expire_password",
1593 .args_type = "protocol:s,time:s",
1594 .params = "protocol time",
1595 .help = "set spice/vnc password expire-time",
1596 .mhandler.cmd = hmp_expire_password,
1599 STEXI
1600 @item expire_password [ vnc | spice ] expire-time
1601 @findex expire_password
1603 Specify when a password for spice/vnc becomes
1604 invalid. @var{expire-time} accepts:
1606 @table @var
1607 @item now
1608 Invalidate password instantly.
1610 @item never
1611 Password stays valid forever.
1613 @item +nsec
1614 Password stays valid for @var{nsec} seconds starting now.
1616 @item nsec
1617 Password is invalidated at the given time. @var{nsec} are the seconds
1618 passed since 1970, i.e. unix epoch.
1620 @end table
1621 ETEXI
1624 .name = "chardev-add",
1625 .args_type = "args:s",
1626 .params = "args",
1627 .help = "add chardev",
1628 .mhandler.cmd = hmp_chardev_add,
1629 .command_completion = chardev_add_completion,
1632 STEXI
1633 @item chardev_add args
1634 @findex chardev_add
1636 chardev_add accepts the same parameters as the -chardev command line switch.
1638 ETEXI
1641 .name = "chardev-remove",
1642 .args_type = "id:s",
1643 .params = "id",
1644 .help = "remove chardev",
1645 .mhandler.cmd = hmp_chardev_remove,
1646 .command_completion = chardev_remove_completion,
1649 STEXI
1650 @item chardev_remove id
1651 @findex chardev_remove
1653 Removes the chardev @var{id}.
1655 ETEXI
1658 .name = "qemu-io",
1659 .args_type = "device:B,command:s",
1660 .params = "[device] \"[command]\"",
1661 .help = "run a qemu-io command on a block device",
1662 .mhandler.cmd = hmp_qemu_io,
1665 STEXI
1666 @item qemu-io @var{device} @var{command}
1667 @findex qemu-io
1669 Executes a qemu-io command on the given block device.
1671 ETEXI
1674 .name = "cpu-add",
1675 .args_type = "id:i",
1676 .params = "id",
1677 .help = "add cpu",
1678 .mhandler.cmd = hmp_cpu_add,
1681 STEXI
1682 @item cpu-add @var{id}
1683 Add CPU with id @var{id}
1684 ETEXI
1687 .name = "info",
1688 .args_type = "item:s?",
1689 .params = "[subcommand]",
1690 .help = "show various information about the system state",
1691 .mhandler.cmd = do_info_help,
1692 .sub_table = info_cmds,
1695 STEXI
1696 @item info @var{subcommand}
1697 @findex info
1698 Show various information about the system state.
1700 @table @option
1701 @item info version
1702 show the version of QEMU
1703 @item info network
1704 show the various VLANs and the associated devices
1705 @item info chardev
1706 show the character devices
1707 @item info block
1708 show the block devices
1709 @item info blockstats
1710 show block device statistics
1711 @item info registers
1712 show the cpu registers
1713 @item info cpus
1714 show infos for each CPU
1715 @item info history
1716 show the command line history
1717 @item info irq
1718 show the interrupts statistics (if available)
1719 @item info pic
1720 show i8259 (PIC) state
1721 @item info pci
1722 show emulated PCI device info
1723 @item info tlb
1724 show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1725 @item info mem
1726 show the active virtual memory mappings (i386 only)
1727 @item info jit
1728 show dynamic compiler info
1729 @item info numa
1730 show NUMA information
1731 @item info kvm
1732 show KVM information
1733 @item info usb
1734 show USB devices plugged on the virtual USB hub
1735 @item info usbhost
1736 show all USB host devices
1737 @item info profile
1738 show profiling information
1739 @item info capture
1740 show information about active capturing
1741 @item info snapshots
1742 show list of VM snapshots
1743 @item info status
1744 show the current VM status (running|paused)
1745 @item info pcmcia
1746 show guest PCMCIA status
1747 @item info mice
1748 show which guest mouse is receiving events
1749 @item info vnc
1750 show the vnc server status
1751 @item info name
1752 show the current VM name
1753 @item info uuid
1754 show the current VM UUID
1755 @item info cpustats
1756 show CPU statistics
1757 @item info usernet
1758 show user network stack connection states
1759 @item info migrate
1760 show migration status
1761 @item info migrate_capabilities
1762 show current migration capabilities
1763 @item info migrate_cache_size
1764 show current migration XBZRLE cache size
1765 @item info balloon
1766 show balloon information
1767 @item info qtree
1768 show device tree
1769 @item info qdm
1770 show qdev device model list
1771 @item info roms
1772 show roms
1773 @item info tpm
1774 show the TPM device
1775 @end table
1776 ETEXI
1778 STEXI
1779 @item info trace-events
1780 show available trace events and their state
1781 ETEXI
1783 STEXI
1784 @end table
1785 ETEXI