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",
22 @item help or ?
[@
var{cmd
}]
24 Show the help
for all commands or just
for command @
var{cmd
}.
29 .args_type
= "device:B",
30 .params
= "device|all",
31 .help
= "commit changes to the disk images (if -snapshot is used) or backing files",
38 Commit changes to the disk
images (if -snapshot is used
) or backing files
.
39 If the backing file is smaller than the snapshot
, then the backing file will be
40 resized to be the same size as the snapshot
. If the snapshot is smaller than
41 the backing file
, the backing file will not be truncated
. If you want the
42 backing file to match the size of the smaller snapshot
, you can safely truncate
43 it yourself once the commit operation successfully completes
.
50 .help
= "quit the emulator",
61 .name
= "exit_preconfig",
64 .help
= "exit the preconfig state",
65 .cmd
= hmp_exit_preconfig
,
71 @findex exit_preconfig
72 This command makes QEMU exit the preconfig state and proceed with
73 VM initialization
using configuration data provided on the command line
74 and via the QMP monitor during the preconfig state
. The command is only
75 available during the preconfig
state (i
.e
. when the
--preconfig command
76 line option was
in use
).
80 .name
= "block_resize",
81 .args_type
= "device:B,size:o",
82 .params
= "device size",
83 .help
= "resize a block image",
84 .cmd
= hmp_block_resize
,
90 Resize a block image
while a guest is running
. Usually requires guest
91 action to see the updated size
. Resize to a lower size is supported
,
92 but should be used with extreme caution
. Note that
this command only
93 resizes image files
, it can not resize block devices like LVM volumes
.
97 .name
= "block_stream",
98 .args_type
= "device:B,speed:o?,base:s?",
99 .params
= "device [speed [base]]",
100 .help
= "copy data from a backing file into a block device",
101 .cmd
= hmp_block_stream
,
107 Copy data from a backing file into a block device
.
111 .name
= "block_job_set_speed",
112 .args_type
= "device:B,speed:o",
113 .params
= "device speed",
114 .help
= "set maximum speed for a background block operation",
115 .cmd
= hmp_block_job_set_speed
,
119 @item block_job_set_speed
120 @findex block_job_set_speed
121 Set maximum speed
for a background block operation
.
125 .name
= "block_job_cancel",
126 .args_type
= "force:-f,device:B",
127 .params
= "[-f] device",
128 .help
= "stop an active background block operation (use -f"
129 "\n\t\t\t if you want to abort the operation immediately"
130 "\n\t\t\t instead of keep running until data is in sync)",
131 .cmd
= hmp_block_job_cancel
,
135 @item block_job_cancel
136 @findex block_job_cancel
137 Stop an active background block
operation (streaming
, mirroring
).
141 .name
= "block_job_complete",
142 .args_type
= "device:B",
144 .help
= "stop an active background block operation",
145 .cmd
= hmp_block_job_complete
,
149 @item block_job_complete
150 @findex block_job_complete
151 Manually trigger completion of an active background block operation
.
152 For mirroring
, this will
switch the device to the destination path
.
156 .name
= "block_job_pause",
157 .args_type
= "device:B",
159 .help
= "pause an active background block operation",
160 .cmd
= hmp_block_job_pause
,
164 @item block_job_pause
165 @findex block_job_pause
166 Pause an active block streaming operation
.
170 .name
= "block_job_resume",
171 .args_type
= "device:B",
173 .help
= "resume a paused background block operation",
174 .cmd
= hmp_block_job_resume
,
178 @item block_job_resume
179 @findex block_job_resume
180 Resume a paused block streaming operation
.
185 .args_type
= "force:-f,device:B",
186 .params
= "[-f] device",
187 .help
= "eject a removable medium (use -f to force it)",
192 @item eject
[-f
] @
var{device
}
194 Eject a removable
medium (use
-f to force it
).
201 .help
= "remove host block device",
202 .cmd
= hmp_drive_del
,
206 @item drive_del @
var{device
}
208 Remove host block device
. The result is that guest generated IO is no longer
209 submitted against the host device underlying the disk
. Once a drive has
210 been deleted
, the QEMU Block layer returns
-EIO which results
in IO
211 errors
in the guest
for applications that are reading
/writing to the device
.
212 These errors are always reported to the guest
, regardless of the drive
's error
213 actions (drive options rerror, werror).
218 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
219 .params = "device filename [format [read-only-mode]]",
220 .help = "change a removable medium, optional format",
225 @item change @var{device} @var{setting}
227 Change the configuration of a device.
230 @item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
231 Change the medium for a removable disk device to point to @var{filename}. eg
234 (qemu) change ide1-cd0 /path/to/some.iso
237 @var{format} is optional.
239 @var{read-only-mode} may be used to change the read-only status of the device.
240 It accepts the following values:
244 Retains the current status; this is the default.
247 Makes the device read-only.
250 Makes the device writable.
253 @item change vnc @var{display},@var{options}
254 Change the configuration of the VNC server. The valid syntax for @var{display}
255 and @var{options} are described at @ref{sec_invocation}. eg
258 (qemu) change vnc localhost:1
261 @item change vnc password [@var{password}]
263 Change the password associated with the VNC server. If the new password is not
264 supplied, the monitor will prompt for it to be entered. VNC passwords are only
265 significant up to 8 letters. eg
268 (qemu) change vnc password
276 .name = "screendump",
277 .args_type = "filename:F,device:s?,head:i?",
278 .params = "filename [device [head]]",
279 .help = "save screen from head 'head
' of display device 'device
' "
280 "into PPM image 'filename
'",
281 .cmd = hmp_screendump,
285 @item screendump @var{filename}
287 Save screen into PPM image @var{filename}.
292 .args_type = "filename:F",
293 .params = "filename",
294 .help = "output logs to 'filename
'",
299 @item logfile @var{filename}
301 Output logs to @var{filename}.
305 .name = "trace-event",
306 .args_type = "name:s,option:b,vcpu:i?",
307 .params = "name on|off [vcpu]",
308 .help = "changes status of a specific trace event "
309 "(vcpu: vCPU to set, default is all)",
310 .cmd = hmp_trace_event,
311 .command_completion = trace_event_completion,
317 changes status of a trace event
320 #if defined(CONFIG_TRACE_SIMPLE)
322 .name = "trace-file",
323 .args_type = "op:s?,arg:F?",
324 .params = "on|off|flush|set [arg]",
325 .help = "open, close, or flush trace file, or set a new file name",
326 .cmd = hmp_trace_file,
330 @item trace-file on|off|flush
332 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
338 .args_type = "items:s",
339 .params = "item1[,...]",
340 .help = "activate logging of the specified items",
345 @item log @var{item1}[,...]
347 Activate logging of the specified items.
352 .args_type = "name:s?",
354 .help = "save a VM snapshot. If no tag is provided, a new snapshot is created",
359 @item savevm @var{tag}
361 Create a snapshot of the whole virtual machine. If @var{tag} is
362 provided, it is used as human readable identifier. If there is already
363 a snapshot with the same tag, it is replaced. More info at
366 Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
367 only @var{tag} as parameter.
372 .args_type = "name:s",
374 .help = "restore a VM snapshot from its tag",
376 .command_completion = loadvm_completion,
380 @item loadvm @var{tag}
382 Set the whole virtual machine to the snapshot identified by the tag
385 Since 4.0, loadvm stopped accepting snapshot id as parameter.
390 .args_type = "name:s",
392 .help = "delete a VM snapshot from its tag",
394 .command_completion = delvm_completion,
398 @item delvm @var{tag}
400 Delete the snapshot identified by @var{tag}.
402 Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
403 only @var{tag} as parameter.
407 .name = "singlestep",
408 .args_type = "option:s?",
409 .params = "[on|off]",
410 .help = "run emulation in singlestep mode or switch to normal mode",
411 .cmd = hmp_singlestep,
415 @item singlestep [off]
417 Run the emulation in single step mode.
418 If called with option off, the emulation returns to normal mode.
425 .help = "stop emulation",
439 .help = "resume emulation",
450 .name = "system_wakeup",
453 .help = "wakeup guest from suspend",
454 .cmd = hmp_system_wakeup,
459 @findex system_wakeup
460 Wakeup guest from suspend.
465 .args_type = "device:s?",
466 .params = "[device]",
467 .help = "start gdbserver on given device (default 'tcp
::1234'), stop with 'none
'",
468 .cmd = hmp_gdbserver,
472 @item gdbserver [@var{port}]
474 Start gdbserver session (default @var{port}=1234)
479 .args_type = "fmt:/,addr:l",
480 .params = "/fmt addr",
481 .help = "virtual memory dump starting at 'addr
'",
482 .cmd = hmp_memory_dump,
486 @item x/fmt @var{addr}
488 Virtual memory dump starting at @var{addr}.
493 .args_type = "fmt:/,addr:l",
494 .params = "/fmt addr",
495 .help = "physical memory dump starting at 'addr
'",
496 .cmd = hmp_physical_memory_dump,
500 @item xp /@var{fmt} @var{addr}
502 Physical memory dump starting at @var{addr}.
504 @var{fmt} is a format which tells the command how to format the
505 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
509 is the number of items to be dumped.
512 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
513 c (char) or i (asm instruction).
516 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
517 @code{h} or @code{w} can be specified with the @code{i} format to
518 respectively select 16 or 32 bit code instruction size.
525 Dump 10 instructions at the current instruction pointer:
530 0x90107065: lea 0x0(%esi,1),%esi
531 0x90107069: lea 0x0(%edi,1),%edi
533 0x90107071: jmp 0x90107080
541 Dump 80 16 bit values at the start of the video memory.
543 (qemu) xp/80hx 0xb8000
544 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
545 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
546 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
547 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
548 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
549 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
550 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
551 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
552 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
553 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
560 .args_type = "addr:l",
562 .help = "print the host virtual address corresponding to a guest physical address",
567 @item gpa2hva @var{addr}
569 Print the host virtual address at which the guest's physical address @
var{addr
}
576 .args_type
= "addr:l",
578 .help
= "print the host physical address corresponding to a guest physical address",
584 @item gpa2hpa @
var{addr
}
586 Print the host physical address at which the guest
's physical address @var{addr}
592 .args_type = "fmt:/,val:l",
593 .params = "/fmt expr",
594 .help = "print expression value (use $reg for CPU register access)",
599 @item p or print/@var{fmt} @var{expr}
601 Print expression value. Only the @var{format} part of @var{fmt} is
607 .args_type = "fmt:/,addr:i,index:i.",
608 .params = "/fmt addr",
609 .help = "I/O port read",
610 .cmd = hmp_ioport_read,
614 @item i/@var{fmt} @var{addr} [.@var{index}]
621 .args_type = "fmt:/,addr:i,val:i",
622 .params = "/fmt addr value",
623 .help = "I/O port write",
624 .cmd = hmp_ioport_write,
628 @item o/@var{fmt} @var{addr} @var{val}
635 .args_type = "keys:s,hold-time:i?",
636 .params = "keys [hold_ms]",
637 .help = "send keys to the VM (e.g. 'sendkey ctrl
-alt
-f1
', default hold time=100 ms)",
639 .command_completion = sendkey_completion,
643 @item sendkey @var{keys}
645 Send @var{keys} to the guest. @var{keys} could be the name of the
646 key or the raw value in hexadecimal format. Use @code{-} to press
647 several keys simultaneously. Example:
652 This command is useful to send keys that your graphical user interface
653 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
656 .name = "sync-profile",
657 .args_type = "op:s?",
658 .params = "[on|off|reset]",
659 .help = "enable, disable or reset synchronization profiling. "
660 "With no arguments, prints whether profiling is on or off.",
661 .cmd = hmp_sync_profile,
665 @item sync-profile [on|off|reset]
667 Enable, disable or reset synchronization profiling. With no arguments, prints
668 whether profiling is on or off.
672 .name = "system_reset",
675 .help = "reset the system",
676 .cmd = hmp_system_reset,
686 .name = "system_powerdown",
689 .help = "send system power down event",
690 .cmd = hmp_system_powerdown,
694 @item system_powerdown
695 @findex system_powerdown
696 Power down the system (if supported).
701 .args_type = "start:i,size:i",
702 .params = "addr size",
703 .help = "compute the checksum of a memory region",
708 @item sum @var{addr} @var{size}
710 Compute the checksum of a memory region.
714 .name = "device_add",
715 .args_type = "device:O",
716 .params = "driver[,prop=value][,...]",
717 .help = "add device, like -device on the command line",
718 .cmd = hmp_device_add,
719 .command_completion = device_add_completion,
723 @item device_add @var{config}
729 .name = "device_del",
732 .help = "remove device",
733 .cmd = hmp_device_del,
734 .command_completion = device_del_completion,
738 @item device_del @var{id}
740 Remove device @var{id}. @var{id} may be a short ID
741 or a QOM object path.
746 .args_type = "index:i",
748 .help = "set the default CPU",
753 @item cpu @var{index}
759 .name = "mouse_move",
760 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
761 .params = "dx dy [dz]",
762 .help = "send mouse move events",
763 .cmd = hmp_mouse_move,
767 @item mouse_move @var{dx} @var{dy} [@var{dz}]
769 Move the active mouse to the specified coordinates @var{dx} @var{dy}
770 with optional scroll axis @var{dz}.
774 .name = "mouse_button",
775 .args_type = "button_state:i",
777 .help = "change mouse button state (1=L, 2=M, 4=R)",
778 .cmd = hmp_mouse_button,
782 @item mouse_button @var{val}
784 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
789 .args_type = "index:i",
791 .help = "set which mouse device receives events",
792 .cmd = hmp_mouse_set,
796 @item mouse_set @var{index}
798 Set which mouse device receives events at given @var{index}, index
806 .name = "wavcapture",
807 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
808 .params = "path [frequency [bits [channels]]]",
809 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
810 .cmd = hmp_wavcapture,
813 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
815 Capture audio into @var{filename}. Using sample rate @var{frequency}
816 bits per sample @var{bits} and number of channels @var{channels}.
820 @item Sample rate = 44100 Hz - CD quality
822 @item Number of channels = 2 - Stereo
827 .name = "stopcapture",
829 .params = "capture index",
830 .help = "stop capture",
831 .cmd = hmp_stopcapture,
834 @item stopcapture @var{index}
836 Stop capture with a given @var{index}, index can be obtained with
844 .args_type = "val:l,size:i,filename:s",
845 .params = "addr size file",
846 .help = "save to disk virtual memory dump starting at 'addr
' of size 'size
'",
851 @item memsave @var{addr} @var{size} @var{file}
853 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
858 .args_type = "val:l,size:i,filename:s",
859 .params = "addr size file",
860 .help = "save to disk physical memory dump starting at 'addr
' of size 'size
'",
865 @item pmemsave @var{addr} @var{size} @var{file}
867 save to disk physical memory dump starting at @var{addr} of size @var{size}.
872 .args_type = "bootdevice:s",
873 .params = "bootdevice",
874 .help = "define new values for the boot device list",
879 @item boot_set @var{bootdevicelist}
881 Define new values for the boot device list. Those values will override
882 the values specified on the command line through the @code{-boot} option.
884 The values that can be specified here depend on the machine type, but are
885 the same that can be specified in the @code{-boot} command line option.
892 .help = "inject an NMI",
898 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
903 .name = "ringbuf_write",
904 .args_type = "device:s,data:s",
905 .params = "device data",
906 .help = "Write to a ring buffer character device",
907 .cmd = hmp_ringbuf_write,
908 .command_completion = ringbuf_write_completion,
912 @item ringbuf_write @var{device} @var{data}
913 @findex ringbuf_write
914 Write @var{data} to ring buffer character device @var{device}.
915 @var{data} must be a UTF-8 string.
920 .name = "ringbuf_read",
921 .args_type = "device:s,size:i",
922 .params = "device size",
923 .help = "Read from a ring buffer character device",
924 .cmd = hmp_ringbuf_read,
925 .command_completion = ringbuf_write_completion,
929 @item ringbuf_read @var{device}
931 Read and print up to @var{size} bytes from ring buffer character
933 Certain non-printable characters are printed \uXXXX, where XXXX is the
934 character code in hexadecimal. Character \ is printed \\.
935 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
936 NUL characters, after the ring buffer lost data, and when reading
937 stops because the size limit is reached.
943 .args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
944 .params = "[-d] [-b] [-i] [-r] uri",
945 .help = "migrate to URI (using -d to not wait for completion)"
946 "\n\t\t\t -b for migration without shared storage with"
947 " full copy of disk\n\t\t\t -i for migration without "
948 "shared storage with incremental copy of disk "
949 "(base image shared between src and destination)"
950 "\n\t\t\t -r to resume a paused migration",
956 @item migrate [-d] [-b] [-i] @var{uri}
958 Migrate to @var{uri} (using -d to not wait for completion).
959 -b for migration with full copy of disk
960 -i for migration with incremental copy of disk (base image is shared)
964 .name = "migrate_cancel",
967 .help = "cancel the current VM migration",
968 .cmd = hmp_migrate_cancel,
973 @findex migrate_cancel
974 Cancel the current VM migration.
978 .name = "migrate_continue",
979 .args_type = "state:s",
981 .help = "Continue migration from the given paused state",
982 .cmd = hmp_migrate_continue,
985 @item migrate_continue @var{state}
986 @findex migrate_continue
987 Continue migration from the paused state @var{state}
991 .name = "migrate_incoming",
992 .args_type = "uri:s",
994 .help = "Continue an incoming migration from an -incoming defer",
995 .cmd = hmp_migrate_incoming,
999 @item migrate_incoming @var{uri}
1000 @findex migrate_incoming
1001 Continue an incoming migration using the @var{uri} (that has the same syntax
1002 as the -incoming option).
1006 .name = "migrate_recover",
1007 .args_type = "uri:s",
1009 .help = "Continue a paused incoming postcopy migration",
1010 .cmd = hmp_migrate_recover,
1014 @item migrate_recover @var{uri}
1015 @findex migrate_recover
1016 Continue a paused incoming postcopy migration using the @var{uri}.
1020 .name = "migrate_pause",
1023 .help = "Pause an ongoing migration (postcopy-only)",
1024 .cmd = hmp_migrate_pause,
1029 @findex migrate_pause
1030 Pause an ongoing migration. Currently it only supports postcopy.
1034 .name = "migrate_set_cache_size",
1035 .args_type = "value:o",
1037 .help = "set cache size (in bytes) for XBZRLE migrations,"
1038 "the cache size will be rounded down to the nearest "
1040 "The cache size affects the number of cache misses."
1041 "In case of a high cache miss ratio you need to increase"
1043 .cmd = hmp_migrate_set_cache_size,
1047 @item migrate_set_cache_size @var{value}
1048 @findex migrate_set_cache_size
1049 Set cache size to @var{value} (in bytes) for xbzrle migrations.
1053 .name = "migrate_set_speed",
1054 .args_type = "value:o",
1056 .help = "set maximum speed (in bytes) for migrations. "
1057 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1058 .cmd = hmp_migrate_set_speed,
1062 @item migrate_set_speed @var{value}
1063 @findex migrate_set_speed
1064 Set maximum speed to @var{value} (in bytes) for migrations.
1068 .name = "migrate_set_downtime",
1069 .args_type = "value:T",
1071 .help = "set maximum tolerated downtime (in seconds) for migrations",
1072 .cmd = hmp_migrate_set_downtime,
1076 @item migrate_set_downtime @var{second}
1077 @findex migrate_set_downtime
1078 Set maximum tolerated downtime (in seconds) for migration.
1082 .name = "migrate_set_capability",
1083 .args_type = "capability:s,state:b",
1084 .params = "capability state",
1085 .help = "Enable/Disable the usage of a capability for migration",
1086 .cmd = hmp_migrate_set_capability,
1087 .command_completion = migrate_set_capability_completion,
1091 @item migrate_set_capability @var{capability} @var{state}
1092 @findex migrate_set_capability
1093 Enable/Disable the usage of a capability @var{capability} for migration.
1097 .name = "migrate_set_parameter",
1098 .args_type = "parameter:s,value:s",
1099 .params = "parameter value",
1100 .help = "Set the parameter for migration",
1101 .cmd = hmp_migrate_set_parameter,
1102 .command_completion = migrate_set_parameter_completion,
1106 @item migrate_set_parameter @var{parameter} @var{value}
1107 @findex migrate_set_parameter
1108 Set the parameter @var{parameter} for migration.
1112 .name = "migrate_start_postcopy",
1115 .help = "Followup to a migration command to switch the migration"
1116 " to postcopy mode. The postcopy-ram capability must "
1117 "be set on both source and destination before the "
1118 "original migration command .",
1119 .cmd = hmp_migrate_start_postcopy,
1123 @item migrate_start_postcopy
1124 @findex migrate_start_postcopy
1125 Switch in-progress migration to postcopy mode. Ignored after the end of
1126 migration (or once already in postcopy).
1130 .name = "x_colo_lost_heartbeat",
1133 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1134 "a failover or takeover is needed.",
1135 .cmd = hmp_x_colo_lost_heartbeat,
1139 @item x_colo_lost_heartbeat
1140 @findex x_colo_lost_heartbeat
1141 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1145 .name = "client_migrate_info",
1146 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1147 .params = "protocol hostname port tls-port cert-subject",
1148 .help = "set migration information for remote display",
1149 .cmd = hmp_client_migrate_info,
1153 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1154 @findex client_migrate_info
1155 Set migration information for remote display. This makes the server
1156 ask the client to automatically reconnect using the new parameters
1157 once migration finished successfully. Only implemented for SPICE.
1161 .name = "dump-guest-memory",
1162 .args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
1163 .params = "[-p] [-d] [-z|-l|-s|-w] filename [begin length]",
1164 .help = "dump guest memory into file 'filename
'.\n\t\t\t"
1165 "-p: do paging to get guest's memory mapping
.\n\t\t\t"
1166 "-d
: return immediately (do not wait
for completion
).\n\t\t\t"
1167 "-z
: dump
in kdump
-compressed format
, with zlib compression
.\n\t\t\t"
1168 "-l
: dump
in kdump
-compressed format
, with lzo compression
.\n\t\t\t"
1169 "-s
: dump
in kdump
-compressed format
, with snappy compression
.\n\t\t\t"
1170 "-w
: dump
in Windows crashdump
format (can be used instead of ELF
-dump converting
),\n\t\t\t"
1171 " for Windows x64 guests with vmcoreinfo driver only
.\n\t\t\t"
1172 "begin
: the starting physical address
.\n\t\t\t"
1173 "length
: the memory size
, in bytes
.",
1174 .cmd = hmp_dump_guest_memory,
1178 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1179 @item dump-guest-memory [-z|-l|-s|-w] @var{filename}
1180 @findex dump-guest-memory
1181 Dump guest memory to @var{protocol}. The file can be processed with crash or
1182 gdb. Without -z|-l|-s|-w, the dump format is ELF.
1183 -p: do paging to get guest's memory mapping.
1184 -z: dump in kdump-compressed format, with zlib compression.
1185 -l: dump in kdump-compressed format, with lzo compression.
1186 -s: dump in kdump-compressed format, with snappy compression.
1187 -w: dump in Windows crashdump format (can be used instead of ELF-dump converting),
1188 for Windows x64 guests with vmcoreinfo driver only
1189 filename: dump file name.
1190 begin: the starting physical address. It's optional, and should be
1191 specified together with length.
1192 length: the memory size, in bytes. It's optional, and should be specified
1193 together with begin.
1196 #if defined(TARGET_S390X)
1198 .name = "dump
-skeys
",
1199 .args_type = "filename
:F
",
1201 .help = "Save guest storage keys into file
'filename'.\n",
1202 .cmd = hmp_dump_skeys,
1207 @item dump-skeys @var{filename}
1209 Save guest storage keys to a file.
1212 #if defined(TARGET_S390X)
1214 .name = "migration_mode
",
1215 .args_type = "mode
:i
",
1217 .help = "Enables or disables migration mode
\n",
1218 .cmd = hmp_migrationmode,
1223 @item migration_mode @var{mode}
1224 @findex migration_mode
1225 Enables or disables migration mode.
1229 .name = "snapshot_blkdev
",
1230 .args_type = "reuse
:-n
,device
:B
,snapshot
-file
:s?
,format
:s?
",
1231 .params = "[-n
] device
[new-image
-file
] [format
]",
1232 .help = "initiates a live snapshot
\n\t\t\t"
1233 "of device
. If a
new image file is specified
, the
\n\t\t\t"
1234 "new image file will become the
new root image
.\n\t\t\t"
1235 "If format is specified
, the snapshot file will
\n\t\t\t"
1236 "be created
in that format
.\n\t\t\t"
1237 "The
default format is qcow2
. The
-n flag requests QEMU
\n\t\t\t"
1238 "to reuse the image found
in new-image
-file
, instead of
\n\t\t\t"
1239 "recreating it from scratch
.",
1240 .cmd = hmp_snapshot_blkdev,
1244 @item snapshot_blkdev
1245 @findex snapshot_blkdev
1246 Snapshot device, using snapshot file as target if provided
1250 .name = "snapshot_blkdev_internal
",
1251 .args_type = "device
:B
,name
:s
",
1252 .params = "device name
",
1253 .help = "take an internal snapshot of device
.\n\t\t\t"
1254 "The format of the image used by device must
\n\t\t\t"
1255 "support it
, such as qcow2
.\n\t\t\t",
1256 .cmd = hmp_snapshot_blkdev_internal,
1260 @item snapshot_blkdev_internal
1261 @findex snapshot_blkdev_internal
1262 Take an internal snapshot on device if it support
1266 .name = "snapshot_delete_blkdev_internal
",
1267 .args_type = "device
:B
,name
:s
,id
:s?
",
1268 .params = "device name
[id
]",
1269 .help = "delete an internal snapshot of device
.\n\t\t\t"
1270 "If id is specified
, qemu will
try delete
\n\t\t\t"
1271 "the snapshot matching both id and name
.\n\t\t\t"
1272 "The format of the image used by device must
\n\t\t\t"
1273 "support it
, such as qcow2
.\n\t\t\t",
1274 .cmd = hmp_snapshot_delete_blkdev_internal,
1278 @item snapshot_delete_blkdev_internal
1279 @findex snapshot_delete_blkdev_internal
1280 Delete an internal snapshot on device if it support
1284 .name = "drive_mirror
",
1285 .args_type = "reuse
:-n
,full
:-f
,device
:B
,target
:s
,format
:s?
",
1286 .params = "[-n
] [-f
] device target
[format
]",
1287 .help = "initiates live storage
\n\t\t\t"
1288 "migration
for a device
. The device
's contents are\n\t\t\t"
1289 "copied to the new image file, including data that\n\t\t\t"
1290 "is written after the command is started.\n\t\t\t"
1291 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1292 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1293 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1294 "so that the result does not need a backing file.\n\t\t\t",
1295 .cmd = hmp_drive_mirror,
1299 @findex drive_mirror
1300 Start mirroring a block device's writes to a
new destination
,
1301 using the specified target
.
1305 .name
= "drive_backup",
1306 .args_type
= "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1307 .params
= "[-n] [-f] [-c] device target [format]",
1308 .help
= "initiates a point-in-time\n\t\t\t"
1309 "copy for a device. The device's contents are\n\t\t\t"
1310 "copied to the new image file, excluding data that\n\t\t\t"
1311 "is written after the command is started.\n\t\t\t"
1312 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1313 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1314 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1315 "so that the result does not need a backing file.\n\t\t\t"
1316 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1317 "(if the target format supports it).\n\t\t\t",
1318 .cmd
= hmp_drive_backup
,
1322 @findex drive_backup
1323 Start a point
-in-time copy of a block device to a specificed target
.
1327 .name
= "drive_add",
1328 .args_type
= "node:-n,pci_addr:s,opts:s",
1329 .params
= "[-n] [[<domain>:]<bus>:]<slot>\n"
1330 "[file=file][,if=type][,bus=n]\n"
1331 "[,unit=m][,media=d][,index=i]\n"
1332 "[,snapshot=on|off][,cache=on|off]\n"
1333 "[,readonly=on|off][,copy-on-read=on|off]",
1334 .help
= "add drive to PCI storage controller",
1335 .cmd
= hmp_drive_add
,
1341 Add drive to PCI storage controller
.
1345 .name
= "pcie_aer_inject_error",
1346 .args_type
= "advisory_non_fatal:-a,correctable:-c,"
1347 "id:s,error_status:s,"
1348 "header0:i?,header1:i?,header2:i?,header3:i?,"
1349 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1350 .params
= "[-a] [-c] id "
1351 "<error_status> [<tlp header> [<tlp header prefix>]]",
1352 .help
= "inject pcie aer error\n\t\t\t"
1353 " -a for advisory non fatal error\n\t\t\t"
1354 " -c for correctable error\n\t\t\t"
1355 "<id> = qdev device id\n\t\t\t"
1356 "<error_status> = error string or 32bit\n\t\t\t"
1357 "<tlb header> = 32bit x 4\n\t\t\t"
1358 "<tlb header prefix> = 32bit x 4",
1359 .cmd
= hmp_pcie_aer_inject_error
,
1363 @item pcie_aer_inject_error
1364 @findex pcie_aer_inject_error
1365 Inject PCIe AER error
1369 .name
= "netdev_add",
1370 .args_type
= "netdev:O",
1371 .params
= "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1372 .help
= "add host network device",
1373 .cmd
= hmp_netdev_add
,
1374 .command_completion
= netdev_add_completion
,
1380 Add host network device
.
1384 .name
= "netdev_del",
1385 .args_type
= "id:s",
1387 .help
= "remove host network device",
1388 .cmd
= hmp_netdev_del
,
1389 .command_completion
= netdev_del_completion
,
1395 Remove host network device
.
1399 .name
= "object_add",
1400 .args_type
= "object:O",
1401 .params
= "[qom-type=]type,id=str[,prop=value][,...]",
1402 .help
= "create QOM object",
1403 .cmd
= hmp_object_add
,
1404 .command_completion
= object_add_completion
,
1414 .name
= "object_del",
1415 .args_type
= "id:s",
1417 .help
= "destroy QOM object",
1418 .cmd
= hmp_object_del
,
1419 .command_completion
= object_del_completion
,
1430 .name
= "hostfwd_add",
1431 .args_type
= "arg1:s,arg2:s?,arg3:s?",
1432 .params
= "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1433 .help
= "redirect TCP or UDP connections from host to guest (requires -net user)",
1434 .cmd
= hmp_hostfwd_add
,
1440 Redirect TCP or UDP connections from host to
guest (requires
-net user
).
1445 .name
= "hostfwd_remove",
1446 .args_type
= "arg1:s,arg2:s?,arg3:s?",
1447 .params
= "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1448 .help
= "remove host-to-guest TCP or UDP redirection",
1449 .cmd
= hmp_hostfwd_remove
,
1454 @item hostfwd_remove
1455 @findex hostfwd_remove
1456 Remove host
-to
-guest TCP or UDP redirection
.
1461 .args_type
= "value:M",
1463 .help
= "request VM to change its memory allocation (in MB)",
1468 @item balloon @
var{value
}
1470 Request VM to change its memory allocation to @
var{value
} (in MB
).
1475 .args_type
= "name:s,up:b",
1476 .params
= "name on|off",
1477 .help
= "change the link status of a network adapter",
1478 .cmd
= hmp_set_link
,
1479 .command_completion
= set_link_completion
,
1483 @item set_link @
var{name
} [on|off
]
1485 Switch link @
var{name
} on (i
.e
. up
) or
off (i
.e
. down
).
1489 .name
= "watchdog_action",
1490 .args_type
= "action:s",
1491 .params
= "[reset|shutdown|poweroff|pause|debug|none]",
1492 .help
= "change watchdog action",
1493 .cmd
= hmp_watchdog_action
,
1494 .command_completion
= watchdog_action_completion
,
1498 @item watchdog_action
1499 @findex watchdog_action
1500 Change watchdog action
.
1505 .args_type
= "aclname:s",
1506 .params
= "aclname",
1507 .help
= "list rules in the access control list",
1508 .cmd
= hmp_acl_show
,
1512 @item acl_show @
var{aclname
}
1514 List all the matching rules
in the access control list
, and the
default
1515 policy
. There are currently two named access control lists
,
1516 @
var{vnc
.x509dname
} and @
var{vnc
.username
} matching on the x509 client
1517 certificate distinguished name
, and SASL username respectively
.
1521 .name
= "acl_policy",
1522 .args_type
= "aclname:s,policy:s",
1523 .params
= "aclname allow|deny",
1524 .help
= "set default access control list policy",
1525 .cmd
= hmp_acl_policy
,
1529 @item acl_policy @
var{aclname
} @code
{allow|deny
}
1531 Set the
default access control list policy
, used
in the event that
1532 none of the explicit rules match
. The
default policy at startup is
1538 .args_type
= "aclname:s,match:s,policy:s,index:i?",
1539 .params
= "aclname match allow|deny [index]",
1540 .help
= "add a match rule to the access control list",
1545 @item acl_add @
var{aclname
} @
var{match
} @code
{allow|deny
} [@
var{index
}]
1547 Add a match rule to the access control list
, allowing or denying access
.
1548 The match will normally be an exact username or x509 distinguished name
,
1549 but can optionally include wildcard globs
. eg @code
{*@@EXAMPLE
.COM
} to
1550 allow all users
in the @code
{EXAMPLE
.COM
} kerberos realm
. The match will
1551 normally be appended to the end of the ACL
, but can be inserted
1552 earlier
in the list
if the optional @
var{index
} parameter is supplied
.
1556 .name
= "acl_remove",
1557 .args_type
= "aclname:s,match:s",
1558 .params
= "aclname match",
1559 .help
= "remove a match rule from the access control list",
1560 .cmd
= hmp_acl_remove
,
1564 @item acl_remove @
var{aclname
} @
var{match
}
1566 Remove the specified match rule from the access control list
.
1570 .name
= "acl_reset",
1571 .args_type
= "aclname:s",
1572 .params
= "aclname",
1573 .help
= "reset the access control list",
1574 .cmd
= hmp_acl_reset
,
1578 @item acl_reset @
var{aclname
}
1580 Remove all matches from the access control list
, and set the
default
1581 policy back to @code
{deny
}.
1585 .name
= "nbd_server_start",
1586 .args_type
= "all:-a,writable:-w,uri:s",
1587 .params
= "nbd_server_start [-a] [-w] host:port",
1588 .help
= "serve block devices on the given host and port",
1589 .cmd
= hmp_nbd_server_start
,
1592 @item nbd_server_start @
var{host
}:@
var{port
}
1593 @findex nbd_server_start
1594 Start an NBD server on the given host and
/or port
. If the @option
{-a
}
1595 option is included
, all of the virtual machine
's block devices that
1596 have an inserted media on them are automatically exported; in this case,
1597 the @option{-w} option makes the devices writable too.
1601 .name = "nbd_server_add",
1602 .args_type = "writable:-w,device:B,name:s?",
1603 .params = "nbd_server_add [-w] device [name]",
1604 .help = "export a block device via NBD",
1605 .cmd = hmp_nbd_server_add,
1608 @item nbd_server_add @var{device} [ @var{name} ]
1609 @findex nbd_server_add
1610 Export a block device through QEMU's NBD server
, which must be started
1611 beforehand with @command
{nbd_server_start
}. The @option
{-w
} option makes the
1612 exported device writable too
. The export name is controlled by @
var{name
},
1613 defaulting to @
var{device
}.
1617 .name
= "nbd_server_remove",
1618 .args_type
= "force:-f,name:s",
1619 .params
= "nbd_server_remove [-f] name",
1620 .help
= "remove an export previously exposed via NBD",
1621 .cmd
= hmp_nbd_server_remove
,
1624 @item nbd_server_remove
[-f
] @
var{name
}
1625 @findex nbd_server_remove
1626 Stop exporting a block device through QEMU
's NBD server, which was
1627 previously started with @command{nbd_server_add}. The @option{-f}
1628 option forces the server to drop the export immediately even if
1629 clients are connected; otherwise the command fails unless there are no
1634 .name = "nbd_server_stop",
1636 .params = "nbd_server_stop",
1637 .help = "stop serving block devices using the NBD protocol",
1638 .cmd = hmp_nbd_server_stop,
1641 @item nbd_server_stop
1642 @findex nbd_server_stop
1643 Stop the QEMU embedded NBD server.
1647 #if defined(TARGET_I386)
1651 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1652 .params = "[-b] cpu bank status mcgstatus addr misc",
1653 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1659 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1661 Inject an MCE on the given CPU (x86 only).
1666 .args_type = "fdname:s",
1667 .params = "getfd name",
1668 .help = "receive a file descriptor via SCM rights and assign it a name",
1673 @item getfd @var{fdname}
1675 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1676 mechanism on unix sockets, it is stored using the name @var{fdname} for
1677 later use by other monitor commands.
1682 .args_type = "fdname:s",
1683 .params = "closefd name",
1684 .help = "close a file descriptor previously passed via SCM rights",
1689 @item closefd @var{fdname}
1691 Close the file descriptor previously assigned to @var{fdname} using the
1692 @code{getfd} command. This is only needed if the file descriptor was never
1693 used by another monitor command.
1697 .name = "block_passwd",
1698 .args_type = "device:B,password:s",
1699 .params = "block_passwd device password",
1700 .help = "set the password of encrypted block devices",
1701 .cmd = hmp_block_passwd,
1705 @item block_passwd @var{device} @var{password}
1706 @findex block_passwd
1707 Set the encrypted device @var{device} password to @var{password}
1709 This command is now obsolete and will always return an error since 2.10
1713 .name = "block_set_io_throttle",
1714 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1715 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1716 .help = "change I/O throttle limits for a block drive",
1717 .cmd = hmp_block_set_io_throttle,
1721 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1722 @findex block_set_io_throttle
1723 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}.
1724 @var{device} can be a block device name, a qdev ID or a QOM path.
1728 .name = "set_password",
1729 .args_type = "protocol:s,password:s,connected:s?",
1730 .params = "protocol password action-if-connected",
1731 .help = "set spice/vnc password",
1732 .cmd = hmp_set_password,
1736 @item set_password [ vnc | spice ] password [ action-if-connected ]
1737 @findex set_password
1738 Change spice/vnc password. Use zero to make the password stay valid
1739 forever. @var{action-if-connected} specifies what should happen in
1740 case a connection is established: @var{fail} makes the password change
1741 fail. @var{disconnect} changes the password and disconnects the
1742 client. @var{keep} changes the password and keeps the connection up.
1743 @var{keep} is the default.
1747 .name = "expire_password",
1748 .args_type = "protocol:s,time:s",
1749 .params = "protocol time",
1750 .help = "set spice/vnc password expire-time",
1751 .cmd = hmp_expire_password,
1755 @item expire_password [ vnc | spice ] expire-time
1756 @findex expire_password
1757 Specify when a password for spice/vnc becomes
1758 invalid. @var{expire-time} accepts:
1762 Invalidate password instantly.
1765 Password stays valid forever.
1768 Password stays valid for @var{nsec} seconds starting now.
1771 Password is invalidated at the given time. @var{nsec} are the seconds
1772 passed since 1970, i.e. unix epoch.
1778 .name = "chardev-add",
1779 .args_type = "args:s",
1781 .help = "add chardev",
1782 .cmd = hmp_chardev_add,
1783 .command_completion = chardev_add_completion,
1787 @item chardev-add args
1789 chardev-add accepts the same parameters as the -chardev command line switch.
1794 .name = "chardev-change",
1795 .args_type = "id:s,args:s",
1796 .params = "id args",
1797 .help = "change chardev",
1798 .cmd = hmp_chardev_change,
1802 @item chardev-change args
1803 @findex chardev-change
1804 chardev-change accepts existing chardev @var{id} and then the same arguments
1805 as the -chardev command line switch (except for "id").
1810 .name = "chardev-remove",
1811 .args_type = "id:s",
1813 .help = "remove chardev",
1814 .cmd = hmp_chardev_remove,
1815 .command_completion = chardev_remove_completion,
1819 @item chardev-remove id
1820 @findex chardev-remove
1821 Removes the chardev @var{id}.
1826 .name = "chardev-send-break",
1827 .args_type = "id:s",
1829 .help = "send a break on chardev",
1830 .cmd = hmp_chardev_send_break,
1831 .command_completion = chardev_remove_completion,
1835 @item chardev-send-break id
1836 @findex chardev-send-break
1837 Send a break on the chardev @var{id}.
1843 .args_type = "device:B,command:s",
1844 .params = "[device] \"[command]\"",
1845 .help = "run a qemu-io command on a block device",
1850 @item qemu-io @var{device} @var{command}
1852 Executes a qemu-io command on the given block device.
1858 .args_type = "id:i",
1860 .help = "add cpu (deprecated, use device_add instead)",
1865 @item cpu-add @var{id}
1867 Add CPU with id @var{id}. This command is deprecated, please
1868 +use @code{device_add} instead. For details, refer to
1869 'docs
/cpu
-hotplug
.rst
'.
1874 .args_type = "path:s?",
1876 .help = "list QOM properties",
1877 .cmd = hmp_qom_list,
1882 @item qom-list [@var{path}]
1883 Print QOM properties of object at location @var{path}
1888 .args_type = "path:s,property:s,value:s",
1889 .params = "path property value",
1890 .help = "set QOM property",
1896 @item qom-set @var{path} @var{property} @var{value}
1897 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1902 .args_type = "item:s?",
1903 .params = "[subcommand]",
1904 .help = "show various information about the system state",
1905 .cmd = hmp_info_help,
1906 .sub_table = info_cmds,