1 HXCOMM Use
DEFHEADING() to define headings
in both help text and rST
.
2 HXCOMM Text between SRST and ERST is copied to the rST 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 rST and C
.
11 .args_type
= "name:S?",
13 .help
= "show the help",
19 ``help`` or ``?``
[*cmd
*]
20 Show the help
for all commands or just
for command
*cmd
*.
25 .args_type
= "device:B",
26 .params
= "device|all",
27 .help
= "commit changes to the disk images (if -snapshot is used) or backing files",
33 Commit changes to the disk
images (if -snapshot is used
) or backing files
.
34 If the backing file is smaller than the snapshot
, then the backing file
35 will be resized to be the same size as the snapshot
. If the snapshot is
36 smaller than the backing file
, the backing file will not be truncated
.
37 If you want the backing file to match the size of the smaller snapshot
,
38 you can safely truncate it yourself once the commit operation successfully
46 .help
= "quit the emulator",
56 .name
= "exit_preconfig",
59 .help
= "exit the preconfig state",
60 .cmd
= hmp_exit_preconfig
,
66 This command makes QEMU exit the preconfig state and proceed with
67 VM initialization
using configuration data provided on the command line
68 and via the QMP monitor during the preconfig state
. The command is only
69 available during the preconfig
state (i
.e
. when the
--preconfig command
70 line option was
in use
).
74 .name
= "block_resize",
75 .args_type
= "device:B,size:o",
76 .params
= "device size",
77 .help
= "resize a block image",
78 .cmd
= hmp_block_resize
,
84 Resize a block image
while a guest is running
. Usually requires guest
85 action to see the updated size
. Resize to a lower size is supported
,
86 but should be used with extreme caution
. Note that
this command only
87 resizes image files
, it can not resize block devices like LVM volumes
.
91 .name
= "block_stream",
92 .args_type
= "device:B,speed:o?,base:s?",
93 .params
= "device [speed [base]]",
94 .help
= "copy data from a backing file into a block device",
95 .cmd
= hmp_block_stream
,
100 Copy data from a backing file into a block device
.
104 .name
= "block_job_set_speed",
105 .args_type
= "device:B,speed:o",
106 .params
= "device speed",
107 .help
= "set maximum speed for a background block operation",
108 .cmd
= hmp_block_job_set_speed
,
112 ``block_job_set_speed``
113 Set maximum speed
for a background block operation
.
117 .name
= "block_job_cancel",
118 .args_type
= "force:-f,device:B",
119 .params
= "[-f] device",
120 .help
= "stop an active background block operation (use -f"
121 "\n\t\t\t if you want to abort the operation immediately"
122 "\n\t\t\t instead of keep running until data is in sync)",
123 .cmd
= hmp_block_job_cancel
,
128 Stop an active background block
operation (streaming
, mirroring
).
132 .name
= "block_job_complete",
133 .args_type
= "device:B",
135 .help
= "stop an active background block operation",
136 .cmd
= hmp_block_job_complete
,
140 ``block_job_complete``
141 Manually trigger completion of an active background block operation
.
142 For mirroring
, this will
switch the device to the destination path
.
146 .name
= "block_job_pause",
147 .args_type
= "device:B",
149 .help
= "pause an active background block operation",
150 .cmd
= hmp_block_job_pause
,
155 Pause an active block streaming operation
.
159 .name
= "block_job_resume",
160 .args_type
= "device:B",
162 .help
= "resume a paused background block operation",
163 .cmd
= hmp_block_job_resume
,
168 Resume a paused block streaming operation
.
173 .args_type
= "force:-f,device:B",
174 .params
= "[-f] device",
175 .help
= "eject a removable medium (use -f to force it)",
180 ``eject
[-f
]``
*device
*
181 Eject a removable
medium (use
-f to force it
).
188 .help
= "remove host block device",
189 .cmd
= hmp_drive_del
,
193 ``drive_del``
*device
*
194 Remove host block device
. The result is that guest generated IO is no longer
195 submitted against the host device underlying the disk
. Once a drive has
196 been deleted
, the QEMU Block layer returns
-EIO which results
in IO
197 errors
in the guest
for applications that are reading
/writing to the device
.
198 These errors are always reported to the guest
, regardless of the drive
's error
199 actions (drive options rerror, werror).
204 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
205 .params = "device filename [format [read-only-mode]]",
206 .help = "change a removable medium, optional format",
211 ``change`` *device* *setting*
212 Change the configuration of a device.
214 ``change`` *diskdevice* *filename* [*format* [*read-only-mode*]]
215 Change the medium for a removable disk device to point to *filename*. eg::
217 (qemu) change ide1-cd0 /path/to/some.iso
219 *format* is optional.
221 *read-only-mode* may be used to change the read-only status of the device.
222 It accepts the following values:
225 Retains the current status; this is the default.
228 Makes the device read-only.
231 Makes the device writable.
233 ``change vnc`` *display*,\ *options*
234 Change the configuration of the VNC server. The valid syntax for *display*
235 and *options* are described at :ref:`sec_005finvocation`. eg::
237 (qemu) change vnc localhost:1
239 ``change vnc password`` [*password*]
241 Change the password associated with the VNC server. If the new password
242 is not supplied, the monitor will prompt for it to be entered. VNC
243 passwords are only significant up to 8 letters. eg::
245 (qemu) change vnc password
251 .name = "screendump",
252 .args_type = "filename:F,device:s?,head:i?",
253 .params = "filename [device [head]]",
254 .help = "save screen from head 'head
' of display device 'device
' "
255 "into PPM image 'filename
'",
256 .cmd = hmp_screendump,
261 ``screendump`` *filename*
262 Save screen into PPM image *filename*.
267 .args_type = "filename:F",
268 .params = "filename",
269 .help = "output logs to 'filename
'",
274 ``logfile`` *filename*
275 Output logs to *filename*.
279 .name = "trace-event",
280 .args_type = "name:s,option:b,vcpu:i?",
281 .params = "name on|off [vcpu]",
282 .help = "changes status of a specific trace event "
283 "(vcpu: vCPU to set, default is all)",
284 .cmd = hmp_trace_event,
285 .command_completion = trace_event_completion,
290 changes status of a trace event
293 #if defined(CONFIG_TRACE_SIMPLE)
295 .name = "trace-file",
296 .args_type = "op:s?,arg:F?",
297 .params = "on|off|flush|set [arg]",
298 .help = "open, close, or flush trace file, or set a new file name",
299 .cmd = hmp_trace_file,
303 ``trace-file on|off|flush``
304 Open, close, or flush the trace file. If no argument is given, the
305 status of the trace file is displayed.
311 .args_type = "items:s",
312 .params = "item1[,...]",
313 .help = "activate logging of the specified items",
318 ``log`` *item1*\ [,...]
319 Activate logging of the specified items.
324 .args_type = "name:s?",
326 .help = "save a VM snapshot. If no tag is provided, a new snapshot is created",
332 Create a snapshot of the whole virtual machine. If *tag* is
333 provided, it is used as human readable identifier. If there is already
334 a snapshot with the same tag, it is replaced. More info at
335 :ref:`vm_005fsnapshots`.
337 Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
338 only *tag* as parameter.
343 .args_type = "name:s",
345 .help = "restore a VM snapshot from its tag",
347 .command_completion = loadvm_completion,
352 Set the whole virtual machine to the snapshot identified by the tag
355 Since 4.0, loadvm stopped accepting snapshot id as parameter.
360 .args_type = "name:s",
362 .help = "delete a VM snapshot from its tag",
364 .command_completion = delvm_completion,
369 Delete the snapshot identified by *tag*.
371 Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
372 only *tag* as parameter.
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 .cmd = hmp_singlestep,
385 Run the emulation in single step mode.
386 If called with option off, the emulation returns to normal mode.
393 .help = "stop emulation",
406 .help = "resume emulation",
416 .name = "system_wakeup",
419 .help = "wakeup guest from suspend",
420 .cmd = hmp_system_wakeup,
425 Wakeup guest from suspend.
430 .args_type = "device:s?",
431 .params = "[device]",
432 .help = "start gdbserver on given device (default 'tcp
::1234'), stop with 'none
'",
433 .cmd = hmp_gdbserver,
437 ``gdbserver`` [*port*]
438 Start gdbserver session (default *port*\=1234)
443 .args_type = "fmt:/,addr:l",
444 .params = "/fmt addr",
445 .help = "virtual memory dump starting at 'addr
'",
446 .cmd = hmp_memory_dump,
451 Virtual memory dump starting at *addr*.
456 .args_type = "fmt:/,addr:l",
457 .params = "/fmt addr",
458 .help = "physical memory dump starting at 'addr
'",
459 .cmd = hmp_physical_memory_dump,
463 ``xp /``\ *fmt* *addr*
464 Physical memory dump starting at *addr*.
466 *fmt* is a format which tells the command how to format the
467 data. Its syntax is: ``/{count}{format}{size}``
470 is the number of items to be dumped.
472 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
473 c (char) or i (asm instruction).
475 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
476 ``h`` or ``w`` can be specified with the ``i`` format to
477 respectively select 16 or 32 bit code instruction size.
481 Dump 10 instructions at the current instruction pointer::
486 0x90107065: lea 0x0(%esi,1),%esi
487 0x90107069: lea 0x0(%edi,1),%edi
489 0x90107071: jmp 0x90107080
495 Dump 80 16 bit values at the start of the video memory::
497 (qemu) xp/80hx 0xb8000
498 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
499 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
500 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
501 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
502 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
503 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
504 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
505 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
506 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
507 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
513 .args_type = "addr:l",
515 .help = "print the host virtual address corresponding to a guest physical address",
521 Print the host virtual address at which the guest's physical address
*addr
*
528 .args_type
= "addr:l",
530 .help
= "print the host physical address corresponding to a guest physical address",
537 Print the host physical address at which the guest
's physical address *addr*
543 .args_type = "addr:l",
545 .help = "print the guest physical address corresponding to a guest virtual address",
551 Print the guest physical address at which the guest's virtual address
*addr
*
552 is mapped based on the mapping
for the current CPU
.
557 .args_type
= "fmt:/,val:l",
558 .params
= "/fmt expr",
559 .help
= "print expression value (use $reg for CPU register access)",
564 ``p`` or ``print
/``\
*fmt
* *expr
*
565 Print expression value
. Only the
*format
* part of
*fmt
* is
571 .args_type
= "fmt:/,addr:i,index:i.",
572 .params
= "/fmt addr",
573 .help
= "I/O port read",
574 .cmd
= hmp_ioport_read
,
578 ``i
/``\
*fmt
* *addr
* [.\
*index
*\
]
584 .args_type
= "fmt:/,addr:i,val:i",
585 .params
= "/fmt addr value",
586 .help
= "I/O port write",
587 .cmd
= hmp_ioport_write
,
591 ``o
/``\
*fmt
* *addr
* *val
*
597 .args_type
= "keys:s,hold-time:i?",
598 .params
= "keys [hold_ms]",
599 .help
= "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
601 .command_completion
= sendkey_completion
,
606 Send
*keys
* to the guest
. *keys
* could be the name of the
607 key or the raw value
in hexadecimal format
. Use ``
-`` to press
608 several keys simultaneously
. Example
::
612 This command is useful to send keys that your graphical user
interface
613 intercepts at low level
, such as ``ctrl
-alt
-f1``
in X Window
.
616 .name
= "sync-profile",
617 .args_type
= "op:s?",
618 .params
= "[on|off|reset]",
619 .help
= "enable, disable or reset synchronization profiling. "
620 "With no arguments, prints whether profiling is on or off.",
621 .cmd
= hmp_sync_profile
,
625 ``sync
-profile
[on|off|reset
]``
626 Enable
, disable or reset synchronization profiling
. With no arguments
, prints
627 whether profiling is on or off
.
631 .name
= "system_reset",
634 .help
= "reset the system",
635 .cmd
= hmp_system_reset
,
644 .name
= "system_powerdown",
647 .help
= "send system power down event",
648 .cmd
= hmp_system_powerdown
,
653 Power down the
system (if supported
).
658 .args_type
= "start:i,size:i",
659 .params
= "addr size",
660 .help
= "compute the checksum of a memory region",
665 ``sum``
*addr
* *size
*
666 Compute the checksum of a memory region
.
670 .name
= "device_add",
671 .args_type
= "device:O",
672 .params
= "driver[,prop=value][,...]",
673 .help
= "add device, like -device on the command line",
674 .cmd
= hmp_device_add
,
675 .command_completion
= device_add_completion
,
679 ``device_add``
*config
*
684 .name
= "device_del",
687 .help
= "remove device",
688 .cmd
= hmp_device_del
,
689 .command_completion
= device_del_completion
,
694 Remove device
*id
*. *id
* may be a short ID
695 or a QOM object path
.
700 .args_type
= "index:i",
702 .help
= "set the default CPU",
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 .cmd
= hmp_mouse_move
,
720 ``mouse_move``
*dx
* *dy
* [*dz
*]
721 Move the active mouse to the specified coordinates
*dx
* *dy
*
722 with optional scroll axis
*dz
*.
726 .name
= "mouse_button",
727 .args_type
= "button_state:i",
729 .help
= "change mouse button state (1=L, 2=M, 4=R)",
730 .cmd
= hmp_mouse_button
,
734 ``mouse_button``
*val
*
735 Change the active mouse button state
*val
* (1=L
, 2=M
, 4=R
).
740 .args_type
= "index:i",
742 .help
= "set which mouse device receives events",
743 .cmd
= hmp_mouse_set
,
747 ``mouse_set``
*index
*
748 Set which mouse device receives events at given
*index
*, index
749 can be obtained with
::
756 .name
= "wavcapture",
757 .args_type
= "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?",
758 .params
= "path audiodev [frequency [bits [channels]]]",
759 .help
= "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
760 .cmd
= hmp_wavcapture
,
763 ``wavcapture``
*filename
* *audiodev
* [*frequency
* [*bits
* [*channels
*]]]
764 Capture audio into
*filename
* from
*audiodev
*, using sample rate
765 *frequency
* bits per sample
*bits
* and number of channels
770 - Sample rate
= 44100 Hz
- CD quality
772 - Number of channels
= 2 - Stereo
776 .name
= "stopcapture",
778 .params
= "capture index",
779 .help
= "stop capture",
780 .cmd
= hmp_stopcapture
,
783 ``stopcapture``
*index
*
784 Stop capture with a given
*index
*, index can be obtained with
::
792 .args_type
= "val:l,size:i,filename:s",
793 .params
= "addr size file",
794 .help
= "save to disk virtual memory dump starting at 'addr' of size 'size'",
799 ``memsave``
*addr
* *size
* *file
*
800 save to disk virtual memory dump starting at
*addr
* of size
*size
*.
805 .args_type
= "val:l,size:i,filename:s",
806 .params
= "addr size file",
807 .help
= "save to disk physical memory dump starting at 'addr' of size 'size'",
812 ``pmemsave``
*addr
* *size
* *file
*
813 save to disk physical memory dump starting at
*addr
* of size
*size
*.
818 .args_type
= "bootdevice:s",
819 .params
= "bootdevice",
820 .help
= "define new values for the boot device list",
825 ``boot_set``
*bootdevicelist
*
826 Define
new values
for the boot device list
. Those values will
override
827 the values specified on the command line through the ``
-boot`` option
.
829 The values that can be specified
here depend on the machine type
, but are
830 the same that can be specified
in the ``
-boot`` command line option
.
837 .help
= "inject an NMI",
842 Inject an NMI on the
default CPU (x86
/s390
) or all
CPUs (ppc64
).
846 .name
= "ringbuf_write",
847 .args_type
= "device:s,data:s",
848 .params
= "device data",
849 .help
= "Write to a ring buffer character device",
850 .cmd
= hmp_ringbuf_write
,
851 .command_completion
= ringbuf_write_completion
,
855 ``ringbuf_write``
*device
* *data
*
856 Write
*data
* to ring buffer character device
*device
*.
857 *data
* must be a UTF
-8 string
.
861 .name
= "ringbuf_read",
862 .args_type
= "device:s,size:i",
863 .params
= "device size",
864 .help
= "Read from a ring buffer character device",
865 .cmd
= hmp_ringbuf_read
,
866 .command_completion
= ringbuf_write_completion
,
870 ``ringbuf_read``
*device
*
871 Read and print up to
*size
* bytes from ring buffer character
873 Certain non
-printable characters are printed ``\uXXXX``
, where ``XXXX`` is the
874 character code
in hexadecimal
. Character ``\`` is printed ``
\\``
.
875 Bug
: can screw up when the buffer contains invalid UTF
-8 sequences
,
876 NUL characters
, after the ring buffer lost data
, and when reading
877 stops because the size limit is reached
.
881 .name
= "announce_self",
882 .args_type
= "interfaces:s?,id:s?",
883 .params
= "[interfaces] [id]",
884 .help
= "Trigger GARP/RARP announcements",
885 .cmd
= hmp_announce_self
,
890 Trigger a round of GARP
/RARP broadcasts
; this is useful
for explicitly
891 updating the network infrastructure after a reconfiguration or some forms
892 of migration
. The timings of the round are set by the migration announce
893 parameters
. An optional comma separated
*interfaces
* list restricts the
894 announce to the named set of interfaces
. An optional
*id
* can be used to
895 start a separate announce timer and to change the parameters of it later
.
900 .args_type
= "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
901 .params
= "[-d] [-b] [-i] [-r] uri",
902 .help
= "migrate to URI (using -d to not wait for completion)"
903 "\n\t\t\t -b for migration without shared storage with"
904 " full copy of disk\n\t\t\t -i for migration without "
905 "shared storage with incremental copy of disk "
906 "(base image shared between src and destination)"
907 "\n\t\t\t -r to resume a paused migration",
913 ``migrate
[-d
] [-b
] [-i
]``
*uri
*
914 Migrate to
*uri
* (using -d to not wait
for completion
).
917 for migration with full copy of disk
919 for migration with incremental copy of
disk (base image is shared
)
923 .name
= "migrate_cancel",
926 .help
= "cancel the current VM migration",
927 .cmd
= hmp_migrate_cancel
,
932 Cancel the current VM migration
.
936 .name
= "migrate_continue",
937 .args_type
= "state:s",
939 .help
= "Continue migration from the given paused state",
940 .cmd
= hmp_migrate_continue
,
943 ``migrate_continue``
*state
*
944 Continue migration from the paused state
*state
*
948 .name
= "migrate_incoming",
949 .args_type
= "uri:s",
951 .help
= "Continue an incoming migration from an -incoming defer",
952 .cmd
= hmp_migrate_incoming
,
956 ``migrate_incoming``
*uri
*
957 Continue an incoming migration
using the
*uri
* (that has the same syntax
958 as the ``
-incoming`` option
).
962 .name
= "migrate_recover",
963 .args_type
= "uri:s",
965 .help
= "Continue a paused incoming postcopy migration",
966 .cmd
= hmp_migrate_recover
,
970 ``migrate_recover``
*uri
*
971 Continue a paused incoming postcopy migration
using the
*uri
*.
975 .name
= "migrate_pause",
978 .help
= "Pause an ongoing migration (postcopy-only)",
979 .cmd
= hmp_migrate_pause
,
984 Pause an ongoing migration
. Currently it only supports postcopy
.
988 .name
= "migrate_set_cache_size",
989 .args_type
= "value:o",
991 .help
= "set cache size (in bytes) for XBZRLE migrations,"
992 "the cache size will be rounded down to the nearest "
994 "The cache size affects the number of cache misses."
995 "In case of a high cache miss ratio you need to increase"
997 .cmd
= hmp_migrate_set_cache_size
,
1001 ``migrate_set_cache_size``
*value
*
1002 Set cache size to
*value
* (in bytes
) for xbzrle migrations
.
1006 .name
= "migrate_set_speed",
1007 .args_type
= "value:o",
1009 .help
= "set maximum speed (in bytes) for migrations. "
1010 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1011 .cmd
= hmp_migrate_set_speed
,
1015 ``migrate_set_speed``
*value
*
1016 Set maximum speed to
*value
* (in bytes
) for migrations
.
1020 .name
= "migrate_set_downtime",
1021 .args_type
= "value:T",
1023 .help
= "set maximum tolerated downtime (in seconds) for migrations",
1024 .cmd
= hmp_migrate_set_downtime
,
1028 ``migrate_set_downtime``
*second
*
1029 Set maximum tolerated
downtime (in seconds
) for migration
.
1033 .name
= "migrate_set_capability",
1034 .args_type
= "capability:s,state:b",
1035 .params
= "capability state",
1036 .help
= "Enable/Disable the usage of a capability for migration",
1037 .cmd
= hmp_migrate_set_capability
,
1038 .command_completion
= migrate_set_capability_completion
,
1042 ``migrate_set_capability``
*capability
* *state
*
1043 Enable
/Disable the usage of a capability
*capability
* for migration
.
1047 .name
= "migrate_set_parameter",
1048 .args_type
= "parameter:s,value:s",
1049 .params
= "parameter value",
1050 .help
= "Set the parameter for migration",
1051 .cmd
= hmp_migrate_set_parameter
,
1052 .command_completion
= migrate_set_parameter_completion
,
1056 ``migrate_set_parameter``
*parameter
* *value
*
1057 Set the parameter
*parameter
* for migration
.
1061 .name
= "migrate_start_postcopy",
1064 .help
= "Followup to a migration command to switch the migration"
1065 " to postcopy mode. The postcopy-ram capability must "
1066 "be set on both source and destination before the "
1067 "original migration command .",
1068 .cmd
= hmp_migrate_start_postcopy
,
1072 ``migrate_start_postcopy``
1073 Switch
in-progress migration to postcopy mode
. Ignored after the end of
1074 migration (or once already
in postcopy
).
1078 .name
= "x_colo_lost_heartbeat",
1081 .help
= "Tell COLO that heartbeat is lost,\n\t\t\t"
1082 "a failover or takeover is needed.",
1083 .cmd
= hmp_x_colo_lost_heartbeat
,
1087 ``x_colo_lost_heartbeat``
1088 Tell COLO that heartbeat is lost
, a failover or takeover is needed
.
1092 .name
= "client_migrate_info",
1093 .args_type
= "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1094 .params
= "protocol hostname port tls-port cert-subject",
1095 .help
= "set migration information for remote display",
1096 .cmd
= hmp_client_migrate_info
,
1100 ``client_migrate_info``
*protocol
* *hostname
* *port
* *tls
-port
* *cert
-subject
*
1101 Set migration information
for remote display
. This makes the server
1102 ask the client to automatically reconnect
using the
new parameters
1103 once migration finished successfully
. Only implemented
for SPICE
.
1107 .name
= "dump-guest-memory",
1108 .args_type
= "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
1109 .params
= "[-p] [-d] [-z|-l|-s|-w] filename [begin length]",
1110 .help
= "dump guest memory into file 'filename'.\n\t\t\t"
1111 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1112 "-d: return immediately (do not wait for completion).\n\t\t\t"
1113 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1114 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1115 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1116 "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
1117 " for Windows x64 guests with vmcoreinfo driver only.\n\t\t\t"
1118 "begin: the starting physical address.\n\t\t\t"
1119 "length: the memory size, in bytes.",
1120 .cmd
= hmp_dump_guest_memory
,
1124 ``dump
-guest
-memory
[-p
]``
*filename
* *begin
* *length
*
1126 ``dump
-guest
-memory
[-z|
-l|
-s|
-w
]``
*filename
*
1127 Dump guest memory to
*protocol
*. The file can be processed with crash or
1128 gdb
. Without ``
-z|
-l|
-s|
-w``
, the dump format is ELF
.
1131 do paging to get guest
's memory mapping.
1133 dump in kdump-compressed format, with zlib compression.
1135 dump in kdump-compressed format, with lzo compression.
1137 dump in kdump-compressed format, with snappy compression.
1139 dump in Windows crashdump format (can be used instead of ELF-dump converting),
1140 for Windows x64 guests with vmcoreinfo driver only
1144 the starting physical address. It's optional
, and should be
1145 specified together with
*length
*.
1147 the memory size
, in bytes
. It
's optional, and should be specified
1148 together with *begin*.
1152 #if defined(TARGET_S390X)
1154 .name = "dump-skeys",
1155 .args_type = "filename:F",
1157 .help = "Save guest storage keys into file 'filename
'.\n",
1158 .cmd = hmp_dump_skeys,
1163 ``dump-skeys`` *filename*
1164 Save guest storage keys to a file.
1167 #if defined(TARGET_S390X)
1169 .name = "migration_mode",
1170 .args_type = "mode:i",
1172 .help = "Enables or disables migration mode\n",
1173 .cmd = hmp_migrationmode,
1178 ``migration_mode`` *mode*
1179 Enables or disables migration mode.
1183 .name = "snapshot_blkdev",
1184 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1185 .params = "[-n] device [new-image-file] [format]",
1186 .help = "initiates a live snapshot\n\t\t\t"
1187 "of device. If a new image file is specified, the\n\t\t\t"
1188 "new image file will become the new root image.\n\t\t\t"
1189 "If format is specified, the snapshot file will\n\t\t\t"
1190 "be created in that format.\n\t\t\t"
1191 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1192 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1193 "recreating it from scratch.",
1194 .cmd = hmp_snapshot_blkdev,
1199 Snapshot device, using snapshot file as target if provided
1203 .name = "snapshot_blkdev_internal",
1204 .args_type = "device:B,name:s",
1205 .params = "device name",
1206 .help = "take an internal snapshot of device.\n\t\t\t"
1207 "The format of the image used by device must\n\t\t\t"
1208 "support it, such as qcow2.\n\t\t\t",
1209 .cmd = hmp_snapshot_blkdev_internal,
1213 ``snapshot_blkdev_internal``
1214 Take an internal snapshot on device if it support
1218 .name = "snapshot_delete_blkdev_internal",
1219 .args_type = "device:B,name:s,id:s?",
1220 .params = "device name [id]",
1221 .help = "delete an internal snapshot of device.\n\t\t\t"
1222 "If id is specified, qemu will try delete\n\t\t\t"
1223 "the snapshot matching both id and name.\n\t\t\t"
1224 "The format of the image used by device must\n\t\t\t"
1225 "support it, such as qcow2.\n\t\t\t",
1226 .cmd = hmp_snapshot_delete_blkdev_internal,
1230 ``snapshot_delete_blkdev_internal``
1231 Delete an internal snapshot on device if it support
1235 .name = "drive_mirror",
1236 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1237 .params = "[-n] [-f] device target [format]",
1238 .help = "initiates live storage\n\t\t\t"
1239 "migration for a device. The device's contents are
\n\t\t\t"
1240 "copied to the
new image file
, including data that
\n\t\t\t"
1241 "is written after the command is started
.\n\t\t\t"
1242 "The
-n flag requests QEMU to reuse the image found
\n\t\t\t"
1243 "in new-image
-file
, instead of recreating it from scratch
.\n\t\t\t"
1244 "The
-f flag requests QEMU to copy the whole disk
,\n\t\t\t"
1245 "so that the result does not need a backing file
.\n\t\t\t",
1246 .cmd = hmp_drive_mirror,
1250 Start mirroring a block device's writes to a new destination,
1251 using the specified target.
1255 .name = "drive_backup
",
1256 .args_type = "reuse
:-n
,full
:-f
,compress
:-c
,device
:B
,target
:s
,format
:s?
",
1257 .params = "[-n
] [-f
] [-c
] device target
[format
]",
1258 .help = "initiates a point
-in-time
\n\t\t\t"
1259 "copy
for a device
. The device
's contents are\n\t\t\t"
1260 "copied to the new image file, excluding data that\n\t\t\t"
1261 "is written after the command is started.\n\t\t\t"
1262 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1263 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1264 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1265 "so that the result does not need a backing file.\n\t\t\t"
1266 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1267 "(if the target format supports it).\n\t\t\t",
1268 .cmd = hmp_drive_backup,
1272 Start a point-in-time copy of a block device to a specified target.
1276 .name = "drive_add",
1277 .args_type = "node:-n,pci_addr:s,opts:s",
1278 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
1279 "[file=file][,if=type][,bus=n]\n"
1280 "[,unit=m][,media=d][,index=i]\n"
1281 "[,snapshot=on|off][,cache=on|off]\n"
1282 "[,readonly=on|off][,copy-on-read=on|off]",
1283 .help = "add drive to PCI storage controller",
1284 .cmd = hmp_drive_add,
1289 Add drive to PCI storage controller.
1293 .name = "pcie_aer_inject_error",
1294 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1295 "id:s,error_status:s,"
1296 "header0:i?,header1:i?,header2:i?,header3:i?,"
1297 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1298 .params = "[-a] [-c] id "
1299 "<error_status> [<tlp header> [<tlp header prefix>]]",
1300 .help = "inject pcie aer error\n\t\t\t"
1301 " -a for advisory non fatal error\n\t\t\t"
1302 " -c for correctable error\n\t\t\t"
1303 "<id> = qdev device id\n\t\t\t"
1304 "<error_status> = error string or 32bit\n\t\t\t"
1305 "<tlp header> = 32bit x 4\n\t\t\t"
1306 "<tlp header prefix> = 32bit x 4",
1307 .cmd = hmp_pcie_aer_inject_error,
1311 ``pcie_aer_inject_error``
1312 Inject PCIe AER error
1316 .name = "netdev_add",
1317 .args_type = "netdev:O",
1318 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1319 .help = "add host network device",
1320 .cmd = hmp_netdev_add,
1321 .command_completion = netdev_add_completion,
1326 Add host network device.
1330 .name = "netdev_del",
1331 .args_type = "id:s",
1333 .help = "remove host network device",
1334 .cmd = hmp_netdev_del,
1335 .command_completion = netdev_del_completion,
1340 Remove host network device.
1344 .name = "object_add",
1345 .args_type = "object:O",
1346 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1347 .help = "create QOM object",
1348 .cmd = hmp_object_add,
1349 .command_completion = object_add_completion,
1358 .name = "object_del",
1359 .args_type = "id:s",
1361 .help = "destroy QOM object",
1362 .cmd = hmp_object_del,
1363 .command_completion = object_del_completion,
1373 .name = "hostfwd_add",
1374 .args_type = "arg1:s,arg2:s?",
1375 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1376 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1377 .cmd = hmp_hostfwd_add,
1382 Redirect TCP or UDP connections from host to guest (requires -net user).
1387 .name = "hostfwd_remove",
1388 .args_type = "arg1:s,arg2:s?",
1389 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1390 .help = "remove host-to-guest TCP or UDP redirection",
1391 .cmd = hmp_hostfwd_remove,
1397 Remove host-to-guest TCP or UDP redirection.
1402 .args_type = "value:M",
1404 .help = "request VM to change its memory allocation (in MB)",
1410 Request VM to change its memory allocation to *value* (in MB).
1415 .args_type = "name:s,up:b",
1416 .params = "name on|off",
1417 .help = "change the link status of a network adapter",
1418 .cmd = hmp_set_link,
1419 .command_completion = set_link_completion,
1423 ``set_link`` *name* ``[on|off]``
1424 Switch link *name* on (i.e. up) or off (i.e. down).
1428 .name = "watchdog_action",
1429 .args_type = "action:s",
1430 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1431 .help = "change watchdog action",
1432 .cmd = hmp_watchdog_action,
1433 .command_completion = watchdog_action_completion,
1438 Change watchdog action.
1443 .args_type = "aclname:s",
1444 .params = "aclname",
1445 .help = "list rules in the access control list",
1446 .cmd = hmp_acl_show,
1450 ``acl_show`` *aclname*
1451 List all the matching rules in the access control list, and the default
1452 policy. There are currently two named access control lists,
1453 *vnc.x509dname* and *vnc.username* matching on the x509 client
1454 certificate distinguished name, and SASL username respectively.
1458 .name = "acl_policy",
1459 .args_type = "aclname:s,policy:s",
1460 .params = "aclname allow|deny",
1461 .help = "set default access control list policy",
1462 .cmd = hmp_acl_policy,
1466 ``acl_policy`` *aclname* ``allow|deny``
1467 Set the default access control list policy, used in the event that
1468 none of the explicit rules match. The default policy at startup is
1474 .args_type = "aclname:s,match:s,policy:s,index:i?",
1475 .params = "aclname match allow|deny [index]",
1476 .help = "add a match rule to the access control list",
1481 ``acl_add`` *aclname* *match* ``allow|deny`` [*index*]
1482 Add a match rule to the access control list, allowing or denying access.
1483 The match will normally be an exact username or x509 distinguished name,
1484 but can optionally include wildcard globs. eg ``*@EXAMPLE.COM`` to
1485 allow all users in the ``EXAMPLE.COM`` kerberos realm. The match will
1486 normally be appended to the end of the ACL, but can be inserted
1487 earlier in the list if the optional *index* parameter is supplied.
1491 .name = "acl_remove",
1492 .args_type = "aclname:s,match:s",
1493 .params = "aclname match",
1494 .help = "remove a match rule from the access control list",
1495 .cmd = hmp_acl_remove,
1499 ``acl_remove`` *aclname* *match*
1500 Remove the specified match rule from the access control list.
1504 .name = "acl_reset",
1505 .args_type = "aclname:s",
1506 .params = "aclname",
1507 .help = "reset the access control list",
1508 .cmd = hmp_acl_reset,
1512 ``acl_reset`` *aclname*
1513 Remove all matches from the access control list, and set the default
1514 policy back to ``deny``.
1518 .name = "nbd_server_start",
1519 .args_type = "all:-a,writable:-w,uri:s",
1520 .params = "nbd_server_start [-a] [-w] host:port",
1521 .help = "serve block devices on the given host and port",
1522 .cmd = hmp_nbd_server_start,
1525 ``nbd_server_start`` *host*:*port*
1526 Start an NBD server on the given host and/or port. If the ``-a``
1527 option is included, all of the virtual machine's block devices that
1528 have an inserted media on them are automatically exported
; in this case,
1529 the ``
-w`` option makes the devices writable too
.
1533 .name
= "nbd_server_add",
1534 .args_type
= "writable:-w,device:B,name:s?",
1535 .params
= "nbd_server_add [-w] device [name]",
1536 .help
= "export a block device via NBD",
1537 .cmd
= hmp_nbd_server_add
,
1540 ``nbd_server_add``
*device
* [ *name
* ]
1541 Export a block device through QEMU
's NBD server, which must be started
1542 beforehand with ``nbd_server_start``. The ``-w`` option makes the
1543 exported device writable too. The export name is controlled by *name*,
1544 defaulting to *device*.
1548 .name = "nbd_server_remove",
1549 .args_type = "force:-f,name:s",
1550 .params = "nbd_server_remove [-f] name",
1551 .help = "remove an export previously exposed via NBD",
1552 .cmd = hmp_nbd_server_remove,
1555 ``nbd_server_remove [-f]`` *name*
1556 Stop exporting a block device through QEMU's NBD server
, which was
1557 previously started with ``nbd_server_add``
. The ``
-f``
1558 option forces the server to drop the export immediately even
if
1559 clients are connected
; otherwise the command fails unless there are no
1564 .name
= "nbd_server_stop",
1566 .params
= "nbd_server_stop",
1567 .help
= "stop serving block devices using the NBD protocol",
1568 .cmd
= hmp_nbd_server_stop
,
1572 Stop the QEMU embedded NBD server
.
1576 #
if defined(TARGET_I386
)
1580 .args_type
= "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1581 .params
= "[-b] cpu bank status mcgstatus addr misc",
1582 .help
= "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1588 ``mce``
*cpu
* *bank
* *status
* *mcgstatus
* *addr
* *misc
*
1589 Inject an MCE on the given
CPU (x86 only
).
1594 .args_type
= "fdname:s",
1595 .params
= "getfd name",
1596 .help
= "receive a file descriptor via SCM rights and assign it a name",
1602 If a file descriptor is passed alongside
this command
using the SCM_RIGHTS
1603 mechanism on unix sockets
, it is stored
using the name
*fdname
* for
1604 later use by other monitor commands
.
1609 .args_type
= "fdname:s",
1610 .params
= "closefd name",
1611 .help
= "close a file descriptor previously passed via SCM rights",
1616 ``closefd``
*fdname
*
1617 Close the file descriptor previously assigned to
*fdname
* using the
1618 ``getfd`` command
. This is only needed
if the file descriptor was
never
1619 used by another monitor command
.
1623 .name
= "block_passwd",
1624 .args_type
= "device:B,password:s",
1625 .params
= "block_passwd device password",
1626 .help
= "set the password of encrypted block devices",
1627 .cmd
= hmp_block_passwd
,
1631 ``block_passwd``
*device
* *password
*
1632 Set the encrypted device
*device
* password to
*password
*
1634 This command is now obsolete and will always
return an error since
2.10
1638 .name
= "block_set_io_throttle",
1639 .args_type
= "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1640 .params
= "device bps bps_rd bps_wr iops iops_rd iops_wr",
1641 .help
= "change I/O throttle limits for a block drive",
1642 .cmd
= hmp_block_set_io_throttle
,
1646 ``block_set_io_throttle``
*device
* *bps
* *bps_rd
* *bps_wr
* *iops
* *iops_rd
* *iops_wr
*
1647 Change I
/O throttle limits
for a block drive to
1648 *bps
* *bps_rd
* *bps_wr
* *iops
* *iops_rd
* *iops_wr
*.
1649 *device
* can be a block device name
, a qdev ID or a QOM path
.
1653 .name
= "set_password",
1654 .args_type
= "protocol:s,password:s,connected:s?",
1655 .params
= "protocol password action-if-connected",
1656 .help
= "set spice/vnc password",
1657 .cmd
= hmp_set_password
,
1661 ``set_password
[ vnc | spice
] password
[ action
-if-connected
]``
1662 Change spice
/vnc password
. Use zero to make the password stay valid
1663 forever
. *action
-if-connected
* specifies what should happen
in
1664 case a connection is established
: *fail
* makes the password change
1665 fail
. *disconnect
* changes the password and disconnects the
1666 client
. *keep
* changes the password and keeps the connection up
.
1667 *keep
* is the
default.
1671 .name
= "expire_password",
1672 .args_type
= "protocol:s,time:s",
1673 .params
= "protocol time",
1674 .help
= "set spice/vnc password expire-time",
1675 .cmd
= hmp_expire_password
,
1679 ``expire_password
[ vnc | spice
]``
*expire
-time
*
1680 Specify when a password
for spice
/vnc becomes
1681 invalid
. *expire
-time
* accepts
:
1684 Invalidate password instantly
.
1686 Password stays valid forever
.
1688 Password stays valid
for *nsec
* seconds starting now
.
1690 Password is invalidated at the given time
. *nsec
* are the seconds
1691 passed since
1970, i
.e
. unix epoch
.
1696 .name
= "chardev-add",
1697 .args_type
= "args:s",
1699 .help
= "add chardev",
1700 .cmd
= hmp_chardev_add
,
1701 .command_completion
= chardev_add_completion
,
1705 ``chardev
-add``
*args
*
1706 chardev
-add accepts the same parameters as the
-chardev command line
switch.
1710 .name
= "chardev-change",
1711 .args_type
= "id:s,args:s",
1712 .params
= "id args",
1713 .help
= "change chardev",
1714 .cmd
= hmp_chardev_change
,
1718 ``chardev
-change``
*args
*
1719 chardev
-change accepts existing chardev
*id
* and then the same arguments
1720 as the
-chardev command line
switch (except
for "id").
1724 .name
= "chardev-remove",
1725 .args_type
= "id:s",
1727 .help
= "remove chardev",
1728 .cmd
= hmp_chardev_remove
,
1729 .command_completion
= chardev_remove_completion
,
1733 ``chardev
-remove``
*id
*
1734 Removes the chardev
*id
*.
1738 .name
= "chardev-send-break",
1739 .args_type
= "id:s",
1741 .help
= "send a break on chardev",
1742 .cmd
= hmp_chardev_send_break
,
1743 .command_completion
= chardev_remove_completion
,
1747 ``chardev
-send
-break``
*id
*
1748 Send a
break on the chardev
*id
*.
1753 .args_type
= "qdev:-d,device:B,command:s",
1754 .params
= "[-d] [device] \"[command]\"",
1755 .help
= "run a qemu-io command on a block device\n\t\t\t"
1756 "-d: [device] is a device ID rather than a "
1757 "drive ID or node name",
1762 ``qemu
-io``
*device
* *command
*
1763 Executes a qemu
-io command on the given block device
.
1768 .args_type
= "path:s?",
1770 .help
= "list QOM properties",
1771 .cmd
= hmp_qom_list
,
1776 ``qom
-list``
[*path
*]
1777 Print QOM properties of object at location
*path
*
1782 .args_type
= "path:s,property:s",
1783 .params
= "path property",
1784 .help
= "print QOM property",
1790 ``qom
-get``
*path
* *property
*
1791 Print QOM property
*property
* of object at location
*path
*
1796 .args_type
= "json:-j,path:s,property:s,value:S",
1797 .params
= "[-j] path property value",
1798 .help
= "set QOM property.\n\t\t\t"
1799 "-j: the value is specified in json format.",
1805 ``qom
-set``
*path
* *property
* *value
*
1806 Set QOM property
*property
* of object at location
*path
* to value
*value
*
1810 .name
= "replay_break",
1811 .args_type
= "icount:i",
1813 .help
= "set breakpoint at the specified instruction count",
1814 .cmd
= hmp_replay_break
,
1818 ``replay_break``
*icount
*
1819 Set replay breakpoint at instruction count
*icount
*.
1820 Execution stops when the specified instruction is reached
.
1821 There can be at most one breakpoint
. When breakpoint is set
, any prior
1822 one is removed
. The breakpoint may be set only
in replay mode and only
1823 "in the future", i
.e
. at instruction counts greater than the current one
.
1824 The current instruction count can be observed with ``info replay``
.
1828 .name
= "replay_delete_break",
1831 .help
= "remove replay breakpoint",
1832 .cmd
= hmp_replay_delete_break
,
1836 ``replay_delete_break``
1837 Remove replay breakpoint which was previously set with ``replay_break``
.
1838 The command is ignored when there are no replay breakpoints
.
1842 .name
= "replay_seek",
1843 .args_type
= "icount:i",
1845 .help
= "replay execution to the specified instruction count",
1846 .cmd
= hmp_replay_seek
,
1850 ``replay_seek``
*icount
*
1851 Automatically proceed to the instruction count
*icount
*, when
1852 replaying the execution
. The command automatically loads nearest
1853 snapshot and replays the execution to find the desired instruction
.
1854 When there is no preceding snapshot or the execution is not replayed
,
1855 then the command fails
.
1856 *icount
* for the reference may be observed with ``info replay`` command
.
1861 .args_type
= "item:s?",
1862 .params
= "[subcommand]",
1863 .help
= "show various information about the system state",
1864 .cmd
= hmp_info_help
,
1865 .sub_table
= hmp_info_cmds
,