target-i386: Remove icc_bridge parameter from cpu_x86_create()
[qemu.git] / hmp-commands.hx
blob9c1e84985901417c69bbb7151e664522bd49a210
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 = hmp_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 = hmp_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_screendump,
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 = hmp_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 = hmp_trace_event,
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 = hmp_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 = hmp_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 = hmp_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 = hmp_loadvm,
338 .command_completion = loadvm_completion,
341 STEXI
342 @item loadvm @var{tag}|@var{id}
343 @findex loadvm
344 Set the whole virtual machine to the snapshot identified by the tag
345 @var{tag} or the unique snapshot ID @var{id}.
346 ETEXI
349 .name = "delvm",
350 .args_type = "name:s",
351 .params = "tag|id",
352 .help = "delete a VM snapshot from its tag or id",
353 .mhandler.cmd = hmp_delvm,
354 .command_completion = delvm_completion,
357 STEXI
358 @item delvm @var{tag}|@var{id}
359 @findex delvm
360 Delete the snapshot identified by @var{tag} or @var{id}.
361 ETEXI
364 .name = "singlestep",
365 .args_type = "option:s?",
366 .params = "[on|off]",
367 .help = "run emulation in singlestep mode or switch to normal mode",
368 .mhandler.cmd = hmp_singlestep,
371 STEXI
372 @item singlestep [off]
373 @findex singlestep
374 Run the emulation in single step mode.
375 If called with option off, the emulation returns to normal mode.
376 ETEXI
379 .name = "stop",
380 .args_type = "",
381 .params = "",
382 .help = "stop emulation",
383 .mhandler.cmd = hmp_stop,
386 STEXI
387 @item stop
388 @findex stop
389 Stop emulation.
390 ETEXI
393 .name = "c|cont",
394 .args_type = "",
395 .params = "",
396 .help = "resume emulation",
397 .mhandler.cmd = hmp_cont,
400 STEXI
401 @item c or cont
402 @findex cont
403 Resume emulation.
404 ETEXI
407 .name = "system_wakeup",
408 .args_type = "",
409 .params = "",
410 .help = "wakeup guest from suspend",
411 .mhandler.cmd = hmp_system_wakeup,
414 STEXI
415 @item system_wakeup
416 @findex system_wakeup
417 Wakeup guest from suspend.
418 ETEXI
421 .name = "gdbserver",
422 .args_type = "device:s?",
423 .params = "[device]",
424 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
425 .mhandler.cmd = hmp_gdbserver,
428 STEXI
429 @item gdbserver [@var{port}]
430 @findex gdbserver
431 Start gdbserver session (default @var{port}=1234)
432 ETEXI
435 .name = "x",
436 .args_type = "fmt:/,addr:l",
437 .params = "/fmt addr",
438 .help = "virtual memory dump starting at 'addr'",
439 .mhandler.cmd = hmp_memory_dump,
442 STEXI
443 @item x/fmt @var{addr}
444 @findex x
445 Virtual memory dump starting at @var{addr}.
446 ETEXI
449 .name = "xp",
450 .args_type = "fmt:/,addr:l",
451 .params = "/fmt addr",
452 .help = "physical memory dump starting at 'addr'",
453 .mhandler.cmd = hmp_physical_memory_dump,
456 STEXI
457 @item xp /@var{fmt} @var{addr}
458 @findex xp
459 Physical memory dump starting at @var{addr}.
461 @var{fmt} is a format which tells the command how to format the
462 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
464 @table @var
465 @item count
466 is the number of items to be dumped.
468 @item format
469 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
470 c (char) or i (asm instruction).
472 @item size
473 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
474 @code{h} or @code{w} can be specified with the @code{i} format to
475 respectively select 16 or 32 bit code instruction size.
477 @end table
479 Examples:
480 @itemize
481 @item
482 Dump 10 instructions at the current instruction pointer:
483 @example
484 (qemu) x/10i $eip
485 0x90107063: ret
486 0x90107064: sti
487 0x90107065: lea 0x0(%esi,1),%esi
488 0x90107069: lea 0x0(%edi,1),%edi
489 0x90107070: ret
490 0x90107071: jmp 0x90107080
491 0x90107073: nop
492 0x90107074: nop
493 0x90107075: nop
494 0x90107076: nop
495 @end example
497 @item
498 Dump 80 16 bit values at the start of the video memory.
499 @smallexample
500 (qemu) xp/80hx 0xb8000
501 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
502 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
503 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
504 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
505 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
506 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
507 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
508 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
509 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
510 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
511 @end smallexample
512 @end itemize
513 ETEXI
516 .name = "p|print",
517 .args_type = "fmt:/,val:l",
518 .params = "/fmt expr",
519 .help = "print expression value (use $reg for CPU register access)",
520 .mhandler.cmd = do_print,
523 STEXI
524 @item p or print/@var{fmt} @var{expr}
525 @findex print
527 Print expression value. Only the @var{format} part of @var{fmt} is
528 used.
529 ETEXI
532 .name = "i",
533 .args_type = "fmt:/,addr:i,index:i.",
534 .params = "/fmt addr",
535 .help = "I/O port read",
536 .mhandler.cmd = hmp_ioport_read,
539 STEXI
540 Read I/O port.
541 ETEXI
544 .name = "o",
545 .args_type = "fmt:/,addr:i,val:i",
546 .params = "/fmt addr value",
547 .help = "I/O port write",
548 .mhandler.cmd = hmp_ioport_write,
551 STEXI
552 Write to I/O port.
553 ETEXI
556 .name = "sendkey",
557 .args_type = "keys:s,hold-time:i?",
558 .params = "keys [hold_ms]",
559 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
560 .mhandler.cmd = hmp_sendkey,
561 .command_completion = sendkey_completion,
564 STEXI
565 @item sendkey @var{keys}
566 @findex sendkey
568 Send @var{keys} to the guest. @var{keys} could be the name of the
569 key or the raw value in hexadecimal format. Use @code{-} to press
570 several keys simultaneously. Example:
571 @example
572 sendkey ctrl-alt-f1
573 @end example
575 This command is useful to send keys that your graphical user interface
576 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
577 ETEXI
580 .name = "system_reset",
581 .args_type = "",
582 .params = "",
583 .help = "reset the system",
584 .mhandler.cmd = hmp_system_reset,
587 STEXI
588 @item system_reset
589 @findex system_reset
591 Reset the system.
592 ETEXI
595 .name = "system_powerdown",
596 .args_type = "",
597 .params = "",
598 .help = "send system power down event",
599 .mhandler.cmd = hmp_system_powerdown,
602 STEXI
603 @item system_powerdown
604 @findex system_powerdown
606 Power down the system (if supported).
607 ETEXI
610 .name = "sum",
611 .args_type = "start:i,size:i",
612 .params = "addr size",
613 .help = "compute the checksum of a memory region",
614 .mhandler.cmd = hmp_sum,
617 STEXI
618 @item sum @var{addr} @var{size}
619 @findex sum
621 Compute the checksum of a memory region.
622 ETEXI
625 .name = "usb_add",
626 .args_type = "devname:s",
627 .params = "device",
628 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
629 .mhandler.cmd = hmp_usb_add,
632 STEXI
633 @item usb_add @var{devname}
634 @findex usb_add
636 Add the USB device @var{devname}. For details of available devices see
637 @ref{usb_devices}
638 ETEXI
641 .name = "usb_del",
642 .args_type = "devname:s",
643 .params = "device",
644 .help = "remove USB device 'bus.addr'",
645 .mhandler.cmd = hmp_usb_del,
648 STEXI
649 @item usb_del @var{devname}
650 @findex usb_del
652 Remove the USB device @var{devname} from the QEMU virtual USB
653 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
654 command @code{info usb} to see the devices you can remove.
655 ETEXI
658 .name = "device_add",
659 .args_type = "device:O",
660 .params = "driver[,prop=value][,...]",
661 .help = "add device, like -device on the command line",
662 .user_print = monitor_user_noop,
663 .mhandler.cmd_new = do_device_add,
664 .command_completion = device_add_completion,
667 STEXI
668 @item device_add @var{config}
669 @findex device_add
671 Add device.
672 ETEXI
675 .name = "device_del",
676 .args_type = "id:s",
677 .params = "device",
678 .help = "remove device",
679 .mhandler.cmd = hmp_device_del,
680 .command_completion = device_del_completion,
683 STEXI
684 @item device_del @var{id}
685 @findex device_del
687 Remove device @var{id}.
688 ETEXI
691 .name = "cpu",
692 .args_type = "index:i",
693 .params = "index",
694 .help = "set the default CPU",
695 .mhandler.cmd = hmp_cpu,
698 STEXI
699 @item cpu @var{index}
700 @findex cpu
701 Set the default CPU.
702 ETEXI
705 .name = "mouse_move",
706 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
707 .params = "dx dy [dz]",
708 .help = "send mouse move events",
709 .mhandler.cmd = hmp_mouse_move,
712 STEXI
713 @item mouse_move @var{dx} @var{dy} [@var{dz}]
714 @findex mouse_move
715 Move the active mouse to the specified coordinates @var{dx} @var{dy}
716 with optional scroll axis @var{dz}.
717 ETEXI
720 .name = "mouse_button",
721 .args_type = "button_state:i",
722 .params = "state",
723 .help = "change mouse button state (1=L, 2=M, 4=R)",
724 .mhandler.cmd = hmp_mouse_button,
727 STEXI
728 @item mouse_button @var{val}
729 @findex mouse_button
730 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
731 ETEXI
734 .name = "mouse_set",
735 .args_type = "index:i",
736 .params = "index",
737 .help = "set which mouse device receives events",
738 .mhandler.cmd = hmp_mouse_set,
741 STEXI
742 @item mouse_set @var{index}
743 @findex mouse_set
744 Set which mouse device receives events at given @var{index}, index
745 can be obtained with
746 @example
747 info mice
748 @end example
749 ETEXI
752 .name = "wavcapture",
753 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
754 .params = "path [frequency [bits [channels]]]",
755 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
756 .mhandler.cmd = hmp_wavcapture,
758 STEXI
759 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
760 @findex wavcapture
761 Capture audio into @var{filename}. Using sample rate @var{frequency}
762 bits per sample @var{bits} and number of channels @var{channels}.
764 Defaults:
765 @itemize @minus
766 @item Sample rate = 44100 Hz - CD quality
767 @item Bits = 16
768 @item Number of channels = 2 - Stereo
769 @end itemize
770 ETEXI
773 .name = "stopcapture",
774 .args_type = "n:i",
775 .params = "capture index",
776 .help = "stop capture",
777 .mhandler.cmd = hmp_stopcapture,
779 STEXI
780 @item stopcapture @var{index}
781 @findex stopcapture
782 Stop capture with a given @var{index}, index can be obtained with
783 @example
784 info capture
785 @end example
786 ETEXI
789 .name = "memsave",
790 .args_type = "val:l,size:i,filename:s",
791 .params = "addr size file",
792 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
793 .mhandler.cmd = hmp_memsave,
796 STEXI
797 @item memsave @var{addr} @var{size} @var{file}
798 @findex memsave
799 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
800 ETEXI
803 .name = "pmemsave",
804 .args_type = "val:l,size:i,filename:s",
805 .params = "addr size file",
806 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
807 .mhandler.cmd = hmp_pmemsave,
810 STEXI
811 @item pmemsave @var{addr} @var{size} @var{file}
812 @findex pmemsave
813 save to disk physical memory dump starting at @var{addr} of size @var{size}.
814 ETEXI
817 .name = "boot_set",
818 .args_type = "bootdevice:s",
819 .params = "bootdevice",
820 .help = "define new values for the boot device list",
821 .mhandler.cmd = hmp_boot_set,
824 STEXI
825 @item boot_set @var{bootdevicelist}
826 @findex boot_set
828 Define new values for the boot device list. Those values will override
829 the values specified on the command line through the @code{-boot} option.
831 The values that can be specified here depend on the machine type, but are
832 the same that can be specified in the @code{-boot} command line option.
833 ETEXI
836 .name = "nmi",
837 .args_type = "",
838 .params = "",
839 .help = "inject an NMI",
840 .mhandler.cmd = hmp_nmi,
842 STEXI
843 @item nmi @var{cpu}
844 @findex nmi
845 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
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,
855 .command_completion = ringbuf_write_completion,
858 STEXI
859 @item ringbuf_write @var{device} @var{data}
860 @findex ringbuf_write
861 Write @var{data} to ring buffer character device @var{device}.
862 @var{data} must be a UTF-8 string.
864 ETEXI
867 .name = "ringbuf_read",
868 .args_type = "device:s,size:i",
869 .params = "device size",
870 .help = "Read from a ring buffer character device",
871 .mhandler.cmd = hmp_ringbuf_read,
872 .command_completion = ringbuf_write_completion,
875 STEXI
876 @item ringbuf_read @var{device}
877 @findex ringbuf_read
878 Read and print up to @var{size} bytes from ring buffer character
879 device @var{device}.
880 Certain non-printable characters are printed \uXXXX, where XXXX is the
881 character code in hexadecimal. Character \ is printed \\.
882 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
883 NUL characters, after the ring buffer lost data, and when reading
884 stops because the size limit is reached.
886 ETEXI
889 .name = "migrate",
890 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
891 .params = "[-d] [-b] [-i] uri",
892 .help = "migrate to URI (using -d to not wait for completion)"
893 "\n\t\t\t -b for migration without shared storage with"
894 " full copy of disk\n\t\t\t -i for migration without "
895 "shared storage with incremental copy of disk "
896 "(base image shared between src and destination)",
897 .mhandler.cmd = hmp_migrate,
901 STEXI
902 @item migrate [-d] [-b] [-i] @var{uri}
903 @findex migrate
904 Migrate to @var{uri} (using -d to not wait for completion).
905 -b for migration with full copy of disk
906 -i for migration with incremental copy of disk (base image is shared)
907 ETEXI
910 .name = "migrate_cancel",
911 .args_type = "",
912 .params = "",
913 .help = "cancel the current VM migration",
914 .mhandler.cmd = hmp_migrate_cancel,
917 STEXI
918 @item migrate_cancel
919 @findex migrate_cancel
920 Cancel the current VM migration.
922 ETEXI
925 .name = "migrate_incoming",
926 .args_type = "uri:s",
927 .params = "uri",
928 .help = "Continue an incoming migration from an -incoming defer",
929 .mhandler.cmd = hmp_migrate_incoming,
932 STEXI
933 @item migrate_incoming @var{uri}
934 @findex migrate_incoming
935 Continue an incoming migration using the @var{uri} (that has the same syntax
936 as the -incoming option).
938 ETEXI
941 .name = "migrate_set_cache_size",
942 .args_type = "value:o",
943 .params = "value",
944 .help = "set cache size (in bytes) for XBZRLE migrations,"
945 "the cache size will be rounded down to the nearest "
946 "power of 2.\n"
947 "The cache size affects the number of cache misses."
948 "In case of a high cache miss ratio you need to increase"
949 " the cache size",
950 .mhandler.cmd = hmp_migrate_set_cache_size,
953 STEXI
954 @item migrate_set_cache_size @var{value}
955 @findex migrate_set_cache_size
956 Set cache size to @var{value} (in bytes) for xbzrle migrations.
957 ETEXI
960 .name = "migrate_set_speed",
961 .args_type = "value:o",
962 .params = "value",
963 .help = "set maximum speed (in bytes) for migrations. "
964 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
965 .mhandler.cmd = hmp_migrate_set_speed,
968 STEXI
969 @item migrate_set_speed @var{value}
970 @findex migrate_set_speed
971 Set maximum speed to @var{value} (in bytes) for migrations.
972 ETEXI
975 .name = "migrate_set_downtime",
976 .args_type = "value:T",
977 .params = "value",
978 .help = "set maximum tolerated downtime (in seconds) for migrations",
979 .mhandler.cmd = hmp_migrate_set_downtime,
982 STEXI
983 @item migrate_set_downtime @var{second}
984 @findex migrate_set_downtime
985 Set maximum tolerated downtime (in seconds) for migration.
986 ETEXI
989 .name = "migrate_set_capability",
990 .args_type = "capability:s,state:b",
991 .params = "capability state",
992 .help = "Enable/Disable the usage of a capability for migration",
993 .mhandler.cmd = hmp_migrate_set_capability,
994 .command_completion = migrate_set_capability_completion,
997 STEXI
998 @item migrate_set_capability @var{capability} @var{state}
999 @findex migrate_set_capability
1000 Enable/Disable the usage of a capability @var{capability} for migration.
1001 ETEXI
1004 .name = "client_migrate_info",
1005 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1006 .params = "protocol hostname port tls-port cert-subject",
1007 .help = "send migration info to spice/vnc client",
1008 .user_print = monitor_user_noop,
1009 .mhandler.cmd_async = client_migrate_info,
1010 .flags = MONITOR_CMD_ASYNC,
1013 STEXI
1014 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1015 @findex client_migrate_info
1016 Set the spice/vnc connection info for the migration target. The spice/vnc
1017 server will ask the spice/vnc client to automatically reconnect using the
1018 new parameters (if specified) once the vm migration finished successfully.
1019 ETEXI
1022 .name = "dump-guest-memory",
1023 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1024 .params = "[-p] [-z|-l|-s] filename [begin length]",
1025 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1026 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1027 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1028 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1029 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1030 "begin: the starting physical address.\n\t\t\t"
1031 "length: the memory size, in bytes.",
1032 .mhandler.cmd = hmp_dump_guest_memory,
1036 STEXI
1037 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1038 @item dump-guest-memory [-z|-l|-s] @var{filename}
1039 @findex dump-guest-memory
1040 Dump guest memory to @var{protocol}. The file can be processed with crash or
1041 gdb. Without -z|-l|-s, the dump format is ELF.
1042 -p: do paging to get guest's memory mapping.
1043 -z: dump in kdump-compressed format, with zlib compression.
1044 -l: dump in kdump-compressed format, with lzo compression.
1045 -s: dump in kdump-compressed format, with snappy compression.
1046 filename: dump file name.
1047 begin: the starting physical address. It's optional, and should be
1048 specified together with length.
1049 length: the memory size, in bytes. It's optional, and should be specified
1050 together with begin.
1051 ETEXI
1054 .name = "snapshot_blkdev",
1055 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1056 .params = "[-n] device [new-image-file] [format]",
1057 .help = "initiates a live snapshot\n\t\t\t"
1058 "of device. If a new image file is specified, the\n\t\t\t"
1059 "new image file will become the new root image.\n\t\t\t"
1060 "If format is specified, the snapshot file will\n\t\t\t"
1061 "be created in that format.\n\t\t\t"
1062 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1063 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1064 "recreating it from scratch.",
1065 .mhandler.cmd = hmp_snapshot_blkdev,
1068 STEXI
1069 @item snapshot_blkdev
1070 @findex snapshot_blkdev
1071 Snapshot device, using snapshot file as target if provided
1072 ETEXI
1075 .name = "snapshot_blkdev_internal",
1076 .args_type = "device:B,name:s",
1077 .params = "device name",
1078 .help = "take an internal snapshot of device.\n\t\t\t"
1079 "The format of the image used by device must\n\t\t\t"
1080 "support it, such as qcow2.\n\t\t\t",
1081 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1084 STEXI
1085 @item snapshot_blkdev_internal
1086 @findex snapshot_blkdev_internal
1087 Take an internal snapshot on device if it support
1088 ETEXI
1091 .name = "snapshot_delete_blkdev_internal",
1092 .args_type = "device:B,name:s,id:s?",
1093 .params = "device name [id]",
1094 .help = "delete an internal snapshot of device.\n\t\t\t"
1095 "If id is specified, qemu will try delete\n\t\t\t"
1096 "the snapshot matching both id and name.\n\t\t\t"
1097 "The format of the image used by device must\n\t\t\t"
1098 "support it, such as qcow2.\n\t\t\t",
1099 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1102 STEXI
1103 @item snapshot_delete_blkdev_internal
1104 @findex snapshot_delete_blkdev_internal
1105 Delete an internal snapshot on device if it support
1106 ETEXI
1109 .name = "drive_mirror",
1110 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1111 .params = "[-n] [-f] device target [format]",
1112 .help = "initiates live storage\n\t\t\t"
1113 "migration for a device. The device's contents are\n\t\t\t"
1114 "copied to the new image file, including data that\n\t\t\t"
1115 "is written after the command is started.\n\t\t\t"
1116 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1117 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1118 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1119 "so that the result does not need a backing file.\n\t\t\t",
1120 .mhandler.cmd = hmp_drive_mirror,
1122 STEXI
1123 @item drive_mirror
1124 @findex drive_mirror
1125 Start mirroring a block device's writes to a new destination,
1126 using the specified target.
1127 ETEXI
1130 .name = "drive_backup",
1131 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1132 .params = "[-n] [-f] device target [format]",
1133 .help = "initiates a point-in-time\n\t\t\t"
1134 "copy for a device. The device's contents are\n\t\t\t"
1135 "copied to the new image file, excluding data that\n\t\t\t"
1136 "is written after the command is started.\n\t\t\t"
1137 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1138 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1139 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1140 "so that the result does not need a backing file.\n\t\t\t",
1141 .mhandler.cmd = hmp_drive_backup,
1143 STEXI
1144 @item drive_backup
1145 @findex drive_backup
1146 Start a point-in-time copy of a block device to a specificed target.
1147 ETEXI
1150 .name = "drive_add",
1151 .args_type = "pci_addr:s,opts:s",
1152 .params = "[[<domain>:]<bus>:]<slot>\n"
1153 "[file=file][,if=type][,bus=n]\n"
1154 "[,unit=m][,media=d][,index=i]\n"
1155 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1156 "[,snapshot=on|off][,cache=on|off]\n"
1157 "[,readonly=on|off][,copy-on-read=on|off]",
1158 .help = "add drive to PCI storage controller",
1159 .mhandler.cmd = hmp_drive_add,
1162 STEXI
1163 @item drive_add
1164 @findex drive_add
1165 Add drive to PCI storage controller.
1166 ETEXI
1169 .name = "pcie_aer_inject_error",
1170 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1171 "id:s,error_status:s,"
1172 "header0:i?,header1:i?,header2:i?,header3:i?,"
1173 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1174 .params = "[-a] [-c] id "
1175 "<error_status> [<tlp header> [<tlp header prefix>]]",
1176 .help = "inject pcie aer error\n\t\t\t"
1177 " -a for advisory non fatal error\n\t\t\t"
1178 " -c for correctable error\n\t\t\t"
1179 "<id> = qdev device id\n\t\t\t"
1180 "<error_status> = error string or 32bit\n\t\t\t"
1181 "<tlb header> = 32bit x 4\n\t\t\t"
1182 "<tlb header prefix> = 32bit x 4",
1183 .user_print = pcie_aer_inject_error_print,
1184 .mhandler.cmd_new = hmp_pcie_aer_inject_error,
1187 STEXI
1188 @item pcie_aer_inject_error
1189 @findex pcie_aer_inject_error
1190 Inject PCIe AER error
1191 ETEXI
1194 .name = "host_net_add",
1195 .args_type = "device:s,opts:s?",
1196 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1197 .help = "add host VLAN client",
1198 .mhandler.cmd = hmp_host_net_add,
1199 .command_completion = host_net_add_completion,
1202 STEXI
1203 @item host_net_add
1204 @findex host_net_add
1205 Add host VLAN client.
1206 ETEXI
1209 .name = "host_net_remove",
1210 .args_type = "vlan_id:i,device:s",
1211 .params = "vlan_id name",
1212 .help = "remove host VLAN client",
1213 .mhandler.cmd = hmp_host_net_remove,
1214 .command_completion = host_net_remove_completion,
1217 STEXI
1218 @item host_net_remove
1219 @findex host_net_remove
1220 Remove host VLAN client.
1221 ETEXI
1224 .name = "netdev_add",
1225 .args_type = "netdev:O",
1226 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1227 .help = "add host network device",
1228 .mhandler.cmd = hmp_netdev_add,
1229 .command_completion = netdev_add_completion,
1232 STEXI
1233 @item netdev_add
1234 @findex netdev_add
1235 Add host network device.
1236 ETEXI
1239 .name = "netdev_del",
1240 .args_type = "id:s",
1241 .params = "id",
1242 .help = "remove host network device",
1243 .mhandler.cmd = hmp_netdev_del,
1244 .command_completion = netdev_del_completion,
1247 STEXI
1248 @item netdev_del
1249 @findex netdev_del
1250 Remove host network device.
1251 ETEXI
1254 .name = "object_add",
1255 .args_type = "object:O",
1256 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1257 .help = "create QOM object",
1258 .mhandler.cmd = hmp_object_add,
1259 .command_completion = object_add_completion,
1262 STEXI
1263 @item object_add
1264 @findex object_add
1265 Create QOM object.
1266 ETEXI
1269 .name = "object_del",
1270 .args_type = "id:s",
1271 .params = "id",
1272 .help = "destroy QOM object",
1273 .mhandler.cmd = hmp_object_del,
1274 .command_completion = object_del_completion,
1277 STEXI
1278 @item object_del
1279 @findex object_del
1280 Destroy QOM object.
1281 ETEXI
1283 #ifdef CONFIG_SLIRP
1285 .name = "hostfwd_add",
1286 .args_type = "arg1:s,arg2:s?,arg3:s?",
1287 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1288 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1289 .mhandler.cmd = hmp_hostfwd_add,
1291 #endif
1292 STEXI
1293 @item hostfwd_add
1294 @findex hostfwd_add
1295 Redirect TCP or UDP connections from host to guest (requires -net user).
1296 ETEXI
1298 #ifdef CONFIG_SLIRP
1300 .name = "hostfwd_remove",
1301 .args_type = "arg1:s,arg2:s?,arg3:s?",
1302 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1303 .help = "remove host-to-guest TCP or UDP redirection",
1304 .mhandler.cmd = hmp_hostfwd_remove,
1307 #endif
1308 STEXI
1309 @item hostfwd_remove
1310 @findex hostfwd_remove
1311 Remove host-to-guest TCP or UDP redirection.
1312 ETEXI
1315 .name = "balloon",
1316 .args_type = "value:M",
1317 .params = "target",
1318 .help = "request VM to change its memory allocation (in MB)",
1319 .mhandler.cmd = hmp_balloon,
1322 STEXI
1323 @item balloon @var{value}
1324 @findex balloon
1325 Request VM to change its memory allocation to @var{value} (in MB).
1326 ETEXI
1329 .name = "set_link",
1330 .args_type = "name:s,up:b",
1331 .params = "name on|off",
1332 .help = "change the link status of a network adapter",
1333 .mhandler.cmd = hmp_set_link,
1334 .command_completion = set_link_completion,
1337 STEXI
1338 @item set_link @var{name} [on|off]
1339 @findex set_link
1340 Switch link @var{name} on (i.e. up) or off (i.e. down).
1341 ETEXI
1344 .name = "watchdog_action",
1345 .args_type = "action:s",
1346 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1347 .help = "change watchdog action",
1348 .mhandler.cmd = hmp_watchdog_action,
1349 .command_completion = watchdog_action_completion,
1352 STEXI
1353 @item watchdog_action
1354 @findex watchdog_action
1355 Change watchdog action.
1356 ETEXI
1359 .name = "acl_show",
1360 .args_type = "aclname:s",
1361 .params = "aclname",
1362 .help = "list rules in the access control list",
1363 .mhandler.cmd = hmp_acl_show,
1366 STEXI
1367 @item acl_show @var{aclname}
1368 @findex acl_show
1369 List all the matching rules in the access control list, and the default
1370 policy. There are currently two named access control lists,
1371 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1372 certificate distinguished name, and SASL username respectively.
1373 ETEXI
1376 .name = "acl_policy",
1377 .args_type = "aclname:s,policy:s",
1378 .params = "aclname allow|deny",
1379 .help = "set default access control list policy",
1380 .mhandler.cmd = hmp_acl_policy,
1383 STEXI
1384 @item acl_policy @var{aclname} @code{allow|deny}
1385 @findex acl_policy
1386 Set the default access control list policy, used in the event that
1387 none of the explicit rules match. The default policy at startup is
1388 always @code{deny}.
1389 ETEXI
1392 .name = "acl_add",
1393 .args_type = "aclname:s,match:s,policy:s,index:i?",
1394 .params = "aclname match allow|deny [index]",
1395 .help = "add a match rule to the access control list",
1396 .mhandler.cmd = hmp_acl_add,
1399 STEXI
1400 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1401 @findex acl_add
1402 Add a match rule to the access control list, allowing or denying access.
1403 The match will normally be an exact username or x509 distinguished name,
1404 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1405 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1406 normally be appended to the end of the ACL, but can be inserted
1407 earlier in the list if the optional @var{index} parameter is supplied.
1408 ETEXI
1411 .name = "acl_remove",
1412 .args_type = "aclname:s,match:s",
1413 .params = "aclname match",
1414 .help = "remove a match rule from the access control list",
1415 .mhandler.cmd = hmp_acl_remove,
1418 STEXI
1419 @item acl_remove @var{aclname} @var{match}
1420 @findex acl_remove
1421 Remove the specified match rule from the access control list.
1422 ETEXI
1425 .name = "acl_reset",
1426 .args_type = "aclname:s",
1427 .params = "aclname",
1428 .help = "reset the access control list",
1429 .mhandler.cmd = hmp_acl_reset,
1432 STEXI
1433 @item acl_reset @var{aclname}
1434 @findex acl_reset
1435 Remove all matches from the access control list, and set the default
1436 policy back to @code{deny}.
1437 ETEXI
1440 .name = "nbd_server_start",
1441 .args_type = "all:-a,writable:-w,uri:s",
1442 .params = "nbd_server_start [-a] [-w] host:port",
1443 .help = "serve block devices on the given host and port",
1444 .mhandler.cmd = hmp_nbd_server_start,
1446 STEXI
1447 @item nbd_server_start @var{host}:@var{port}
1448 @findex nbd_server_start
1449 Start an NBD server on the given host and/or port. If the @option{-a}
1450 option is included, all of the virtual machine's block devices that
1451 have an inserted media on them are automatically exported; in this case,
1452 the @option{-w} option makes the devices writable too.
1453 ETEXI
1456 .name = "nbd_server_add",
1457 .args_type = "writable:-w,device:B",
1458 .params = "nbd_server_add [-w] device",
1459 .help = "export a block device via NBD",
1460 .mhandler.cmd = hmp_nbd_server_add,
1462 STEXI
1463 @item nbd_server_add @var{device}
1464 @findex nbd_server_add
1465 Export a block device through QEMU's NBD server, which must be started
1466 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1467 exported device writable too.
1468 ETEXI
1471 .name = "nbd_server_stop",
1472 .args_type = "",
1473 .params = "nbd_server_stop",
1474 .help = "stop serving block devices using the NBD protocol",
1475 .mhandler.cmd = hmp_nbd_server_stop,
1477 STEXI
1478 @item nbd_server_stop
1479 @findex nbd_server_stop
1480 Stop the QEMU embedded NBD server.
1481 ETEXI
1484 #if defined(TARGET_I386)
1487 .name = "mce",
1488 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1489 .params = "[-b] cpu bank status mcgstatus addr misc",
1490 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1491 .mhandler.cmd = hmp_mce,
1494 #endif
1495 STEXI
1496 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1497 @findex mce (x86)
1498 Inject an MCE on the given CPU (x86 only).
1499 ETEXI
1502 .name = "getfd",
1503 .args_type = "fdname:s",
1504 .params = "getfd name",
1505 .help = "receive a file descriptor via SCM rights and assign it a name",
1506 .mhandler.cmd = hmp_getfd,
1509 STEXI
1510 @item getfd @var{fdname}
1511 @findex getfd
1512 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1513 mechanism on unix sockets, it is stored using the name @var{fdname} for
1514 later use by other monitor commands.
1515 ETEXI
1518 .name = "closefd",
1519 .args_type = "fdname:s",
1520 .params = "closefd name",
1521 .help = "close a file descriptor previously passed via SCM rights",
1522 .mhandler.cmd = hmp_closefd,
1525 STEXI
1526 @item closefd @var{fdname}
1527 @findex closefd
1528 Close the file descriptor previously assigned to @var{fdname} using the
1529 @code{getfd} command. This is only needed if the file descriptor was never
1530 used by another monitor command.
1531 ETEXI
1534 .name = "block_passwd",
1535 .args_type = "device:B,password:s",
1536 .params = "block_passwd device password",
1537 .help = "set the password of encrypted block devices",
1538 .mhandler.cmd = hmp_block_passwd,
1541 STEXI
1542 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1543 @findex block_set_io_throttle
1544 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}
1545 ETEXI
1548 .name = "block_set_io_throttle",
1549 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1550 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1551 .help = "change I/O throttle limits for a block drive",
1552 .mhandler.cmd = hmp_block_set_io_throttle,
1555 STEXI
1556 @item block_passwd @var{device} @var{password}
1557 @findex block_passwd
1558 Set the encrypted device @var{device} password to @var{password}
1559 ETEXI
1562 .name = "set_password",
1563 .args_type = "protocol:s,password:s,connected:s?",
1564 .params = "protocol password action-if-connected",
1565 .help = "set spice/vnc password",
1566 .mhandler.cmd = hmp_set_password,
1569 STEXI
1570 @item set_password [ vnc | spice ] password [ action-if-connected ]
1571 @findex set_password
1573 Change spice/vnc password. Use zero to make the password stay valid
1574 forever. @var{action-if-connected} specifies what should happen in
1575 case a connection is established: @var{fail} makes the password change
1576 fail. @var{disconnect} changes the password and disconnects the
1577 client. @var{keep} changes the password and keeps the connection up.
1578 @var{keep} is the default.
1579 ETEXI
1582 .name = "expire_password",
1583 .args_type = "protocol:s,time:s",
1584 .params = "protocol time",
1585 .help = "set spice/vnc password expire-time",
1586 .mhandler.cmd = hmp_expire_password,
1589 STEXI
1590 @item expire_password [ vnc | spice ] expire-time
1591 @findex expire_password
1593 Specify when a password for spice/vnc becomes
1594 invalid. @var{expire-time} accepts:
1596 @table @var
1597 @item now
1598 Invalidate password instantly.
1600 @item never
1601 Password stays valid forever.
1603 @item +nsec
1604 Password stays valid for @var{nsec} seconds starting now.
1606 @item nsec
1607 Password is invalidated at the given time. @var{nsec} are the seconds
1608 passed since 1970, i.e. unix epoch.
1610 @end table
1611 ETEXI
1614 .name = "chardev-add",
1615 .args_type = "args:s",
1616 .params = "args",
1617 .help = "add chardev",
1618 .mhandler.cmd = hmp_chardev_add,
1619 .command_completion = chardev_add_completion,
1622 STEXI
1623 @item chardev_add args
1624 @findex chardev_add
1626 chardev_add accepts the same parameters as the -chardev command line switch.
1628 ETEXI
1631 .name = "chardev-remove",
1632 .args_type = "id:s",
1633 .params = "id",
1634 .help = "remove chardev",
1635 .mhandler.cmd = hmp_chardev_remove,
1636 .command_completion = chardev_remove_completion,
1639 STEXI
1640 @item chardev_remove id
1641 @findex chardev_remove
1643 Removes the chardev @var{id}.
1645 ETEXI
1648 .name = "qemu-io",
1649 .args_type = "device:B,command:s",
1650 .params = "[device] \"[command]\"",
1651 .help = "run a qemu-io command on a block device",
1652 .mhandler.cmd = hmp_qemu_io,
1655 STEXI
1656 @item qemu-io @var{device} @var{command}
1657 @findex qemu-io
1659 Executes a qemu-io command on the given block device.
1661 ETEXI
1664 .name = "cpu-add",
1665 .args_type = "id:i",
1666 .params = "id",
1667 .help = "add cpu",
1668 .mhandler.cmd = hmp_cpu_add,
1671 STEXI
1672 @item cpu-add @var{id}
1673 Add CPU with id @var{id}
1674 ETEXI
1677 .name = "info",
1678 .args_type = "item:s?",
1679 .params = "[subcommand]",
1680 .help = "show various information about the system state",
1681 .mhandler.cmd = hmp_info_help,
1682 .sub_table = info_cmds,
1685 STEXI
1686 @item info @var{subcommand}
1687 @findex info
1688 Show various information about the system state.
1690 @table @option
1691 @item info version
1692 show the version of QEMU
1693 @item info network
1694 show the various VLANs and the associated devices
1695 @item info chardev
1696 show the character devices
1697 @item info block
1698 show the block devices
1699 @item info blockstats
1700 show block device statistics
1701 @item info registers
1702 show the cpu registers
1703 @item info cpus
1704 show infos for each CPU
1705 @item info history
1706 show the command line history
1707 @item info irq
1708 show the interrupts statistics (if available)
1709 @item info pic
1710 show i8259 (PIC) state
1711 @item info pci
1712 show emulated PCI device info
1713 @item info tlb
1714 show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1715 @item info mem
1716 show the active virtual memory mappings (i386 only)
1717 @item info jit
1718 show dynamic compiler info
1719 @item info numa
1720 show NUMA information
1721 @item info kvm
1722 show KVM information
1723 @item info usb
1724 show USB devices plugged on the virtual USB hub
1725 @item info usbhost
1726 show all USB host devices
1727 @item info profile
1728 show profiling information
1729 @item info capture
1730 show information about active capturing
1731 @item info snapshots
1732 show list of VM snapshots
1733 @item info status
1734 show the current VM status (running|paused)
1735 @item info mice
1736 show which guest mouse is receiving events
1737 @item info vnc
1738 show the vnc server status
1739 @item info name
1740 show the current VM name
1741 @item info uuid
1742 show the current VM UUID
1743 @item info cpustats
1744 show CPU statistics
1745 @item info usernet
1746 show user network stack connection states
1747 @item info migrate
1748 show migration status
1749 @item info migrate_capabilities
1750 show current migration capabilities
1751 @item info migrate_cache_size
1752 show current migration XBZRLE cache size
1753 @item info balloon
1754 show balloon information
1755 @item info qtree
1756 show device tree
1757 @item info qdm
1758 show qdev device model list
1759 @item info roms
1760 show roms
1761 @item info tpm
1762 show the TPM device
1763 @item info memory-devices
1764 show the memory devices
1765 @end table
1766 ETEXI
1768 STEXI
1769 @item info trace-events
1770 show available trace events and their state
1771 ETEXI
1773 STEXI
1774 @end table
1775 ETEXI