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 .user_print
= monitor_user_noop
,
182 .mhandler
.cmd_new
= hmp_drive_del
,
186 @item drive_del @
var{device
}
188 Remove host block device
. The result is that guest generated IO is no longer
189 submitted against the host device underlying the disk
. Once a drive has
190 been deleted
, the QEMU Block layer returns
-EIO which results
in IO
191 errors
in the guest
for applications that are reading
/writing to the device
.
192 These errors are always reported to the guest
, regardless of the drive
's error
193 actions (drive options rerror, werror).
198 .args_type = "device:B,target:F,arg:s?",
199 .params = "device filename [format]",
200 .help = "change a removable medium, optional format",
201 .mhandler.cmd = hmp_change,
205 @item change @var{device} @var{setting}
207 Change the configuration of a device.
210 @item change @var{diskdevice} @var{filename} [@var{format}]
211 Change the medium for a removable disk device to point to @var{filename}. eg
214 (qemu) change ide1-cd0 /path/to/some.iso
217 @var{format} is optional.
219 @item change vnc @var{display},@var{options}
220 Change the configuration of the VNC server. The valid syntax for @var{display}
221 and @var{options} are described at @ref{sec_invocation}. eg
224 (qemu) change vnc localhost:1
227 @item change vnc password [@var{password}]
229 Change the password associated with the VNC server. If the new password is not
230 supplied, the monitor will prompt for it to be entered. VNC passwords are only
231 significant up to 8 letters. eg
234 (qemu) change vnc password
242 .name = "screendump",
243 .args_type = "filename:F",
244 .params = "filename",
245 .help = "save screen into PPM image 'filename
'",
246 .mhandler.cmd = hmp_screendump,
250 @item screendump @var{filename}
252 Save screen into PPM image @var{filename}.
257 .args_type = "filename:F",
258 .params = "filename",
259 .help = "output logs to 'filename
'",
260 .mhandler.cmd = hmp_logfile,
264 @item logfile @var{filename}
266 Output logs to @var{filename}.
270 .name = "trace-event",
271 .args_type = "name:s,option:b",
272 .params = "name on|off",
273 .help = "changes status of a specific trace event",
274 .mhandler.cmd = hmp_trace_event,
280 changes status of a trace event
283 #if defined(CONFIG_TRACE_SIMPLE)
285 .name = "trace-file",
286 .args_type = "op:s?,arg:F?",
287 .params = "on|off|flush|set [arg]",
288 .help = "open, close, or flush trace file, or set a new file name",
289 .mhandler.cmd = hmp_trace_file,
293 @item trace-file on|off|flush
295 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
301 .args_type = "items:s",
302 .params = "item1[,...]",
303 .help = "activate logging of the specified items",
304 .mhandler.cmd = hmp_log,
308 @item log @var{item1}[,...]
310 Activate logging of the specified items.
315 .args_type = "name:s?",
316 .params = "[tag|id]",
317 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
318 .mhandler.cmd = hmp_savevm,
322 @item savevm [@var{tag}|@var{id}]
324 Create a snapshot of the whole virtual machine. If @var{tag} is
325 provided, it is used as human readable identifier. If there is already
326 a snapshot with the same tag or ID, it is replaced. More info at
332 .args_type = "name:s",
334 .help = "restore a VM snapshot from its tag or id",
335 .mhandler.cmd = hmp_loadvm,
336 .command_completion = loadvm_completion,
340 @item loadvm @var{tag}|@var{id}
342 Set the whole virtual machine to the snapshot identified by the tag
343 @var{tag} or the unique snapshot ID @var{id}.
348 .args_type = "name:s",
350 .help = "delete a VM snapshot from its tag or id",
351 .mhandler.cmd = hmp_delvm,
352 .command_completion = delvm_completion,
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 = hmp_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 = hmp_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 = hmp_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 = hmp_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}
524 Print expression value. Only the @var{format} part of @var{fmt} is
530 .args_type = "fmt:/,addr:i,index:i.",
531 .params = "/fmt addr",
532 .help = "I/O port read",
533 .mhandler.cmd = hmp_ioport_read,
537 @item i/@var{fmt} @var{addr} [.@var{index}]
544 .args_type = "fmt:/,addr:i,val:i",
545 .params = "/fmt addr value",
546 .help = "I/O port write",
547 .mhandler.cmd = hmp_ioport_write,
551 @item o/@var{fmt} @var{addr} @var{val}
558 .args_type = "keys:s,hold-time:i?",
559 .params = "keys [hold_ms]",
560 .help = "send keys to the VM (e.g. 'sendkey ctrl
-alt
-f1
', default hold time=100 ms)",
561 .mhandler.cmd = hmp_sendkey,
562 .command_completion = sendkey_completion,
566 @item sendkey @var{keys}
568 Send @var{keys} to the guest. @var{keys} could be the name of the
569 key or the raw value in hexadecimal format. Use @code{-} to press
570 several keys simultaneously. Example:
575 This command is useful to send keys that your graphical user interface
576 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
580 .name = "system_reset",
583 .help = "reset the system",
584 .mhandler.cmd = hmp_system_reset,
594 .name = "system_powerdown",
597 .help = "send system power down event",
598 .mhandler.cmd = hmp_system_powerdown,
602 @item system_powerdown
603 @findex system_powerdown
604 Power down the system (if supported).
609 .args_type = "start:i,size:i",
610 .params = "addr size",
611 .help = "compute the checksum of a memory region",
612 .mhandler.cmd = hmp_sum,
616 @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 = hmp_usb_add,
630 @item usb_add @var{devname}
632 Add the USB device @var{devname}. For details of available devices see
638 .args_type = "devname:s",
640 .help = "remove USB device 'bus
.addr
'",
641 .mhandler.cmd = hmp_usb_del,
645 @item usb_del @var{devname}
647 Remove the USB device @var{devname} from the QEMU virtual USB
648 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
649 command @code{info usb} to see the devices you can remove.
653 .name = "device_add",
654 .args_type = "device:O",
655 .params = "driver[,prop=value][,...]",
656 .help = "add device, like -device on the command line",
657 .user_print = monitor_user_noop,
658 .mhandler.cmd_new = do_device_add,
659 .command_completion = device_add_completion,
663 @item device_add @var{config}
669 .name = "device_del",
672 .help = "remove device",
673 .mhandler.cmd = hmp_device_del,
674 .command_completion = device_del_completion,
678 @item device_del @var{id}
680 Remove device @var{id}.
685 .args_type = "index:i",
687 .help = "set the default CPU",
688 .mhandler.cmd = hmp_cpu,
692 @item cpu @var{index}
698 .name = "mouse_move",
699 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
700 .params = "dx dy [dz]",
701 .help = "send mouse move events",
702 .mhandler.cmd = hmp_mouse_move,
706 @item mouse_move @var{dx} @var{dy} [@var{dz}]
708 Move the active mouse to the specified coordinates @var{dx} @var{dy}
709 with optional scroll axis @var{dz}.
713 .name = "mouse_button",
714 .args_type = "button_state:i",
716 .help = "change mouse button state (1=L, 2=M, 4=R)",
717 .mhandler.cmd = hmp_mouse_button,
721 @item mouse_button @var{val}
723 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
728 .args_type = "index:i",
730 .help = "set which mouse device receives events",
731 .mhandler.cmd = hmp_mouse_set,
735 @item mouse_set @var{index}
737 Set which mouse device receives events at given @var{index}, index
745 .name = "wavcapture",
746 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
747 .params = "path [frequency [bits [channels]]]",
748 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
749 .mhandler.cmd = hmp_wavcapture,
752 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
754 Capture audio into @var{filename}. Using sample rate @var{frequency}
755 bits per sample @var{bits} and number of channels @var{channels}.
759 @item Sample rate = 44100 Hz - CD quality
761 @item Number of channels = 2 - Stereo
766 .name = "stopcapture",
768 .params = "capture index",
769 .help = "stop capture",
770 .mhandler.cmd = hmp_stopcapture,
773 @item stopcapture @var{index}
775 Stop capture with a given @var{index}, index can be obtained with
783 .args_type = "val:l,size:i,filename:s",
784 .params = "addr size file",
785 .help = "save to disk virtual memory dump starting at 'addr
' of size 'size
'",
786 .mhandler.cmd = hmp_memsave,
790 @item memsave @var{addr} @var{size} @var{file}
792 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
797 .args_type = "val:l,size:i,filename:s",
798 .params = "addr size file",
799 .help = "save to disk physical memory dump starting at 'addr
' of size 'size
'",
800 .mhandler.cmd = hmp_pmemsave,
804 @item pmemsave @var{addr} @var{size} @var{file}
806 save to disk physical memory dump starting at @var{addr} of size @var{size}.
811 .args_type = "bootdevice:s",
812 .params = "bootdevice",
813 .help = "define new values for the boot device list",
814 .mhandler.cmd = hmp_boot_set,
818 @item boot_set @var{bootdevicelist}
820 Define new values for the boot device list. Those values will override
821 the values specified on the command line through the @code{-boot} option.
823 The values that can be specified here depend on the machine type, but are
824 the same that can be specified in the @code{-boot} command line option.
831 .help = "inject an NMI",
832 .mhandler.cmd = hmp_nmi,
837 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
842 .name = "ringbuf_write",
843 .args_type = "device:s,data:s",
844 .params = "device data",
845 .help = "Write to a ring buffer character device",
846 .mhandler.cmd = hmp_ringbuf_write,
847 .command_completion = ringbuf_write_completion,
851 @item ringbuf_write @var{device} @var{data}
852 @findex ringbuf_write
853 Write @var{data} to ring buffer character device @var{device}.
854 @var{data} must be a UTF-8 string.
859 .name = "ringbuf_read",
860 .args_type = "device:s,size:i",
861 .params = "device size",
862 .help = "Read from a ring buffer character device",
863 .mhandler.cmd = hmp_ringbuf_read,
864 .command_completion = ringbuf_write_completion,
868 @item ringbuf_read @var{device}
870 Read and print up to @var{size} bytes from ring buffer character
872 Certain non-printable characters are printed \uXXXX, where XXXX is the
873 character code in hexadecimal. Character \ is printed \\.
874 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
875 NUL characters, after the ring buffer lost data, and when reading
876 stops because the size limit is reached.
882 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
883 .params = "[-d] [-b] [-i] uri",
884 .help = "migrate to URI (using -d to not wait for completion)"
885 "\n\t\t\t -b for migration without shared storage with"
886 " full copy of disk\n\t\t\t -i for migration without "
887 "shared storage with incremental copy of disk "
888 "(base image shared between src and destination)",
889 .mhandler.cmd = hmp_migrate,
894 @item migrate [-d] [-b] [-i] @var{uri}
896 Migrate to @var{uri} (using -d to not wait for completion).
897 -b for migration with full copy of disk
898 -i for migration with incremental copy of disk (base image is shared)
902 .name = "migrate_cancel",
905 .help = "cancel the current VM migration",
906 .mhandler.cmd = hmp_migrate_cancel,
911 @findex migrate_cancel
912 Cancel the current VM migration.
917 .name = "migrate_incoming",
918 .args_type = "uri:s",
920 .help = "Continue an incoming migration from an -incoming defer",
921 .mhandler.cmd = hmp_migrate_incoming,
925 @item migrate_incoming @var{uri}
926 @findex migrate_incoming
927 Continue an incoming migration using the @var{uri} (that has the same syntax
928 as the -incoming option).
933 .name = "migrate_set_cache_size",
934 .args_type = "value:o",
936 .help = "set cache size (in bytes) for XBZRLE migrations,"
937 "the cache size will be rounded down to the nearest "
939 "The cache size affects the number of cache misses."
940 "In case of a high cache miss ratio you need to increase"
942 .mhandler.cmd = hmp_migrate_set_cache_size,
946 @item migrate_set_cache_size @var{value}
947 @findex migrate_set_cache_size
948 Set cache size to @var{value} (in bytes) for xbzrle migrations.
952 .name = "migrate_set_speed",
953 .args_type = "value:o",
955 .help = "set maximum speed (in bytes) for migrations. "
956 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
957 .mhandler.cmd = hmp_migrate_set_speed,
961 @item migrate_set_speed @var{value}
962 @findex migrate_set_speed
963 Set maximum speed to @var{value} (in bytes) for migrations.
967 .name = "migrate_set_downtime",
968 .args_type = "value:T",
970 .help = "set maximum tolerated downtime (in seconds) for migrations",
971 .mhandler.cmd = hmp_migrate_set_downtime,
975 @item migrate_set_downtime @var{second}
976 @findex migrate_set_downtime
977 Set maximum tolerated downtime (in seconds) for migration.
981 .name = "migrate_set_capability",
982 .args_type = "capability:s,state:b",
983 .params = "capability state",
984 .help = "Enable/Disable the usage of a capability for migration",
985 .mhandler.cmd = hmp_migrate_set_capability,
986 .command_completion = migrate_set_capability_completion,
990 @item migrate_set_capability @var{capability} @var{state}
991 @findex migrate_set_capability
992 Enable/Disable the usage of a capability @var{capability} for migration.
996 .name = "migrate_set_parameter",
997 .args_type = "parameter:s,value:i",
998 .params = "parameter value",
999 .help = "Set the parameter for migration",
1000 .mhandler.cmd = hmp_migrate_set_parameter,
1001 .command_completion = migrate_set_parameter_completion,
1005 @item migrate_set_parameter @var{parameter} @var{value}
1006 @findex migrate_set_parameter
1007 Set the parameter @var{parameter} for migration.
1011 .name = "client_migrate_info",
1012 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1013 .params = "protocol hostname port tls-port cert-subject",
1014 .help = "send migration info to spice/vnc client",
1015 .user_print = monitor_user_noop,
1016 .mhandler.cmd_new = client_migrate_info,
1020 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1021 @findex client_migrate_info
1022 Set the spice/vnc connection info for the migration target. The spice/vnc
1023 server will ask the spice/vnc client to automatically reconnect using the
1024 new parameters (if specified) once the vm migration finished successfully.
1028 .name = "dump-guest-memory",
1029 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1030 .params = "[-p] [-z|-l|-s] filename [begin length]",
1031 .help = "dump guest memory into file 'filename
'.\n\t\t\t"
1032 "-p: do paging to get guest's memory mapping
.\n\t\t\t"
1033 "-z
: dump
in kdump
-compressed format
, with zlib compression
.\n\t\t\t"
1034 "-l
: dump
in kdump
-compressed format
, with lzo compression
.\n\t\t\t"
1035 "-s
: dump
in kdump
-compressed format
, with snappy compression
.\n\t\t\t"
1036 "begin
: the starting physical address
.\n\t\t\t"
1037 "length
: the memory size
, in bytes
.",
1038 .mhandler.cmd = hmp_dump_guest_memory,
1043 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1044 @item dump-guest-memory [-z|-l|-s] @var{filename}
1045 @findex dump-guest-memory
1046 Dump guest memory to @var{protocol}. The file can be processed with crash or
1047 gdb. Without -z|-l|-s, the dump format is ELF.
1048 -p: do paging to get guest's memory mapping.
1049 -z: dump in kdump-compressed format, with zlib compression.
1050 -l: dump in kdump-compressed format, with lzo compression.
1051 -s: dump in kdump-compressed format, with snappy compression.
1052 filename: dump file name.
1053 begin: the starting physical address. It's optional, and should be
1054 specified together with length.
1055 length: the memory size, in bytes. It's optional, and should be specified
1056 together with begin.
1060 .name = "snapshot_blkdev
",
1061 .args_type = "reuse
:-n
,device
:B
,snapshot
-file
:s?
,format
:s?
",
1062 .params = "[-n
] device
[new-image
-file
] [format
]",
1063 .help = "initiates a live snapshot
\n\t\t\t"
1064 "of device
. If a
new image file is specified
, the
\n\t\t\t"
1065 "new image file will become the
new root image
.\n\t\t\t"
1066 "If format is specified
, the snapshot file will
\n\t\t\t"
1067 "be created
in that format
.\n\t\t\t"
1068 "The
default format is qcow2
. The
-n flag requests QEMU
\n\t\t\t"
1069 "to reuse the image found
in new-image
-file
, instead of
\n\t\t\t"
1070 "recreating it from scratch
.",
1071 .mhandler.cmd = hmp_snapshot_blkdev,
1075 @item snapshot_blkdev
1076 @findex snapshot_blkdev
1077 Snapshot device, using snapshot file as target if provided
1081 .name = "snapshot_blkdev_internal
",
1082 .args_type = "device
:B
,name
:s
",
1083 .params = "device name
",
1084 .help = "take an internal snapshot of device
.\n\t\t\t"
1085 "The format of the image used by device must
\n\t\t\t"
1086 "support it
, such as qcow2
.\n\t\t\t",
1087 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1091 @item snapshot_blkdev_internal
1092 @findex snapshot_blkdev_internal
1093 Take an internal snapshot on device if it support
1097 .name = "snapshot_delete_blkdev_internal
",
1098 .args_type = "device
:B
,name
:s
,id
:s?
",
1099 .params = "device name
[id
]",
1100 .help = "delete an internal snapshot of device
.\n\t\t\t"
1101 "If id is specified
, qemu will
try delete
\n\t\t\t"
1102 "the snapshot matching both id and name
.\n\t\t\t"
1103 "The format of the image used by device must
\n\t\t\t"
1104 "support it
, such as qcow2
.\n\t\t\t",
1105 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1109 @item snapshot_delete_blkdev_internal
1110 @findex snapshot_delete_blkdev_internal
1111 Delete an internal snapshot on device if it support
1115 .name = "drive_mirror
",
1116 .args_type = "reuse
:-n
,full
:-f
,device
:B
,target
:s
,format
:s?
",
1117 .params = "[-n
] [-f
] device target
[format
]",
1118 .help = "initiates live storage
\n\t\t\t"
1119 "migration
for a device
. The device
's contents are\n\t\t\t"
1120 "copied to the new image file, including data that\n\t\t\t"
1121 "is written after the command is started.\n\t\t\t"
1122 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1123 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1124 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1125 "so that the result does not need a backing file.\n\t\t\t",
1126 .mhandler.cmd = hmp_drive_mirror,
1130 @findex drive_mirror
1131 Start mirroring a block device's writes to a
new destination
,
1132 using the specified target
.
1136 .name
= "drive_backup",
1137 .args_type
= "reuse:-n,full:-f,device:B,target:s,format:s?",
1138 .params
= "[-n] [-f] device target [format]",
1139 .help
= "initiates a point-in-time\n\t\t\t"
1140 "copy for a device. The device's contents are\n\t\t\t"
1141 "copied to the new image file, excluding data that\n\t\t\t"
1142 "is written after the command is started.\n\t\t\t"
1143 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1144 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1145 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1146 "so that the result does not need a backing file.\n\t\t\t",
1147 .mhandler
.cmd
= hmp_drive_backup
,
1151 @findex drive_backup
1152 Start a point
-in-time copy of a block device to a specificed target
.
1156 .name
= "drive_add",
1157 .args_type
= "pci_addr:s,opts:s",
1158 .params
= "[[<domain>:]<bus>:]<slot>\n"
1159 "[file=file][,if=type][,bus=n]\n"
1160 "[,unit=m][,media=d][,index=i]\n"
1161 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1162 "[,snapshot=on|off][,cache=on|off]\n"
1163 "[,readonly=on|off][,copy-on-read=on|off]",
1164 .help
= "add drive to PCI storage controller",
1165 .mhandler
.cmd
= hmp_drive_add
,
1171 Add drive to PCI storage controller
.
1175 .name
= "pcie_aer_inject_error",
1176 .args_type
= "advisory_non_fatal:-a,correctable:-c,"
1177 "id:s,error_status:s,"
1178 "header0:i?,header1:i?,header2:i?,header3:i?,"
1179 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1180 .params
= "[-a] [-c] id "
1181 "<error_status> [<tlp header> [<tlp header prefix>]]",
1182 .help
= "inject pcie aer error\n\t\t\t"
1183 " -a for advisory non fatal error\n\t\t\t"
1184 " -c for correctable error\n\t\t\t"
1185 "<id> = qdev device id\n\t\t\t"
1186 "<error_status> = error string or 32bit\n\t\t\t"
1187 "<tlb header> = 32bit x 4\n\t\t\t"
1188 "<tlb header prefix> = 32bit x 4",
1189 .user_print
= pcie_aer_inject_error_print
,
1190 .mhandler
.cmd_new
= hmp_pcie_aer_inject_error
,
1194 @item pcie_aer_inject_error
1195 @findex pcie_aer_inject_error
1196 Inject PCIe AER error
1200 .name
= "host_net_add",
1201 .args_type
= "device:s,opts:s?",
1202 .params
= "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1203 .help
= "add host VLAN client",
1204 .mhandler
.cmd
= hmp_host_net_add
,
1205 .command_completion
= host_net_add_completion
,
1210 @findex host_net_add
1211 Add host VLAN client
.
1215 .name
= "host_net_remove",
1216 .args_type
= "vlan_id:i,device:s",
1217 .params
= "vlan_id name",
1218 .help
= "remove host VLAN client",
1219 .mhandler
.cmd
= hmp_host_net_remove
,
1220 .command_completion
= host_net_remove_completion
,
1224 @item host_net_remove
1225 @findex host_net_remove
1226 Remove host VLAN client
.
1230 .name
= "netdev_add",
1231 .args_type
= "netdev:O",
1232 .params
= "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1233 .help
= "add host network device",
1234 .mhandler
.cmd
= hmp_netdev_add
,
1235 .command_completion
= netdev_add_completion
,
1241 Add host network device
.
1245 .name
= "netdev_del",
1246 .args_type
= "id:s",
1248 .help
= "remove host network device",
1249 .mhandler
.cmd
= hmp_netdev_del
,
1250 .command_completion
= netdev_del_completion
,
1256 Remove host network device
.
1260 .name
= "object_add",
1261 .args_type
= "object:O",
1262 .params
= "[qom-type=]type,id=str[,prop=value][,...]",
1263 .help
= "create QOM object",
1264 .mhandler
.cmd
= hmp_object_add
,
1265 .command_completion
= object_add_completion
,
1275 .name
= "object_del",
1276 .args_type
= "id:s",
1278 .help
= "destroy QOM object",
1279 .mhandler
.cmd
= hmp_object_del
,
1280 .command_completion
= object_del_completion
,
1291 .name
= "hostfwd_add",
1292 .args_type
= "arg1:s,arg2:s?,arg3:s?",
1293 .params
= "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1294 .help
= "redirect TCP or UDP connections from host to guest (requires -net user)",
1295 .mhandler
.cmd
= hmp_hostfwd_add
,
1301 Redirect TCP or UDP connections from host to
guest (requires
-net user
).
1306 .name
= "hostfwd_remove",
1307 .args_type
= "arg1:s,arg2:s?,arg3:s?",
1308 .params
= "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1309 .help
= "remove host-to-guest TCP or UDP redirection",
1310 .mhandler
.cmd
= hmp_hostfwd_remove
,
1315 @item hostfwd_remove
1316 @findex hostfwd_remove
1317 Remove host
-to
-guest TCP or UDP redirection
.
1322 .args_type
= "value:M",
1324 .help
= "request VM to change its memory allocation (in MB)",
1325 .mhandler
.cmd
= hmp_balloon
,
1329 @item balloon @
var{value
}
1331 Request VM to change its memory allocation to @
var{value
} (in MB
).
1336 .args_type
= "name:s,up:b",
1337 .params
= "name on|off",
1338 .help
= "change the link status of a network adapter",
1339 .mhandler
.cmd
= hmp_set_link
,
1340 .command_completion
= set_link_completion
,
1344 @item set_link @
var{name
} [on|off
]
1346 Switch link @
var{name
} on (i
.e
. up
) or
off (i
.e
. down
).
1350 .name
= "watchdog_action",
1351 .args_type
= "action:s",
1352 .params
= "[reset|shutdown|poweroff|pause|debug|none]",
1353 .help
= "change watchdog action",
1354 .mhandler
.cmd
= hmp_watchdog_action
,
1355 .command_completion
= watchdog_action_completion
,
1359 @item watchdog_action
1360 @findex watchdog_action
1361 Change watchdog action
.
1366 .args_type
= "aclname:s",
1367 .params
= "aclname",
1368 .help
= "list rules in the access control list",
1369 .mhandler
.cmd
= hmp_acl_show
,
1373 @item acl_show @
var{aclname
}
1375 List all the matching rules
in the access control list
, and the
default
1376 policy
. There are currently two named access control lists
,
1377 @
var{vnc
.x509dname
} and @
var{vnc
.username
} matching on the x509 client
1378 certificate distinguished name
, and SASL username respectively
.
1382 .name
= "acl_policy",
1383 .args_type
= "aclname:s,policy:s",
1384 .params
= "aclname allow|deny",
1385 .help
= "set default access control list policy",
1386 .mhandler
.cmd
= hmp_acl_policy
,
1390 @item acl_policy @
var{aclname
} @code
{allow|deny
}
1392 Set the
default access control list policy
, used
in the event that
1393 none of the explicit rules match
. The
default policy at startup is
1399 .args_type
= "aclname:s,match:s,policy:s,index:i?",
1400 .params
= "aclname match allow|deny [index]",
1401 .help
= "add a match rule to the access control list",
1402 .mhandler
.cmd
= hmp_acl_add
,
1406 @item acl_add @
var{aclname
} @
var{match
} @code
{allow|deny
} [@
var{index
}]
1408 Add a match rule to the access control list
, allowing or denying access
.
1409 The match will normally be an exact username or x509 distinguished name
,
1410 but can optionally include wildcard globs
. eg @code
{*@@EXAMPLE
.COM
} to
1411 allow all users
in the @code
{EXAMPLE
.COM
} kerberos realm
. The match will
1412 normally be appended to the end of the ACL
, but can be inserted
1413 earlier
in the list
if the optional @
var{index
} parameter is supplied
.
1417 .name
= "acl_remove",
1418 .args_type
= "aclname:s,match:s",
1419 .params
= "aclname match",
1420 .help
= "remove a match rule from the access control list",
1421 .mhandler
.cmd
= hmp_acl_remove
,
1425 @item acl_remove @
var{aclname
} @
var{match
}
1427 Remove the specified match rule from the access control list
.
1431 .name
= "acl_reset",
1432 .args_type
= "aclname:s",
1433 .params
= "aclname",
1434 .help
= "reset the access control list",
1435 .mhandler
.cmd
= hmp_acl_reset
,
1439 @item acl_reset @
var{aclname
}
1441 Remove all matches from the access control list
, and set the
default
1442 policy back to @code
{deny
}.
1446 .name
= "nbd_server_start",
1447 .args_type
= "all:-a,writable:-w,uri:s",
1448 .params
= "nbd_server_start [-a] [-w] host:port",
1449 .help
= "serve block devices on the given host and port",
1450 .mhandler
.cmd
= hmp_nbd_server_start
,
1453 @item nbd_server_start @
var{host
}:@
var{port
}
1454 @findex nbd_server_start
1455 Start an NBD server on the given host and
/or port
. If the @option
{-a
}
1456 option is included
, all of the virtual machine
's block devices that
1457 have an inserted media on them are automatically exported; in this case,
1458 the @option{-w} option makes the devices writable too.
1462 .name = "nbd_server_add",
1463 .args_type = "writable:-w,device:B",
1464 .params = "nbd_server_add [-w] device",
1465 .help = "export a block device via NBD",
1466 .mhandler.cmd = hmp_nbd_server_add,
1469 @item nbd_server_add @var{device}
1470 @findex nbd_server_add
1471 Export a block device through QEMU's NBD server
, which must be started
1472 beforehand with @command
{nbd_server_start
}. The @option
{-w
} option makes the
1473 exported device writable too
.
1477 .name
= "nbd_server_stop",
1479 .params
= "nbd_server_stop",
1480 .help
= "stop serving block devices using the NBD protocol",
1481 .mhandler
.cmd
= hmp_nbd_server_stop
,
1484 @item nbd_server_stop
1485 @findex nbd_server_stop
1486 Stop the QEMU embedded NBD server
.
1490 #
if defined(TARGET_I386
)
1494 .args_type
= "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1495 .params
= "[-b] cpu bank status mcgstatus addr misc",
1496 .help
= "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1497 .mhandler
.cmd
= hmp_mce
,
1502 @item mce @
var{cpu
} @
var{bank
} @
var{status
} @
var{mcgstatus
} @
var{addr
} @
var{misc
}
1504 Inject an MCE on the given
CPU (x86 only
).
1509 .args_type
= "fdname:s",
1510 .params
= "getfd name",
1511 .help
= "receive a file descriptor via SCM rights and assign it a name",
1512 .mhandler
.cmd
= hmp_getfd
,
1516 @item getfd @
var{fdname
}
1518 If a file descriptor is passed alongside
this command
using the SCM_RIGHTS
1519 mechanism on unix sockets
, it is stored
using the name @
var{fdname
} for
1520 later use by other monitor commands
.
1525 .args_type
= "fdname:s",
1526 .params
= "closefd name",
1527 .help
= "close a file descriptor previously passed via SCM rights",
1528 .mhandler
.cmd
= hmp_closefd
,
1532 @item closefd @
var{fdname
}
1534 Close the file descriptor previously assigned to @
var{fdname
} using the
1535 @code
{getfd
} command
. This is only needed
if the file descriptor was
never
1536 used by another monitor command
.
1540 .name
= "block_passwd",
1541 .args_type
= "device:B,password:s",
1542 .params
= "block_passwd device password",
1543 .help
= "set the password of encrypted block devices",
1544 .mhandler
.cmd
= hmp_block_passwd
,
1548 @item block_passwd @
var{device
} @
var{password
}
1549 @findex block_passwd
1550 Set the encrypted device @
var{device
} password to @
var{password
}
1554 .name
= "block_set_io_throttle",
1555 .args_type
= "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1556 .params
= "device bps bps_rd bps_wr iops iops_rd iops_wr",
1557 .help
= "change I/O throttle limits for a block drive",
1558 .mhandler
.cmd
= hmp_block_set_io_throttle
,
1562 @item block_set_io_throttle @
var{device
} @
var{bps
} @
var{bps_rd
} @
var{bps_wr
} @
var{iops
} @
var{iops_rd
} @
var{iops_wr
}
1563 @findex block_set_io_throttle
1564 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
}
1568 .name
= "set_password",
1569 .args_type
= "protocol:s,password:s,connected:s?",
1570 .params
= "protocol password action-if-connected",
1571 .help
= "set spice/vnc password",
1572 .mhandler
.cmd
= hmp_set_password
,
1576 @item set_password
[ vnc | spice
] password
[ action
-if-connected
]
1577 @findex set_password
1578 Change spice
/vnc password
. Use zero to make the password stay valid
1579 forever
. @
var{action
-if-connected
} specifies what should happen
in
1580 case a connection is established
: @
var{fail
} makes the password change
1581 fail
. @
var{disconnect
} changes the password and disconnects the
1582 client
. @
var{keep
} changes the password and keeps the connection up
.
1583 @
var{keep
} is the
default.
1587 .name
= "expire_password",
1588 .args_type
= "protocol:s,time:s",
1589 .params
= "protocol time",
1590 .help
= "set spice/vnc password expire-time",
1591 .mhandler
.cmd
= hmp_expire_password
,
1595 @item expire_password
[ vnc | spice
] expire
-time
1596 @findex expire_password
1597 Specify when a password
for spice
/vnc becomes
1598 invalid
. @
var{expire
-time
} accepts
:
1602 Invalidate password instantly
.
1605 Password stays valid forever
.
1608 Password stays valid
for @
var{nsec
} seconds starting now
.
1611 Password is invalidated at the given time
. @
var{nsec
} are the seconds
1612 passed since
1970, i
.e
. unix epoch
.
1618 .name
= "chardev-add",
1619 .args_type
= "args:s",
1621 .help
= "add chardev",
1622 .mhandler
.cmd
= hmp_chardev_add
,
1623 .command_completion
= chardev_add_completion
,
1627 @item chardev
-add args
1629 chardev_add accepts the same parameters as the
-chardev command line
switch.
1634 .name
= "chardev-remove",
1635 .args_type
= "id:s",
1637 .help
= "remove chardev",
1638 .mhandler
.cmd
= hmp_chardev_remove
,
1639 .command_completion
= chardev_remove_completion
,
1643 @item chardev
-remove id
1644 @findex chardev
-remove
1645 Removes the chardev @
var{id
}.
1651 .args_type
= "device:B,command:s",
1652 .params
= "[device] \"[command]\"",
1653 .help
= "run a qemu-io command on a block device",
1654 .mhandler
.cmd
= hmp_qemu_io
,
1658 @item qemu
-io @
var{device
} @
var{command
}
1660 Executes a qemu
-io command on the given block device
.
1666 .args_type
= "id:i",
1669 .mhandler
.cmd
= hmp_cpu_add
,
1673 @item cpu
-add @
var{id
}
1675 Add CPU with id @
var{id
}
1680 .args_type
= "path:s?",
1682 .help
= "list QOM properties",
1683 .mhandler
.cmd
= hmp_qom_list
,
1687 @item qom
-list
[@
var{path
}]
1688 Print QOM properties of object at location @
var{path
}
1693 .args_type
= "path:s,property:s,value:s",
1694 .params
= "path property value",
1695 .help
= "set QOM property",
1696 .mhandler
.cmd
= hmp_qom_set
,
1700 @item qom
-set @
var{path
} @
var{property
} @
var{value
}
1701 Set QOM property @
var{property
} of object at location @
var{path
} to value @
var{value
}
1706 .args_type
= "item:s?",
1707 .params
= "[subcommand]",
1708 .help
= "show various information about the system state",
1709 .mhandler
.cmd
= hmp_info_help
,
1710 .sub_table
= info_cmds
,
1714 @item info @
var{subcommand
}
1716 Show various information about the system state
.
1720 show the version of QEMU
1722 show the various VLANs and the associated devices
1724 show the character devices
1726 show the block devices
1727 @item info blockstats
1728 show block device statistics
1729 @item info registers
1730 show the cpu registers
1732 show infos
for each CPU
1734 show the command line history
1736 show the interrupts
statistics (if available
)
1738 show
i8259 (PIC
) state
1740 show emulated PCI device info
1742 show virtual to physical memory
mappings (i386
, SH4
, SPARC
, PPC
, and Xtensa only
)
1744 show the active virtual memory
mappings (i386 only
)
1746 show
dynamic compiler info
1748 show NUMA information
1750 show KVM information
1752 show USB devices plugged on the virtual USB hub
1754 show all USB host devices
1756 show profiling information
1758 show information about active capturing
1759 @item info snapshots
1760 show list of VM snapshots
1762 show the current VM
status (running|paused
)
1764 show which guest mouse is receiving events
1766 show the vnc server status
1768 show the current VM name
1770 show the current VM UUID
1774 show user network stack connection states
1776 show migration status
1777 @item info migrate_capabilities
1778 show current migration capabilities
1779 @item info migrate_parameters
1780 show current migration parameters
1781 @item info migrate_cache_size
1782 show current migration XBZRLE cache size
1784 show balloon information
1788 show qdev device model list
1790 show object composition tree
1795 @item info memory
-devices
1796 show the memory devices
1801 @item info
trace-events
1802 show available
trace events and their state