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
14 .args_type = "name:s?",
16 .help = "show the help",
17 .mhandler.cmd = do_help_cmd,
21 @item help or ? [@var{cmd}]
23 Show the help for all commands or just for command @var{cmd}.
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,
37 Commit changes to the disk images (if -snapshot is used) or backing files.
44 .help = "quit the emulator",
45 .user_print = monitor_user_noop,
46 .mhandler.cmd = hmp_quit,
56 .name = "block_resize",
57 .args_type = "device:B,size:o",
58 .params = "device size",
59 .help = "resize a block image",
60 .user_print = monitor_user_noop,
61 .mhandler.cmd_new = do_block_resize,
67 Resize a block image while a guest is running. Usually requires guest
68 action to see the updated size. Resize to a lower size is supported,
69 but should be used with extreme caution. Note that this command only
70 resizes image files, it can not resize block devices like LVM volumes.
76 .args_type = "force:-f,device:B",
77 .params = "[-f] device",
78 .help = "eject a removable medium (use -f to force it)",
79 .user_print = monitor_user_noop,
80 .mhandler.cmd_new = do_eject,
84 @item eject [-f] @var{device}
86 Eject a removable medium (use -f to force it).
93 .help = "remove host block device",
94 .user_print = monitor_user_noop,
95 .mhandler.cmd_new = do_drive_del,
99 @item drive_del @var{device}
101 Remove host block device. The result is that guest generated IO is no longer
102 submitted against the host device underlying the disk. Once a drive has
103 been deleted, the QEMU Block layer returns -EIO which results in IO
104 errors in the guest for applications that are reading/writing to the device.
109 .args_type = "device:B,target:F,arg:s?",
110 .params = "device filename [format]",
111 .help = "change a removable medium, optional format",
112 .user_print = monitor_user_noop,
113 .mhandler.cmd_new = do_change,
117 @item change @var{device} @var{setting}
120 Change the configuration of a device.
123 @item change @var{diskdevice} @var{filename} [@var{format}]
124 Change the medium for a removable disk device to point to @var{filename}. eg
127 (qemu) change ide1-cd0 /path/to/some.iso
130 @var{format} is optional.
132 @item change vnc @var{display},@var{options}
133 Change the configuration of the VNC server. The valid syntax for @var{display}
134 and @var{options} are described at @ref{sec_invocation}. eg
137 (qemu) change vnc localhost:1
140 @item change vnc password [@var{password}]
142 Change the password associated with the VNC server. If the new password is not
143 supplied, the monitor will prompt for it to be entered. VNC passwords are only
144 significant up to 8 letters. eg
147 (qemu) change vnc password
155 .name = "screendump",
156 .args_type = "filename:F",
157 .params = "filename",
158 .help = "save screen into PPM image 'filename'",
159 .user_print = monitor_user_noop,
160 .mhandler.cmd_new = do_screen_dump,
164 @item screendump @var{filename}
166 Save screen into PPM image @var{filename}.
171 .args_type = "filename:F",
172 .params = "filename",
173 .help = "output logs to 'filename'",
174 .mhandler.cmd = do_logfile,
178 @item logfile @var{filename}
180 Output logs to @var{filename}.
184 .name = "trace-event",
185 .args_type = "name:s,option:b",
186 .params = "name on|off",
187 .help = "changes status of a specific trace event",
188 .mhandler.cmd = do_trace_event_set_state,
194 changes status of a trace event
197 #if defined(CONFIG_SIMPLE_TRACE)
199 .name = "trace-file",
200 .args_type = "op:s?,arg:F?",
201 .params = "on|off|flush|set [arg]",
202 .help = "open, close, or flush trace file, or set a new file name",
203 .mhandler.cmd = do_trace_file,
207 @item trace-file on|off|flush
209 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
215 .args_type = "items:s",
216 .params = "item1[,...]",
217 .help = "activate logging of the specified items to '/tmp/qemu.log'",
218 .mhandler.cmd = do_log,
222 @item log @var{item1}[,...]
224 Activate logging of the specified items to @file{/tmp/qemu.log}.
229 .args_type = "name:s?",
230 .params = "[tag|id]",
231 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
232 .mhandler.cmd = do_savevm,
236 @item savevm [@var{tag}|@var{id}]
238 Create a snapshot of the whole virtual machine. If @var{tag} is
239 provided, it is used as human readable identifier. If there is already
240 a snapshot with the same tag or ID, it is replaced. More info at
246 .args_type = "name:s",
248 .help = "restore a VM snapshot from its tag or id",
249 .mhandler.cmd = do_loadvm,
253 @item loadvm @var{tag}|@var{id}
255 Set the whole virtual machine to the snapshot identified by the tag
256 @var{tag} or the unique snapshot ID @var{id}.
261 .args_type = "name:s",
263 .help = "delete a VM snapshot from its tag or id",
264 .mhandler.cmd = do_delvm,
268 @item delvm @var{tag}|@var{id}
270 Delete the snapshot identified by @var{tag} or @var{id}.
274 .name = "singlestep",
275 .args_type = "option:s?",
276 .params = "[on|off]",
277 .help = "run emulation in singlestep mode or switch to normal mode",
278 .mhandler.cmd = do_singlestep,
282 @item singlestep [off]
284 Run the emulation in single step mode.
285 If called with option off, the emulation returns to normal mode.
292 .help = "stop emulation",
293 .mhandler.cmd = hmp_stop,
306 .help = "resume emulation",
307 .user_print = monitor_user_noop,
308 .mhandler.cmd_new = do_cont,
319 .args_type = "device:s?",
320 .params = "[device]",
321 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
322 .mhandler.cmd = do_gdbserver,
326 @item gdbserver [@var{port}]
328 Start gdbserver session (default @var{port}=1234)
333 .args_type = "fmt:/,addr:l",
334 .params = "/fmt addr",
335 .help = "virtual memory dump starting at 'addr'",
336 .mhandler.cmd = do_memory_dump,
340 @item x/fmt @var{addr}
342 Virtual memory dump starting at @var{addr}.
347 .args_type = "fmt:/,addr:l",
348 .params = "/fmt addr",
349 .help = "physical memory dump starting at 'addr'",
350 .mhandler.cmd = do_physical_memory_dump,
354 @item xp /@var{fmt} @var{addr}
356 Physical memory dump starting at @var{addr}.
358 @var{fmt} is a format which tells the command how to format the
359 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
363 is the number of items to be dumped.
366 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
367 c (char) or i (asm instruction).
370 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
371 @code{h} or @code{w} can be specified with the @code{i} format to
372 respectively select 16 or 32 bit code instruction size.
379 Dump 10 instructions at the current instruction pointer:
384 0x90107065: lea 0x0(%esi,1),%esi
385 0x90107069: lea 0x0(%edi,1),%edi
387 0x90107071: jmp 0x90107080
395 Dump 80 16 bit values at the start of the video memory.
397 (qemu) xp/80hx 0xb8000
398 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
399 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
400 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
401 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
402 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
403 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
404 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
405 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
406 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
407 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
414 .args_type = "fmt:/,val:l",
415 .params = "/fmt expr",
416 .help = "print expression value (use $reg for CPU register access)",
417 .mhandler.cmd = do_print,
421 @item p or print/@var{fmt} @var{expr}
424 Print expression value. Only the @var{format} part of @var{fmt} is
430 .args_type = "fmt:/,addr:i,index:i.",
431 .params = "/fmt addr",
432 .help = "I/O port read",
433 .mhandler.cmd = do_ioport_read,
442 .args_type = "fmt:/,addr:i,val:i",
443 .params = "/fmt addr value",
444 .help = "I/O port write",
445 .mhandler.cmd = do_ioport_write,
454 .args_type = "string:s,hold_time:i?",
455 .params = "keys [hold_ms]",
456 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
457 .mhandler.cmd = do_sendkey,
461 @item sendkey @var{keys}
464 Send @var{keys} to the emulator. @var{keys} could be the name of the
465 key or @code{#} followed by the raw value in either decimal or hexadecimal
466 format. Use @code{-} to press several keys simultaneously. Example:
471 This command is useful to send keys that your graphical user interface
472 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
476 .name = "system_reset",
479 .help = "reset the system",
480 .user_print = monitor_user_noop,
481 .mhandler.cmd_new = do_system_reset,
492 .name = "system_powerdown",
495 .help = "send system power down event",
496 .user_print = monitor_user_noop,
497 .mhandler.cmd_new = do_system_powerdown,
501 @item system_powerdown
502 @findex system_powerdown
504 Power down the system (if supported).
509 .args_type = "start:i,size:i",
510 .params = "addr size",
511 .help = "compute the checksum of a memory region",
512 .mhandler.cmd = do_sum,
516 @item sum @var{addr} @var{size}
519 Compute the checksum of a memory region.
524 .args_type = "devname:s",
526 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
527 .mhandler.cmd = do_usb_add,
531 @item usb_add @var{devname}
534 Add the USB device @var{devname}. For details of available devices see
540 .args_type = "devname:s",
542 .help = "remove USB device 'bus.addr'",
543 .mhandler.cmd = do_usb_del,
547 @item usb_del @var{devname}
550 Remove the USB device @var{devname} from the QEMU virtual USB
551 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
552 command @code{info usb} to see the devices you can remove.
556 .name = "device_add",
557 .args_type = "device:O",
558 .params = "driver[,prop=value][,...]",
559 .help = "add device, like -device on the command line",
560 .user_print = monitor_user_noop,
561 .mhandler.cmd_new = do_device_add,
565 @item device_add @var{config}
572 .name = "device_del",
575 .help = "remove device",
576 .user_print = monitor_user_noop,
577 .mhandler.cmd_new = do_device_del,
581 @item device_del @var{id}
584 Remove device @var{id}.
589 .args_type = "index:i",
591 .help = "set the default CPU",
592 .user_print = monitor_user_noop,
593 .mhandler.cmd_new = do_cpu_set,
597 @item cpu @var{index}
603 .name = "mouse_move",
604 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
605 .params = "dx dy [dz]",
606 .help = "send mouse move events",
607 .mhandler.cmd = do_mouse_move,
611 @item mouse_move @var{dx} @var{dy} [@var{dz}]
613 Move the active mouse to the specified coordinates @var{dx} @var{dy}
614 with optional scroll axis @var{dz}.
618 .name = "mouse_button",
619 .args_type = "button_state:i",
621 .help = "change mouse button state (1=L, 2=M, 4=R)",
622 .mhandler.cmd = do_mouse_button,
626 @item mouse_button @var{val}
628 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
633 .args_type = "index:i",
635 .help = "set which mouse device receives events",
636 .mhandler.cmd = do_mouse_set,
640 @item mouse_set @var{index}
642 Set which mouse device receives events at given @var{index}, index
651 .name = "wavcapture",
652 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
653 .params = "path [frequency [bits [channels]]]",
654 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
655 .mhandler.cmd = do_wav_capture,
659 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
661 Capture audio into @var{filename}. Using sample rate @var{frequency}
662 bits per sample @var{bits} and number of channels @var{channels}.
666 @item Sample rate = 44100 Hz - CD quality
668 @item Number of channels = 2 - Stereo
674 .name = "stopcapture",
676 .params = "capture index",
677 .help = "stop capture",
678 .mhandler.cmd = do_stop_capture,
682 @item stopcapture @var{index}
684 Stop capture with a given @var{index}, index can be obtained with
692 .args_type = "val:l,size:i,filename:s",
693 .params = "addr size file",
694 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
695 .user_print = monitor_user_noop,
696 .mhandler.cmd_new = do_memory_save,
700 @item memsave @var{addr} @var{size} @var{file}
702 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
707 .args_type = "val:l,size:i,filename:s",
708 .params = "addr size file",
709 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
710 .user_print = monitor_user_noop,
711 .mhandler.cmd_new = do_physical_memory_save,
715 @item pmemsave @var{addr} @var{size} @var{file}
717 save to disk physical memory dump starting at @var{addr} of size @var{size}.
722 .args_type = "bootdevice:s",
723 .params = "bootdevice",
724 .help = "define new values for the boot device list",
725 .mhandler.cmd = do_boot_set,
729 @item boot_set @var{bootdevicelist}
732 Define new values for the boot device list. Those values will override
733 the values specified on the command line through the @code{-boot} option.
735 The values that can be specified here depend on the machine type, but are
736 the same that can be specified in the @code{-boot} command line option.
739 #if defined(TARGET_I386)
744 .help = "inject an NMI on all guest's CPUs",
745 .user_print = monitor_user_noop,
746 .mhandler.cmd_new = do_inject_nmi,
752 Inject an NMI on the given CPU (x86 only).
757 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
758 .params = "[-d] [-b] [-i] uri",
759 .help = "migrate to URI (using -d to not wait for completion)"
760 "\n\t\t\t -b for migration without shared storage with"
761 " full copy of disk\n\t\t\t -i for migration without "
762 "shared storage with incremental copy of disk "
763 "(base image shared between src and destination)",
764 .user_print = monitor_user_noop,
765 .mhandler.cmd_new = do_migrate,
770 @item migrate [-d] [-b] [-i] @var{uri}
772 Migrate to @var{uri} (using -d to not wait for completion).
773 -b for migration with full copy of disk
774 -i for migration with incremental copy of disk (base image is shared)
778 .name = "migrate_cancel",
781 .help = "cancel the current VM migration",
782 .user_print = monitor_user_noop,
783 .mhandler.cmd_new = do_migrate_cancel,
788 @findex migrate_cancel
789 Cancel the current VM migration.
793 .name = "migrate_set_speed",
794 .args_type = "value:o",
796 .help = "set maximum speed (in bytes) for migrations. "
797 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
798 .user_print = monitor_user_noop,
799 .mhandler.cmd_new = do_migrate_set_speed,
803 @item migrate_set_speed @var{value}
804 @findex migrate_set_speed
805 Set maximum speed to @var{value} (in bytes) for migrations.
809 .name = "migrate_set_downtime",
810 .args_type = "value:T",
812 .help = "set maximum tolerated downtime (in seconds) for migrations",
813 .user_print = monitor_user_noop,
814 .mhandler.cmd_new = do_migrate_set_downtime,
818 @item migrate_set_downtime @var{second}
819 @findex migrate_set_downtime
820 Set maximum tolerated downtime (in seconds) for migration.
824 .name = "client_migrate_info",
825 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
826 .params = "protocol hostname port tls-port cert-subject",
827 .help = "send migration info to spice/vnc client",
828 .user_print = monitor_user_noop,
829 .mhandler.cmd_new = client_migrate_info,
833 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
834 @findex client_migrate_info
835 Set the spice/vnc connection info for the migration target. The spice/vnc
836 server will ask the spice/vnc client to automatically reconnect using the
837 new parameters (if specified) once the vm migration finished successfully.
841 .name = "snapshot_blkdev",
842 .args_type = "device:B,snapshot-file:s?,format:s?",
843 .params = "device [new-image-file] [format]",
844 .help = "initiates a live snapshot\n\t\t\t"
845 "of device. If a new image file is specified, the\n\t\t\t"
846 "new image file will become the new root image.\n\t\t\t"
847 "If format is specified, the snapshot file will\n\t\t\t"
848 "be created in that format. Otherwise the\n\t\t\t"
849 "snapshot will be internal! (currently unsupported)",
850 .mhandler.cmd_new = do_snapshot_blkdev,
854 @item snapshot_blkdev
855 @findex snapshot_blkdev
856 Snapshot device, using snapshot file as target if provided
859 #if defined(TARGET_I386)
862 .args_type = "pci_addr:s,opts:s",
863 .params = "[[<domain>:]<bus>:]<slot>\n"
864 "[file=file][,if=type][,bus=n]\n"
865 "[,unit=m][,media=d][index=i]\n"
866 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
867 "[snapshot=on|off][,cache=on|off]",
868 .help = "add drive to PCI storage controller",
869 .mhandler.cmd = drive_hot_add,
876 Add drive to PCI storage controller.
879 #if defined(TARGET_I386)
882 .args_type = "pci_addr:s,type:s,opts:s?",
883 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
884 .help = "hot-add PCI device",
885 .mhandler.cmd = pci_device_hot_add,
895 #if defined(TARGET_I386)
898 .args_type = "pci_addr:s",
899 .params = "[[<domain>:]<bus>:]<slot>",
900 .help = "hot remove PCI device",
901 .mhandler.cmd = do_pci_device_hot_remove,
908 Hot remove PCI device.
912 .name = "pcie_aer_inject_error",
913 .args_type = "advisory_non_fatal:-a,correctable:-c,"
914 "id:s,error_status:s,"
915 "header0:i?,header1:i?,header2:i?,header3:i?,"
916 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
917 .params = "[-a] [-c] id "
918 "<error_status> [<tlp header> [<tlp header prefix>]]",
919 .help = "inject pcie aer error\n\t\t\t"
920 " -a for advisory non fatal error\n\t\t\t"
921 " -c for correctable error\n\t\t\t"
922 "<id> = qdev device id\n\t\t\t"
923 "<error_status> = error string or 32bit\n\t\t\t"
924 "<tlb header> = 32bit x 4\n\t\t\t"
925 "<tlb header prefix> = 32bit x 4",
926 .user_print = pcie_aer_inject_error_print,
927 .mhandler.cmd_new = do_pcie_aer_inejct_error,
931 @item pcie_aer_inject_error
932 @findex pcie_aer_inject_error
933 Inject PCIe AER error
937 .name = "host_net_add",
938 .args_type = "device:s,opts:s?",
939 .params = "tap|user|socket|vde|dump [options]",
940 .help = "add host VLAN client",
941 .mhandler.cmd = net_host_device_add,
947 Add host VLAN client.
951 .name = "host_net_remove",
952 .args_type = "vlan_id:i,device:s",
953 .params = "vlan_id name",
954 .help = "remove host VLAN client",
955 .mhandler.cmd = net_host_device_remove,
959 @item host_net_remove
960 @findex host_net_remove
961 Remove host VLAN client.
965 .name = "netdev_add",
966 .args_type = "netdev:O",
967 .params = "[user|tap|socket],id=str[,prop=value][,...]",
968 .help = "add host network device",
969 .user_print = monitor_user_noop,
970 .mhandler.cmd_new = do_netdev_add,
976 Add host network device.
980 .name = "netdev_del",
983 .help = "remove host network device",
984 .user_print = monitor_user_noop,
985 .mhandler.cmd_new = do_netdev_del,
991 Remove host network device.
996 .name = "hostfwd_add",
997 .args_type = "arg1:s,arg2:s?,arg3:s?",
998 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
999 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1000 .mhandler.cmd = net_slirp_hostfwd_add,
1006 Redirect TCP or UDP connections from host to guest (requires -net user).
1011 .name = "hostfwd_remove",
1012 .args_type = "arg1:s,arg2:s?,arg3:s?",
1013 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1014 .help = "remove host-to-guest TCP or UDP redirection",
1015 .mhandler.cmd = net_slirp_hostfwd_remove,
1020 @item hostfwd_remove
1021 @findex hostfwd_remove
1022 Remove host-to-guest TCP or UDP redirection.
1027 .args_type = "value:M",
1029 .help = "request VM to change its memory allocation (in MB)",
1030 .user_print = monitor_user_noop,
1031 .mhandler.cmd_async = do_balloon,
1032 .flags = MONITOR_CMD_ASYNC,
1036 @item balloon @var{value}
1038 Request VM to change its memory allocation to @var{value} (in MB).
1043 .args_type = "name:s,up:b",
1044 .params = "name on|off",
1045 .help = "change the link status of a network adapter",
1046 .user_print = monitor_user_noop,
1047 .mhandler.cmd_new = do_set_link,
1051 @item set_link @var{name} [on|off]
1053 Switch link @var{name} on (i.e. up) or off (i.e. down).
1057 .name = "watchdog_action",
1058 .args_type = "action:s",
1059 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1060 .help = "change watchdog action",
1061 .mhandler.cmd = do_watchdog_action,
1065 @item watchdog_action
1066 @findex watchdog_action
1067 Change watchdog action.
1072 .args_type = "aclname:s",
1073 .params = "aclname",
1074 .help = "list rules in the access control list",
1075 .mhandler.cmd = do_acl_show,
1079 @item acl_show @var{aclname}
1081 List all the matching rules in the access control list, and the default
1082 policy. There are currently two named access control lists,
1083 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1084 certificate distinguished name, and SASL username respectively.
1088 .name = "acl_policy",
1089 .args_type = "aclname:s,policy:s",
1090 .params = "aclname allow|deny",
1091 .help = "set default access control list policy",
1092 .mhandler.cmd = do_acl_policy,
1096 @item acl_policy @var{aclname} @code{allow|deny}
1098 Set the default access control list policy, used in the event that
1099 none of the explicit rules match. The default policy at startup is
1105 .args_type = "aclname:s,match:s,policy:s,index:i?",
1106 .params = "aclname match allow|deny [index]",
1107 .help = "add a match rule to the access control list",
1108 .mhandler.cmd = do_acl_add,
1112 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1114 Add a match rule to the access control list, allowing or denying access.
1115 The match will normally be an exact username or x509 distinguished name,
1116 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1117 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1118 normally be appended to the end of the ACL, but can be inserted
1119 earlier in the list if the optional @var{index} parameter is supplied.
1123 .name = "acl_remove",
1124 .args_type = "aclname:s,match:s",
1125 .params = "aclname match",
1126 .help = "remove a match rule from the access control list",
1127 .mhandler.cmd = do_acl_remove,
1131 @item acl_remove @var{aclname} @var{match}
1133 Remove the specified match rule from the access control list.
1137 .name = "acl_reset",
1138 .args_type = "aclname:s",
1139 .params = "aclname",
1140 .help = "reset the access control list",
1141 .mhandler.cmd = do_acl_reset,
1145 @item acl_reset @var{aclname}
1147 Remove all matches from the access control list, and set the default
1148 policy back to @code{deny}.
1151 #if defined(TARGET_I386)
1155 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1156 .params = "[-b] cpu bank status mcgstatus addr misc",
1157 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1158 .mhandler.cmd = do_inject_mce,
1163 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1165 Inject an MCE on the given CPU (x86 only).
1170 .args_type = "fdname:s",
1171 .params = "getfd name",
1172 .help = "receive a file descriptor via SCM rights and assign it a name",
1173 .user_print = monitor_user_noop,
1174 .mhandler.cmd_new = do_getfd,
1178 @item getfd @var{fdname}
1180 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1181 mechanism on unix sockets, it is stored using the name @var{fdname} for
1182 later use by other monitor commands.
1187 .args_type = "fdname:s",
1188 .params = "closefd name",
1189 .help = "close a file descriptor previously passed via SCM rights",
1190 .user_print = monitor_user_noop,
1191 .mhandler.cmd_new = do_closefd,
1195 @item closefd @var{fdname}
1197 Close the file descriptor previously assigned to @var{fdname} using the
1198 @code{getfd} command. This is only needed if the file descriptor was never
1199 used by another monitor command.
1203 .name = "block_passwd",
1204 .args_type = "device:B,password:s",
1205 .params = "block_passwd device password",
1206 .help = "set the password of encrypted block devices",
1207 .user_print = monitor_user_noop,
1208 .mhandler.cmd_new = do_block_set_passwd,
1212 @item block_passwd @var{device} @var{password}
1213 @findex block_passwd
1214 Set the encrypted device @var{device} password to @var{password}
1218 .name = "set_password",
1219 .args_type = "protocol:s,password:s,connected:s?",
1220 .params = "protocol password action-if-connected",
1221 .help = "set spice/vnc password",
1222 .user_print = monitor_user_noop,
1223 .mhandler.cmd_new = set_password,
1227 @item set_password [ vnc | spice ] password [ action-if-connected ]
1228 @findex set_password
1230 Change spice/vnc password. Use zero to make the password stay valid
1231 forever. @var{action-if-connected} specifies what should happen in
1232 case a connection is established: @var{fail} makes the password change
1233 fail. @var{disconnect} changes the password and disconnects the
1234 client. @var{keep} changes the password and keeps the connection up.
1235 @var{keep} is the default.
1239 .name = "expire_password",
1240 .args_type = "protocol:s,time:s",
1241 .params = "protocol time",
1242 .help = "set spice/vnc password expire-time",
1243 .user_print = monitor_user_noop,
1244 .mhandler.cmd_new = expire_password,
1248 @item expire_password [ vnc | spice ] expire-time
1249 @findex expire_password
1251 Specify when a password for spice/vnc becomes
1252 invalid. @var{expire-time} accepts:
1256 Invalidate password instantly.
1259 Password stays valid forever.
1262 Password stays valid for @var{nsec} seconds starting now.
1265 Password is invalidated at the given time. @var{nsec} are the seconds
1266 passed since 1970, i.e. unix epoch.
1273 .args_type = "item:s?",
1274 .params = "[subcommand]",
1275 .help = "show various information about the system state",
1276 .mhandler.cmd = do_info,
1280 @item info @var{subcommand}
1282 Show various information about the system state.
1286 show the version of QEMU
1288 show the various VLANs and the associated devices
1290 show the character devices
1292 show the block devices
1293 @item info blockstats
1294 show block device statistics
1295 @item info registers
1296 show the cpu registers
1298 show infos for each CPU
1300 show the command line history
1302 show the interrupts statistics (if available)
1304 show i8259 (PIC) state
1306 show emulated PCI device info
1308 show virtual to physical memory mappings (i386, SH4 and SPARC only)
1310 show the active virtual memory mappings (i386 only)
1312 show dynamic compiler info
1314 show NUMA information
1316 show KVM information
1318 show USB devices plugged on the virtual USB hub
1320 show all USB host devices
1322 show profiling information
1324 show information about active capturing
1325 @item info snapshots
1326 show list of VM snapshots
1328 show the current VM status (running|paused)
1330 show guest PCMCIA status
1332 show which guest mouse is receiving events
1334 show the vnc server status
1336 show the current VM name
1338 show the current VM UUID
1342 show user network stack connection states
1344 show migration status
1346 show balloon information
1350 show qdev device model list
1356 #ifdef CONFIG_TRACE_SIMPLE
1359 show contents of trace buffer
1364 @item info trace-events
1365 show available trace events and their state