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,
260 ``screendump`` *filename*
261 Save screen into PPM image *filename*.
266 .args_type = "filename:F",
267 .params = "filename",
268 .help = "output logs to 'filename
'",
273 ``logfile`` *filename*
274 Output logs to *filename*.
278 .name = "trace-event",
279 .args_type = "name:s,option:b,vcpu:i?",
280 .params = "name on|off [vcpu]",
281 .help = "changes status of a specific trace event "
282 "(vcpu: vCPU to set, default is all)",
283 .cmd = hmp_trace_event,
284 .command_completion = trace_event_completion,
289 changes status of a trace event
292 #if defined(CONFIG_TRACE_SIMPLE)
294 .name = "trace-file",
295 .args_type = "op:s?,arg:F?",
296 .params = "on|off|flush|set [arg]",
297 .help = "open, close, or flush trace file, or set a new file name",
298 .cmd = hmp_trace_file,
302 ``trace-file on|off|flush``
303 Open, close, or flush the trace file. If no argument is given, the
304 status of the trace file is displayed.
310 .args_type = "items:s",
311 .params = "item1[,...]",
312 .help = "activate logging of the specified items",
317 ``log`` *item1*\ [,...]
318 Activate logging of the specified items.
323 .args_type = "name:s?",
325 .help = "save a VM snapshot. If no tag is provided, a new snapshot is created",
331 Create a snapshot of the whole virtual machine. If *tag* is
332 provided, it is used as human readable identifier. If there is already
333 a snapshot with the same tag, it is replaced. More info at
334 :ref:`vm_005fsnapshots`.
336 Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
337 only *tag* as parameter.
342 .args_type = "name:s",
344 .help = "restore a VM snapshot from its tag",
346 .command_completion = loadvm_completion,
351 Set the whole virtual machine to the snapshot identified by the tag
354 Since 4.0, loadvm stopped accepting snapshot id as parameter.
359 .args_type = "name:s",
361 .help = "delete a VM snapshot from its tag",
363 .command_completion = delvm_completion,
368 Delete the snapshot identified by *tag*.
370 Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
371 only *tag* as parameter.
375 .name = "singlestep",
376 .args_type = "option:s?",
377 .params = "[on|off]",
378 .help = "run emulation in singlestep mode or switch to normal mode",
379 .cmd = hmp_singlestep,
384 Run the emulation in single step mode.
385 If called with option off, the emulation returns to normal mode.
392 .help = "stop emulation",
405 .help = "resume emulation",
415 .name = "system_wakeup",
418 .help = "wakeup guest from suspend",
419 .cmd = hmp_system_wakeup,
424 Wakeup guest from suspend.
429 .args_type = "device:s?",
430 .params = "[device]",
431 .help = "start gdbserver on given device (default 'tcp
::1234'), stop with 'none
'",
432 .cmd = hmp_gdbserver,
436 ``gdbserver`` [*port*]
437 Start gdbserver session (default *port*\=1234)
442 .args_type = "fmt:/,addr:l",
443 .params = "/fmt addr",
444 .help = "virtual memory dump starting at 'addr
'",
445 .cmd = hmp_memory_dump,
450 Virtual memory dump starting at *addr*.
455 .args_type = "fmt:/,addr:l",
456 .params = "/fmt addr",
457 .help = "physical memory dump starting at 'addr
'",
458 .cmd = hmp_physical_memory_dump,
462 ``xp /``\ *fmt* *addr*
463 Physical memory dump starting at *addr*.
465 *fmt* is a format which tells the command how to format the
466 data. Its syntax is: ``/{count}{format}{size}``
469 is the number of items to be dumped.
471 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
472 c (char) or i (asm instruction).
474 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
475 ``h`` or ``w`` can be specified with the ``i`` format to
476 respectively select 16 or 32 bit code instruction size.
480 Dump 10 instructions at the current instruction pointer::
485 0x90107065: lea 0x0(%esi,1),%esi
486 0x90107069: lea 0x0(%edi,1),%edi
488 0x90107071: jmp 0x90107080
494 Dump 80 16 bit values at the start of the video memory::
496 (qemu) xp/80hx 0xb8000
497 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
498 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
499 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
500 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
501 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
502 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
503 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
504 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
505 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
506 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
512 .args_type = "addr:l",
514 .help = "print the host virtual address corresponding to a guest physical address",
520 Print the host virtual address at which the guest's physical address
*addr
*
527 .args_type
= "addr:l",
529 .help
= "print the host physical address corresponding to a guest physical address",
536 Print the host physical address at which the guest
's physical address *addr*
542 .args_type = "addr:l",
544 .help = "print the guest physical address corresponding to a guest virtual address",
550 Print the guest physical address at which the guest's virtual address
*addr
*
551 is mapped based on the mapping
for the current CPU
.
556 .args_type
= "fmt:/,val:l",
557 .params
= "/fmt expr",
558 .help
= "print expression value (use $reg for CPU register access)",
563 ``p`` or ``print
/``\
*fmt
* *expr
*
564 Print expression value
. Only the
*format
* part of
*fmt
* is
570 .args_type
= "fmt:/,addr:i,index:i.",
571 .params
= "/fmt addr",
572 .help
= "I/O port read",
573 .cmd
= hmp_ioport_read
,
577 ``i
/``\
*fmt
* *addr
* [.\
*index
*\
]
583 .args_type
= "fmt:/,addr:i,val:i",
584 .params
= "/fmt addr value",
585 .help
= "I/O port write",
586 .cmd
= hmp_ioport_write
,
590 ``o
/``\
*fmt
* *addr
* *val
*
596 .args_type
= "keys:s,hold-time:i?",
597 .params
= "keys [hold_ms]",
598 .help
= "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
600 .command_completion
= sendkey_completion
,
605 Send
*keys
* to the guest
. *keys
* could be the name of the
606 key or the raw value
in hexadecimal format
. Use ``
-`` to press
607 several keys simultaneously
. Example
::
611 This command is useful to send keys that your graphical user
interface
612 intercepts at low level
, such as ``ctrl
-alt
-f1``
in X Window
.
615 .name
= "sync-profile",
616 .args_type
= "op:s?",
617 .params
= "[on|off|reset]",
618 .help
= "enable, disable or reset synchronization profiling. "
619 "With no arguments, prints whether profiling is on or off.",
620 .cmd
= hmp_sync_profile
,
624 ``sync
-profile
[on|off|reset
]``
625 Enable
, disable or reset synchronization profiling
. With no arguments
, prints
626 whether profiling is on or off
.
630 .name
= "system_reset",
633 .help
= "reset the system",
634 .cmd
= hmp_system_reset
,
643 .name
= "system_powerdown",
646 .help
= "send system power down event",
647 .cmd
= hmp_system_powerdown
,
652 Power down the
system (if supported
).
657 .args_type
= "start:i,size:i",
658 .params
= "addr size",
659 .help
= "compute the checksum of a memory region",
664 ``sum``
*addr
* *size
*
665 Compute the checksum of a memory region
.
669 .name
= "device_add",
670 .args_type
= "device:O",
671 .params
= "driver[,prop=value][,...]",
672 .help
= "add device, like -device on the command line",
673 .cmd
= hmp_device_add
,
674 .command_completion
= device_add_completion
,
678 ``device_add``
*config
*
683 .name
= "device_del",
686 .help
= "remove device",
687 .cmd
= hmp_device_del
,
688 .command_completion
= device_del_completion
,
693 Remove device
*id
*. *id
* may be a short ID
694 or a QOM object path
.
699 .args_type
= "index:i",
701 .help
= "set the default CPU",
711 .name
= "mouse_move",
712 .args_type
= "dx_str:s,dy_str:s,dz_str:s?",
713 .params
= "dx dy [dz]",
714 .help
= "send mouse move events",
715 .cmd
= hmp_mouse_move
,
719 ``mouse_move``
*dx
* *dy
* [*dz
*]
720 Move the active mouse to the specified coordinates
*dx
* *dy
*
721 with optional scroll axis
*dz
*.
725 .name
= "mouse_button",
726 .args_type
= "button_state:i",
728 .help
= "change mouse button state (1=L, 2=M, 4=R)",
729 .cmd
= hmp_mouse_button
,
733 ``mouse_button``
*val
*
734 Change the active mouse button state
*val
* (1=L
, 2=M
, 4=R
).
739 .args_type
= "index:i",
741 .help
= "set which mouse device receives events",
742 .cmd
= hmp_mouse_set
,
746 ``mouse_set``
*index
*
747 Set which mouse device receives events at given
*index
*, index
748 can be obtained with
::
755 .name
= "wavcapture",
756 .args_type
= "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?",
757 .params
= "path audiodev [frequency [bits [channels]]]",
758 .help
= "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
759 .cmd
= hmp_wavcapture
,
762 ``wavcapture``
*filename
* *audiodev
* [*frequency
* [*bits
* [*channels
*]]]
763 Capture audio into
*filename
* from
*audiodev
*, using sample rate
764 *frequency
* bits per sample
*bits
* and number of channels
769 - Sample rate
= 44100 Hz
- CD quality
771 - Number of channels
= 2 - Stereo
775 .name
= "stopcapture",
777 .params
= "capture index",
778 .help
= "stop capture",
779 .cmd
= hmp_stopcapture
,
782 ``stopcapture``
*index
*
783 Stop capture with a given
*index
*, index can be obtained with
::
791 .args_type
= "val:l,size:i,filename:s",
792 .params
= "addr size file",
793 .help
= "save to disk virtual memory dump starting at 'addr' of size 'size'",
798 ``memsave``
*addr
* *size
* *file
*
799 save to disk virtual memory dump starting at
*addr
* of size
*size
*.
804 .args_type
= "val:l,size:i,filename:s",
805 .params
= "addr size file",
806 .help
= "save to disk physical memory dump starting at 'addr' of size 'size'",
811 ``pmemsave``
*addr
* *size
* *file
*
812 save to disk physical memory dump starting at
*addr
* of size
*size
*.
817 .args_type
= "bootdevice:s",
818 .params
= "bootdevice",
819 .help
= "define new values for the boot device list",
824 ``boot_set``
*bootdevicelist
*
825 Define
new values
for the boot device list
. Those values will
override
826 the values specified on the command line through the ``
-boot`` option
.
828 The values that can be specified
here depend on the machine type
, but are
829 the same that can be specified
in the ``
-boot`` command line option
.
836 .help
= "inject an NMI",
841 Inject an NMI on the
default CPU (x86
/s390
) or all
CPUs (ppc64
).
845 .name
= "ringbuf_write",
846 .args_type
= "device:s,data:s",
847 .params
= "device data",
848 .help
= "Write to a ring buffer character device",
849 .cmd
= hmp_ringbuf_write
,
850 .command_completion
= ringbuf_write_completion
,
854 ``ringbuf_write``
*device
* *data
*
855 Write
*data
* to ring buffer character device
*device
*.
856 *data
* must be a UTF
-8 string
.
860 .name
= "ringbuf_read",
861 .args_type
= "device:s,size:i",
862 .params
= "device size",
863 .help
= "Read from a ring buffer character device",
864 .cmd
= hmp_ringbuf_read
,
865 .command_completion
= ringbuf_write_completion
,
869 ``ringbuf_read``
*device
*
870 Read and print up to
*size
* bytes from ring buffer character
872 Certain non
-printable characters are printed ``\uXXXX``
, where ``XXXX`` is the
873 character code
in hexadecimal
. Character ``\`` is printed ``
\\``
.
874 Bug
: can screw up when the buffer contains invalid UTF
-8 sequences
,
875 NUL characters
, after the ring buffer lost data
, and when reading
876 stops because the size limit is reached
.
880 .name
= "announce_self",
881 .args_type
= "interfaces:s?,id:s?",
882 .params
= "[interfaces] [id]",
883 .help
= "Trigger GARP/RARP announcements",
884 .cmd
= hmp_announce_self
,
889 Trigger a round of GARP
/RARP broadcasts
; this is useful
for explicitly
890 updating the network infrastructure after a reconfiguration or some forms
891 of migration
. The timings of the round are set by the migration announce
892 parameters
. An optional comma separated
*interfaces
* list restricts the
893 announce to the named set of interfaces
. An optional
*id
* can be used to
894 start a separate announce timer and to change the parameters of it later
.
899 .args_type
= "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
900 .params
= "[-d] [-b] [-i] [-r] uri",
901 .help
= "migrate to URI (using -d to not wait for completion)"
902 "\n\t\t\t -b for migration without shared storage with"
903 " full copy of disk\n\t\t\t -i for migration without "
904 "shared storage with incremental copy of disk "
905 "(base image shared between src and destination)"
906 "\n\t\t\t -r to resume a paused migration",
912 ``migrate
[-d
] [-b
] [-i
]``
*uri
*
913 Migrate to
*uri
* (using -d to not wait
for completion
).
916 for migration with full copy of disk
918 for migration with incremental copy of
disk (base image is shared
)
922 .name
= "migrate_cancel",
925 .help
= "cancel the current VM migration",
926 .cmd
= hmp_migrate_cancel
,
931 Cancel the current VM migration
.
935 .name
= "migrate_continue",
936 .args_type
= "state:s",
938 .help
= "Continue migration from the given paused state",
939 .cmd
= hmp_migrate_continue
,
942 ``migrate_continue``
*state
*
943 Continue migration from the paused state
*state
*
947 .name
= "migrate_incoming",
948 .args_type
= "uri:s",
950 .help
= "Continue an incoming migration from an -incoming defer",
951 .cmd
= hmp_migrate_incoming
,
955 ``migrate_incoming``
*uri
*
956 Continue an incoming migration
using the
*uri
* (that has the same syntax
957 as the ``
-incoming`` option
).
961 .name
= "migrate_recover",
962 .args_type
= "uri:s",
964 .help
= "Continue a paused incoming postcopy migration",
965 .cmd
= hmp_migrate_recover
,
969 ``migrate_recover``
*uri
*
970 Continue a paused incoming postcopy migration
using the
*uri
*.
974 .name
= "migrate_pause",
977 .help
= "Pause an ongoing migration (postcopy-only)",
978 .cmd
= hmp_migrate_pause
,
983 Pause an ongoing migration
. Currently it only supports postcopy
.
987 .name
= "migrate_set_cache_size",
988 .args_type
= "value:o",
990 .help
= "set cache size (in bytes) for XBZRLE migrations,"
991 "the cache size will be rounded down to the nearest "
993 "The cache size affects the number of cache misses."
994 "In case of a high cache miss ratio you need to increase"
996 .cmd
= hmp_migrate_set_cache_size
,
1000 ``migrate_set_cache_size``
*value
*
1001 Set cache size to
*value
* (in bytes
) for xbzrle migrations
.
1005 .name
= "migrate_set_speed",
1006 .args_type
= "value:o",
1008 .help
= "set maximum speed (in bytes) for migrations. "
1009 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1010 .cmd
= hmp_migrate_set_speed
,
1014 ``migrate_set_speed``
*value
*
1015 Set maximum speed to
*value
* (in bytes
) for migrations
.
1019 .name
= "migrate_set_downtime",
1020 .args_type
= "value:T",
1022 .help
= "set maximum tolerated downtime (in seconds) for migrations",
1023 .cmd
= hmp_migrate_set_downtime
,
1027 ``migrate_set_downtime``
*second
*
1028 Set maximum tolerated
downtime (in seconds
) for migration
.
1032 .name
= "migrate_set_capability",
1033 .args_type
= "capability:s,state:b",
1034 .params
= "capability state",
1035 .help
= "Enable/Disable the usage of a capability for migration",
1036 .cmd
= hmp_migrate_set_capability
,
1037 .command_completion
= migrate_set_capability_completion
,
1041 ``migrate_set_capability``
*capability
* *state
*
1042 Enable
/Disable the usage of a capability
*capability
* for migration
.
1046 .name
= "migrate_set_parameter",
1047 .args_type
= "parameter:s,value:s",
1048 .params
= "parameter value",
1049 .help
= "Set the parameter for migration",
1050 .cmd
= hmp_migrate_set_parameter
,
1051 .command_completion
= migrate_set_parameter_completion
,
1055 ``migrate_set_parameter``
*parameter
* *value
*
1056 Set the parameter
*parameter
* for migration
.
1060 .name
= "migrate_start_postcopy",
1063 .help
= "Followup to a migration command to switch the migration"
1064 " to postcopy mode. The postcopy-ram capability must "
1065 "be set on both source and destination before the "
1066 "original migration command .",
1067 .cmd
= hmp_migrate_start_postcopy
,
1071 ``migrate_start_postcopy``
1072 Switch
in-progress migration to postcopy mode
. Ignored after the end of
1073 migration (or once already
in postcopy
).
1077 .name
= "x_colo_lost_heartbeat",
1080 .help
= "Tell COLO that heartbeat is lost,\n\t\t\t"
1081 "a failover or takeover is needed.",
1082 .cmd
= hmp_x_colo_lost_heartbeat
,
1086 ``x_colo_lost_heartbeat``
1087 Tell COLO that heartbeat is lost
, a failover or takeover is needed
.
1091 .name
= "client_migrate_info",
1092 .args_type
= "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1093 .params
= "protocol hostname port tls-port cert-subject",
1094 .help
= "set migration information for remote display",
1095 .cmd
= hmp_client_migrate_info
,
1099 ``client_migrate_info``
*protocol
* *hostname
* *port
* *tls
-port
* *cert
-subject
*
1100 Set migration information
for remote display
. This makes the server
1101 ask the client to automatically reconnect
using the
new parameters
1102 once migration finished successfully
. Only implemented
for SPICE
.
1106 .name
= "dump-guest-memory",
1107 .args_type
= "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
1108 .params
= "[-p] [-d] [-z|-l|-s|-w] filename [begin length]",
1109 .help
= "dump guest memory into file 'filename'.\n\t\t\t"
1110 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1111 "-d: return immediately (do not wait for completion).\n\t\t\t"
1112 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1113 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1114 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1115 "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
1116 " for Windows x64 guests with vmcoreinfo driver only.\n\t\t\t"
1117 "begin: the starting physical address.\n\t\t\t"
1118 "length: the memory size, in bytes.",
1119 .cmd
= hmp_dump_guest_memory
,
1123 ``dump
-guest
-memory
[-p
]``
*filename
* *begin
* *length
*
1125 ``dump
-guest
-memory
[-z|
-l|
-s|
-w
]``
*filename
*
1126 Dump guest memory to
*protocol
*. The file can be processed with crash or
1127 gdb
. Without ``
-z|
-l|
-s|
-w``
, the dump format is ELF
.
1130 do paging to get guest
's memory mapping.
1132 dump in kdump-compressed format, with zlib compression.
1134 dump in kdump-compressed format, with lzo compression.
1136 dump in kdump-compressed format, with snappy compression.
1138 dump in Windows crashdump format (can be used instead of ELF-dump converting),
1139 for Windows x64 guests with vmcoreinfo driver only
1143 the starting physical address. It's optional
, and should be
1144 specified together with
*length
*.
1146 the memory size
, in bytes
. It
's optional, and should be specified
1147 together with *begin*.
1151 #if defined(TARGET_S390X)
1153 .name = "dump-skeys",
1154 .args_type = "filename:F",
1156 .help = "Save guest storage keys into file 'filename
'.\n",
1157 .cmd = hmp_dump_skeys,
1162 ``dump-skeys`` *filename*
1163 Save guest storage keys to a file.
1166 #if defined(TARGET_S390X)
1168 .name = "migration_mode",
1169 .args_type = "mode:i",
1171 .help = "Enables or disables migration mode\n",
1172 .cmd = hmp_migrationmode,
1177 ``migration_mode`` *mode*
1178 Enables or disables migration mode.
1182 .name = "snapshot_blkdev",
1183 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1184 .params = "[-n] device [new-image-file] [format]",
1185 .help = "initiates a live snapshot\n\t\t\t"
1186 "of device. If a new image file is specified, the\n\t\t\t"
1187 "new image file will become the new root image.\n\t\t\t"
1188 "If format is specified, the snapshot file will\n\t\t\t"
1189 "be created in that format.\n\t\t\t"
1190 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1191 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1192 "recreating it from scratch.",
1193 .cmd = hmp_snapshot_blkdev,
1198 Snapshot device, using snapshot file as target if provided
1202 .name = "snapshot_blkdev_internal",
1203 .args_type = "device:B,name:s",
1204 .params = "device name",
1205 .help = "take an internal snapshot of device.\n\t\t\t"
1206 "The format of the image used by device must\n\t\t\t"
1207 "support it, such as qcow2.\n\t\t\t",
1208 .cmd = hmp_snapshot_blkdev_internal,
1212 ``snapshot_blkdev_internal``
1213 Take an internal snapshot on device if it support
1217 .name = "snapshot_delete_blkdev_internal",
1218 .args_type = "device:B,name:s,id:s?",
1219 .params = "device name [id]",
1220 .help = "delete an internal snapshot of device.\n\t\t\t"
1221 "If id is specified, qemu will try delete\n\t\t\t"
1222 "the snapshot matching both id and name.\n\t\t\t"
1223 "The format of the image used by device must\n\t\t\t"
1224 "support it, such as qcow2.\n\t\t\t",
1225 .cmd = hmp_snapshot_delete_blkdev_internal,
1229 ``snapshot_delete_blkdev_internal``
1230 Delete an internal snapshot on device if it support
1234 .name = "drive_mirror",
1235 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1236 .params = "[-n] [-f] device target [format]",
1237 .help = "initiates live storage\n\t\t\t"
1238 "migration for a device. The device's contents are
\n\t\t\t"
1239 "copied to the
new image file
, including data that
\n\t\t\t"
1240 "is written after the command is started
.\n\t\t\t"
1241 "The
-n flag requests QEMU to reuse the image found
\n\t\t\t"
1242 "in new-image
-file
, instead of recreating it from scratch
.\n\t\t\t"
1243 "The
-f flag requests QEMU to copy the whole disk
,\n\t\t\t"
1244 "so that the result does not need a backing file
.\n\t\t\t",
1245 .cmd = hmp_drive_mirror,
1249 Start mirroring a block device's writes to a new destination,
1250 using the specified target.
1254 .name = "drive_backup
",
1255 .args_type = "reuse
:-n
,full
:-f
,compress
:-c
,device
:B
,target
:s
,format
:s?
",
1256 .params = "[-n
] [-f
] [-c
] device target
[format
]",
1257 .help = "initiates a point
-in-time
\n\t\t\t"
1258 "copy
for a device
. The device
's contents are\n\t\t\t"
1259 "copied to the new image file, excluding data that\n\t\t\t"
1260 "is written after the command is started.\n\t\t\t"
1261 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1262 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1263 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1264 "so that the result does not need a backing file.\n\t\t\t"
1265 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1266 "(if the target format supports it).\n\t\t\t",
1267 .cmd = hmp_drive_backup,
1271 Start a point-in-time copy of a block device to a specified target.
1275 .name = "drive_add",
1276 .args_type = "node:-n,pci_addr:s,opts:s",
1277 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
1278 "[file=file][,if=type][,bus=n]\n"
1279 "[,unit=m][,media=d][,index=i]\n"
1280 "[,snapshot=on|off][,cache=on|off]\n"
1281 "[,readonly=on|off][,copy-on-read=on|off]",
1282 .help = "add drive to PCI storage controller",
1283 .cmd = hmp_drive_add,
1288 Add drive to PCI storage controller.
1292 .name = "pcie_aer_inject_error",
1293 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1294 "id:s,error_status:s,"
1295 "header0:i?,header1:i?,header2:i?,header3:i?,"
1296 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1297 .params = "[-a] [-c] id "
1298 "<error_status> [<tlp header> [<tlp header prefix>]]",
1299 .help = "inject pcie aer error\n\t\t\t"
1300 " -a for advisory non fatal error\n\t\t\t"
1301 " -c for correctable error\n\t\t\t"
1302 "<id> = qdev device id\n\t\t\t"
1303 "<error_status> = error string or 32bit\n\t\t\t"
1304 "<tlb header> = 32bit x 4\n\t\t\t"
1305 "<tlb header prefix> = 32bit x 4",
1306 .cmd = hmp_pcie_aer_inject_error,
1310 ``pcie_aer_inject_error``
1311 Inject PCIe AER error
1315 .name = "netdev_add",
1316 .args_type = "netdev:O",
1317 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1318 .help = "add host network device",
1319 .cmd = hmp_netdev_add,
1320 .command_completion = netdev_add_completion,
1325 Add host network device.
1329 .name = "netdev_del",
1330 .args_type = "id:s",
1332 .help = "remove host network device",
1333 .cmd = hmp_netdev_del,
1334 .command_completion = netdev_del_completion,
1339 Remove host network device.
1343 .name = "object_add",
1344 .args_type = "object:O",
1345 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1346 .help = "create QOM object",
1347 .cmd = hmp_object_add,
1348 .command_completion = object_add_completion,
1357 .name = "object_del",
1358 .args_type = "id:s",
1360 .help = "destroy QOM object",
1361 .cmd = hmp_object_del,
1362 .command_completion = object_del_completion,
1372 .name = "hostfwd_add",
1373 .args_type = "arg1:s,arg2:s?",
1374 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1375 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1376 .cmd = hmp_hostfwd_add,
1381 Redirect TCP or UDP connections from host to guest (requires -net user).
1386 .name = "hostfwd_remove",
1387 .args_type = "arg1:s,arg2:s?",
1388 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1389 .help = "remove host-to-guest TCP or UDP redirection",
1390 .cmd = hmp_hostfwd_remove,
1396 Remove host-to-guest TCP or UDP redirection.
1401 .args_type = "value:M",
1403 .help = "request VM to change its memory allocation (in MB)",
1409 Request VM to change its memory allocation to *value* (in MB).
1414 .args_type = "name:s,up:b",
1415 .params = "name on|off",
1416 .help = "change the link status of a network adapter",
1417 .cmd = hmp_set_link,
1418 .command_completion = set_link_completion,
1422 ``set_link`` *name* ``[on|off]``
1423 Switch link *name* on (i.e. up) or off (i.e. down).
1427 .name = "watchdog_action",
1428 .args_type = "action:s",
1429 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1430 .help = "change watchdog action",
1431 .cmd = hmp_watchdog_action,
1432 .command_completion = watchdog_action_completion,
1437 Change watchdog action.
1442 .args_type = "aclname:s",
1443 .params = "aclname",
1444 .help = "list rules in the access control list",
1445 .cmd = hmp_acl_show,
1449 ``acl_show`` *aclname*
1450 List all the matching rules in the access control list, and the default
1451 policy. There are currently two named access control lists,
1452 *vnc.x509dname* and *vnc.username* matching on the x509 client
1453 certificate distinguished name, and SASL username respectively.
1457 .name = "acl_policy",
1458 .args_type = "aclname:s,policy:s",
1459 .params = "aclname allow|deny",
1460 .help = "set default access control list policy",
1461 .cmd = hmp_acl_policy,
1465 ``acl_policy`` *aclname* ``allow|deny``
1466 Set the default access control list policy, used in the event that
1467 none of the explicit rules match. The default policy at startup is
1473 .args_type = "aclname:s,match:s,policy:s,index:i?",
1474 .params = "aclname match allow|deny [index]",
1475 .help = "add a match rule to the access control list",
1480 ``acl_add`` *aclname* *match* ``allow|deny`` [*index*]
1481 Add a match rule to the access control list, allowing or denying access.
1482 The match will normally be an exact username or x509 distinguished name,
1483 but can optionally include wildcard globs. eg ``*@EXAMPLE.COM`` to
1484 allow all users in the ``EXAMPLE.COM`` kerberos realm. The match will
1485 normally be appended to the end of the ACL, but can be inserted
1486 earlier in the list if the optional *index* parameter is supplied.
1490 .name = "acl_remove",
1491 .args_type = "aclname:s,match:s",
1492 .params = "aclname match",
1493 .help = "remove a match rule from the access control list",
1494 .cmd = hmp_acl_remove,
1498 ``acl_remove`` *aclname* *match*
1499 Remove the specified match rule from the access control list.
1503 .name = "acl_reset",
1504 .args_type = "aclname:s",
1505 .params = "aclname",
1506 .help = "reset the access control list",
1507 .cmd = hmp_acl_reset,
1511 ``acl_reset`` *aclname*
1512 Remove all matches from the access control list, and set the default
1513 policy back to ``deny``.
1517 .name = "nbd_server_start",
1518 .args_type = "all:-a,writable:-w,uri:s",
1519 .params = "nbd_server_start [-a] [-w] host:port",
1520 .help = "serve block devices on the given host and port",
1521 .cmd = hmp_nbd_server_start,
1524 ``nbd_server_start`` *host*:*port*
1525 Start an NBD server on the given host and/or port. If the ``-a``
1526 option is included, all of the virtual machine's block devices that
1527 have an inserted media on them are automatically exported
; in this case,
1528 the ``
-w`` option makes the devices writable too
.
1532 .name
= "nbd_server_add",
1533 .args_type
= "writable:-w,device:B,name:s?",
1534 .params
= "nbd_server_add [-w] device [name]",
1535 .help
= "export a block device via NBD",
1536 .cmd
= hmp_nbd_server_add
,
1539 ``nbd_server_add``
*device
* [ *name
* ]
1540 Export a block device through QEMU
's NBD server, which must be started
1541 beforehand with ``nbd_server_start``. The ``-w`` option makes the
1542 exported device writable too. The export name is controlled by *name*,
1543 defaulting to *device*.
1547 .name = "nbd_server_remove",
1548 .args_type = "force:-f,name:s",
1549 .params = "nbd_server_remove [-f] name",
1550 .help = "remove an export previously exposed via NBD",
1551 .cmd = hmp_nbd_server_remove,
1554 ``nbd_server_remove [-f]`` *name*
1555 Stop exporting a block device through QEMU's NBD server
, which was
1556 previously started with ``nbd_server_add``
. The ``
-f``
1557 option forces the server to drop the export immediately even
if
1558 clients are connected
; otherwise the command fails unless there are no
1563 .name
= "nbd_server_stop",
1565 .params
= "nbd_server_stop",
1566 .help
= "stop serving block devices using the NBD protocol",
1567 .cmd
= hmp_nbd_server_stop
,
1571 Stop the QEMU embedded NBD server
.
1575 #
if defined(TARGET_I386
)
1579 .args_type
= "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1580 .params
= "[-b] cpu bank status mcgstatus addr misc",
1581 .help
= "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1587 ``mce``
*cpu
* *bank
* *status
* *mcgstatus
* *addr
* *misc
*
1588 Inject an MCE on the given
CPU (x86 only
).
1593 .args_type
= "fdname:s",
1594 .params
= "getfd name",
1595 .help
= "receive a file descriptor via SCM rights and assign it a name",
1601 If a file descriptor is passed alongside
this command
using the SCM_RIGHTS
1602 mechanism on unix sockets
, it is stored
using the name
*fdname
* for
1603 later use by other monitor commands
.
1608 .args_type
= "fdname:s",
1609 .params
= "closefd name",
1610 .help
= "close a file descriptor previously passed via SCM rights",
1615 ``closefd``
*fdname
*
1616 Close the file descriptor previously assigned to
*fdname
* using the
1617 ``getfd`` command
. This is only needed
if the file descriptor was
never
1618 used by another monitor command
.
1622 .name
= "block_passwd",
1623 .args_type
= "device:B,password:s",
1624 .params
= "block_passwd device password",
1625 .help
= "set the password of encrypted block devices",
1626 .cmd
= hmp_block_passwd
,
1630 ``block_passwd``
*device
* *password
*
1631 Set the encrypted device
*device
* password to
*password
*
1633 This command is now obsolete and will always
return an error since
2.10
1637 .name
= "block_set_io_throttle",
1638 .args_type
= "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1639 .params
= "device bps bps_rd bps_wr iops iops_rd iops_wr",
1640 .help
= "change I/O throttle limits for a block drive",
1641 .cmd
= hmp_block_set_io_throttle
,
1645 ``block_set_io_throttle``
*device
* *bps
* *bps_rd
* *bps_wr
* *iops
* *iops_rd
* *iops_wr
*
1646 Change I
/O throttle limits
for a block drive to
1647 *bps
* *bps_rd
* *bps_wr
* *iops
* *iops_rd
* *iops_wr
*.
1648 *device
* can be a block device name
, a qdev ID or a QOM path
.
1652 .name
= "set_password",
1653 .args_type
= "protocol:s,password:s,connected:s?",
1654 .params
= "protocol password action-if-connected",
1655 .help
= "set spice/vnc password",
1656 .cmd
= hmp_set_password
,
1660 ``set_password
[ vnc | spice
] password
[ action
-if-connected
]``
1661 Change spice
/vnc password
. Use zero to make the password stay valid
1662 forever
. *action
-if-connected
* specifies what should happen
in
1663 case a connection is established
: *fail
* makes the password change
1664 fail
. *disconnect
* changes the password and disconnects the
1665 client
. *keep
* changes the password and keeps the connection up
.
1666 *keep
* is the
default.
1670 .name
= "expire_password",
1671 .args_type
= "protocol:s,time:s",
1672 .params
= "protocol time",
1673 .help
= "set spice/vnc password expire-time",
1674 .cmd
= hmp_expire_password
,
1678 ``expire_password
[ vnc | spice
]``
*expire
-time
*
1679 Specify when a password
for spice
/vnc becomes
1680 invalid
. *expire
-time
* accepts
:
1683 Invalidate password instantly
.
1685 Password stays valid forever
.
1687 Password stays valid
for *nsec
* seconds starting now
.
1689 Password is invalidated at the given time
. *nsec
* are the seconds
1690 passed since
1970, i
.e
. unix epoch
.
1695 .name
= "chardev-add",
1696 .args_type
= "args:s",
1698 .help
= "add chardev",
1699 .cmd
= hmp_chardev_add
,
1700 .command_completion
= chardev_add_completion
,
1704 ``chardev
-add``
*args
*
1705 chardev
-add accepts the same parameters as the
-chardev command line
switch.
1709 .name
= "chardev-change",
1710 .args_type
= "id:s,args:s",
1711 .params
= "id args",
1712 .help
= "change chardev",
1713 .cmd
= hmp_chardev_change
,
1717 ``chardev
-change``
*args
*
1718 chardev
-change accepts existing chardev
*id
* and then the same arguments
1719 as the
-chardev command line
switch (except
for "id").
1723 .name
= "chardev-remove",
1724 .args_type
= "id:s",
1726 .help
= "remove chardev",
1727 .cmd
= hmp_chardev_remove
,
1728 .command_completion
= chardev_remove_completion
,
1732 ``chardev
-remove``
*id
*
1733 Removes the chardev
*id
*.
1737 .name
= "chardev-send-break",
1738 .args_type
= "id:s",
1740 .help
= "send a break on chardev",
1741 .cmd
= hmp_chardev_send_break
,
1742 .command_completion
= chardev_remove_completion
,
1746 ``chardev
-send
-break``
*id
*
1747 Send a
break on the chardev
*id
*.
1752 .args_type
= "qdev:-d,device:B,command:s",
1753 .params
= "[-d] [device] \"[command]\"",
1754 .help
= "run a qemu-io command on a block device\n\t\t\t"
1755 "-d: [device] is a device ID rather than a "
1756 "drive ID or node name",
1761 ``qemu
-io``
*device
* *command
*
1762 Executes a qemu
-io command on the given block device
.
1767 .args_type
= "path:s?",
1769 .help
= "list QOM properties",
1770 .cmd
= hmp_qom_list
,
1775 ``qom
-list``
[*path
*]
1776 Print QOM properties of object at location
*path
*
1781 .args_type
= "path:s,property:s",
1782 .params
= "path property",
1783 .help
= "print QOM property",
1789 ``qom
-get``
*path
* *property
*
1790 Print QOM property
*property
* of object at location
*path
*
1795 .args_type
= "json:-j,path:s,property:s,value:S",
1796 .params
= "[-j] path property value",
1797 .help
= "set QOM property.\n\t\t\t"
1798 "-j: the value is specified in json format.",
1804 ``qom
-set``
*path
* *property
* *value
*
1805 Set QOM property
*property
* of object at location
*path
* to value
*value
*
1809 .name
= "replay_break",
1810 .args_type
= "icount:i",
1812 .help
= "set breakpoint at the specified instruction count",
1813 .cmd
= hmp_replay_break
,
1817 ``replay_break``
*icount
*
1818 Set replay breakpoint at instruction count
*icount
*.
1819 Execution stops when the specified instruction is reached
.
1820 There can be at most one breakpoint
. When breakpoint is set
, any prior
1821 one is removed
. The breakpoint may be set only
in replay mode and only
1822 "in the future", i
.e
. at instruction counts greater than the current one
.
1823 The current instruction count can be observed with ``info replay``
.
1827 .name
= "replay_delete_break",
1830 .help
= "remove replay breakpoint",
1831 .cmd
= hmp_replay_delete_break
,
1835 ``replay_delete_break``
1836 Remove replay breakpoint which was previously set with ``replay_break``
.
1837 The command is ignored when there are no replay breakpoints
.
1841 .name
= "replay_seek",
1842 .args_type
= "icount:i",
1844 .help
= "replay execution to the specified instruction count",
1845 .cmd
= hmp_replay_seek
,
1849 ``replay_seek``
*icount
*
1850 Automatically proceed to the instruction count
*icount
*, when
1851 replaying the execution
. The command automatically loads nearest
1852 snapshot and replays the execution to find the desired instruction
.
1853 When there is no preceding snapshot or the execution is not replayed
,
1854 then the command fails
.
1855 *icount
* for the reference may be observed with ``info replay`` command
.
1860 .args_type
= "item:s?",
1861 .params
= "[subcommand]",
1862 .help
= "show various information about the system state",
1863 .cmd
= hmp_info_help
,
1864 .sub_table
= hmp_info_cmds
,