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.
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 .user_print = monitor_user_noop,
51 .mhandler.cmd = hmp_quit,
61 .name = "block_resize",
62 .args_type = "device:B,size:o",
63 .params = "device size",
64 .help = "resize a block image",
65 .mhandler.cmd = hmp_block_resize,
71 Resize a block image while a guest is running. Usually requires guest
72 action to see the updated size. Resize to a lower size is supported,
73 but should be used with extreme caution. Note that this command only
74 resizes image files, it can not resize block devices like LVM volumes.
78 .name = "block_stream",
79 .args_type = "device:B,speed:o?,base:s?",
80 .params = "device [speed [base]]",
81 .help = "copy data from a backing file into a block device",
82 .mhandler.cmd = hmp_block_stream,
88 Copy data from a backing file into a block device.
92 .name = "block_job_set_speed",
93 .args_type = "device:B,speed:o",
94 .params = "device speed",
95 .help = "set maximum speed for a background block operation",
96 .mhandler.cmd = hmp_block_job_set_speed,
100 @item block_job_set_speed
101 @findex block_job_set_speed
102 Set maximum speed for a background block operation.
106 .name = "block_job_cancel",
107 .args_type = "force:-f,device:B",
108 .params = "[-f] device",
109 .help = "stop an active background block operation (use -f"
110 "\n\t\t\t if the operation is currently paused)",
111 .mhandler.cmd = hmp_block_job_cancel,
115 @item block_job_cancel
116 @findex block_job_cancel
117 Stop an active background block operation (streaming, mirroring).
121 .name = "block_job_complete",
122 .args_type = "device:B",
124 .help = "stop an active background block operation",
125 .mhandler.cmd = hmp_block_job_complete,
129 @item block_job_complete
130 @findex block_job_complete
131 Manually trigger completion of an active background block operation.
132 For mirroring, this will switch the device to the destination path.
136 .name = "block_job_pause",
137 .args_type = "device:B",
139 .help = "pause an active background block operation",
140 .mhandler.cmd = hmp_block_job_pause,
144 @item block_job_pause
145 @findex block_job_pause
146 Pause an active block streaming operation.
150 .name = "block_job_resume",
151 .args_type = "device:B",
153 .help = "resume a paused background block operation",
154 .mhandler.cmd = hmp_block_job_resume,
158 @item block_job_resume
159 @findex block_job_resume
160 Resume a paused block streaming operation.
165 .args_type = "force:-f,device:B",
166 .params = "[-f] device",
167 .help = "eject a removable medium (use -f to force it)",
168 .mhandler.cmd = hmp_eject,
172 @item eject [-f] @var{device}
174 Eject a removable medium (use -f to force it).
181 .help = "remove host block device",
182 .user_print = monitor_user_noop,
183 .mhandler.cmd_new = do_drive_del,
187 @item drive_del @var{device}
189 Remove host block device. The result is that guest generated IO is no longer
190 submitted against the host device underlying the disk. Once a drive has
191 been deleted, the QEMU Block layer returns -EIO which results in IO
192 errors in the guest for applications that are reading/writing to the device.
193 These errors are always reported to the guest, regardless of the drive's error
194 actions (drive options rerror, werror).
199 .args_type = "device:B,target:F,arg:s?",
200 .params = "device filename [format]",
201 .help = "change a removable medium, optional format",
202 .mhandler.cmd = hmp_change,
206 @item change @var{device} @var{setting}
209 Change the configuration of a device.
212 @item change @var{diskdevice} @var{filename} [@var{format}]
213 Change the medium for a removable disk device to point to @var{filename}. eg
216 (qemu) change ide1-cd0 /path/to/some.iso
219 @var{format} is optional.
221 @item change vnc @var{display},@var{options}
222 Change the configuration of the VNC server. The valid syntax for @var{display}
223 and @var{options} are described at @ref{sec_invocation}. eg
226 (qemu) change vnc localhost:1
229 @item change vnc password [@var{password}]
231 Change the password associated with the VNC server. If the new password is not
232 supplied, the monitor will prompt for it to be entered. VNC passwords are only
233 significant up to 8 letters. eg
236 (qemu) change vnc password
244 .name = "screendump",
245 .args_type = "filename:F",
246 .params = "filename",
247 .help = "save screen into PPM image 'filename'",
248 .mhandler.cmd = hmp_screen_dump,
252 @item screendump @var{filename}
254 Save screen into PPM image @var{filename}.
259 .args_type = "filename:F",
260 .params = "filename",
261 .help = "output logs to 'filename'",
262 .mhandler.cmd = do_logfile,
266 @item logfile @var{filename}
268 Output logs to @var{filename}.
272 .name = "trace-event",
273 .args_type = "name:s,option:b",
274 .params = "name on|off",
275 .help = "changes status of a specific trace event",
276 .mhandler.cmd = do_trace_event_set_state,
282 changes status of a trace event
285 #if defined(CONFIG_TRACE_SIMPLE)
287 .name = "trace-file",
288 .args_type = "op:s?,arg:F?",
289 .params = "on|off|flush|set [arg]",
290 .help = "open, close, or flush trace file, or set a new file name",
291 .mhandler.cmd = do_trace_file,
295 @item trace-file on|off|flush
297 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
303 .args_type = "items:s",
304 .params = "item1[,...]",
305 .help = "activate logging of the specified items",
306 .mhandler.cmd = do_log,
310 @item log @var{item1}[,...]
312 Activate logging of the specified items.
317 .args_type = "name:s?",
318 .params = "[tag|id]",
319 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
320 .mhandler.cmd = do_savevm,
324 @item savevm [@var{tag}|@var{id}]
326 Create a snapshot of the whole virtual machine. If @var{tag} is
327 provided, it is used as human readable identifier. If there is already
328 a snapshot with the same tag or ID, it is replaced. More info at
334 .args_type = "name:s",
336 .help = "restore a VM snapshot from its tag or id",
337 .mhandler.cmd = do_loadvm,
341 @item loadvm @var{tag}|@var{id}
343 Set the whole virtual machine to the snapshot identified by the tag
344 @var{tag} or the unique snapshot ID @var{id}.
349 .args_type = "name:s",
351 .help = "delete a VM snapshot from its tag or id",
352 .mhandler.cmd = do_delvm,
356 @item delvm @var{tag}|@var{id}
358 Delete the snapshot identified by @var{tag} or @var{id}.
362 .name = "singlestep",
363 .args_type = "option:s?",
364 .params = "[on|off]",
365 .help = "run emulation in singlestep mode or switch to normal mode",
366 .mhandler.cmd = do_singlestep,
370 @item singlestep [off]
372 Run the emulation in single step mode.
373 If called with option off, the emulation returns to normal mode.
380 .help = "stop emulation",
381 .mhandler.cmd = hmp_stop,
394 .help = "resume emulation",
395 .mhandler.cmd = hmp_cont,
405 .name = "system_wakeup",
408 .help = "wakeup guest from suspend",
409 .mhandler.cmd = hmp_system_wakeup,
414 @findex system_wakeup
415 Wakeup guest from suspend.
420 .args_type = "device:s?",
421 .params = "[device]",
422 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
423 .mhandler.cmd = do_gdbserver,
427 @item gdbserver [@var{port}]
429 Start gdbserver session (default @var{port}=1234)
434 .args_type = "fmt:/,addr:l",
435 .params = "/fmt addr",
436 .help = "virtual memory dump starting at 'addr'",
437 .mhandler.cmd = do_memory_dump,
441 @item x/fmt @var{addr}
443 Virtual memory dump starting at @var{addr}.
448 .args_type = "fmt:/,addr:l",
449 .params = "/fmt addr",
450 .help = "physical memory dump starting at 'addr'",
451 .mhandler.cmd = do_physical_memory_dump,
455 @item xp /@var{fmt} @var{addr}
457 Physical memory dump starting at @var{addr}.
459 @var{fmt} is a format which tells the command how to format the
460 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
464 is the number of items to be dumped.
467 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
468 c (char) or i (asm instruction).
471 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
472 @code{h} or @code{w} can be specified with the @code{i} format to
473 respectively select 16 or 32 bit code instruction size.
480 Dump 10 instructions at the current instruction pointer:
485 0x90107065: lea 0x0(%esi,1),%esi
486 0x90107069: lea 0x0(%edi,1),%edi
488 0x90107071: jmp 0x90107080
496 Dump 80 16 bit values at the start of the video memory.
498 (qemu) xp/80hx 0xb8000
499 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
500 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
501 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
502 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
503 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
504 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
505 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
506 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
507 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
508 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
515 .args_type = "fmt:/,val:l",
516 .params = "/fmt expr",
517 .help = "print expression value (use $reg for CPU register access)",
518 .mhandler.cmd = do_print,
522 @item p or print/@var{fmt} @var{expr}
525 Print expression value. Only the @var{format} part of @var{fmt} is
531 .args_type = "fmt:/,addr:i,index:i.",
532 .params = "/fmt addr",
533 .help = "I/O port read",
534 .mhandler.cmd = do_ioport_read,
543 .args_type = "fmt:/,addr:i,val:i",
544 .params = "/fmt addr value",
545 .help = "I/O port write",
546 .mhandler.cmd = do_ioport_write,
555 .args_type = "keys:s,hold-time:i?",
556 .params = "keys [hold_ms]",
557 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
558 .mhandler.cmd = hmp_send_key,
562 @item sendkey @var{keys}
565 Send @var{keys} to the guest. @var{keys} could be the name of the
566 key or the raw value in hexadecimal format. Use @code{-} to press
567 several keys simultaneously. Example:
572 This command is useful to send keys that your graphical user interface
573 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
577 .name = "system_reset",
580 .help = "reset the system",
581 .mhandler.cmd = hmp_system_reset,
592 .name = "system_powerdown",
595 .help = "send system power down event",
596 .mhandler.cmd = hmp_system_powerdown,
600 @item system_powerdown
601 @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 = do_sum,
615 @item sum @var{addr} @var{size}
618 Compute the checksum of a memory region.
623 .args_type = "devname:s",
625 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
626 .mhandler.cmd = do_usb_add,
630 @item usb_add @var{devname}
633 Add the USB device @var{devname}. For details of available devices see
639 .args_type = "devname:s",
641 .help = "remove USB device 'bus.addr'",
642 .mhandler.cmd = do_usb_del,
646 @item usb_del @var{devname}
649 Remove the USB device @var{devname} from the QEMU virtual USB
650 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
651 command @code{info usb} to see the devices you can remove.
655 .name = "device_add",
656 .args_type = "device:O",
657 .params = "driver[,prop=value][,...]",
658 .help = "add device, like -device on the command line",
659 .user_print = monitor_user_noop,
660 .mhandler.cmd_new = do_device_add,
661 .command_completion = device_add_completion,
665 @item device_add @var{config}
672 .name = "device_del",
675 .help = "remove device",
676 .mhandler.cmd = hmp_device_del,
677 .command_completion = device_del_completion,
681 @item device_del @var{id}
684 Remove device @var{id}.
689 .args_type = "index:i",
691 .help = "set the default CPU",
692 .mhandler.cmd = hmp_cpu,
696 @item cpu @var{index}
702 .name = "mouse_move",
703 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
704 .params = "dx dy [dz]",
705 .help = "send mouse move events",
706 .mhandler.cmd = do_mouse_move,
710 @item mouse_move @var{dx} @var{dy} [@var{dz}]
712 Move the active mouse to the specified coordinates @var{dx} @var{dy}
713 with optional scroll axis @var{dz}.
717 .name = "mouse_button",
718 .args_type = "button_state:i",
720 .help = "change mouse button state (1=L, 2=M, 4=R)",
721 .mhandler.cmd = do_mouse_button,
725 @item mouse_button @var{val}
727 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
732 .args_type = "index:i",
734 .help = "set which mouse device receives events",
735 .mhandler.cmd = do_mouse_set,
739 @item mouse_set @var{index}
741 Set which mouse device receives events at given @var{index}, index
749 .name = "wavcapture",
750 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
751 .params = "path [frequency [bits [channels]]]",
752 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
753 .mhandler.cmd = do_wav_capture,
756 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
758 Capture audio into @var{filename}. Using sample rate @var{frequency}
759 bits per sample @var{bits} and number of channels @var{channels}.
763 @item Sample rate = 44100 Hz - CD quality
765 @item Number of channels = 2 - Stereo
770 .name = "stopcapture",
772 .params = "capture index",
773 .help = "stop capture",
774 .mhandler.cmd = do_stop_capture,
777 @item stopcapture @var{index}
779 Stop capture with a given @var{index}, index can be obtained with
787 .args_type = "val:l,size:i,filename:s",
788 .params = "addr size file",
789 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
790 .mhandler.cmd = hmp_memsave,
794 @item memsave @var{addr} @var{size} @var{file}
796 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
801 .args_type = "val:l,size:i,filename:s",
802 .params = "addr size file",
803 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
804 .mhandler.cmd = hmp_pmemsave,
808 @item pmemsave @var{addr} @var{size} @var{file}
810 save to disk physical memory dump starting at @var{addr} of size @var{size}.
815 .args_type = "bootdevice:s",
816 .params = "bootdevice",
817 .help = "define new values for the boot device list",
818 .mhandler.cmd = do_boot_set,
822 @item boot_set @var{bootdevicelist}
825 Define new values for the boot device list. Those values will override
826 the values specified on the command line through the @code{-boot} option.
828 The values that can be specified here depend on the machine type, but are
829 the same that can be specified in the @code{-boot} command line option.
832 #if defined(TARGET_I386) || defined(TARGET_S390X)
837 .help = "inject an NMI on all guest's CPUs",
838 .mhandler.cmd = hmp_inject_nmi,
844 Inject an NMI (x86) or RESTART (s390x) on the given CPU.
849 .name = "ringbuf_write",
850 .args_type = "device:s,data:s",
851 .params = "device data",
852 .help = "Write to a ring buffer character device",
853 .mhandler.cmd = hmp_ringbuf_write,
857 @item ringbuf_write @var{device} @var{data}
858 @findex ringbuf_write
859 Write @var{data} to ring buffer character device @var{device}.
860 @var{data} must be a UTF-8 string.
865 .name = "ringbuf_read",
866 .args_type = "device:s,size:i",
867 .params = "device size",
868 .help = "Read from a ring buffer character device",
869 .mhandler.cmd = hmp_ringbuf_read,
873 @item ringbuf_read @var{device}
875 Read and print up to @var{size} bytes from ring buffer character
877 Certain non-printable characters are printed \uXXXX, where XXXX is the
878 character code in hexadecimal. Character \ is printed \\.
879 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
880 NUL characters, after the ring buffer lost data, and when reading
881 stops because the size limit is reached.
887 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
888 .params = "[-d] [-b] [-i] uri",
889 .help = "migrate to URI (using -d to not wait for completion)"
890 "\n\t\t\t -b for migration without shared storage with"
891 " full copy of disk\n\t\t\t -i for migration without "
892 "shared storage with incremental copy of disk "
893 "(base image shared between src and destination)",
894 .mhandler.cmd = hmp_migrate,
899 @item migrate [-d] [-b] [-i] @var{uri}
901 Migrate to @var{uri} (using -d to not wait for completion).
902 -b for migration with full copy of disk
903 -i for migration with incremental copy of disk (base image is shared)
907 .name = "migrate_cancel",
910 .help = "cancel the current VM migration",
911 .mhandler.cmd = hmp_migrate_cancel,
916 @findex migrate_cancel
917 Cancel the current VM migration.
922 .name = "migrate_set_cache_size",
923 .args_type = "value:o",
925 .help = "set cache size (in bytes) for XBZRLE migrations,"
926 "the cache size will be rounded down to the nearest "
928 "The cache size affects the number of cache misses."
929 "In case of a high cache miss ratio you need to increase"
931 .mhandler.cmd = hmp_migrate_set_cache_size,
935 @item migrate_set_cache_size @var{value}
936 @findex migrate_set_cache_size
937 Set cache size to @var{value} (in bytes) for xbzrle migrations.
941 .name = "migrate_set_speed",
942 .args_type = "value:o",
944 .help = "set maximum speed (in bytes) for migrations. "
945 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
946 .mhandler.cmd = hmp_migrate_set_speed,
950 @item migrate_set_speed @var{value}
951 @findex migrate_set_speed
952 Set maximum speed to @var{value} (in bytes) for migrations.
956 .name = "migrate_set_downtime",
957 .args_type = "value:T",
959 .help = "set maximum tolerated downtime (in seconds) for migrations",
960 .mhandler.cmd = hmp_migrate_set_downtime,
964 @item migrate_set_downtime @var{second}
965 @findex migrate_set_downtime
966 Set maximum tolerated downtime (in seconds) for migration.
970 .name = "migrate_set_capability",
971 .args_type = "capability:s,state:b",
972 .params = "capability state",
973 .help = "Enable/Disable the usage of a capability for migration",
974 .mhandler.cmd = hmp_migrate_set_capability,
978 @item migrate_set_capability @var{capability} @var{state}
979 @findex migrate_set_capability
980 Enable/Disable the usage of a capability @var{capability} for migration.
984 .name = "client_migrate_info",
985 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
986 .params = "protocol hostname port tls-port cert-subject",
987 .help = "send migration info to spice/vnc client",
988 .user_print = monitor_user_noop,
989 .mhandler.cmd_async = client_migrate_info,
990 .flags = MONITOR_CMD_ASYNC,
994 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
995 @findex client_migrate_info
996 Set the spice/vnc connection info for the migration target. The spice/vnc
997 server will ask the spice/vnc client to automatically reconnect using the
998 new parameters (if specified) once the vm migration finished successfully.
1002 .name = "dump-guest-memory",
1003 .args_type = "paging:-p,filename:F,begin:i?,length:i?",
1004 .params = "[-p] filename [begin] [length]",
1005 .help = "dump guest memory to file"
1006 "\n\t\t\t begin(optional): the starting physical address"
1007 "\n\t\t\t length(optional): the memory size, in bytes",
1008 .mhandler.cmd = hmp_dump_guest_memory,
1013 @item dump-guest-memory [-p] @var{protocol} @var{begin} @var{length}
1014 @findex dump-guest-memory
1015 Dump guest memory to @var{protocol}. The file can be processed with crash or
1017 filename: dump file name
1018 paging: do paging to get guest's memory mapping
1019 begin: the starting physical address. It's optional, and should be
1020 specified with length together.
1021 length: the memory size, in bytes. It's optional, and should be specified
1022 with begin together.
1026 .name = "snapshot_blkdev",
1027 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1028 .params = "[-n] device [new-image-file] [format]",
1029 .help = "initiates a live snapshot\n\t\t\t"
1030 "of device. If a new image file is specified, the\n\t\t\t"
1031 "new image file will become the new root image.\n\t\t\t"
1032 "If format is specified, the snapshot file will\n\t\t\t"
1033 "be created in that format.\n\t\t\t"
1034 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1035 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1036 "recreating it from scratch.",
1037 .mhandler.cmd = hmp_snapshot_blkdev,
1041 @item snapshot_blkdev
1042 @findex snapshot_blkdev
1043 Snapshot device, using snapshot file as target if provided
1047 .name = "snapshot_blkdev_internal",
1048 .args_type = "device:B,name:s",
1049 .params = "device name",
1050 .help = "take an internal snapshot of device.\n\t\t\t"
1051 "The format of the image used by device must\n\t\t\t"
1052 "support it, such as qcow2.\n\t\t\t",
1053 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1057 @item snapshot_blkdev_internal
1058 @findex snapshot_blkdev_internal
1059 Take an internal snapshot on device if it support
1063 .name = "snapshot_delete_blkdev_internal",
1064 .args_type = "device:B,name:s,id:s?",
1065 .params = "device name [id]",
1066 .help = "delete an internal snapshot of device.\n\t\t\t"
1067 "If id is specified, qemu will try delete\n\t\t\t"
1068 "the snapshot matching both id and name.\n\t\t\t"
1069 "The format of the image used by device must\n\t\t\t"
1070 "support it, such as qcow2.\n\t\t\t",
1071 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1075 @item snapshot_delete_blkdev_internal
1076 @findex snapshot_delete_blkdev_internal
1077 Delete an internal snapshot on device if it support
1081 .name = "drive_mirror",
1082 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1083 .params = "[-n] [-f] device target [format]",
1084 .help = "initiates live storage\n\t\t\t"
1085 "migration for a device. The device's contents are\n\t\t\t"
1086 "copied to the new image file, including data that\n\t\t\t"
1087 "is written after the command is started.\n\t\t\t"
1088 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1089 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1090 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1091 "so that the result does not need a backing file.\n\t\t\t",
1092 .mhandler.cmd = hmp_drive_mirror,
1096 @findex drive_mirror
1097 Start mirroring a block device's writes to a new destination,
1098 using the specified target.
1102 .name = "drive_backup",
1103 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1104 .params = "[-n] [-f] device target [format]",
1105 .help = "initiates a point-in-time\n\t\t\t"
1106 "copy for a device. The device's contents are\n\t\t\t"
1107 "copied to the new image file, excluding data that\n\t\t\t"
1108 "is written after the command is started.\n\t\t\t"
1109 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1110 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1111 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1112 "so that the result does not need a backing file.\n\t\t\t",
1113 .mhandler.cmd = hmp_drive_backup,
1117 @findex drive_backup
1118 Start a point-in-time copy of a block device to a specificed target.
1122 .name = "drive_add",
1123 .args_type = "pci_addr:s,opts:s",
1124 .params = "[[<domain>:]<bus>:]<slot>\n"
1125 "[file=file][,if=type][,bus=n]\n"
1126 "[,unit=m][,media=d][,index=i]\n"
1127 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1128 "[,snapshot=on|off][,cache=on|off]\n"
1129 "[,readonly=on|off][,copy-on-read=on|off]",
1130 .help = "add drive to PCI storage controller",
1131 .mhandler.cmd = drive_hot_add,
1137 Add drive to PCI storage controller.
1140 #if defined(CONFIG_PCI_HOTPLUG_OLD)
1143 .args_type = "pci_addr:s,type:s,opts:s?",
1144 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
1145 .help = "hot-add PCI device",
1146 .mhandler.cmd = pci_device_hot_add,
1156 #if defined(CONFIG_PCI_HOTPLUG_OLD)
1159 .args_type = "pci_addr:s",
1160 .params = "[[<domain>:]<bus>:]<slot>",
1161 .help = "hot remove PCI device",
1162 .mhandler.cmd = do_pci_device_hot_remove,
1169 Hot remove PCI device.
1173 .name = "pcie_aer_inject_error",
1174 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1175 "id:s,error_status:s,"
1176 "header0:i?,header1:i?,header2:i?,header3:i?,"
1177 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1178 .params = "[-a] [-c] id "
1179 "<error_status> [<tlp header> [<tlp header prefix>]]",
1180 .help = "inject pcie aer error\n\t\t\t"
1181 " -a for advisory non fatal error\n\t\t\t"
1182 " -c for correctable error\n\t\t\t"
1183 "<id> = qdev device id\n\t\t\t"
1184 "<error_status> = error string or 32bit\n\t\t\t"
1185 "<tlb header> = 32bit x 4\n\t\t\t"
1186 "<tlb header prefix> = 32bit x 4",
1187 .user_print = pcie_aer_inject_error_print,
1188 .mhandler.cmd_new = do_pcie_aer_inject_error,
1192 @item pcie_aer_inject_error
1193 @findex pcie_aer_inject_error
1194 Inject PCIe AER error
1198 .name = "host_net_add",
1199 .args_type = "device:s,opts:s?",
1200 .params = "tap|user|socket|vde|netmap|dump [options]",
1201 .help = "add host VLAN client",
1202 .mhandler.cmd = net_host_device_add,
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 = net_host_device_remove,
1220 @item host_net_remove
1221 @findex host_net_remove
1222 Remove host VLAN client.
1226 .name = "netdev_add",
1227 .args_type = "netdev:O",
1228 .params = "[user|tap|socket|hubport|netmap],id=str[,prop=value][,...]",
1229 .help = "add host network device",
1230 .mhandler.cmd = hmp_netdev_add,
1236 Add host network device.
1240 .name = "netdev_del",
1241 .args_type = "id:s",
1243 .help = "remove host network device",
1244 .mhandler.cmd = hmp_netdev_del,
1250 Remove host network device.
1254 .name = "object_add",
1255 .args_type = "object:O",
1256 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1257 .help = "create QOM object",
1258 .mhandler.cmd = hmp_object_add,
1259 .command_completion = object_add_completion,
1269 .name = "object_del",
1270 .args_type = "id:s",
1272 .help = "destroy QOM object",
1273 .mhandler.cmd = hmp_object_del,
1274 .command_completion = object_del_completion,
1285 .name = "hostfwd_add",
1286 .args_type = "arg1:s,arg2:s?,arg3:s?",
1287 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1288 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1289 .mhandler.cmd = net_slirp_hostfwd_add,
1295 Redirect TCP or UDP connections from host to guest (requires -net user).
1300 .name = "hostfwd_remove",
1301 .args_type = "arg1:s,arg2:s?,arg3:s?",
1302 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1303 .help = "remove host-to-guest TCP or UDP redirection",
1304 .mhandler.cmd = net_slirp_hostfwd_remove,
1309 @item hostfwd_remove
1310 @findex hostfwd_remove
1311 Remove host-to-guest TCP or UDP redirection.
1316 .args_type = "value:M",
1318 .help = "request VM to change its memory allocation (in MB)",
1319 .mhandler.cmd = hmp_balloon,
1323 @item balloon @var{value}
1325 Request VM to change its memory allocation to @var{value} (in MB).
1330 .args_type = "name:s,up:b",
1331 .params = "name on|off",
1332 .help = "change the link status of a network adapter",
1333 .mhandler.cmd = hmp_set_link,
1337 @item set_link @var{name} [on|off]
1339 Switch link @var{name} on (i.e. up) or off (i.e. down).
1343 .name = "watchdog_action",
1344 .args_type = "action:s",
1345 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1346 .help = "change watchdog action",
1347 .mhandler.cmd = do_watchdog_action,
1351 @item watchdog_action
1352 @findex watchdog_action
1353 Change watchdog action.
1358 .args_type = "aclname:s",
1359 .params = "aclname",
1360 .help = "list rules in the access control list",
1361 .mhandler.cmd = do_acl_show,
1365 @item acl_show @var{aclname}
1367 List all the matching rules in the access control list, and the default
1368 policy. There are currently two named access control lists,
1369 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1370 certificate distinguished name, and SASL username respectively.
1374 .name = "acl_policy",
1375 .args_type = "aclname:s,policy:s",
1376 .params = "aclname allow|deny",
1377 .help = "set default access control list policy",
1378 .mhandler.cmd = do_acl_policy,
1382 @item acl_policy @var{aclname} @code{allow|deny}
1384 Set the default access control list policy, used in the event that
1385 none of the explicit rules match. The default policy at startup is
1391 .args_type = "aclname:s,match:s,policy:s,index:i?",
1392 .params = "aclname match allow|deny [index]",
1393 .help = "add a match rule to the access control list",
1394 .mhandler.cmd = do_acl_add,
1398 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1400 Add a match rule to the access control list, allowing or denying access.
1401 The match will normally be an exact username or x509 distinguished name,
1402 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1403 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1404 normally be appended to the end of the ACL, but can be inserted
1405 earlier in the list if the optional @var{index} parameter is supplied.
1409 .name = "acl_remove",
1410 .args_type = "aclname:s,match:s",
1411 .params = "aclname match",
1412 .help = "remove a match rule from the access control list",
1413 .mhandler.cmd = do_acl_remove,
1417 @item acl_remove @var{aclname} @var{match}
1419 Remove the specified match rule from the access control list.
1423 .name = "acl_reset",
1424 .args_type = "aclname:s",
1425 .params = "aclname",
1426 .help = "reset the access control list",
1427 .mhandler.cmd = do_acl_reset,
1431 @item acl_reset @var{aclname}
1433 Remove all matches from the access control list, and set the default
1434 policy back to @code{deny}.
1438 .name = "nbd_server_start",
1439 .args_type = "all:-a,writable:-w,uri:s",
1440 .params = "nbd_server_start [-a] [-w] host:port",
1441 .help = "serve block devices on the given host and port",
1442 .mhandler.cmd = hmp_nbd_server_start,
1445 @item nbd_server_start @var{host}:@var{port}
1446 @findex nbd_server_start
1447 Start an NBD server on the given host and/or port. If the @option{-a}
1448 option is included, all of the virtual machine's block devices that
1449 have an inserted media on them are automatically exported; in this case,
1450 the @option{-w} option makes the devices writable too.
1454 .name = "nbd_server_add",
1455 .args_type = "writable:-w,device:B",
1456 .params = "nbd_server_add [-w] device",
1457 .help = "export a block device via NBD",
1458 .mhandler.cmd = hmp_nbd_server_add,
1461 @item nbd_server_add @var{device}
1462 @findex nbd_server_add
1463 Export a block device through QEMU's NBD server, which must be started
1464 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1465 exported device writable too.
1469 .name = "nbd_server_stop",
1471 .params = "nbd_server_stop",
1472 .help = "stop serving block devices using the NBD protocol",
1473 .mhandler.cmd = hmp_nbd_server_stop,
1476 @item nbd_server_stop
1477 @findex nbd_server_stop
1478 Stop the QEMU embedded NBD server.
1482 #if defined(TARGET_I386)
1486 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1487 .params = "[-b] cpu bank status mcgstatus addr misc",
1488 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1489 .mhandler.cmd = do_inject_mce,
1494 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1496 Inject an MCE on the given CPU (x86 only).
1501 .args_type = "fdname:s",
1502 .params = "getfd name",
1503 .help = "receive a file descriptor via SCM rights and assign it a name",
1504 .mhandler.cmd = hmp_getfd,
1508 @item getfd @var{fdname}
1510 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1511 mechanism on unix sockets, it is stored using the name @var{fdname} for
1512 later use by other monitor commands.
1517 .args_type = "fdname:s",
1518 .params = "closefd name",
1519 .help = "close a file descriptor previously passed via SCM rights",
1520 .mhandler.cmd = hmp_closefd,
1524 @item closefd @var{fdname}
1526 Close the file descriptor previously assigned to @var{fdname} using the
1527 @code{getfd} command. This is only needed if the file descriptor was never
1528 used by another monitor command.
1532 .name = "block_passwd",
1533 .args_type = "device:B,password:s",
1534 .params = "block_passwd device password",
1535 .help = "set the password of encrypted block devices",
1536 .mhandler.cmd = hmp_block_passwd,
1540 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1541 @findex block_set_io_throttle
1542 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}
1546 .name = "block_set_io_throttle",
1547 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1548 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1549 .help = "change I/O throttle limits for a block drive",
1550 .mhandler.cmd = hmp_block_set_io_throttle,
1554 @item block_passwd @var{device} @var{password}
1555 @findex block_passwd
1556 Set the encrypted device @var{device} password to @var{password}
1560 .name = "set_password",
1561 .args_type = "protocol:s,password:s,connected:s?",
1562 .params = "protocol password action-if-connected",
1563 .help = "set spice/vnc password",
1564 .mhandler.cmd = hmp_set_password,
1568 @item set_password [ vnc | spice ] password [ action-if-connected ]
1569 @findex set_password
1571 Change spice/vnc password. Use zero to make the password stay valid
1572 forever. @var{action-if-connected} specifies what should happen in
1573 case a connection is established: @var{fail} makes the password change
1574 fail. @var{disconnect} changes the password and disconnects the
1575 client. @var{keep} changes the password and keeps the connection up.
1576 @var{keep} is the default.
1580 .name = "expire_password",
1581 .args_type = "protocol:s,time:s",
1582 .params = "protocol time",
1583 .help = "set spice/vnc password expire-time",
1584 .mhandler.cmd = hmp_expire_password,
1588 @item expire_password [ vnc | spice ] expire-time
1589 @findex expire_password
1591 Specify when a password for spice/vnc becomes
1592 invalid. @var{expire-time} accepts:
1596 Invalidate password instantly.
1599 Password stays valid forever.
1602 Password stays valid for @var{nsec} seconds starting now.
1605 Password is invalidated at the given time. @var{nsec} are the seconds
1606 passed since 1970, i.e. unix epoch.
1612 .name = "chardev-add",
1613 .args_type = "args:s",
1615 .help = "add chardev",
1616 .mhandler.cmd = hmp_chardev_add,
1620 @item chardev_add args
1623 chardev_add accepts the same parameters as the -chardev command line switch.
1628 .name = "chardev-remove",
1629 .args_type = "id:s",
1631 .help = "remove chardev",
1632 .mhandler.cmd = hmp_chardev_remove,
1636 @item chardev_remove id
1637 @findex chardev_remove
1639 Removes the chardev @var{id}.
1645 .args_type = "device:B,command:s",
1646 .params = "[device] \"[command]\"",
1647 .help = "run a qemu-io command on a block device",
1648 .mhandler.cmd = hmp_qemu_io,
1652 @item qemu-io @var{device} @var{command}
1655 Executes a qemu-io command on the given block device.
1661 .args_type = "id:i",
1664 .mhandler.cmd = hmp_cpu_add,
1668 @item cpu-add @var{id}
1669 Add CPU with id @var{id}
1674 .args_type = "item:s?",
1675 .params = "[subcommand]",
1676 .help = "show various information about the system state",
1677 .mhandler.cmd = do_info_help,
1678 .sub_table = info_cmds,
1682 @item info @var{subcommand}
1684 Show various information about the system state.
1688 show the version of QEMU
1690 show the various VLANs and the associated devices
1692 show the character devices
1694 show the block devices
1695 @item info blockstats
1696 show block device statistics
1697 @item info registers
1698 show the cpu registers
1700 show infos for each CPU
1702 show the command line history
1704 show the interrupts statistics (if available)
1706 show i8259 (PIC) state
1708 show emulated PCI device info
1710 show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1712 show the active virtual memory mappings (i386 only)
1714 show dynamic compiler info
1716 show NUMA information
1718 show KVM information
1720 show USB devices plugged on the virtual USB hub
1722 show all USB host devices
1724 show profiling information
1726 show information about active capturing
1727 @item info snapshots
1728 show list of VM snapshots
1730 show the current VM status (running|paused)
1732 show guest PCMCIA status
1734 show which guest mouse is receiving events
1736 show the vnc server status
1738 show the current VM name
1740 show the current VM UUID
1744 show user network stack connection states
1746 show migration status
1747 @item info migrate_capabilities
1748 show current migration capabilities
1749 @item info migrate_cache_size
1750 show current migration XBZRLE cache size
1752 show balloon information
1756 show qdev device model list
1765 @item info trace-events
1766 show available trace events and their state