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 = hmp_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.
49 .help = "quit the emulator",
50 .mhandler.cmd = hmp_quit,
60 .name = "block_resize",
61 .args_type = "device:B,size:o",
62 .params = "device size",
63 .help = "resize a block image",
64 .mhandler.cmd = hmp_block_resize,
70 Resize a block image while a guest is running. Usually requires guest
71 action to see the updated size. Resize to a lower size is supported,
72 but should be used with extreme caution. Note that this command only
73 resizes image files, it can not resize block devices like LVM volumes.
77 .name = "block_stream",
78 .args_type = "device:B,speed:o?,base:s?",
79 .params = "device [speed [base]]",
80 .help = "copy data from a backing file into a block device",
81 .mhandler.cmd = hmp_block_stream,
87 Copy data from a backing file into a block device.
91 .name = "block_job_set_speed",
92 .args_type = "device:B,speed:o",
93 .params = "device speed",
94 .help = "set maximum speed for a background block operation",
95 .mhandler.cmd = hmp_block_job_set_speed,
99 @item block_job_set_speed
100 @findex block_job_set_speed
101 Set maximum speed for a background block operation.
105 .name = "block_job_cancel",
106 .args_type = "force:-f,device:B",
107 .params = "[-f] device",
108 .help = "stop an active background block operation (use -f"
109 "\n\t\t\t if the operation is currently paused)",
110 .mhandler.cmd = hmp_block_job_cancel,
114 @item block_job_cancel
115 @findex block_job_cancel
116 Stop an active background block operation (streaming, mirroring).
120 .name = "block_job_complete",
121 .args_type = "device:B",
123 .help = "stop an active background block operation",
124 .mhandler.cmd = hmp_block_job_complete,
128 @item block_job_complete
129 @findex block_job_complete
130 Manually trigger completion of an active background block operation.
131 For mirroring, this will switch the device to the destination path.
135 .name = "block_job_pause",
136 .args_type = "device:B",
138 .help = "pause an active background block operation",
139 .mhandler.cmd = hmp_block_job_pause,
143 @item block_job_pause
144 @findex block_job_pause
145 Pause an active block streaming operation.
149 .name = "block_job_resume",
150 .args_type = "device:B",
152 .help = "resume a paused background block operation",
153 .mhandler.cmd = hmp_block_job_resume,
157 @item block_job_resume
158 @findex block_job_resume
159 Resume a paused block streaming operation.
164 .args_type = "force:-f,device:B",
165 .params = "[-f] device",
166 .help = "eject a removable medium (use -f to force it)",
167 .mhandler.cmd = hmp_eject,
171 @item eject [-f] @var{device}
173 Eject a removable medium (use -f to force it).
180 .help = "remove host block device",
181 .mhandler.cmd = hmp_drive_del,
185 @item drive_del @var{device}
187 Remove host block device. The result is that guest generated IO is no longer
188 submitted against the host device underlying the disk. Once a drive has
189 been deleted, the QEMU Block layer returns -EIO which results in IO
190 errors in the guest for applications that are reading/writing to the device.
191 These errors are always reported to the guest, regardless of the drive's error
192 actions (drive options rerror, werror).
197 .args_type = "device:B,target:F,arg:s?",
198 .params = "device filename [format]",
199 .help = "change a removable medium, optional format",
200 .mhandler.cmd = hmp_change,
204 @item change @var{device} @var{setting}
206 Change the configuration of a device.
209 @item change @var{diskdevice} @var{filename} [@var{format}]
210 Change the medium for a removable disk device to point to @var{filename}. eg
213 (qemu) change ide1-cd0 /path/to/some.iso
216 @var{format} is optional.
218 @item change vnc @var{display},@var{options}
219 Change the configuration of the VNC server. The valid syntax for @var{display}
220 and @var{options} are described at @ref{sec_invocation}. eg
223 (qemu) change vnc localhost:1
226 @item change vnc password [@var{password}]
228 Change the password associated with the VNC server. If the new password is not
229 supplied, the monitor will prompt for it to be entered. VNC passwords are only
230 significant up to 8 letters. eg
233 (qemu) change vnc password
241 .name = "screendump",
242 .args_type = "filename:F",
243 .params = "filename",
244 .help = "save screen into PPM image 'filename'",
245 .mhandler.cmd = hmp_screendump,
249 @item screendump @var{filename}
251 Save screen into PPM image @var{filename}.
256 .args_type = "filename:F",
257 .params = "filename",
258 .help = "output logs to 'filename'",
259 .mhandler.cmd = hmp_logfile,
263 @item logfile @var{filename}
265 Output logs to @var{filename}.
269 .name = "trace-event",
270 .args_type = "name:s,option:b",
271 .params = "name on|off",
272 .help = "changes status of a specific trace event",
273 .mhandler.cmd = hmp_trace_event,
279 changes status of a trace event
282 #if defined(CONFIG_TRACE_SIMPLE)
284 .name = "trace-file",
285 .args_type = "op:s?,arg:F?",
286 .params = "on|off|flush|set [arg]",
287 .help = "open, close, or flush trace file, or set a new file name",
288 .mhandler.cmd = hmp_trace_file,
292 @item trace-file on|off|flush
294 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
300 .args_type = "items:s",
301 .params = "item1[,...]",
302 .help = "activate logging of the specified items",
303 .mhandler.cmd = hmp_log,
307 @item log @var{item1}[,...]
309 Activate logging of the specified items.
314 .args_type = "name:s?",
315 .params = "[tag|id]",
316 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
317 .mhandler.cmd = hmp_savevm,
321 @item savevm [@var{tag}|@var{id}]
323 Create a snapshot of the whole virtual machine. If @var{tag} is
324 provided, it is used as human readable identifier. If there is already
325 a snapshot with the same tag or ID, it is replaced. More info at
331 .args_type = "name:s",
333 .help = "restore a VM snapshot from its tag or id",
334 .mhandler.cmd = hmp_loadvm,
335 .command_completion = loadvm_completion,
339 @item loadvm @var{tag}|@var{id}
341 Set the whole virtual machine to the snapshot identified by the tag
342 @var{tag} or the unique snapshot ID @var{id}.
347 .args_type = "name:s",
349 .help = "delete a VM snapshot from its tag or id",
350 .mhandler.cmd = hmp_delvm,
351 .command_completion = delvm_completion,
355 @item delvm @var{tag}|@var{id}
357 Delete the snapshot identified by @var{tag} or @var{id}.
361 .name = "singlestep",
362 .args_type = "option:s?",
363 .params = "[on|off]",
364 .help = "run emulation in singlestep mode or switch to normal mode",
365 .mhandler.cmd = hmp_singlestep,
369 @item singlestep [off]
371 Run the emulation in single step mode.
372 If called with option off, the emulation returns to normal mode.
379 .help = "stop emulation",
380 .mhandler.cmd = hmp_stop,
393 .help = "resume emulation",
394 .mhandler.cmd = hmp_cont,
404 .name = "system_wakeup",
407 .help = "wakeup guest from suspend",
408 .mhandler.cmd = hmp_system_wakeup,
413 @findex system_wakeup
414 Wakeup guest from suspend.
419 .args_type = "device:s?",
420 .params = "[device]",
421 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
422 .mhandler.cmd = hmp_gdbserver,
426 @item gdbserver [@var{port}]
428 Start gdbserver session (default @var{port}=1234)
433 .args_type = "fmt:/,addr:l",
434 .params = "/fmt addr",
435 .help = "virtual memory dump starting at 'addr'",
436 .mhandler.cmd = hmp_memory_dump,
440 @item x/fmt @var{addr}
442 Virtual memory dump starting at @var{addr}.
447 .args_type = "fmt:/,addr:l",
448 .params = "/fmt addr",
449 .help = "physical memory dump starting at 'addr'",
450 .mhandler.cmd = hmp_physical_memory_dump,
454 @item xp /@var{fmt} @var{addr}
456 Physical memory dump starting at @var{addr}.
458 @var{fmt} is a format which tells the command how to format the
459 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
463 is the number of items to be dumped.
466 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
467 c (char) or i (asm instruction).
470 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
471 @code{h} or @code{w} can be specified with the @code{i} format to
472 respectively select 16 or 32 bit code instruction size.
479 Dump 10 instructions at the current instruction pointer:
484 0x90107065: lea 0x0(%esi,1),%esi
485 0x90107069: lea 0x0(%edi,1),%edi
487 0x90107071: jmp 0x90107080
495 Dump 80 16 bit values at the start of the video memory.
497 (qemu) xp/80hx 0xb8000
498 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
499 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
500 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
501 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
502 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
503 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
504 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
505 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
506 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
507 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
514 .args_type = "fmt:/,val:l",
515 .params = "/fmt expr",
516 .help = "print expression value (use $reg for CPU register access)",
517 .mhandler.cmd = do_print,
521 @item p or print/@var{fmt} @var{expr}
523 Print expression value. Only the @var{format} part of @var{fmt} is
529 .args_type = "fmt:/,addr:i,index:i.",
530 .params = "/fmt addr",
531 .help = "I/O port read",
532 .mhandler.cmd = hmp_ioport_read,
536 @item i/@var{fmt} @var{addr} [.@var{index}]
543 .args_type = "fmt:/,addr:i,val:i",
544 .params = "/fmt addr value",
545 .help = "I/O port write",
546 .mhandler.cmd = hmp_ioport_write,
550 @item o/@var{fmt} @var{addr} @var{val}
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,
565 @item sendkey @var{keys}
567 Send @var{keys} to the guest. @var{keys} could be the name of the
568 key or the raw value in hexadecimal format. Use @code{-} to press
569 several keys simultaneously. Example:
574 This command is useful to send keys that your graphical user interface
575 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
579 .name = "system_reset",
582 .help = "reset the system",
583 .mhandler.cmd = hmp_system_reset,
593 .name = "system_powerdown",
596 .help = "send system power down event",
597 .mhandler.cmd = hmp_system_powerdown,
601 @item system_powerdown
602 @findex system_powerdown
603 Power down the system (if supported).
608 .args_type = "start:i,size:i",
609 .params = "addr size",
610 .help = "compute the checksum of a memory region",
611 .mhandler.cmd = hmp_sum,
615 @item sum @var{addr} @var{size}
617 Compute the checksum of a memory region.
622 .args_type = "devname:s",
624 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
625 .mhandler.cmd = hmp_usb_add,
629 @item usb_add @var{devname}
631 Add the USB device @var{devname}. For details of available devices see
637 .args_type = "devname:s",
639 .help = "remove USB device 'bus.addr'",
640 .mhandler.cmd = hmp_usb_del,
644 @item usb_del @var{devname}
646 Remove the USB device @var{devname} from the QEMU virtual USB
647 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
648 command @code{info usb} to see the devices you can remove.
652 .name = "device_add",
653 .args_type = "device:O",
654 .params = "driver[,prop=value][,...]",
655 .help = "add device, like -device on the command line",
656 .mhandler.cmd = hmp_device_add,
657 .command_completion = device_add_completion,
661 @item device_add @var{config}
667 .name = "device_del",
670 .help = "remove device",
671 .mhandler.cmd = hmp_device_del,
672 .command_completion = device_del_completion,
676 @item device_del @var{id}
678 Remove device @var{id}.
683 .args_type = "index:i",
685 .help = "set the default CPU",
686 .mhandler.cmd = hmp_cpu,
690 @item cpu @var{index}
696 .name = "mouse_move",
697 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
698 .params = "dx dy [dz]",
699 .help = "send mouse move events",
700 .mhandler.cmd = hmp_mouse_move,
704 @item mouse_move @var{dx} @var{dy} [@var{dz}]
706 Move the active mouse to the specified coordinates @var{dx} @var{dy}
707 with optional scroll axis @var{dz}.
711 .name = "mouse_button",
712 .args_type = "button_state:i",
714 .help = "change mouse button state (1=L, 2=M, 4=R)",
715 .mhandler.cmd = hmp_mouse_button,
719 @item mouse_button @var{val}
721 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
726 .args_type = "index:i",
728 .help = "set which mouse device receives events",
729 .mhandler.cmd = hmp_mouse_set,
733 @item mouse_set @var{index}
735 Set which mouse device receives events at given @var{index}, index
743 .name = "wavcapture",
744 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
745 .params = "path [frequency [bits [channels]]]",
746 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
747 .mhandler.cmd = hmp_wavcapture,
750 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
752 Capture audio into @var{filename}. Using sample rate @var{frequency}
753 bits per sample @var{bits} and number of channels @var{channels}.
757 @item Sample rate = 44100 Hz - CD quality
759 @item Number of channels = 2 - Stereo
764 .name = "stopcapture",
766 .params = "capture index",
767 .help = "stop capture",
768 .mhandler.cmd = hmp_stopcapture,
771 @item stopcapture @var{index}
773 Stop capture with a given @var{index}, index can be obtained with
781 .args_type = "val:l,size:i,filename:s",
782 .params = "addr size file",
783 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
784 .mhandler.cmd = hmp_memsave,
788 @item memsave @var{addr} @var{size} @var{file}
790 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
795 .args_type = "val:l,size:i,filename:s",
796 .params = "addr size file",
797 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
798 .mhandler.cmd = hmp_pmemsave,
802 @item pmemsave @var{addr} @var{size} @var{file}
804 save to disk physical memory dump starting at @var{addr} of size @var{size}.
809 .args_type = "bootdevice:s",
810 .params = "bootdevice",
811 .help = "define new values for the boot device list",
812 .mhandler.cmd = hmp_boot_set,
816 @item boot_set @var{bootdevicelist}
818 Define new values for the boot device list. Those values will override
819 the values specified on the command line through the @code{-boot} option.
821 The values that can be specified here depend on the machine type, but are
822 the same that can be specified in the @code{-boot} command line option.
829 .help = "inject an NMI",
830 .mhandler.cmd = hmp_nmi,
835 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
840 .name = "ringbuf_write",
841 .args_type = "device:s,data:s",
842 .params = "device data",
843 .help = "Write to a ring buffer character device",
844 .mhandler.cmd = hmp_ringbuf_write,
845 .command_completion = ringbuf_write_completion,
849 @item ringbuf_write @var{device} @var{data}
850 @findex ringbuf_write
851 Write @var{data} to ring buffer character device @var{device}.
852 @var{data} must be a UTF-8 string.
857 .name = "ringbuf_read",
858 .args_type = "device:s,size:i",
859 .params = "device size",
860 .help = "Read from a ring buffer character device",
861 .mhandler.cmd = hmp_ringbuf_read,
862 .command_completion = ringbuf_write_completion,
866 @item ringbuf_read @var{device}
868 Read and print up to @var{size} bytes from ring buffer character
870 Certain non-printable characters are printed \uXXXX, where XXXX is the
871 character code in hexadecimal. Character \ is printed \\.
872 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
873 NUL characters, after the ring buffer lost data, and when reading
874 stops because the size limit is reached.
880 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
881 .params = "[-d] [-b] [-i] uri",
882 .help = "migrate to URI (using -d to not wait for completion)"
883 "\n\t\t\t -b for migration without shared storage with"
884 " full copy of disk\n\t\t\t -i for migration without "
885 "shared storage with incremental copy of disk "
886 "(base image shared between src and destination)",
887 .mhandler.cmd = hmp_migrate,
892 @item migrate [-d] [-b] [-i] @var{uri}
894 Migrate to @var{uri} (using -d to not wait for completion).
895 -b for migration with full copy of disk
896 -i for migration with incremental copy of disk (base image is shared)
900 .name = "migrate_cancel",
903 .help = "cancel the current VM migration",
904 .mhandler.cmd = hmp_migrate_cancel,
909 @findex migrate_cancel
910 Cancel the current VM migration.
915 .name = "migrate_incoming",
916 .args_type = "uri:s",
918 .help = "Continue an incoming migration from an -incoming defer",
919 .mhandler.cmd = hmp_migrate_incoming,
923 @item migrate_incoming @var{uri}
924 @findex migrate_incoming
925 Continue an incoming migration using the @var{uri} (that has the same syntax
926 as the -incoming option).
931 .name = "migrate_set_cache_size",
932 .args_type = "value:o",
934 .help = "set cache size (in bytes) for XBZRLE migrations,"
935 "the cache size will be rounded down to the nearest "
937 "The cache size affects the number of cache misses."
938 "In case of a high cache miss ratio you need to increase"
940 .mhandler.cmd = hmp_migrate_set_cache_size,
944 @item migrate_set_cache_size @var{value}
945 @findex migrate_set_cache_size
946 Set cache size to @var{value} (in bytes) for xbzrle migrations.
950 .name = "migrate_set_speed",
951 .args_type = "value:o",
953 .help = "set maximum speed (in bytes) for migrations. "
954 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
955 .mhandler.cmd = hmp_migrate_set_speed,
959 @item migrate_set_speed @var{value}
960 @findex migrate_set_speed
961 Set maximum speed to @var{value} (in bytes) for migrations.
965 .name = "migrate_set_downtime",
966 .args_type = "value:T",
968 .help = "set maximum tolerated downtime (in seconds) for migrations",
969 .mhandler.cmd = hmp_migrate_set_downtime,
973 @item migrate_set_downtime @var{second}
974 @findex migrate_set_downtime
975 Set maximum tolerated downtime (in seconds) for migration.
979 .name = "migrate_set_capability",
980 .args_type = "capability:s,state:b",
981 .params = "capability state",
982 .help = "Enable/Disable the usage of a capability for migration",
983 .mhandler.cmd = hmp_migrate_set_capability,
984 .command_completion = migrate_set_capability_completion,
988 @item migrate_set_capability @var{capability} @var{state}
989 @findex migrate_set_capability
990 Enable/Disable the usage of a capability @var{capability} for migration.
994 .name = "migrate_set_parameter",
995 .args_type = "parameter:s,value:i",
996 .params = "parameter value",
997 .help = "Set the parameter for migration",
998 .mhandler.cmd = hmp_migrate_set_parameter,
999 .command_completion = migrate_set_parameter_completion,
1003 @item migrate_set_parameter @var{parameter} @var{value}
1004 @findex migrate_set_parameter
1005 Set the parameter @var{parameter} for migration.
1009 .name = "client_migrate_info",
1010 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1011 .params = "protocol hostname port tls-port cert-subject",
1012 .help = "set migration information for remote display",
1013 .mhandler.cmd = hmp_client_migrate_info,
1017 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1018 @findex client_migrate_info
1019 Set migration information for remote display. This makes the server
1020 ask the client to automatically reconnect using the new parameters
1021 once migration finished successfully. Only implemented for SPICE.
1025 .name = "dump-guest-memory",
1026 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1027 .params = "[-p] [-z|-l|-s] filename [begin length]",
1028 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1029 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1030 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1031 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1032 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1033 "begin: the starting physical address.\n\t\t\t"
1034 "length: the memory size, in bytes.",
1035 .mhandler.cmd = hmp_dump_guest_memory,
1040 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1041 @item dump-guest-memory [-z|-l|-s] @var{filename}
1042 @findex dump-guest-memory
1043 Dump guest memory to @var{protocol}. The file can be processed with crash or
1044 gdb. Without -z|-l|-s, the dump format is ELF.
1045 -p: do paging to get guest's memory mapping.
1046 -z: dump in kdump-compressed format, with zlib compression.
1047 -l: dump in kdump-compressed format, with lzo compression.
1048 -s: dump in kdump-compressed format, with snappy compression.
1049 filename: dump file name.
1050 begin: the starting physical address. It's optional, and should be
1051 specified together with length.
1052 length: the memory size, in bytes. It's optional, and should be specified
1053 together with begin.
1057 .name = "snapshot_blkdev",
1058 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1059 .params = "[-n] device [new-image-file] [format]",
1060 .help = "initiates a live snapshot\n\t\t\t"
1061 "of device. If a new image file is specified, the\n\t\t\t"
1062 "new image file will become the new root image.\n\t\t\t"
1063 "If format is specified, the snapshot file will\n\t\t\t"
1064 "be created in that format.\n\t\t\t"
1065 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1066 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1067 "recreating it from scratch.",
1068 .mhandler.cmd = hmp_snapshot_blkdev,
1072 @item snapshot_blkdev
1073 @findex snapshot_blkdev
1074 Snapshot device, using snapshot file as target if provided
1078 .name = "snapshot_blkdev_internal",
1079 .args_type = "device:B,name:s",
1080 .params = "device name",
1081 .help = "take an internal snapshot of device.\n\t\t\t"
1082 "The format of the image used by device must\n\t\t\t"
1083 "support it, such as qcow2.\n\t\t\t",
1084 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1088 @item snapshot_blkdev_internal
1089 @findex snapshot_blkdev_internal
1090 Take an internal snapshot on device if it support
1094 .name = "snapshot_delete_blkdev_internal",
1095 .args_type = "device:B,name:s,id:s?",
1096 .params = "device name [id]",
1097 .help = "delete an internal snapshot of device.\n\t\t\t"
1098 "If id is specified, qemu will try delete\n\t\t\t"
1099 "the snapshot matching both id and name.\n\t\t\t"
1100 "The format of the image used by device must\n\t\t\t"
1101 "support it, such as qcow2.\n\t\t\t",
1102 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1106 @item snapshot_delete_blkdev_internal
1107 @findex snapshot_delete_blkdev_internal
1108 Delete an internal snapshot on device if it support
1112 .name = "drive_mirror",
1113 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1114 .params = "[-n] [-f] device target [format]",
1115 .help = "initiates live storage\n\t\t\t"
1116 "migration for a device. The device's contents are\n\t\t\t"
1117 "copied to the new image file, including data that\n\t\t\t"
1118 "is written after the command is started.\n\t\t\t"
1119 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1120 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1121 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1122 "so that the result does not need a backing file.\n\t\t\t",
1123 .mhandler.cmd = hmp_drive_mirror,
1127 @findex drive_mirror
1128 Start mirroring a block device's writes to a new destination,
1129 using the specified target.
1133 .name = "drive_backup",
1134 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1135 .params = "[-n] [-f] device target [format]",
1136 .help = "initiates a point-in-time\n\t\t\t"
1137 "copy for a device. The device's contents are\n\t\t\t"
1138 "copied to the new image file, excluding data that\n\t\t\t"
1139 "is written after the command is started.\n\t\t\t"
1140 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1141 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1142 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1143 "so that the result does not need a backing file.\n\t\t\t",
1144 .mhandler.cmd = hmp_drive_backup,
1148 @findex drive_backup
1149 Start a point-in-time copy of a block device to a specificed target.
1153 .name = "drive_add",
1154 .args_type = "pci_addr:s,opts:s",
1155 .params = "[[<domain>:]<bus>:]<slot>\n"
1156 "[file=file][,if=type][,bus=n]\n"
1157 "[,unit=m][,media=d][,index=i]\n"
1158 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1159 "[,snapshot=on|off][,cache=on|off]\n"
1160 "[,readonly=on|off][,copy-on-read=on|off]",
1161 .help = "add drive to PCI storage controller",
1162 .mhandler.cmd = hmp_drive_add,
1168 Add drive to PCI storage controller.
1172 .name = "pcie_aer_inject_error",
1173 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1174 "id:s,error_status:s,"
1175 "header0:i?,header1:i?,header2:i?,header3:i?,"
1176 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1177 .params = "[-a] [-c] id "
1178 "<error_status> [<tlp header> [<tlp header prefix>]]",
1179 .help = "inject pcie aer error\n\t\t\t"
1180 " -a for advisory non fatal error\n\t\t\t"
1181 " -c for correctable error\n\t\t\t"
1182 "<id> = qdev device id\n\t\t\t"
1183 "<error_status> = error string or 32bit\n\t\t\t"
1184 "<tlb header> = 32bit x 4\n\t\t\t"
1185 "<tlb header prefix> = 32bit x 4",
1186 .user_print = pcie_aer_inject_error_print,
1187 .mhandler.cmd_new = hmp_pcie_aer_inject_error,
1191 @item pcie_aer_inject_error
1192 @findex pcie_aer_inject_error
1193 Inject PCIe AER error
1197 .name = "host_net_add",
1198 .args_type = "device:s,opts:s?",
1199 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1200 .help = "add host VLAN client",
1201 .mhandler.cmd = hmp_host_net_add,
1202 .command_completion = host_net_add_completion,
1207 @findex host_net_add
1208 Add host VLAN client.
1212 .name = "host_net_remove",
1213 .args_type = "vlan_id:i,device:s",
1214 .params = "vlan_id name",
1215 .help = "remove host VLAN client",
1216 .mhandler.cmd = hmp_host_net_remove,
1217 .command_completion = host_net_remove_completion,
1221 @item host_net_remove
1222 @findex host_net_remove
1223 Remove host VLAN client.
1227 .name = "netdev_add",
1228 .args_type = "netdev:O",
1229 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1230 .help = "add host network device",
1231 .mhandler.cmd = hmp_netdev_add,
1232 .command_completion = netdev_add_completion,
1238 Add host network device.
1242 .name = "netdev_del",
1243 .args_type = "id:s",
1245 .help = "remove host network device",
1246 .mhandler.cmd = hmp_netdev_del,
1247 .command_completion = netdev_del_completion,
1253 Remove host network device.
1257 .name = "object_add",
1258 .args_type = "object:O",
1259 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1260 .help = "create QOM object",
1261 .mhandler.cmd = hmp_object_add,
1262 .command_completion = object_add_completion,
1272 .name = "object_del",
1273 .args_type = "id:s",
1275 .help = "destroy QOM object",
1276 .mhandler.cmd = hmp_object_del,
1277 .command_completion = object_del_completion,
1288 .name = "hostfwd_add",
1289 .args_type = "arg1:s,arg2:s?,arg3:s?",
1290 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1291 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1292 .mhandler.cmd = hmp_hostfwd_add,
1298 Redirect TCP or UDP connections from host to guest (requires -net user).
1303 .name = "hostfwd_remove",
1304 .args_type = "arg1:s,arg2:s?,arg3:s?",
1305 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1306 .help = "remove host-to-guest TCP or UDP redirection",
1307 .mhandler.cmd = hmp_hostfwd_remove,
1312 @item hostfwd_remove
1313 @findex hostfwd_remove
1314 Remove host-to-guest TCP or UDP redirection.
1319 .args_type = "value:M",
1321 .help = "request VM to change its memory allocation (in MB)",
1322 .mhandler.cmd = hmp_balloon,
1326 @item balloon @var{value}
1328 Request VM to change its memory allocation to @var{value} (in MB).
1333 .args_type = "name:s,up:b",
1334 .params = "name on|off",
1335 .help = "change the link status of a network adapter",
1336 .mhandler.cmd = hmp_set_link,
1337 .command_completion = set_link_completion,
1341 @item set_link @var{name} [on|off]
1343 Switch link @var{name} on (i.e. up) or off (i.e. down).
1347 .name = "watchdog_action",
1348 .args_type = "action:s",
1349 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1350 .help = "change watchdog action",
1351 .mhandler.cmd = hmp_watchdog_action,
1352 .command_completion = watchdog_action_completion,
1356 @item watchdog_action
1357 @findex watchdog_action
1358 Change watchdog action.
1363 .args_type = "aclname:s",
1364 .params = "aclname",
1365 .help = "list rules in the access control list",
1366 .mhandler.cmd = hmp_acl_show,
1370 @item acl_show @var{aclname}
1372 List all the matching rules in the access control list, and the default
1373 policy. There are currently two named access control lists,
1374 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1375 certificate distinguished name, and SASL username respectively.
1379 .name = "acl_policy",
1380 .args_type = "aclname:s,policy:s",
1381 .params = "aclname allow|deny",
1382 .help = "set default access control list policy",
1383 .mhandler.cmd = hmp_acl_policy,
1387 @item acl_policy @var{aclname} @code{allow|deny}
1389 Set the default access control list policy, used in the event that
1390 none of the explicit rules match. The default policy at startup is
1396 .args_type = "aclname:s,match:s,policy:s,index:i?",
1397 .params = "aclname match allow|deny [index]",
1398 .help = "add a match rule to the access control list",
1399 .mhandler.cmd = hmp_acl_add,
1403 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1405 Add a match rule to the access control list, allowing or denying access.
1406 The match will normally be an exact username or x509 distinguished name,
1407 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1408 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1409 normally be appended to the end of the ACL, but can be inserted
1410 earlier in the list if the optional @var{index} parameter is supplied.
1414 .name = "acl_remove",
1415 .args_type = "aclname:s,match:s",
1416 .params = "aclname match",
1417 .help = "remove a match rule from the access control list",
1418 .mhandler.cmd = hmp_acl_remove,
1422 @item acl_remove @var{aclname} @var{match}
1424 Remove the specified match rule from the access control list.
1428 .name = "acl_reset",
1429 .args_type = "aclname:s",
1430 .params = "aclname",
1431 .help = "reset the access control list",
1432 .mhandler.cmd = hmp_acl_reset,
1436 @item acl_reset @var{aclname}
1438 Remove all matches from the access control list, and set the default
1439 policy back to @code{deny}.
1443 .name = "nbd_server_start",
1444 .args_type = "all:-a,writable:-w,uri:s",
1445 .params = "nbd_server_start [-a] [-w] host:port",
1446 .help = "serve block devices on the given host and port",
1447 .mhandler.cmd = hmp_nbd_server_start,
1450 @item nbd_server_start @var{host}:@var{port}
1451 @findex nbd_server_start
1452 Start an NBD server on the given host and/or port. If the @option{-a}
1453 option is included, all of the virtual machine's block devices that
1454 have an inserted media on them are automatically exported; in this case,
1455 the @option{-w} option makes the devices writable too.
1459 .name = "nbd_server_add",
1460 .args_type = "writable:-w,device:B",
1461 .params = "nbd_server_add [-w] device",
1462 .help = "export a block device via NBD",
1463 .mhandler.cmd = hmp_nbd_server_add,
1466 @item nbd_server_add @var{device}
1467 @findex nbd_server_add
1468 Export a block device through QEMU's NBD server, which must be started
1469 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1470 exported device writable too.
1474 .name = "nbd_server_stop",
1476 .params = "nbd_server_stop",
1477 .help = "stop serving block devices using the NBD protocol",
1478 .mhandler.cmd = hmp_nbd_server_stop,
1481 @item nbd_server_stop
1482 @findex nbd_server_stop
1483 Stop the QEMU embedded NBD server.
1487 #if defined(TARGET_I386)
1491 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1492 .params = "[-b] cpu bank status mcgstatus addr misc",
1493 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1494 .mhandler.cmd = hmp_mce,
1499 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1501 Inject an MCE on the given CPU (x86 only).
1506 .args_type = "fdname:s",
1507 .params = "getfd name",
1508 .help = "receive a file descriptor via SCM rights and assign it a name",
1509 .mhandler.cmd = hmp_getfd,
1513 @item getfd @var{fdname}
1515 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1516 mechanism on unix sockets, it is stored using the name @var{fdname} for
1517 later use by other monitor commands.
1522 .args_type = "fdname:s",
1523 .params = "closefd name",
1524 .help = "close a file descriptor previously passed via SCM rights",
1525 .mhandler.cmd = hmp_closefd,
1529 @item closefd @var{fdname}
1531 Close the file descriptor previously assigned to @var{fdname} using the
1532 @code{getfd} command. This is only needed if the file descriptor was never
1533 used by another monitor command.
1537 .name = "block_passwd",
1538 .args_type = "device:B,password:s",
1539 .params = "block_passwd device password",
1540 .help = "set the password of encrypted block devices",
1541 .mhandler.cmd = hmp_block_passwd,
1545 @item block_passwd @var{device} @var{password}
1546 @findex block_passwd
1547 Set the encrypted device @var{device} password to @var{password}
1551 .name = "block_set_io_throttle",
1552 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1553 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1554 .help = "change I/O throttle limits for a block drive",
1555 .mhandler.cmd = hmp_block_set_io_throttle,
1559 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1560 @findex block_set_io_throttle
1561 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}
1565 .name = "set_password",
1566 .args_type = "protocol:s,password:s,connected:s?",
1567 .params = "protocol password action-if-connected",
1568 .help = "set spice/vnc password",
1569 .mhandler.cmd = hmp_set_password,
1573 @item set_password [ vnc | spice ] password [ action-if-connected ]
1574 @findex set_password
1575 Change spice/vnc password. Use zero to make the password stay valid
1576 forever. @var{action-if-connected} specifies what should happen in
1577 case a connection is established: @var{fail} makes the password change
1578 fail. @var{disconnect} changes the password and disconnects the
1579 client. @var{keep} changes the password and keeps the connection up.
1580 @var{keep} is the default.
1584 .name = "expire_password",
1585 .args_type = "protocol:s,time:s",
1586 .params = "protocol time",
1587 .help = "set spice/vnc password expire-time",
1588 .mhandler.cmd = hmp_expire_password,
1592 @item expire_password [ vnc | spice ] expire-time
1593 @findex expire_password
1594 Specify when a password for spice/vnc becomes
1595 invalid. @var{expire-time} accepts:
1599 Invalidate password instantly.
1602 Password stays valid forever.
1605 Password stays valid for @var{nsec} seconds starting now.
1608 Password is invalidated at the given time. @var{nsec} are the seconds
1609 passed since 1970, i.e. unix epoch.
1615 .name = "chardev-add",
1616 .args_type = "args:s",
1618 .help = "add chardev",
1619 .mhandler.cmd = hmp_chardev_add,
1620 .command_completion = chardev_add_completion,
1624 @item chardev-add args
1626 chardev_add accepts the same parameters as the -chardev command line switch.
1631 .name = "chardev-remove",
1632 .args_type = "id:s",
1634 .help = "remove chardev",
1635 .mhandler.cmd = hmp_chardev_remove,
1636 .command_completion = chardev_remove_completion,
1640 @item chardev-remove id
1641 @findex chardev-remove
1642 Removes the chardev @var{id}.
1648 .args_type = "device:B,command:s",
1649 .params = "[device] \"[command]\"",
1650 .help = "run a qemu-io command on a block device",
1651 .mhandler.cmd = hmp_qemu_io,
1655 @item qemu-io @var{device} @var{command}
1657 Executes a qemu-io command on the given block device.
1663 .args_type = "id:i",
1666 .mhandler.cmd = hmp_cpu_add,
1670 @item cpu-add @var{id}
1672 Add CPU with id @var{id}
1677 .args_type = "path:s?",
1679 .help = "list QOM properties",
1680 .mhandler.cmd = hmp_qom_list,
1684 @item qom-list [@var{path}]
1685 Print QOM properties of object at location @var{path}
1690 .args_type = "path:s,property:s,value:s",
1691 .params = "path property value",
1692 .help = "set QOM property",
1693 .mhandler.cmd = hmp_qom_set,
1697 @item qom-set @var{path} @var{property} @var{value}
1698 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1703 .args_type = "item:s?",
1704 .params = "[subcommand]",
1705 .help = "show various information about the system state",
1706 .mhandler.cmd = hmp_info_help,
1707 .sub_table = info_cmds,
1711 @item info @var{subcommand}
1713 Show various information about the system state.
1717 show the version of QEMU
1719 show the various VLANs and the associated devices
1721 show the character devices
1723 show the block devices
1724 @item info blockstats
1725 show block device statistics
1726 @item info registers
1727 show the cpu registers
1729 show infos for each CPU
1731 show the command line history
1733 show the interrupts statistics (if available)
1735 show i8259 (PIC) state
1737 show emulated PCI device info
1739 show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1741 show the active virtual memory mappings (i386 only)
1743 show dynamic compiler info
1745 show NUMA information
1747 show KVM information
1749 show USB devices plugged on the virtual USB hub
1751 show all USB host devices
1753 show profiling information
1755 show information about active capturing
1756 @item info snapshots
1757 show list of VM snapshots
1759 show the current VM status (running|paused)
1761 show which guest mouse is receiving events
1763 show the vnc server status
1765 show the current VM name
1767 show the current VM UUID
1771 show user network stack connection states
1773 show migration status
1774 @item info migrate_capabilities
1775 show current migration capabilities
1776 @item info migrate_parameters
1777 show current migration parameters
1778 @item info migrate_cache_size
1779 show current migration XBZRLE cache size
1781 show balloon information
1785 show qdev device model list
1787 show object composition tree
1792 @item info memory-devices
1793 show the memory devices
1798 @item info trace-events
1799 show available trace events and their state