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 .mhandler.cmd = hmp_block_resize,
66 Resize a block image while a guest is running. Usually requires guest
67 action to see the updated size. Resize to a lower size is supported,
68 but should be used with extreme caution. Note that this command only
69 resizes image files, it can not resize block devices like LVM volumes.
75 .args_type = "force:-f,device:B",
76 .params = "[-f] device",
77 .help = "eject a removable medium (use -f to force it)",
78 .mhandler.cmd = hmp_eject,
82 @item eject [-f] @var{device}
84 Eject a removable medium (use -f to force it).
91 .help = "remove host block device",
92 .user_print = monitor_user_noop,
93 .mhandler.cmd_new = do_drive_del,
97 @item drive_del @var{device}
99 Remove host block device. The result is that guest generated IO is no longer
100 submitted against the host device underlying the disk. Once a drive has
101 been deleted, the QEMU Block layer returns -EIO which results in IO
102 errors in the guest for applications that are reading/writing to the device.
107 .args_type = "device:B,target:F,arg:s?",
108 .params = "device filename [format]",
109 .help = "change a removable medium, optional format",
110 .user_print = monitor_user_noop,
111 .mhandler.cmd_new = do_change,
115 @item change @var{device} @var{setting}
118 Change the configuration of a device.
121 @item change @var{diskdevice} @var{filename} [@var{format}]
122 Change the medium for a removable disk device to point to @var{filename}. eg
125 (qemu) change ide1-cd0 /path/to/some.iso
128 @var{format} is optional.
130 @item change vnc @var{display},@var{options}
131 Change the configuration of the VNC server. The valid syntax for @var{display}
132 and @var{options} are described at @ref{sec_invocation}. eg
135 (qemu) change vnc localhost:1
138 @item change vnc password [@var{password}]
140 Change the password associated with the VNC server. If the new password is not
141 supplied, the monitor will prompt for it to be entered. VNC passwords are only
142 significant up to 8 letters. eg
145 (qemu) change vnc password
153 .name = "screendump",
154 .args_type = "filename:F",
155 .params = "filename",
156 .help = "save screen into PPM image 'filename'",
157 .user_print = monitor_user_noop,
158 .mhandler.cmd_new = do_screen_dump,
162 @item screendump @var{filename}
164 Save screen into PPM image @var{filename}.
169 .args_type = "filename:F",
170 .params = "filename",
171 .help = "output logs to 'filename'",
172 .mhandler.cmd = do_logfile,
176 @item logfile @var{filename}
178 Output logs to @var{filename}.
182 .name = "trace-event",
183 .args_type = "name:s,option:b",
184 .params = "name on|off",
185 .help = "changes status of a specific trace event",
186 .mhandler.cmd = do_trace_event_set_state,
192 changes status of a trace event
195 #if defined(CONFIG_TRACE_SIMPLE)
197 .name = "trace-file",
198 .args_type = "op:s?,arg:F?",
199 .params = "on|off|flush|set [arg]",
200 .help = "open, close, or flush trace file, or set a new file name",
201 .mhandler.cmd = do_trace_file,
205 @item trace-file on|off|flush
207 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
213 .args_type = "items:s",
214 .params = "item1[,...]",
215 .help = "activate logging of the specified items to '/tmp/qemu.log'",
216 .mhandler.cmd = do_log,
220 @item log @var{item1}[,...]
222 Activate logging of the specified items to @file{/tmp/qemu.log}.
227 .args_type = "name:s?",
228 .params = "[tag|id]",
229 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
230 .mhandler.cmd = do_savevm,
234 @item savevm [@var{tag}|@var{id}]
236 Create a snapshot of the whole virtual machine. If @var{tag} is
237 provided, it is used as human readable identifier. If there is already
238 a snapshot with the same tag or ID, it is replaced. More info at
244 .args_type = "name:s",
246 .help = "restore a VM snapshot from its tag or id",
247 .mhandler.cmd = do_loadvm,
251 @item loadvm @var{tag}|@var{id}
253 Set the whole virtual machine to the snapshot identified by the tag
254 @var{tag} or the unique snapshot ID @var{id}.
259 .args_type = "name:s",
261 .help = "delete a VM snapshot from its tag or id",
262 .mhandler.cmd = do_delvm,
266 @item delvm @var{tag}|@var{id}
268 Delete the snapshot identified by @var{tag} or @var{id}.
272 .name = "singlestep",
273 .args_type = "option:s?",
274 .params = "[on|off]",
275 .help = "run emulation in singlestep mode or switch to normal mode",
276 .mhandler.cmd = do_singlestep,
280 @item singlestep [off]
282 Run the emulation in single step mode.
283 If called with option off, the emulation returns to normal mode.
290 .help = "stop emulation",
291 .mhandler.cmd = hmp_stop,
304 .help = "resume emulation",
305 .mhandler.cmd = hmp_cont,
316 .args_type = "device:s?",
317 .params = "[device]",
318 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
319 .mhandler.cmd = do_gdbserver,
323 @item gdbserver [@var{port}]
325 Start gdbserver session (default @var{port}=1234)
330 .args_type = "fmt:/,addr:l",
331 .params = "/fmt addr",
332 .help = "virtual memory dump starting at 'addr'",
333 .mhandler.cmd = do_memory_dump,
337 @item x/fmt @var{addr}
339 Virtual memory dump starting at @var{addr}.
344 .args_type = "fmt:/,addr:l",
345 .params = "/fmt addr",
346 .help = "physical memory dump starting at 'addr'",
347 .mhandler.cmd = do_physical_memory_dump,
351 @item xp /@var{fmt} @var{addr}
353 Physical memory dump starting at @var{addr}.
355 @var{fmt} is a format which tells the command how to format the
356 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
360 is the number of items to be dumped.
363 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
364 c (char) or i (asm instruction).
367 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
368 @code{h} or @code{w} can be specified with the @code{i} format to
369 respectively select 16 or 32 bit code instruction size.
376 Dump 10 instructions at the current instruction pointer:
381 0x90107065: lea 0x0(%esi,1),%esi
382 0x90107069: lea 0x0(%edi,1),%edi
384 0x90107071: jmp 0x90107080
392 Dump 80 16 bit values at the start of the video memory.
394 (qemu) xp/80hx 0xb8000
395 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
396 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
397 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
398 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
399 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
400 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
401 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
402 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
403 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
404 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
411 .args_type = "fmt:/,val:l",
412 .params = "/fmt expr",
413 .help = "print expression value (use $reg for CPU register access)",
414 .mhandler.cmd = do_print,
418 @item p or print/@var{fmt} @var{expr}
421 Print expression value. Only the @var{format} part of @var{fmt} is
427 .args_type = "fmt:/,addr:i,index:i.",
428 .params = "/fmt addr",
429 .help = "I/O port read",
430 .mhandler.cmd = do_ioport_read,
439 .args_type = "fmt:/,addr:i,val:i",
440 .params = "/fmt addr value",
441 .help = "I/O port write",
442 .mhandler.cmd = do_ioport_write,
451 .args_type = "string:s,hold_time:i?",
452 .params = "keys [hold_ms]",
453 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
454 .mhandler.cmd = do_sendkey,
458 @item sendkey @var{keys}
461 Send @var{keys} to the emulator. @var{keys} could be the name of the
462 key or @code{#} followed by the raw value in either decimal or hexadecimal
463 format. Use @code{-} to press several keys simultaneously. Example:
468 This command is useful to send keys that your graphical user interface
469 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
473 .name = "system_reset",
476 .help = "reset the system",
477 .mhandler.cmd = hmp_system_reset,
488 .name = "system_powerdown",
491 .help = "send system power down event",
492 .mhandler.cmd = hmp_system_powerdown,
496 @item system_powerdown
497 @findex system_powerdown
499 Power down the system (if supported).
504 .args_type = "start:i,size:i",
505 .params = "addr size",
506 .help = "compute the checksum of a memory region",
507 .mhandler.cmd = do_sum,
511 @item sum @var{addr} @var{size}
514 Compute the checksum of a memory region.
519 .args_type = "devname:s",
521 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
522 .mhandler.cmd = do_usb_add,
526 @item usb_add @var{devname}
529 Add the USB device @var{devname}. For details of available devices see
535 .args_type = "devname:s",
537 .help = "remove USB device 'bus.addr'",
538 .mhandler.cmd = do_usb_del,
542 @item usb_del @var{devname}
545 Remove the USB device @var{devname} from the QEMU virtual USB
546 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
547 command @code{info usb} to see the devices you can remove.
551 .name = "device_add",
552 .args_type = "device:O",
553 .params = "driver[,prop=value][,...]",
554 .help = "add device, like -device on the command line",
555 .user_print = monitor_user_noop,
556 .mhandler.cmd_new = do_device_add,
560 @item device_add @var{config}
567 .name = "device_del",
570 .help = "remove device",
571 .user_print = monitor_user_noop,
572 .mhandler.cmd_new = do_device_del,
576 @item device_del @var{id}
579 Remove device @var{id}.
584 .args_type = "index:i",
586 .help = "set the default CPU",
587 .mhandler.cmd = hmp_cpu,
591 @item cpu @var{index}
597 .name = "mouse_move",
598 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
599 .params = "dx dy [dz]",
600 .help = "send mouse move events",
601 .mhandler.cmd = do_mouse_move,
605 @item mouse_move @var{dx} @var{dy} [@var{dz}]
607 Move the active mouse to the specified coordinates @var{dx} @var{dy}
608 with optional scroll axis @var{dz}.
612 .name = "mouse_button",
613 .args_type = "button_state:i",
615 .help = "change mouse button state (1=L, 2=M, 4=R)",
616 .mhandler.cmd = do_mouse_button,
620 @item mouse_button @var{val}
622 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
627 .args_type = "index:i",
629 .help = "set which mouse device receives events",
630 .mhandler.cmd = do_mouse_set,
634 @item mouse_set @var{index}
636 Set which mouse device receives events at given @var{index}, index
645 .name = "wavcapture",
646 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
647 .params = "path [frequency [bits [channels]]]",
648 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
649 .mhandler.cmd = do_wav_capture,
653 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
655 Capture audio into @var{filename}. Using sample rate @var{frequency}
656 bits per sample @var{bits} and number of channels @var{channels}.
660 @item Sample rate = 44100 Hz - CD quality
662 @item Number of channels = 2 - Stereo
668 .name = "stopcapture",
670 .params = "capture index",
671 .help = "stop capture",
672 .mhandler.cmd = do_stop_capture,
676 @item stopcapture @var{index}
678 Stop capture with a given @var{index}, index can be obtained with
686 .args_type = "val:l,size:i,filename:s",
687 .params = "addr size file",
688 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
689 .mhandler.cmd = hmp_memsave,
693 @item memsave @var{addr} @var{size} @var{file}
695 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
700 .args_type = "val:l,size:i,filename:s",
701 .params = "addr size file",
702 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
703 .mhandler.cmd = hmp_pmemsave,
707 @item pmemsave @var{addr} @var{size} @var{file}
709 save to disk physical memory dump starting at @var{addr} of size @var{size}.
714 .args_type = "bootdevice:s",
715 .params = "bootdevice",
716 .help = "define new values for the boot device list",
717 .mhandler.cmd = do_boot_set,
721 @item boot_set @var{bootdevicelist}
724 Define new values for the boot device list. Those values will override
725 the values specified on the command line through the @code{-boot} option.
727 The values that can be specified here depend on the machine type, but are
728 the same that can be specified in the @code{-boot} command line option.
731 #if defined(TARGET_I386)
736 .help = "inject an NMI on all guest's CPUs",
737 .mhandler.cmd = hmp_inject_nmi,
743 Inject an NMI on the given CPU (x86 only).
748 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
749 .params = "[-d] [-b] [-i] uri",
750 .help = "migrate to URI (using -d to not wait for completion)"
751 "\n\t\t\t -b for migration without shared storage with"
752 " full copy of disk\n\t\t\t -i for migration without "
753 "shared storage with incremental copy of disk "
754 "(base image shared between src and destination)",
755 .user_print = monitor_user_noop,
756 .mhandler.cmd_new = do_migrate,
761 @item migrate [-d] [-b] [-i] @var{uri}
763 Migrate to @var{uri} (using -d to not wait for completion).
764 -b for migration with full copy of disk
765 -i for migration with incremental copy of disk (base image is shared)
769 .name = "migrate_cancel",
772 .help = "cancel the current VM migration",
773 .mhandler.cmd = hmp_migrate_cancel,
778 @findex migrate_cancel
779 Cancel the current VM migration.
783 .name = "migrate_set_speed",
784 .args_type = "value:o",
786 .help = "set maximum speed (in bytes) for migrations. "
787 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
788 .mhandler.cmd = hmp_migrate_set_speed,
792 @item migrate_set_speed @var{value}
793 @findex migrate_set_speed
794 Set maximum speed to @var{value} (in bytes) for migrations.
798 .name = "migrate_set_downtime",
799 .args_type = "value:T",
801 .help = "set maximum tolerated downtime (in seconds) for migrations",
802 .mhandler.cmd = hmp_migrate_set_downtime,
806 @item migrate_set_downtime @var{second}
807 @findex migrate_set_downtime
808 Set maximum tolerated downtime (in seconds) for migration.
812 .name = "client_migrate_info",
813 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
814 .params = "protocol hostname port tls-port cert-subject",
815 .help = "send migration info to spice/vnc client",
816 .user_print = monitor_user_noop,
817 .mhandler.cmd_async = client_migrate_info,
818 .flags = MONITOR_CMD_ASYNC,
822 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
823 @findex client_migrate_info
824 Set the spice/vnc connection info for the migration target. The spice/vnc
825 server will ask the spice/vnc client to automatically reconnect using the
826 new parameters (if specified) once the vm migration finished successfully.
830 .name = "snapshot_blkdev",
831 .args_type = "device:B,snapshot-file:s?,format:s?",
832 .params = "device [new-image-file] [format]",
833 .help = "initiates a live snapshot\n\t\t\t"
834 "of device. If a new image file is specified, the\n\t\t\t"
835 "new image file will become the new root image.\n\t\t\t"
836 "If format is specified, the snapshot file will\n\t\t\t"
837 "be created in that format. Otherwise the\n\t\t\t"
838 "snapshot will be internal! (currently unsupported)",
839 .mhandler.cmd = hmp_snapshot_blkdev,
843 @item snapshot_blkdev
844 @findex snapshot_blkdev
845 Snapshot device, using snapshot file as target if provided
850 .args_type = "pci_addr:s,opts:s",
851 .params = "[[<domain>:]<bus>:]<slot>\n"
852 "[file=file][,if=type][,bus=n]\n"
853 "[,unit=m][,media=d][,index=i]\n"
854 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
855 "[,snapshot=on|off][,cache=on|off]\n"
856 "[,readonly=on|off][,copy-on-read=on|off]",
857 .help = "add drive to PCI storage controller",
858 .mhandler.cmd = drive_hot_add,
864 Add drive to PCI storage controller.
867 #if defined(TARGET_I386)
870 .args_type = "pci_addr:s,type:s,opts:s?",
871 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
872 .help = "hot-add PCI device",
873 .mhandler.cmd = pci_device_hot_add,
883 #if defined(TARGET_I386)
886 .args_type = "pci_addr:s",
887 .params = "[[<domain>:]<bus>:]<slot>",
888 .help = "hot remove PCI device",
889 .mhandler.cmd = do_pci_device_hot_remove,
896 Hot remove PCI device.
900 .name = "pcie_aer_inject_error",
901 .args_type = "advisory_non_fatal:-a,correctable:-c,"
902 "id:s,error_status:s,"
903 "header0:i?,header1:i?,header2:i?,header3:i?,"
904 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
905 .params = "[-a] [-c] id "
906 "<error_status> [<tlp header> [<tlp header prefix>]]",
907 .help = "inject pcie aer error\n\t\t\t"
908 " -a for advisory non fatal error\n\t\t\t"
909 " -c for correctable error\n\t\t\t"
910 "<id> = qdev device id\n\t\t\t"
911 "<error_status> = error string or 32bit\n\t\t\t"
912 "<tlb header> = 32bit x 4\n\t\t\t"
913 "<tlb header prefix> = 32bit x 4",
914 .user_print = pcie_aer_inject_error_print,
915 .mhandler.cmd_new = do_pcie_aer_inject_error,
919 @item pcie_aer_inject_error
920 @findex pcie_aer_inject_error
921 Inject PCIe AER error
925 .name = "host_net_add",
926 .args_type = "device:s,opts:s?",
927 .params = "tap|user|socket|vde|dump [options]",
928 .help = "add host VLAN client",
929 .mhandler.cmd = net_host_device_add,
935 Add host VLAN client.
939 .name = "host_net_remove",
940 .args_type = "vlan_id:i,device:s",
941 .params = "vlan_id name",
942 .help = "remove host VLAN client",
943 .mhandler.cmd = net_host_device_remove,
947 @item host_net_remove
948 @findex host_net_remove
949 Remove host VLAN client.
953 .name = "netdev_add",
954 .args_type = "netdev:O",
955 .params = "[user|tap|socket],id=str[,prop=value][,...]",
956 .help = "add host network device",
957 .user_print = monitor_user_noop,
958 .mhandler.cmd_new = do_netdev_add,
964 Add host network device.
968 .name = "netdev_del",
971 .help = "remove host network device",
972 .user_print = monitor_user_noop,
973 .mhandler.cmd_new = do_netdev_del,
979 Remove host network device.
984 .name = "hostfwd_add",
985 .args_type = "arg1:s,arg2:s?,arg3:s?",
986 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
987 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
988 .mhandler.cmd = net_slirp_hostfwd_add,
994 Redirect TCP or UDP connections from host to guest (requires -net user).
999 .name = "hostfwd_remove",
1000 .args_type = "arg1:s,arg2:s?,arg3:s?",
1001 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1002 .help = "remove host-to-guest TCP or UDP redirection",
1003 .mhandler.cmd = net_slirp_hostfwd_remove,
1008 @item hostfwd_remove
1009 @findex hostfwd_remove
1010 Remove host-to-guest TCP or UDP redirection.
1015 .args_type = "value:M",
1017 .help = "request VM to change its memory allocation (in MB)",
1018 .mhandler.cmd = hmp_balloon,
1022 @item balloon @var{value}
1024 Request VM to change its memory allocation to @var{value} (in MB).
1029 .args_type = "name:s,up:b",
1030 .params = "name on|off",
1031 .help = "change the link status of a network adapter",
1032 .mhandler.cmd = hmp_set_link,
1036 @item set_link @var{name} [on|off]
1038 Switch link @var{name} on (i.e. up) or off (i.e. down).
1042 .name = "watchdog_action",
1043 .args_type = "action:s",
1044 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1045 .help = "change watchdog action",
1046 .mhandler.cmd = do_watchdog_action,
1050 @item watchdog_action
1051 @findex watchdog_action
1052 Change watchdog action.
1057 .args_type = "aclname:s",
1058 .params = "aclname",
1059 .help = "list rules in the access control list",
1060 .mhandler.cmd = do_acl_show,
1064 @item acl_show @var{aclname}
1066 List all the matching rules in the access control list, and the default
1067 policy. There are currently two named access control lists,
1068 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1069 certificate distinguished name, and SASL username respectively.
1073 .name = "acl_policy",
1074 .args_type = "aclname:s,policy:s",
1075 .params = "aclname allow|deny",
1076 .help = "set default access control list policy",
1077 .mhandler.cmd = do_acl_policy,
1081 @item acl_policy @var{aclname} @code{allow|deny}
1083 Set the default access control list policy, used in the event that
1084 none of the explicit rules match. The default policy at startup is
1090 .args_type = "aclname:s,match:s,policy:s,index:i?",
1091 .params = "aclname match allow|deny [index]",
1092 .help = "add a match rule to the access control list",
1093 .mhandler.cmd = do_acl_add,
1097 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1099 Add a match rule to the access control list, allowing or denying access.
1100 The match will normally be an exact username or x509 distinguished name,
1101 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1102 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1103 normally be appended to the end of the ACL, but can be inserted
1104 earlier in the list if the optional @var{index} parameter is supplied.
1108 .name = "acl_remove",
1109 .args_type = "aclname:s,match:s",
1110 .params = "aclname match",
1111 .help = "remove a match rule from the access control list",
1112 .mhandler.cmd = do_acl_remove,
1116 @item acl_remove @var{aclname} @var{match}
1118 Remove the specified match rule from the access control list.
1122 .name = "acl_reset",
1123 .args_type = "aclname:s",
1124 .params = "aclname",
1125 .help = "reset the access control list",
1126 .mhandler.cmd = do_acl_reset,
1130 @item acl_reset @var{aclname}
1132 Remove all matches from the access control list, and set the default
1133 policy back to @code{deny}.
1136 #if defined(TARGET_I386)
1140 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1141 .params = "[-b] cpu bank status mcgstatus addr misc",
1142 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1143 .mhandler.cmd = do_inject_mce,
1148 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1150 Inject an MCE on the given CPU (x86 only).
1155 .args_type = "fdname:s",
1156 .params = "getfd name",
1157 .help = "receive a file descriptor via SCM rights and assign it a name",
1158 .user_print = monitor_user_noop,
1159 .mhandler.cmd_new = do_getfd,
1163 @item getfd @var{fdname}
1165 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1166 mechanism on unix sockets, it is stored using the name @var{fdname} for
1167 later use by other monitor commands.
1172 .args_type = "fdname:s",
1173 .params = "closefd name",
1174 .help = "close a file descriptor previously passed via SCM rights",
1175 .user_print = monitor_user_noop,
1176 .mhandler.cmd_new = do_closefd,
1180 @item closefd @var{fdname}
1182 Close the file descriptor previously assigned to @var{fdname} using the
1183 @code{getfd} command. This is only needed if the file descriptor was never
1184 used by another monitor command.
1188 .name = "block_passwd",
1189 .args_type = "device:B,password:s",
1190 .params = "block_passwd device password",
1191 .help = "set the password of encrypted block devices",
1192 .mhandler.cmd = hmp_block_passwd,
1196 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1197 @findex block_set_io_throttle
1198 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}
1202 .name = "block_set_io_throttle",
1203 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1204 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1205 .help = "change I/O throttle limits for a block drive",
1206 .user_print = monitor_user_noop,
1207 .mhandler.cmd_new = do_block_set_io_throttle,
1211 @item block_passwd @var{device} @var{password}
1212 @findex block_passwd
1213 Set the encrypted device @var{device} password to @var{password}
1217 .name = "set_password",
1218 .args_type = "protocol:s,password:s,connected:s?",
1219 .params = "protocol password action-if-connected",
1220 .help = "set spice/vnc password",
1221 .mhandler.cmd = hmp_set_password,
1225 @item set_password [ vnc | spice ] password [ action-if-connected ]
1226 @findex set_password
1228 Change spice/vnc password. Use zero to make the password stay valid
1229 forever. @var{action-if-connected} specifies what should happen in
1230 case a connection is established: @var{fail} makes the password change
1231 fail. @var{disconnect} changes the password and disconnects the
1232 client. @var{keep} changes the password and keeps the connection up.
1233 @var{keep} is the default.
1237 .name = "expire_password",
1238 .args_type = "protocol:s,time:s",
1239 .params = "protocol time",
1240 .help = "set spice/vnc password expire-time",
1241 .mhandler.cmd = hmp_expire_password,
1245 @item expire_password [ vnc | spice ] expire-time
1246 @findex expire_password
1248 Specify when a password for spice/vnc becomes
1249 invalid. @var{expire-time} accepts:
1253 Invalidate password instantly.
1256 Password stays valid forever.
1259 Password stays valid for @var{nsec} seconds starting now.
1262 Password is invalidated at the given time. @var{nsec} are the seconds
1263 passed since 1970, i.e. unix epoch.
1270 .args_type = "item:s?",
1271 .params = "[subcommand]",
1272 .help = "show various information about the system state",
1273 .mhandler.cmd = do_info,
1277 @item info @var{subcommand}
1279 Show various information about the system state.
1283 show the version of QEMU
1285 show the various VLANs and the associated devices
1287 show the character devices
1289 show the block devices
1290 @item info blockstats
1291 show block device statistics
1292 @item info registers
1293 show the cpu registers
1295 show infos for each CPU
1297 show the command line history
1299 show the interrupts statistics (if available)
1301 show i8259 (PIC) state
1303 show emulated PCI device info
1305 show virtual to physical memory mappings (i386, SH4, SPARC, and PPC only)
1307 show the active virtual memory mappings (i386 only)
1309 show dynamic compiler info
1311 show NUMA information
1313 show KVM information
1315 show USB devices plugged on the virtual USB hub
1317 show all USB host devices
1319 show profiling information
1321 show information about active capturing
1322 @item info snapshots
1323 show list of VM snapshots
1325 show the current VM status (running|paused)
1327 show guest PCMCIA status
1329 show which guest mouse is receiving events
1331 show the vnc server status
1333 show the current VM name
1335 show the current VM UUID
1339 show user network stack connection states
1341 show migration status
1343 show balloon information
1347 show qdev device model list
1353 #ifdef CONFIG_TRACE_SIMPLE
1356 show contents of trace buffer
1361 @item info trace-events
1362 show available trace events and their state