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.
73 .name = "block_stream",
74 .args_type = "device:B,base:s?",
75 .params = "device [base]",
76 .help = "copy data from a backing file into a block device",
77 .mhandler.cmd = hmp_block_stream,
83 Copy data from a backing file into a block device.
87 .name = "block_job_set_speed",
88 .args_type = "device:B,value:o",
89 .params = "device value",
90 .help = "set maximum speed for a background block operation",
91 .mhandler.cmd = hmp_block_job_set_speed,
95 @item block_job_set_stream
96 @findex block_job_set_stream
97 Set maximum speed for a background block operation.
102 .args_type = "force:-f,device:B",
103 .params = "[-f] device",
104 .help = "eject a removable medium (use -f to force it)",
105 .mhandler.cmd = hmp_eject,
109 @item eject [-f] @var{device}
111 Eject a removable medium (use -f to force it).
118 .help = "remove host block device",
119 .user_print = monitor_user_noop,
120 .mhandler.cmd_new = do_drive_del,
124 @item drive_del @var{device}
126 Remove host block device. The result is that guest generated IO is no longer
127 submitted against the host device underlying the disk. Once a drive has
128 been deleted, the QEMU Block layer returns -EIO which results in IO
129 errors in the guest for applications that are reading/writing to the device.
134 .args_type = "device:B,target:F,arg:s?",
135 .params = "device filename [format]",
136 .help = "change a removable medium, optional format",
137 .mhandler.cmd = hmp_change,
141 @item change @var{device} @var{setting}
144 Change the configuration of a device.
147 @item change @var{diskdevice} @var{filename} [@var{format}]
148 Change the medium for a removable disk device to point to @var{filename}. eg
151 (qemu) change ide1-cd0 /path/to/some.iso
154 @var{format} is optional.
156 @item change vnc @var{display},@var{options}
157 Change the configuration of the VNC server. The valid syntax for @var{display}
158 and @var{options} are described at @ref{sec_invocation}. eg
161 (qemu) change vnc localhost:1
164 @item change vnc password [@var{password}]
166 Change the password associated with the VNC server. If the new password is not
167 supplied, the monitor will prompt for it to be entered. VNC passwords are only
168 significant up to 8 letters. eg
171 (qemu) change vnc password
179 .name = "screendump",
180 .args_type = "filename:F",
181 .params = "filename",
182 .help = "save screen into PPM image 'filename'",
183 .user_print = monitor_user_noop,
184 .mhandler.cmd_new = do_screen_dump,
188 @item screendump @var{filename}
190 Save screen into PPM image @var{filename}.
195 .args_type = "filename:F",
196 .params = "filename",
197 .help = "output logs to 'filename'",
198 .mhandler.cmd = do_logfile,
202 @item logfile @var{filename}
204 Output logs to @var{filename}.
208 .name = "trace-event",
209 .args_type = "name:s,option:b",
210 .params = "name on|off",
211 .help = "changes status of a specific trace event",
212 .mhandler.cmd = do_trace_event_set_state,
218 changes status of a trace event
221 #if defined(CONFIG_TRACE_SIMPLE)
223 .name = "trace-file",
224 .args_type = "op:s?,arg:F?",
225 .params = "on|off|flush|set [arg]",
226 .help = "open, close, or flush trace file, or set a new file name",
227 .mhandler.cmd = do_trace_file,
231 @item trace-file on|off|flush
233 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
239 .args_type = "items:s",
240 .params = "item1[,...]",
241 .help = "activate logging of the specified items to '/tmp/qemu.log'",
242 .mhandler.cmd = do_log,
246 @item log @var{item1}[,...]
248 Activate logging of the specified items to @file{/tmp/qemu.log}.
253 .args_type = "name:s?",
254 .params = "[tag|id]",
255 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
256 .mhandler.cmd = do_savevm,
260 @item savevm [@var{tag}|@var{id}]
262 Create a snapshot of the whole virtual machine. If @var{tag} is
263 provided, it is used as human readable identifier. If there is already
264 a snapshot with the same tag or ID, it is replaced. More info at
270 .args_type = "name:s",
272 .help = "restore a VM snapshot from its tag or id",
273 .mhandler.cmd = do_loadvm,
277 @item loadvm @var{tag}|@var{id}
279 Set the whole virtual machine to the snapshot identified by the tag
280 @var{tag} or the unique snapshot ID @var{id}.
285 .args_type = "name:s",
287 .help = "delete a VM snapshot from its tag or id",
288 .mhandler.cmd = do_delvm,
292 @item delvm @var{tag}|@var{id}
294 Delete the snapshot identified by @var{tag} or @var{id}.
298 .name = "singlestep",
299 .args_type = "option:s?",
300 .params = "[on|off]",
301 .help = "run emulation in singlestep mode or switch to normal mode",
302 .mhandler.cmd = do_singlestep,
306 @item singlestep [off]
308 Run the emulation in single step mode.
309 If called with option off, the emulation returns to normal mode.
316 .help = "stop emulation",
317 .mhandler.cmd = hmp_stop,
330 .help = "resume emulation",
331 .mhandler.cmd = hmp_cont,
342 .args_type = "device:s?",
343 .params = "[device]",
344 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
345 .mhandler.cmd = do_gdbserver,
349 @item gdbserver [@var{port}]
351 Start gdbserver session (default @var{port}=1234)
356 .args_type = "fmt:/,addr:l",
357 .params = "/fmt addr",
358 .help = "virtual memory dump starting at 'addr'",
359 .mhandler.cmd = do_memory_dump,
363 @item x/fmt @var{addr}
365 Virtual memory dump starting at @var{addr}.
370 .args_type = "fmt:/,addr:l",
371 .params = "/fmt addr",
372 .help = "physical memory dump starting at 'addr'",
373 .mhandler.cmd = do_physical_memory_dump,
377 @item xp /@var{fmt} @var{addr}
379 Physical memory dump starting at @var{addr}.
381 @var{fmt} is a format which tells the command how to format the
382 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
386 is the number of items to be dumped.
389 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
390 c (char) or i (asm instruction).
393 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
394 @code{h} or @code{w} can be specified with the @code{i} format to
395 respectively select 16 or 32 bit code instruction size.
402 Dump 10 instructions at the current instruction pointer:
407 0x90107065: lea 0x0(%esi,1),%esi
408 0x90107069: lea 0x0(%edi,1),%edi
410 0x90107071: jmp 0x90107080
418 Dump 80 16 bit values at the start of the video memory.
420 (qemu) xp/80hx 0xb8000
421 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
422 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
423 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
424 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
425 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
426 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
427 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
428 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
429 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
430 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
437 .args_type = "fmt:/,val:l",
438 .params = "/fmt expr",
439 .help = "print expression value (use $reg for CPU register access)",
440 .mhandler.cmd = do_print,
444 @item p or print/@var{fmt} @var{expr}
447 Print expression value. Only the @var{format} part of @var{fmt} is
453 .args_type = "fmt:/,addr:i,index:i.",
454 .params = "/fmt addr",
455 .help = "I/O port read",
456 .mhandler.cmd = do_ioport_read,
465 .args_type = "fmt:/,addr:i,val:i",
466 .params = "/fmt addr value",
467 .help = "I/O port write",
468 .mhandler.cmd = do_ioport_write,
477 .args_type = "string:s,hold_time:i?",
478 .params = "keys [hold_ms]",
479 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
480 .mhandler.cmd = do_sendkey,
484 @item sendkey @var{keys}
487 Send @var{keys} to the emulator. @var{keys} could be the name of the
488 key or @code{#} followed by the raw value in either decimal or hexadecimal
489 format. Use @code{-} to press several keys simultaneously. Example:
494 This command is useful to send keys that your graphical user interface
495 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
499 .name = "system_reset",
502 .help = "reset the system",
503 .mhandler.cmd = hmp_system_reset,
514 .name = "system_powerdown",
517 .help = "send system power down event",
518 .mhandler.cmd = hmp_system_powerdown,
522 @item system_powerdown
523 @findex system_powerdown
525 Power down the system (if supported).
530 .args_type = "start:i,size:i",
531 .params = "addr size",
532 .help = "compute the checksum of a memory region",
533 .mhandler.cmd = do_sum,
537 @item sum @var{addr} @var{size}
540 Compute the checksum of a memory region.
545 .args_type = "devname:s",
547 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
548 .mhandler.cmd = do_usb_add,
552 @item usb_add @var{devname}
555 Add the USB device @var{devname}. For details of available devices see
561 .args_type = "devname:s",
563 .help = "remove USB device 'bus.addr'",
564 .mhandler.cmd = do_usb_del,
568 @item usb_del @var{devname}
571 Remove the USB device @var{devname} from the QEMU virtual USB
572 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
573 command @code{info usb} to see the devices you can remove.
577 .name = "device_add",
578 .args_type = "device:O",
579 .params = "driver[,prop=value][,...]",
580 .help = "add device, like -device on the command line",
581 .user_print = monitor_user_noop,
582 .mhandler.cmd_new = do_device_add,
586 @item device_add @var{config}
593 .name = "device_del",
596 .help = "remove device",
597 .user_print = monitor_user_noop,
598 .mhandler.cmd_new = do_device_del,
602 @item device_del @var{id}
605 Remove device @var{id}.
610 .args_type = "index:i",
612 .help = "set the default CPU",
613 .mhandler.cmd = hmp_cpu,
617 @item cpu @var{index}
623 .name = "mouse_move",
624 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
625 .params = "dx dy [dz]",
626 .help = "send mouse move events",
627 .mhandler.cmd = do_mouse_move,
631 @item mouse_move @var{dx} @var{dy} [@var{dz}]
633 Move the active mouse to the specified coordinates @var{dx} @var{dy}
634 with optional scroll axis @var{dz}.
638 .name = "mouse_button",
639 .args_type = "button_state:i",
641 .help = "change mouse button state (1=L, 2=M, 4=R)",
642 .mhandler.cmd = do_mouse_button,
646 @item mouse_button @var{val}
648 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
653 .args_type = "index:i",
655 .help = "set which mouse device receives events",
656 .mhandler.cmd = do_mouse_set,
660 @item mouse_set @var{index}
662 Set which mouse device receives events at given @var{index}, index
671 .name = "wavcapture",
672 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
673 .params = "path [frequency [bits [channels]]]",
674 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
675 .mhandler.cmd = do_wav_capture,
679 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
681 Capture audio into @var{filename}. Using sample rate @var{frequency}
682 bits per sample @var{bits} and number of channels @var{channels}.
686 @item Sample rate = 44100 Hz - CD quality
688 @item Number of channels = 2 - Stereo
694 .name = "stopcapture",
696 .params = "capture index",
697 .help = "stop capture",
698 .mhandler.cmd = do_stop_capture,
702 @item stopcapture @var{index}
704 Stop capture with a given @var{index}, index can be obtained with
712 .args_type = "val:l,size:i,filename:s",
713 .params = "addr size file",
714 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
715 .mhandler.cmd = hmp_memsave,
719 @item memsave @var{addr} @var{size} @var{file}
721 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
726 .args_type = "val:l,size:i,filename:s",
727 .params = "addr size file",
728 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
729 .mhandler.cmd = hmp_pmemsave,
733 @item pmemsave @var{addr} @var{size} @var{file}
735 save to disk physical memory dump starting at @var{addr} of size @var{size}.
740 .args_type = "bootdevice:s",
741 .params = "bootdevice",
742 .help = "define new values for the boot device list",
743 .mhandler.cmd = do_boot_set,
747 @item boot_set @var{bootdevicelist}
750 Define new values for the boot device list. Those values will override
751 the values specified on the command line through the @code{-boot} option.
753 The values that can be specified here depend on the machine type, but are
754 the same that can be specified in the @code{-boot} command line option.
757 #if defined(TARGET_I386)
762 .help = "inject an NMI on all guest's CPUs",
763 .mhandler.cmd = hmp_inject_nmi,
769 Inject an NMI on the given CPU (x86 only).
774 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
775 .params = "[-d] [-b] [-i] uri",
776 .help = "migrate to URI (using -d to not wait for completion)"
777 "\n\t\t\t -b for migration without shared storage with"
778 " full copy of disk\n\t\t\t -i for migration without "
779 "shared storage with incremental copy of disk "
780 "(base image shared between src and destination)",
781 .user_print = monitor_user_noop,
782 .mhandler.cmd_new = do_migrate,
787 @item migrate [-d] [-b] [-i] @var{uri}
789 Migrate to @var{uri} (using -d to not wait for completion).
790 -b for migration with full copy of disk
791 -i for migration with incremental copy of disk (base image is shared)
795 .name = "migrate_cancel",
798 .help = "cancel the current VM migration",
799 .mhandler.cmd = hmp_migrate_cancel,
804 @findex migrate_cancel
805 Cancel the current VM migration.
809 .name = "migrate_set_speed",
810 .args_type = "value:o",
812 .help = "set maximum speed (in bytes) for migrations. "
813 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
814 .mhandler.cmd = hmp_migrate_set_speed,
818 @item migrate_set_speed @var{value}
819 @findex migrate_set_speed
820 Set maximum speed to @var{value} (in bytes) for migrations.
824 .name = "migrate_set_downtime",
825 .args_type = "value:T",
827 .help = "set maximum tolerated downtime (in seconds) for migrations",
828 .mhandler.cmd = hmp_migrate_set_downtime,
832 @item migrate_set_downtime @var{second}
833 @findex migrate_set_downtime
834 Set maximum tolerated downtime (in seconds) for migration.
838 .name = "client_migrate_info",
839 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
840 .params = "protocol hostname port tls-port cert-subject",
841 .help = "send migration info to spice/vnc client",
842 .user_print = monitor_user_noop,
843 .mhandler.cmd_async = client_migrate_info,
844 .flags = MONITOR_CMD_ASYNC,
848 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
849 @findex client_migrate_info
850 Set the spice/vnc connection info for the migration target. The spice/vnc
851 server will ask the spice/vnc client to automatically reconnect using the
852 new parameters (if specified) once the vm migration finished successfully.
856 .name = "snapshot_blkdev",
857 .args_type = "device:B,snapshot-file:s?,format:s?",
858 .params = "device [new-image-file] [format]",
859 .help = "initiates a live snapshot\n\t\t\t"
860 "of device. If a new image file is specified, the\n\t\t\t"
861 "new image file will become the new root image.\n\t\t\t"
862 "If format is specified, the snapshot file will\n\t\t\t"
863 "be created in that format. Otherwise the\n\t\t\t"
864 "snapshot will be internal! (currently unsupported)",
865 .mhandler.cmd = hmp_snapshot_blkdev,
869 @item snapshot_blkdev
870 @findex snapshot_blkdev
871 Snapshot device, using snapshot file as target if provided
876 .args_type = "pci_addr:s,opts:s",
877 .params = "[[<domain>:]<bus>:]<slot>\n"
878 "[file=file][,if=type][,bus=n]\n"
879 "[,unit=m][,media=d][,index=i]\n"
880 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
881 "[,snapshot=on|off][,cache=on|off]\n"
882 "[,readonly=on|off][,copy-on-read=on|off]",
883 .help = "add drive to PCI storage controller",
884 .mhandler.cmd = drive_hot_add,
890 Add drive to PCI storage controller.
893 #if defined(TARGET_I386)
896 .args_type = "pci_addr:s,type:s,opts:s?",
897 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
898 .help = "hot-add PCI device",
899 .mhandler.cmd = pci_device_hot_add,
909 #if defined(TARGET_I386)
912 .args_type = "pci_addr:s",
913 .params = "[[<domain>:]<bus>:]<slot>",
914 .help = "hot remove PCI device",
915 .mhandler.cmd = do_pci_device_hot_remove,
922 Hot remove PCI device.
926 .name = "pcie_aer_inject_error",
927 .args_type = "advisory_non_fatal:-a,correctable:-c,"
928 "id:s,error_status:s,"
929 "header0:i?,header1:i?,header2:i?,header3:i?,"
930 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
931 .params = "[-a] [-c] id "
932 "<error_status> [<tlp header> [<tlp header prefix>]]",
933 .help = "inject pcie aer error\n\t\t\t"
934 " -a for advisory non fatal error\n\t\t\t"
935 " -c for correctable error\n\t\t\t"
936 "<id> = qdev device id\n\t\t\t"
937 "<error_status> = error string or 32bit\n\t\t\t"
938 "<tlb header> = 32bit x 4\n\t\t\t"
939 "<tlb header prefix> = 32bit x 4",
940 .user_print = pcie_aer_inject_error_print,
941 .mhandler.cmd_new = do_pcie_aer_inject_error,
945 @item pcie_aer_inject_error
946 @findex pcie_aer_inject_error
947 Inject PCIe AER error
951 .name = "host_net_add",
952 .args_type = "device:s,opts:s?",
953 .params = "tap|user|socket|vde|dump [options]",
954 .help = "add host VLAN client",
955 .mhandler.cmd = net_host_device_add,
961 Add host VLAN client.
965 .name = "host_net_remove",
966 .args_type = "vlan_id:i,device:s",
967 .params = "vlan_id name",
968 .help = "remove host VLAN client",
969 .mhandler.cmd = net_host_device_remove,
973 @item host_net_remove
974 @findex host_net_remove
975 Remove host VLAN client.
979 .name = "netdev_add",
980 .args_type = "netdev:O",
981 .params = "[user|tap|socket],id=str[,prop=value][,...]",
982 .help = "add host network device",
983 .user_print = monitor_user_noop,
984 .mhandler.cmd_new = do_netdev_add,
990 Add host network device.
994 .name = "netdev_del",
997 .help = "remove host network device",
998 .user_print = monitor_user_noop,
999 .mhandler.cmd_new = do_netdev_del,
1005 Remove host network device.
1010 .name = "hostfwd_add",
1011 .args_type = "arg1:s,arg2:s?,arg3:s?",
1012 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1013 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1014 .mhandler.cmd = net_slirp_hostfwd_add,
1020 Redirect TCP or UDP connections from host to guest (requires -net user).
1025 .name = "hostfwd_remove",
1026 .args_type = "arg1:s,arg2:s?,arg3:s?",
1027 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1028 .help = "remove host-to-guest TCP or UDP redirection",
1029 .mhandler.cmd = net_slirp_hostfwd_remove,
1034 @item hostfwd_remove
1035 @findex hostfwd_remove
1036 Remove host-to-guest TCP or UDP redirection.
1041 .args_type = "value:M",
1043 .help = "request VM to change its memory allocation (in MB)",
1044 .mhandler.cmd = hmp_balloon,
1048 @item balloon @var{value}
1050 Request VM to change its memory allocation to @var{value} (in MB).
1055 .args_type = "name:s,up:b",
1056 .params = "name on|off",
1057 .help = "change the link status of a network adapter",
1058 .mhandler.cmd = hmp_set_link,
1062 @item set_link @var{name} [on|off]
1064 Switch link @var{name} on (i.e. up) or off (i.e. down).
1068 .name = "watchdog_action",
1069 .args_type = "action:s",
1070 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1071 .help = "change watchdog action",
1072 .mhandler.cmd = do_watchdog_action,
1076 @item watchdog_action
1077 @findex watchdog_action
1078 Change watchdog action.
1083 .args_type = "aclname:s",
1084 .params = "aclname",
1085 .help = "list rules in the access control list",
1086 .mhandler.cmd = do_acl_show,
1090 @item acl_show @var{aclname}
1092 List all the matching rules in the access control list, and the default
1093 policy. There are currently two named access control lists,
1094 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1095 certificate distinguished name, and SASL username respectively.
1099 .name = "acl_policy",
1100 .args_type = "aclname:s,policy:s",
1101 .params = "aclname allow|deny",
1102 .help = "set default access control list policy",
1103 .mhandler.cmd = do_acl_policy,
1107 @item acl_policy @var{aclname} @code{allow|deny}
1109 Set the default access control list policy, used in the event that
1110 none of the explicit rules match. The default policy at startup is
1116 .args_type = "aclname:s,match:s,policy:s,index:i?",
1117 .params = "aclname match allow|deny [index]",
1118 .help = "add a match rule to the access control list",
1119 .mhandler.cmd = do_acl_add,
1123 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1125 Add a match rule to the access control list, allowing or denying access.
1126 The match will normally be an exact username or x509 distinguished name,
1127 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1128 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1129 normally be appended to the end of the ACL, but can be inserted
1130 earlier in the list if the optional @var{index} parameter is supplied.
1134 .name = "acl_remove",
1135 .args_type = "aclname:s,match:s",
1136 .params = "aclname match",
1137 .help = "remove a match rule from the access control list",
1138 .mhandler.cmd = do_acl_remove,
1142 @item acl_remove @var{aclname} @var{match}
1144 Remove the specified match rule from the access control list.
1148 .name = "acl_reset",
1149 .args_type = "aclname:s",
1150 .params = "aclname",
1151 .help = "reset the access control list",
1152 .mhandler.cmd = do_acl_reset,
1156 @item acl_reset @var{aclname}
1158 Remove all matches from the access control list, and set the default
1159 policy back to @code{deny}.
1162 #if defined(TARGET_I386)
1166 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1167 .params = "[-b] cpu bank status mcgstatus addr misc",
1168 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1169 .mhandler.cmd = do_inject_mce,
1174 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1176 Inject an MCE on the given CPU (x86 only).
1181 .args_type = "fdname:s",
1182 .params = "getfd name",
1183 .help = "receive a file descriptor via SCM rights and assign it a name",
1184 .user_print = monitor_user_noop,
1185 .mhandler.cmd_new = do_getfd,
1189 @item getfd @var{fdname}
1191 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1192 mechanism on unix sockets, it is stored using the name @var{fdname} for
1193 later use by other monitor commands.
1198 .args_type = "fdname:s",
1199 .params = "closefd name",
1200 .help = "close a file descriptor previously passed via SCM rights",
1201 .user_print = monitor_user_noop,
1202 .mhandler.cmd_new = do_closefd,
1206 @item closefd @var{fdname}
1208 Close the file descriptor previously assigned to @var{fdname} using the
1209 @code{getfd} command. This is only needed if the file descriptor was never
1210 used by another monitor command.
1214 .name = "block_passwd",
1215 .args_type = "device:B,password:s",
1216 .params = "block_passwd device password",
1217 .help = "set the password of encrypted block devices",
1218 .mhandler.cmd = hmp_block_passwd,
1222 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1223 @findex block_set_io_throttle
1224 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}
1228 .name = "block_set_io_throttle",
1229 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1230 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1231 .help = "change I/O throttle limits for a block drive",
1232 .mhandler.cmd = hmp_block_set_io_throttle,
1236 @item block_passwd @var{device} @var{password}
1237 @findex block_passwd
1238 Set the encrypted device @var{device} password to @var{password}
1242 .name = "set_password",
1243 .args_type = "protocol:s,password:s,connected:s?",
1244 .params = "protocol password action-if-connected",
1245 .help = "set spice/vnc password",
1246 .mhandler.cmd = hmp_set_password,
1250 @item set_password [ vnc | spice ] password [ action-if-connected ]
1251 @findex set_password
1253 Change spice/vnc password. Use zero to make the password stay valid
1254 forever. @var{action-if-connected} specifies what should happen in
1255 case a connection is established: @var{fail} makes the password change
1256 fail. @var{disconnect} changes the password and disconnects the
1257 client. @var{keep} changes the password and keeps the connection up.
1258 @var{keep} is the default.
1262 .name = "expire_password",
1263 .args_type = "protocol:s,time:s",
1264 .params = "protocol time",
1265 .help = "set spice/vnc password expire-time",
1266 .mhandler.cmd = hmp_expire_password,
1270 @item expire_password [ vnc | spice ] expire-time
1271 @findex expire_password
1273 Specify when a password for spice/vnc becomes
1274 invalid. @var{expire-time} accepts:
1278 Invalidate password instantly.
1281 Password stays valid forever.
1284 Password stays valid for @var{nsec} seconds starting now.
1287 Password is invalidated at the given time. @var{nsec} are the seconds
1288 passed since 1970, i.e. unix epoch.
1295 .args_type = "item:s?",
1296 .params = "[subcommand]",
1297 .help = "show various information about the system state",
1298 .mhandler.cmd = do_info,
1302 @item info @var{subcommand}
1304 Show various information about the system state.
1308 show the version of QEMU
1310 show the various VLANs and the associated devices
1312 show the character devices
1314 show the block devices
1315 @item info blockstats
1316 show block device statistics
1317 @item info registers
1318 show the cpu registers
1320 show infos for each CPU
1322 show the command line history
1324 show the interrupts statistics (if available)
1326 show i8259 (PIC) state
1328 show emulated PCI device info
1330 show virtual to physical memory mappings (i386, SH4, SPARC, and PPC only)
1332 show the active virtual memory mappings (i386 only)
1334 show dynamic compiler info
1336 show NUMA information
1338 show KVM information
1340 show USB devices plugged on the virtual USB hub
1342 show all USB host devices
1344 show profiling information
1346 show information about active capturing
1347 @item info snapshots
1348 show list of VM snapshots
1350 show the current VM status (running|paused)
1352 show guest PCMCIA status
1354 show which guest mouse is receiving events
1356 show the vnc server status
1358 show the current VM name
1360 show the current VM UUID
1364 show user network stack connection states
1366 show migration status
1368 show balloon information
1372 show qdev device model list
1378 #ifdef CONFIG_TRACE_SIMPLE
1381 show contents of trace buffer
1386 @item info trace-events
1387 show available trace events and their state