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?,read-only-mode:s?",
198 .params = "device filename [format [read-only-mode]]",
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} [@var{read-only-mode}]]
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 @var{read-only-mode} may be used to change the read-only status of the device.
219 It accepts the following values:
223 Retains the current status; this is the default.
226 Makes the device read-only.
229 Makes the device writable.
232 @item change vnc @var{display},@var{options}
233 Change the configuration of the VNC server. The valid syntax for @var{display}
234 and @var{options} are described at @ref{sec_invocation}. eg
237 (qemu) change vnc localhost:1
240 @item change vnc password [@var{password}]
242 Change the password associated with the VNC server. If the new password is not
243 supplied, the monitor will prompt for it to be entered. VNC passwords are only
244 significant up to 8 letters. eg
247 (qemu) change vnc password
255 .name = "screendump",
256 .args_type = "filename:F",
257 .params = "filename",
258 .help = "save screen into PPM image 'filename
'",
259 .mhandler.cmd = hmp_screendump,
263 @item screendump @var{filename}
265 Save screen into PPM image @var{filename}.
270 .args_type = "filename:F",
271 .params = "filename",
272 .help = "output logs to 'filename
'",
273 .mhandler.cmd = hmp_logfile,
277 @item logfile @var{filename}
279 Output logs to @var{filename}.
283 .name = "trace-event",
284 .args_type = "name:s,option:b",
285 .params = "name on|off",
286 .help = "changes status of a specific trace event",
287 .mhandler.cmd = hmp_trace_event,
288 .command_completion = trace_event_completion,
294 changes status of a trace event
297 #if defined(CONFIG_TRACE_SIMPLE)
299 .name = "trace-file",
300 .args_type = "op:s?,arg:F?",
301 .params = "on|off|flush|set [arg]",
302 .help = "open, close, or flush trace file, or set a new file name",
303 .mhandler.cmd = hmp_trace_file,
307 @item trace-file on|off|flush
309 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
315 .args_type = "items:s",
316 .params = "item1[,...]",
317 .help = "activate logging of the specified items",
318 .mhandler.cmd = hmp_log,
322 @item log @var{item1}[,...]
324 Activate logging of the specified items.
329 .args_type = "name:s?",
330 .params = "[tag|id]",
331 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
332 .mhandler.cmd = hmp_savevm,
336 @item savevm [@var{tag}|@var{id}]
338 Create a snapshot of the whole virtual machine. If @var{tag} is
339 provided, it is used as human readable identifier. If there is already
340 a snapshot with the same tag or ID, it is replaced. More info at
346 .args_type = "name:s",
348 .help = "restore a VM snapshot from its tag or id",
349 .mhandler.cmd = hmp_loadvm,
350 .command_completion = loadvm_completion,
354 @item loadvm @var{tag}|@var{id}
356 Set the whole virtual machine to the snapshot identified by the tag
357 @var{tag} or the unique snapshot ID @var{id}.
362 .args_type = "name:s",
364 .help = "delete a VM snapshot from its tag or id",
365 .mhandler.cmd = hmp_delvm,
366 .command_completion = delvm_completion,
370 @item delvm @var{tag}|@var{id}
372 Delete the snapshot identified by @var{tag} or @var{id}.
376 .name = "singlestep",
377 .args_type = "option:s?",
378 .params = "[on|off]",
379 .help = "run emulation in singlestep mode or switch to normal mode",
380 .mhandler.cmd = hmp_singlestep,
384 @item singlestep [off]
386 Run the emulation in single step mode.
387 If called with option off, the emulation returns to normal mode.
394 .help = "stop emulation",
395 .mhandler.cmd = hmp_stop,
408 .help = "resume emulation",
409 .mhandler.cmd = hmp_cont,
419 .name = "system_wakeup",
422 .help = "wakeup guest from suspend",
423 .mhandler.cmd = hmp_system_wakeup,
428 @findex system_wakeup
429 Wakeup guest from suspend.
434 .args_type = "device:s?",
435 .params = "[device]",
436 .help = "start gdbserver on given device (default 'tcp
::1234'), stop with 'none
'",
437 .mhandler.cmd = hmp_gdbserver,
441 @item gdbserver [@var{port}]
443 Start gdbserver session (default @var{port}=1234)
448 .args_type = "fmt:/,addr:l",
449 .params = "/fmt addr",
450 .help = "virtual memory dump starting at 'addr
'",
451 .mhandler.cmd = hmp_memory_dump,
455 @item x/fmt @var{addr}
457 Virtual memory dump starting at @var{addr}.
462 .args_type = "fmt:/,addr:l",
463 .params = "/fmt addr",
464 .help = "physical memory dump starting at 'addr
'",
465 .mhandler.cmd = hmp_physical_memory_dump,
469 @item xp /@var{fmt} @var{addr}
471 Physical memory dump starting at @var{addr}.
473 @var{fmt} is a format which tells the command how to format the
474 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
478 is the number of items to be dumped.
481 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
482 c (char) or i (asm instruction).
485 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
486 @code{h} or @code{w} can be specified with the @code{i} format to
487 respectively select 16 or 32 bit code instruction size.
494 Dump 10 instructions at the current instruction pointer:
499 0x90107065: lea 0x0(%esi,1),%esi
500 0x90107069: lea 0x0(%edi,1),%edi
502 0x90107071: jmp 0x90107080
510 Dump 80 16 bit values at the start of the video memory.
512 (qemu) xp/80hx 0xb8000
513 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
514 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
515 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
516 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
517 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
518 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
519 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
520 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
521 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
522 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
529 .args_type = "fmt:/,val:l",
530 .params = "/fmt expr",
531 .help = "print expression value (use $reg for CPU register access)",
532 .mhandler.cmd = do_print,
536 @item p or print/@var{fmt} @var{expr}
538 Print expression value. Only the @var{format} part of @var{fmt} is
544 .args_type = "fmt:/,addr:i,index:i.",
545 .params = "/fmt addr",
546 .help = "I/O port read",
547 .mhandler.cmd = hmp_ioport_read,
551 @item i/@var{fmt} @var{addr} [.@var{index}]
558 .args_type = "fmt:/,addr:i,val:i",
559 .params = "/fmt addr value",
560 .help = "I/O port write",
561 .mhandler.cmd = hmp_ioport_write,
565 @item o/@var{fmt} @var{addr} @var{val}
572 .args_type = "keys:s,hold-time:i?",
573 .params = "keys [hold_ms]",
574 .help = "send keys to the VM (e.g. 'sendkey ctrl
-alt
-f1
', default hold time=100 ms)",
575 .mhandler.cmd = hmp_sendkey,
576 .command_completion = sendkey_completion,
580 @item sendkey @var{keys}
582 Send @var{keys} to the guest. @var{keys} could be the name of the
583 key or the raw value in hexadecimal format. Use @code{-} to press
584 several keys simultaneously. Example:
589 This command is useful to send keys that your graphical user interface
590 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
594 .name = "system_reset",
597 .help = "reset the system",
598 .mhandler.cmd = hmp_system_reset,
608 .name = "system_powerdown",
611 .help = "send system power down event",
612 .mhandler.cmd = hmp_system_powerdown,
616 @item system_powerdown
617 @findex system_powerdown
618 Power down the system (if supported).
623 .args_type = "start:i,size:i",
624 .params = "addr size",
625 .help = "compute the checksum of a memory region",
626 .mhandler.cmd = hmp_sum,
630 @item sum @var{addr} @var{size}
632 Compute the checksum of a memory region.
637 .args_type = "devname:s",
639 .help = "add USB device (e.g. 'host
:bus
.addr
' or 'host
:vendor_id
:product_id
')",
640 .mhandler.cmd = hmp_usb_add,
644 @item usb_add @var{devname}
646 Add the USB device @var{devname}. For details of available devices see
652 .args_type = "devname:s",
654 .help = "remove USB device 'bus
.addr
'",
655 .mhandler.cmd = hmp_usb_del,
659 @item usb_del @var{devname}
661 Remove the USB device @var{devname} from the QEMU virtual USB
662 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
663 command @code{info usb} to see the devices you can remove.
667 .name = "device_add",
668 .args_type = "device:O",
669 .params = "driver[,prop=value][,...]",
670 .help = "add device, like -device on the command line",
671 .mhandler.cmd = hmp_device_add,
672 .command_completion = device_add_completion,
676 @item device_add @var{config}
682 .name = "device_del",
685 .help = "remove device",
686 .mhandler.cmd = hmp_device_del,
687 .command_completion = device_del_completion,
691 @item device_del @var{id}
693 Remove device @var{id}. @var{id} may be a short ID
694 or a QOM object path.
699 .args_type = "index:i",
701 .help = "set the default CPU",
702 .mhandler.cmd = hmp_cpu,
706 @item cpu @var{index}
712 .name = "mouse_move",
713 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
714 .params = "dx dy [dz]",
715 .help = "send mouse move events",
716 .mhandler.cmd = hmp_mouse_move,
720 @item mouse_move @var{dx} @var{dy} [@var{dz}]
722 Move the active mouse to the specified coordinates @var{dx} @var{dy}
723 with optional scroll axis @var{dz}.
727 .name = "mouse_button",
728 .args_type = "button_state:i",
730 .help = "change mouse button state (1=L, 2=M, 4=R)",
731 .mhandler.cmd = hmp_mouse_button,
735 @item mouse_button @var{val}
737 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
742 .args_type = "index:i",
744 .help = "set which mouse device receives events",
745 .mhandler.cmd = hmp_mouse_set,
749 @item mouse_set @var{index}
751 Set which mouse device receives events at given @var{index}, index
759 .name = "wavcapture",
760 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
761 .params = "path [frequency [bits [channels]]]",
762 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
763 .mhandler.cmd = hmp_wavcapture,
766 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
768 Capture audio into @var{filename}. Using sample rate @var{frequency}
769 bits per sample @var{bits} and number of channels @var{channels}.
773 @item Sample rate = 44100 Hz - CD quality
775 @item Number of channels = 2 - Stereo
780 .name = "stopcapture",
782 .params = "capture index",
783 .help = "stop capture",
784 .mhandler.cmd = hmp_stopcapture,
787 @item stopcapture @var{index}
789 Stop capture with a given @var{index}, index can be obtained with
797 .args_type = "val:l,size:i,filename:s",
798 .params = "addr size file",
799 .help = "save to disk virtual memory dump starting at 'addr
' of size 'size
'",
800 .mhandler.cmd = hmp_memsave,
804 @item memsave @var{addr} @var{size} @var{file}
806 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
811 .args_type = "val:l,size:i,filename:s",
812 .params = "addr size file",
813 .help = "save to disk physical memory dump starting at 'addr
' of size 'size
'",
814 .mhandler.cmd = hmp_pmemsave,
818 @item pmemsave @var{addr} @var{size} @var{file}
820 save to disk physical memory dump starting at @var{addr} of size @var{size}.
825 .args_type = "bootdevice:s",
826 .params = "bootdevice",
827 .help = "define new values for the boot device list",
828 .mhandler.cmd = hmp_boot_set,
832 @item boot_set @var{bootdevicelist}
834 Define new values for the boot device list. Those values will override
835 the values specified on the command line through the @code{-boot} option.
837 The values that can be specified here depend on the machine type, but are
838 the same that can be specified in the @code{-boot} command line option.
845 .help = "inject an NMI",
846 .mhandler.cmd = hmp_nmi,
851 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
856 .name = "ringbuf_write",
857 .args_type = "device:s,data:s",
858 .params = "device data",
859 .help = "Write to a ring buffer character device",
860 .mhandler.cmd = hmp_ringbuf_write,
861 .command_completion = ringbuf_write_completion,
865 @item ringbuf_write @var{device} @var{data}
866 @findex ringbuf_write
867 Write @var{data} to ring buffer character device @var{device}.
868 @var{data} must be a UTF-8 string.
873 .name = "ringbuf_read",
874 .args_type = "device:s,size:i",
875 .params = "device size",
876 .help = "Read from a ring buffer character device",
877 .mhandler.cmd = hmp_ringbuf_read,
878 .command_completion = ringbuf_write_completion,
882 @item ringbuf_read @var{device}
884 Read and print up to @var{size} bytes from ring buffer character
886 Certain non-printable characters are printed \uXXXX, where XXXX is the
887 character code in hexadecimal. Character \ is printed \\.
888 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
889 NUL characters, after the ring buffer lost data, and when reading
890 stops because the size limit is reached.
896 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
897 .params = "[-d] [-b] [-i] uri",
898 .help = "migrate to URI (using -d to not wait for completion)"
899 "\n\t\t\t -b for migration without shared storage with"
900 " full copy of disk\n\t\t\t -i for migration without "
901 "shared storage with incremental copy of disk "
902 "(base image shared between src and destination)",
903 .mhandler.cmd = hmp_migrate,
908 @item migrate [-d] [-b] [-i] @var{uri}
910 Migrate to @var{uri} (using -d to not wait for completion).
911 -b for migration with full copy of disk
912 -i for migration with incremental copy of disk (base image is shared)
916 .name = "migrate_cancel",
919 .help = "cancel the current VM migration",
920 .mhandler.cmd = hmp_migrate_cancel,
925 @findex migrate_cancel
926 Cancel the current VM migration.
931 .name = "migrate_incoming",
932 .args_type = "uri:s",
934 .help = "Continue an incoming migration from an -incoming defer",
935 .mhandler.cmd = hmp_migrate_incoming,
939 @item migrate_incoming @var{uri}
940 @findex migrate_incoming
941 Continue an incoming migration using the @var{uri} (that has the same syntax
942 as the -incoming option).
947 .name = "migrate_set_cache_size",
948 .args_type = "value:o",
950 .help = "set cache size (in bytes) for XBZRLE migrations,"
951 "the cache size will be rounded down to the nearest "
953 "The cache size affects the number of cache misses."
954 "In case of a high cache miss ratio you need to increase"
956 .mhandler.cmd = hmp_migrate_set_cache_size,
960 @item migrate_set_cache_size @var{value}
961 @findex migrate_set_cache_size
962 Set cache size to @var{value} (in bytes) for xbzrle migrations.
966 .name = "migrate_set_speed",
967 .args_type = "value:o",
969 .help = "set maximum speed (in bytes) for migrations. "
970 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
971 .mhandler.cmd = hmp_migrate_set_speed,
975 @item migrate_set_speed @var{value}
976 @findex migrate_set_speed
977 Set maximum speed to @var{value} (in bytes) for migrations.
981 .name = "migrate_set_downtime",
982 .args_type = "value:T",
984 .help = "set maximum tolerated downtime (in seconds) for migrations",
985 .mhandler.cmd = hmp_migrate_set_downtime,
989 @item migrate_set_downtime @var{second}
990 @findex migrate_set_downtime
991 Set maximum tolerated downtime (in seconds) for migration.
995 .name = "migrate_set_capability",
996 .args_type = "capability:s,state:b",
997 .params = "capability state",
998 .help = "Enable/Disable the usage of a capability for migration",
999 .mhandler.cmd = hmp_migrate_set_capability,
1000 .command_completion = migrate_set_capability_completion,
1004 @item migrate_set_capability @var{capability} @var{state}
1005 @findex migrate_set_capability
1006 Enable/Disable the usage of a capability @var{capability} for migration.
1010 .name = "migrate_set_parameter",
1011 .args_type = "parameter:s,value:i",
1012 .params = "parameter value",
1013 .help = "Set the parameter for migration",
1014 .mhandler.cmd = hmp_migrate_set_parameter,
1015 .command_completion = migrate_set_parameter_completion,
1019 @item migrate_set_parameter @var{parameter} @var{value}
1020 @findex migrate_set_parameter
1021 Set the parameter @var{parameter} for migration.
1025 .name = "migrate_start_postcopy",
1028 .help = "Followup to a migration command to switch the migration"
1029 " to postcopy mode. The x-postcopy-ram capability must "
1030 "be set before the original migration command.",
1031 .mhandler.cmd = hmp_migrate_start_postcopy,
1035 @item migrate_start_postcopy
1036 @findex migrate_start_postcopy
1037 Switch in-progress migration to postcopy mode. Ignored after the end of
1038 migration (or once already in postcopy).
1042 .name = "client_migrate_info",
1043 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1044 .params = "protocol hostname port tls-port cert-subject",
1045 .help = "set migration information for remote display",
1046 .mhandler.cmd = hmp_client_migrate_info,
1050 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1051 @findex client_migrate_info
1052 Set migration information for remote display. This makes the server
1053 ask the client to automatically reconnect using the new parameters
1054 once migration finished successfully. Only implemented for SPICE.
1058 .name = "dump-guest-memory",
1059 .args_type = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1060 .params = "[-p] [-d] [-z|-l|-s] filename [begin length]",
1061 .help = "dump guest memory into file 'filename
'.\n\t\t\t"
1062 "-p: do paging to get guest's memory mapping
.\n\t\t\t"
1063 "-d
: return immediately (do not wait
for completion
).\n\t\t\t"
1064 "-z
: dump
in kdump
-compressed format
, with zlib compression
.\n\t\t\t"
1065 "-l
: dump
in kdump
-compressed format
, with lzo compression
.\n\t\t\t"
1066 "-s
: dump
in kdump
-compressed format
, with snappy compression
.\n\t\t\t"
1067 "begin
: the starting physical address
.\n\t\t\t"
1068 "length
: the memory size
, in bytes
.",
1069 .mhandler.cmd = hmp_dump_guest_memory,
1074 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1075 @item dump-guest-memory [-z|-l|-s] @var{filename}
1076 @findex dump-guest-memory
1077 Dump guest memory to @var{protocol}. The file can be processed with crash or
1078 gdb. Without -z|-l|-s, the dump format is ELF.
1079 -p: do paging to get guest's memory mapping.
1080 -z: dump in kdump-compressed format, with zlib compression.
1081 -l: dump in kdump-compressed format, with lzo compression.
1082 -s: dump in kdump-compressed format, with snappy compression.
1083 filename: dump file name.
1084 begin: the starting physical address. It's optional, and should be
1085 specified together with length.
1086 length: the memory size, in bytes. It's optional, and should be specified
1087 together with begin.
1090 #if defined(TARGET_S390X)
1092 .name = "dump
-skeys
",
1093 .args_type = "filename
:F
",
1095 .help = "Save guest storage keys into file
'filename'.\n",
1096 .mhandler.cmd = hmp_dump_skeys,
1101 @item dump-skeys @var{filename}
1103 Save guest storage keys to a file.
1107 .name = "snapshot_blkdev
",
1108 .args_type = "reuse
:-n
,device
:B
,snapshot
-file
:s?
,format
:s?
",
1109 .params = "[-n
] device
[new-image
-file
] [format
]",
1110 .help = "initiates a live snapshot
\n\t\t\t"
1111 "of device
. If a
new image file is specified
, the
\n\t\t\t"
1112 "new image file will become the
new root image
.\n\t\t\t"
1113 "If format is specified
, the snapshot file will
\n\t\t\t"
1114 "be created
in that format
.\n\t\t\t"
1115 "The
default format is qcow2
. The
-n flag requests QEMU
\n\t\t\t"
1116 "to reuse the image found
in new-image
-file
, instead of
\n\t\t\t"
1117 "recreating it from scratch
.",
1118 .mhandler.cmd = hmp_snapshot_blkdev,
1122 @item snapshot_blkdev
1123 @findex snapshot_blkdev
1124 Snapshot device, using snapshot file as target if provided
1128 .name = "snapshot_blkdev_internal
",
1129 .args_type = "device
:B
,name
:s
",
1130 .params = "device name
",
1131 .help = "take an internal snapshot of device
.\n\t\t\t"
1132 "The format of the image used by device must
\n\t\t\t"
1133 "support it
, such as qcow2
.\n\t\t\t",
1134 .mhandler.cmd = hmp_snapshot_blkdev_internal,
1138 @item snapshot_blkdev_internal
1139 @findex snapshot_blkdev_internal
1140 Take an internal snapshot on device if it support
1144 .name = "snapshot_delete_blkdev_internal
",
1145 .args_type = "device
:B
,name
:s
,id
:s?
",
1146 .params = "device name
[id
]",
1147 .help = "delete an internal snapshot of device
.\n\t\t\t"
1148 "If id is specified
, qemu will
try delete
\n\t\t\t"
1149 "the snapshot matching both id and name
.\n\t\t\t"
1150 "The format of the image used by device must
\n\t\t\t"
1151 "support it
, such as qcow2
.\n\t\t\t",
1152 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
1156 @item snapshot_delete_blkdev_internal
1157 @findex snapshot_delete_blkdev_internal
1158 Delete an internal snapshot on device if it support
1162 .name = "drive_mirror
",
1163 .args_type = "reuse
:-n
,full
:-f
,device
:B
,target
:s
,format
:s?
",
1164 .params = "[-n
] [-f
] device target
[format
]",
1165 .help = "initiates live storage
\n\t\t\t"
1166 "migration
for a device
. The device
's contents are\n\t\t\t"
1167 "copied to the new image file, including data that\n\t\t\t"
1168 "is written after the command is started.\n\t\t\t"
1169 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1170 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1171 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1172 "so that the result does not need a backing file.\n\t\t\t",
1173 .mhandler.cmd = hmp_drive_mirror,
1177 @findex drive_mirror
1178 Start mirroring a block device's writes to a
new destination
,
1179 using the specified target
.
1183 .name
= "drive_backup",
1184 .args_type
= "reuse:-n,full:-f,device:B,target:s,format:s?",
1185 .params
= "[-n] [-f] device target [format]",
1186 .help
= "initiates a point-in-time\n\t\t\t"
1187 "copy for a device. The device's contents are\n\t\t\t"
1188 "copied to the new image file, excluding data that\n\t\t\t"
1189 "is written after the command is started.\n\t\t\t"
1190 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1191 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1192 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1193 "so that the result does not need a backing file.\n\t\t\t",
1194 .mhandler
.cmd
= hmp_drive_backup
,
1198 @findex drive_backup
1199 Start a point
-in-time copy of a block device to a specificed target
.
1203 .name
= "drive_add",
1204 .args_type
= "pci_addr:s,opts:s",
1205 .params
= "[[<domain>:]<bus>:]<slot>\n"
1206 "[file=file][,if=type][,bus=n]\n"
1207 "[,unit=m][,media=d][,index=i]\n"
1208 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1209 "[,snapshot=on|off][,cache=on|off]\n"
1210 "[,readonly=on|off][,copy-on-read=on|off]",
1211 .help
= "add drive to PCI storage controller",
1212 .mhandler
.cmd
= hmp_drive_add
,
1218 Add drive to PCI storage controller
.
1222 .name
= "pcie_aer_inject_error",
1223 .args_type
= "advisory_non_fatal:-a,correctable:-c,"
1224 "id:s,error_status:s,"
1225 "header0:i?,header1:i?,header2:i?,header3:i?,"
1226 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1227 .params
= "[-a] [-c] id "
1228 "<error_status> [<tlp header> [<tlp header prefix>]]",
1229 .help
= "inject pcie aer error\n\t\t\t"
1230 " -a for advisory non fatal error\n\t\t\t"
1231 " -c for correctable error\n\t\t\t"
1232 "<id> = qdev device id\n\t\t\t"
1233 "<error_status> = error string or 32bit\n\t\t\t"
1234 "<tlb header> = 32bit x 4\n\t\t\t"
1235 "<tlb header prefix> = 32bit x 4",
1236 .mhandler
.cmd
= hmp_pcie_aer_inject_error
,
1240 @item pcie_aer_inject_error
1241 @findex pcie_aer_inject_error
1242 Inject PCIe AER error
1246 .name
= "host_net_add",
1247 .args_type
= "device:s,opts:s?",
1248 .params
= "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
1249 .help
= "add host VLAN client",
1250 .mhandler
.cmd
= hmp_host_net_add
,
1251 .command_completion
= host_net_add_completion
,
1256 @findex host_net_add
1257 Add host VLAN client
.
1261 .name
= "host_net_remove",
1262 .args_type
= "vlan_id:i,device:s",
1263 .params
= "vlan_id name",
1264 .help
= "remove host VLAN client",
1265 .mhandler
.cmd
= hmp_host_net_remove
,
1266 .command_completion
= host_net_remove_completion
,
1270 @item host_net_remove
1271 @findex host_net_remove
1272 Remove host VLAN client
.
1276 .name
= "netdev_add",
1277 .args_type
= "netdev:O",
1278 .params
= "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1279 .help
= "add host network device",
1280 .mhandler
.cmd
= hmp_netdev_add
,
1281 .command_completion
= netdev_add_completion
,
1287 Add host network device
.
1291 .name
= "netdev_del",
1292 .args_type
= "id:s",
1294 .help
= "remove host network device",
1295 .mhandler
.cmd
= hmp_netdev_del
,
1296 .command_completion
= netdev_del_completion
,
1302 Remove host network device
.
1306 .name
= "object_add",
1307 .args_type
= "object:O",
1308 .params
= "[qom-type=]type,id=str[,prop=value][,...]",
1309 .help
= "create QOM object",
1310 .mhandler
.cmd
= hmp_object_add
,
1311 .command_completion
= object_add_completion
,
1321 .name
= "object_del",
1322 .args_type
= "id:s",
1324 .help
= "destroy QOM object",
1325 .mhandler
.cmd
= hmp_object_del
,
1326 .command_completion
= object_del_completion
,
1337 .name
= "hostfwd_add",
1338 .args_type
= "arg1:s,arg2:s?,arg3:s?",
1339 .params
= "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1340 .help
= "redirect TCP or UDP connections from host to guest (requires -net user)",
1341 .mhandler
.cmd
= hmp_hostfwd_add
,
1347 Redirect TCP or UDP connections from host to
guest (requires
-net user
).
1352 .name
= "hostfwd_remove",
1353 .args_type
= "arg1:s,arg2:s?,arg3:s?",
1354 .params
= "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1355 .help
= "remove host-to-guest TCP or UDP redirection",
1356 .mhandler
.cmd
= hmp_hostfwd_remove
,
1361 @item hostfwd_remove
1362 @findex hostfwd_remove
1363 Remove host
-to
-guest TCP or UDP redirection
.
1368 .args_type
= "value:M",
1370 .help
= "request VM to change its memory allocation (in MB)",
1371 .mhandler
.cmd
= hmp_balloon
,
1375 @item balloon @
var{value
}
1377 Request VM to change its memory allocation to @
var{value
} (in MB
).
1382 .args_type
= "name:s,up:b",
1383 .params
= "name on|off",
1384 .help
= "change the link status of a network adapter",
1385 .mhandler
.cmd
= hmp_set_link
,
1386 .command_completion
= set_link_completion
,
1390 @item set_link @
var{name
} [on|off
]
1392 Switch link @
var{name
} on (i
.e
. up
) or
off (i
.e
. down
).
1396 .name
= "watchdog_action",
1397 .args_type
= "action:s",
1398 .params
= "[reset|shutdown|poweroff|pause|debug|none]",
1399 .help
= "change watchdog action",
1400 .mhandler
.cmd
= hmp_watchdog_action
,
1401 .command_completion
= watchdog_action_completion
,
1405 @item watchdog_action
1406 @findex watchdog_action
1407 Change watchdog action
.
1412 .args_type
= "aclname:s",
1413 .params
= "aclname",
1414 .help
= "list rules in the access control list",
1415 .mhandler
.cmd
= hmp_acl_show
,
1419 @item acl_show @
var{aclname
}
1421 List all the matching rules
in the access control list
, and the
default
1422 policy
. There are currently two named access control lists
,
1423 @
var{vnc
.x509dname
} and @
var{vnc
.username
} matching on the x509 client
1424 certificate distinguished name
, and SASL username respectively
.
1428 .name
= "acl_policy",
1429 .args_type
= "aclname:s,policy:s",
1430 .params
= "aclname allow|deny",
1431 .help
= "set default access control list policy",
1432 .mhandler
.cmd
= hmp_acl_policy
,
1436 @item acl_policy @
var{aclname
} @code
{allow|deny
}
1438 Set the
default access control list policy
, used
in the event that
1439 none of the explicit rules match
. The
default policy at startup is
1445 .args_type
= "aclname:s,match:s,policy:s,index:i?",
1446 .params
= "aclname match allow|deny [index]",
1447 .help
= "add a match rule to the access control list",
1448 .mhandler
.cmd
= hmp_acl_add
,
1452 @item acl_add @
var{aclname
} @
var{match
} @code
{allow|deny
} [@
var{index
}]
1454 Add a match rule to the access control list
, allowing or denying access
.
1455 The match will normally be an exact username or x509 distinguished name
,
1456 but can optionally include wildcard globs
. eg @code
{*@@EXAMPLE
.COM
} to
1457 allow all users
in the @code
{EXAMPLE
.COM
} kerberos realm
. The match will
1458 normally be appended to the end of the ACL
, but can be inserted
1459 earlier
in the list
if the optional @
var{index
} parameter is supplied
.
1463 .name
= "acl_remove",
1464 .args_type
= "aclname:s,match:s",
1465 .params
= "aclname match",
1466 .help
= "remove a match rule from the access control list",
1467 .mhandler
.cmd
= hmp_acl_remove
,
1471 @item acl_remove @
var{aclname
} @
var{match
}
1473 Remove the specified match rule from the access control list
.
1477 .name
= "acl_reset",
1478 .args_type
= "aclname:s",
1479 .params
= "aclname",
1480 .help
= "reset the access control list",
1481 .mhandler
.cmd
= hmp_acl_reset
,
1485 @item acl_reset @
var{aclname
}
1487 Remove all matches from the access control list
, and set the
default
1488 policy back to @code
{deny
}.
1492 .name
= "nbd_server_start",
1493 .args_type
= "all:-a,writable:-w,uri:s",
1494 .params
= "nbd_server_start [-a] [-w] host:port",
1495 .help
= "serve block devices on the given host and port",
1496 .mhandler
.cmd
= hmp_nbd_server_start
,
1499 @item nbd_server_start @
var{host
}:@
var{port
}
1500 @findex nbd_server_start
1501 Start an NBD server on the given host and
/or port
. If the @option
{-a
}
1502 option is included
, all of the virtual machine
's block devices that
1503 have an inserted media on them are automatically exported; in this case,
1504 the @option{-w} option makes the devices writable too.
1508 .name = "nbd_server_add",
1509 .args_type = "writable:-w,device:B",
1510 .params = "nbd_server_add [-w] device",
1511 .help = "export a block device via NBD",
1512 .mhandler.cmd = hmp_nbd_server_add,
1515 @item nbd_server_add @var{device}
1516 @findex nbd_server_add
1517 Export a block device through QEMU's NBD server
, which must be started
1518 beforehand with @command
{nbd_server_start
}. The @option
{-w
} option makes the
1519 exported device writable too
.
1523 .name
= "nbd_server_stop",
1525 .params
= "nbd_server_stop",
1526 .help
= "stop serving block devices using the NBD protocol",
1527 .mhandler
.cmd
= hmp_nbd_server_stop
,
1530 @item nbd_server_stop
1531 @findex nbd_server_stop
1532 Stop the QEMU embedded NBD server
.
1536 #
if defined(TARGET_I386
)
1540 .args_type
= "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1541 .params
= "[-b] cpu bank status mcgstatus addr misc",
1542 .help
= "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1543 .mhandler
.cmd
= hmp_mce
,
1548 @item mce @
var{cpu
} @
var{bank
} @
var{status
} @
var{mcgstatus
} @
var{addr
} @
var{misc
}
1550 Inject an MCE on the given
CPU (x86 only
).
1555 .args_type
= "fdname:s",
1556 .params
= "getfd name",
1557 .help
= "receive a file descriptor via SCM rights and assign it a name",
1558 .mhandler
.cmd
= hmp_getfd
,
1562 @item getfd @
var{fdname
}
1564 If a file descriptor is passed alongside
this command
using the SCM_RIGHTS
1565 mechanism on unix sockets
, it is stored
using the name @
var{fdname
} for
1566 later use by other monitor commands
.
1571 .args_type
= "fdname:s",
1572 .params
= "closefd name",
1573 .help
= "close a file descriptor previously passed via SCM rights",
1574 .mhandler
.cmd
= hmp_closefd
,
1578 @item closefd @
var{fdname
}
1580 Close the file descriptor previously assigned to @
var{fdname
} using the
1581 @code
{getfd
} command
. This is only needed
if the file descriptor was
never
1582 used by another monitor command
.
1586 .name
= "block_passwd",
1587 .args_type
= "device:B,password:s",
1588 .params
= "block_passwd device password",
1589 .help
= "set the password of encrypted block devices",
1590 .mhandler
.cmd
= hmp_block_passwd
,
1594 @item block_passwd @
var{device
} @
var{password
}
1595 @findex block_passwd
1596 Set the encrypted device @
var{device
} password to @
var{password
}
1600 .name
= "block_set_io_throttle",
1601 .args_type
= "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1602 .params
= "device bps bps_rd bps_wr iops iops_rd iops_wr",
1603 .help
= "change I/O throttle limits for a block drive",
1604 .mhandler
.cmd
= hmp_block_set_io_throttle
,
1608 @item block_set_io_throttle @
var{device
} @
var{bps
} @
var{bps_rd
} @
var{bps_wr
} @
var{iops
} @
var{iops_rd
} @
var{iops_wr
}
1609 @findex block_set_io_throttle
1610 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
}
1614 .name
= "set_password",
1615 .args_type
= "protocol:s,password:s,connected:s?",
1616 .params
= "protocol password action-if-connected",
1617 .help
= "set spice/vnc password",
1618 .mhandler
.cmd
= hmp_set_password
,
1622 @item set_password
[ vnc | spice
] password
[ action
-if-connected
]
1623 @findex set_password
1624 Change spice
/vnc password
. Use zero to make the password stay valid
1625 forever
. @
var{action
-if-connected
} specifies what should happen
in
1626 case a connection is established
: @
var{fail
} makes the password change
1627 fail
. @
var{disconnect
} changes the password and disconnects the
1628 client
. @
var{keep
} changes the password and keeps the connection up
.
1629 @
var{keep
} is the
default.
1633 .name
= "expire_password",
1634 .args_type
= "protocol:s,time:s",
1635 .params
= "protocol time",
1636 .help
= "set spice/vnc password expire-time",
1637 .mhandler
.cmd
= hmp_expire_password
,
1641 @item expire_password
[ vnc | spice
] expire
-time
1642 @findex expire_password
1643 Specify when a password
for spice
/vnc becomes
1644 invalid
. @
var{expire
-time
} accepts
:
1648 Invalidate password instantly
.
1651 Password stays valid forever
.
1654 Password stays valid
for @
var{nsec
} seconds starting now
.
1657 Password is invalidated at the given time
. @
var{nsec
} are the seconds
1658 passed since
1970, i
.e
. unix epoch
.
1664 .name
= "chardev-add",
1665 .args_type
= "args:s",
1667 .help
= "add chardev",
1668 .mhandler
.cmd
= hmp_chardev_add
,
1669 .command_completion
= chardev_add_completion
,
1673 @item chardev
-add args
1675 chardev_add accepts the same parameters as the
-chardev command line
switch.
1680 .name
= "chardev-remove",
1681 .args_type
= "id:s",
1683 .help
= "remove chardev",
1684 .mhandler
.cmd
= hmp_chardev_remove
,
1685 .command_completion
= chardev_remove_completion
,
1689 @item chardev
-remove id
1690 @findex chardev
-remove
1691 Removes the chardev @
var{id
}.
1697 .args_type
= "device:B,command:s",
1698 .params
= "[device] \"[command]\"",
1699 .help
= "run a qemu-io command on a block device",
1700 .mhandler
.cmd
= hmp_qemu_io
,
1704 @item qemu
-io @
var{device
} @
var{command
}
1706 Executes a qemu
-io command on the given block device
.
1712 .args_type
= "id:i",
1715 .mhandler
.cmd
= hmp_cpu_add
,
1719 @item cpu
-add @
var{id
}
1721 Add CPU with id @
var{id
}
1726 .args_type
= "path:s?",
1728 .help
= "list QOM properties",
1729 .mhandler
.cmd
= hmp_qom_list
,
1733 @item qom
-list
[@
var{path
}]
1734 Print QOM properties of object at location @
var{path
}
1739 .args_type
= "path:s,property:s,value:s",
1740 .params
= "path property value",
1741 .help
= "set QOM property",
1742 .mhandler
.cmd
= hmp_qom_set
,
1746 @item qom
-set @
var{path
} @
var{property
} @
var{value
}
1747 Set QOM property @
var{property
} of object at location @
var{path
} to value @
var{value
}
1752 .args_type
= "item:s?",
1753 .params
= "[subcommand]",
1754 .help
= "show various information about the system state",
1755 .mhandler
.cmd
= hmp_info_help
,
1756 .sub_table
= info_cmds
,