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",
21 @item help or ?
[@
var{cmd
}]
23 Show the help
for all commands or just
for command @
var{cmd
}.
28 .args_type
= "device:B",
29 .params
= "device|all",
30 .help
= "commit changes to the disk images (if -snapshot is used) or backing files",
37 Commit changes to the disk
images (if -snapshot is used
) or backing files
.
38 If the backing file is smaller than the snapshot
, then the backing file will be
39 resized to be the same size as the snapshot
. If the snapshot is smaller than
40 the backing file
, the backing file will not be truncated
. If you want the
41 backing file to match the size of the smaller snapshot
, you can safely truncate
42 it yourself once the commit operation successfully completes
.
49 .help
= "quit the emulator",
60 .name
= "block_resize",
61 .args_type
= "device:B,size:o",
62 .params
= "device size",
63 .help
= "resize a block image",
64 .cmd
= hmp_block_resize
,
70 Resize a block image
while a guest is running
. Usually requires guest
71 action to see the updated size
. Resize to a lower size is supported
,
72 but should be used with extreme caution
. Note that
this command only
73 resizes image files
, it can not resize block devices like LVM volumes
.
77 .name
= "block_stream",
78 .args_type
= "device:B,speed:o?,base:s?",
79 .params
= "device [speed [base]]",
80 .help
= "copy data from a backing file into a block device",
81 .cmd
= hmp_block_stream
,
87 Copy data from a backing file into a block device
.
91 .name
= "block_job_set_speed",
92 .args_type
= "device:B,speed:o",
93 .params
= "device speed",
94 .help
= "set maximum speed for a background block operation",
95 .cmd
= hmp_block_job_set_speed
,
99 @item block_job_set_speed
100 @findex block_job_set_speed
101 Set maximum speed
for a background block operation
.
105 .name
= "block_job_cancel",
106 .args_type
= "force:-f,device:B",
107 .params
= "[-f] device",
108 .help
= "stop an active background block operation (use -f"
109 "\n\t\t\t if you want to abort the operation immediately"
110 "\n\t\t\t instead of keep running until data is in sync)",
111 .cmd
= hmp_block_job_cancel
,
115 @item block_job_cancel
116 @findex block_job_cancel
117 Stop an active background block
operation (streaming
, mirroring
).
121 .name
= "block_job_complete",
122 .args_type
= "device:B",
124 .help
= "stop an active background block operation",
125 .cmd
= hmp_block_job_complete
,
129 @item block_job_complete
130 @findex block_job_complete
131 Manually trigger completion of an active background block operation
.
132 For mirroring
, this will
switch the device to the destination path
.
136 .name
= "block_job_pause",
137 .args_type
= "device:B",
139 .help
= "pause an active background block operation",
140 .cmd
= hmp_block_job_pause
,
144 @item block_job_pause
145 @findex block_job_pause
146 Pause an active block streaming operation
.
150 .name
= "block_job_resume",
151 .args_type
= "device:B",
153 .help
= "resume a paused background block operation",
154 .cmd
= hmp_block_job_resume
,
158 @item block_job_resume
159 @findex block_job_resume
160 Resume a paused block streaming operation
.
165 .args_type
= "force:-f,device:B",
166 .params
= "[-f] device",
167 .help
= "eject a removable medium (use -f to force it)",
172 @item eject
[-f
] @
var{device
}
174 Eject a removable
medium (use
-f to force it
).
181 .help
= "remove host block device",
182 .cmd
= hmp_drive_del
,
186 @item drive_del @
var{device
}
188 Remove host block device
. The result is that guest generated IO is no longer
189 submitted against the host device underlying the disk
. Once a drive has
190 been deleted
, the QEMU Block layer returns
-EIO which results
in IO
191 errors
in the guest
for applications that are reading
/writing to the device
.
192 These errors are always reported to the guest
, regardless of the drive
's error
193 actions (drive options rerror, werror).
198 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
199 .params = "device filename [format [read-only-mode]]",
200 .help = "change a removable medium, optional format",
205 @item change @var{device} @var{setting}
207 Change the configuration of a device.
210 @item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
211 Change the medium for a removable disk device to point to @var{filename}. eg
214 (qemu) change ide1-cd0 /path/to/some.iso
217 @var{format} is optional.
219 @var{read-only-mode} may be used to change the read-only status of the device.
220 It accepts the following values:
224 Retains the current status; this is the default.
227 Makes the device read-only.
230 Makes the device writable.
233 @item change vnc @var{display},@var{options}
234 Change the configuration of the VNC server. The valid syntax for @var{display}
235 and @var{options} are described at @ref{sec_invocation}. eg
238 (qemu) change vnc localhost:1
241 @item change vnc password [@var{password}]
243 Change the password associated with the VNC server. If the new password is not
244 supplied, the monitor will prompt for it to be entered. VNC passwords are only
245 significant up to 8 letters. eg
248 (qemu) change vnc password
256 .name = "screendump",
257 .args_type = "filename:F,device:s?,head:i?",
258 .params = "filename [device [head]]",
259 .help = "save screen from head 'head
' of display device 'device
' "
260 "into PPM image 'filename
'",
261 .cmd = hmp_screendump,
265 @item screendump @var{filename}
267 Save screen into PPM image @var{filename}.
272 .args_type = "filename:F",
273 .params = "filename",
274 .help = "output logs to 'filename
'",
279 @item logfile @var{filename}
281 Output logs to @var{filename}.
285 .name = "trace-event",
286 .args_type = "name:s,option:b,vcpu:i?",
287 .params = "name on|off [vcpu]",
288 .help = "changes status of a specific trace event "
289 "(vcpu: vCPU to set, default is all)",
290 .cmd = hmp_trace_event,
291 .command_completion = trace_event_completion,
297 changes status of a trace event
300 #if defined(CONFIG_TRACE_SIMPLE)
302 .name = "trace-file",
303 .args_type = "op:s?,arg:F?",
304 .params = "on|off|flush|set [arg]",
305 .help = "open, close, or flush trace file, or set a new file name",
306 .cmd = hmp_trace_file,
310 @item trace-file on|off|flush
312 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
318 .args_type = "items:s",
319 .params = "item1[,...]",
320 .help = "activate logging of the specified items",
325 @item log @var{item1}[,...]
327 Activate logging of the specified items.
332 .args_type = "name:s?",
333 .params = "[tag|id]",
334 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
339 @item savevm [@var{tag}|@var{id}]
341 Create a snapshot of the whole virtual machine. If @var{tag} is
342 provided, it is used as human readable identifier. If there is already
343 a snapshot with the same tag or ID, it is replaced. More info at
349 .args_type = "name:s",
351 .help = "restore a VM snapshot from its tag or id",
353 .command_completion = loadvm_completion,
357 @item loadvm @var{tag}|@var{id}
359 Set the whole virtual machine to the snapshot identified by the tag
360 @var{tag} or the unique snapshot ID @var{id}.
365 .args_type = "name:s",
367 .help = "delete a VM snapshot from its tag or id",
369 .command_completion = delvm_completion,
373 @item delvm @var{tag}|@var{id}
375 Delete the snapshot identified by @var{tag} or @var{id}.
379 .name = "singlestep",
380 .args_type = "option:s?",
381 .params = "[on|off]",
382 .help = "run emulation in singlestep mode or switch to normal mode",
383 .cmd = hmp_singlestep,
387 @item singlestep [off]
389 Run the emulation in single step mode.
390 If called with option off, the emulation returns to normal mode.
397 .help = "stop emulation",
411 .help = "resume emulation",
422 .name = "system_wakeup",
425 .help = "wakeup guest from suspend",
426 .cmd = hmp_system_wakeup,
431 @findex system_wakeup
432 Wakeup guest from suspend.
437 .args_type = "device:s?",
438 .params = "[device]",
439 .help = "start gdbserver on given device (default 'tcp
::1234'), stop with 'none
'",
440 .cmd = hmp_gdbserver,
444 @item gdbserver [@var{port}]
446 Start gdbserver session (default @var{port}=1234)
451 .args_type = "fmt:/,addr:l",
452 .params = "/fmt addr",
453 .help = "virtual memory dump starting at 'addr
'",
454 .cmd = hmp_memory_dump,
458 @item x/fmt @var{addr}
460 Virtual memory dump starting at @var{addr}.
465 .args_type = "fmt:/,addr:l",
466 .params = "/fmt addr",
467 .help = "physical memory dump starting at 'addr
'",
468 .cmd = hmp_physical_memory_dump,
472 @item xp /@var{fmt} @var{addr}
474 Physical memory dump starting at @var{addr}.
476 @var{fmt} is a format which tells the command how to format the
477 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
481 is the number of items to be dumped.
484 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
485 c (char) or i (asm instruction).
488 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
489 @code{h} or @code{w} can be specified with the @code{i} format to
490 respectively select 16 or 32 bit code instruction size.
497 Dump 10 instructions at the current instruction pointer:
502 0x90107065: lea 0x0(%esi,1),%esi
503 0x90107069: lea 0x0(%edi,1),%edi
505 0x90107071: jmp 0x90107080
513 Dump 80 16 bit values at the start of the video memory.
515 (qemu) xp/80hx 0xb8000
516 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
517 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
518 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
519 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
520 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
521 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
522 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
523 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
524 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
525 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
532 .args_type = "addr:l",
534 .help = "print the host virtual address corresponding to a guest physical address",
539 @item gpa2hva @var{addr}
541 Print the host virtual address at which the guest's physical address @
var{addr
}
548 .args_type
= "addr:l",
550 .help
= "print the host physical address corresponding to a guest physical address",
556 @item gpa2hpa @
var{addr
}
558 Print the host physical address at which the guest
's physical address @var{addr}
564 .args_type = "fmt:/,val:l",
565 .params = "/fmt expr",
566 .help = "print expression value (use $reg for CPU register access)",
571 @item p or print/@var{fmt} @var{expr}
573 Print expression value. Only the @var{format} part of @var{fmt} is
579 .args_type = "fmt:/,addr:i,index:i.",
580 .params = "/fmt addr",
581 .help = "I/O port read",
582 .cmd = hmp_ioport_read,
586 @item i/@var{fmt} @var{addr} [.@var{index}]
593 .args_type = "fmt:/,addr:i,val:i",
594 .params = "/fmt addr value",
595 .help = "I/O port write",
596 .cmd = hmp_ioport_write,
600 @item o/@var{fmt} @var{addr} @var{val}
607 .args_type = "keys:s,hold-time:i?",
608 .params = "keys [hold_ms]",
609 .help = "send keys to the VM (e.g. 'sendkey ctrl
-alt
-f1
', default hold time=100 ms)",
611 .command_completion = sendkey_completion,
615 @item sendkey @var{keys}
617 Send @var{keys} to the guest. @var{keys} could be the name of the
618 key or the raw value in hexadecimal format. Use @code{-} to press
619 several keys simultaneously. Example:
624 This command is useful to send keys that your graphical user interface
625 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
629 .name = "system_reset",
632 .help = "reset the system",
633 .cmd = hmp_system_reset,
643 .name = "system_powerdown",
646 .help = "send system power down event",
647 .cmd = hmp_system_powerdown,
651 @item system_powerdown
652 @findex 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 @item sum @var{addr} @var{size}
667 Compute the checksum of a memory region.
671 .name = "device_add",
672 .args_type = "device:O",
673 .params = "driver[,prop=value][,...]",
674 .help = "add device, like -device on the command line",
675 .cmd = hmp_device_add,
676 .command_completion = device_add_completion,
680 @item device_add @var{config}
686 .name = "device_del",
689 .help = "remove device",
690 .cmd = hmp_device_del,
691 .command_completion = device_del_completion,
695 @item device_del @var{id}
697 Remove device @var{id}. @var{id} may be a short ID
698 or a QOM object path.
703 .args_type = "index:i",
705 .help = "set the default CPU",
710 @item cpu @var{index}
716 .name = "mouse_move",
717 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
718 .params = "dx dy [dz]",
719 .help = "send mouse move events",
720 .cmd = hmp_mouse_move,
724 @item mouse_move @var{dx} @var{dy} [@var{dz}]
726 Move the active mouse to the specified coordinates @var{dx} @var{dy}
727 with optional scroll axis @var{dz}.
731 .name = "mouse_button",
732 .args_type = "button_state:i",
734 .help = "change mouse button state (1=L, 2=M, 4=R)",
735 .cmd = hmp_mouse_button,
739 @item mouse_button @var{val}
741 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
746 .args_type = "index:i",
748 .help = "set which mouse device receives events",
749 .cmd = hmp_mouse_set,
753 @item mouse_set @var{index}
755 Set which mouse device receives events at given @var{index}, index
763 .name = "wavcapture",
764 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
765 .params = "path [frequency [bits [channels]]]",
766 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
767 .cmd = hmp_wavcapture,
770 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
772 Capture audio into @var{filename}. Using sample rate @var{frequency}
773 bits per sample @var{bits} and number of channels @var{channels}.
777 @item Sample rate = 44100 Hz - CD quality
779 @item Number of channels = 2 - Stereo
784 .name = "stopcapture",
786 .params = "capture index",
787 .help = "stop capture",
788 .cmd = hmp_stopcapture,
791 @item stopcapture @var{index}
793 Stop capture with a given @var{index}, index can be obtained with
801 .args_type = "val:l,size:i,filename:s",
802 .params = "addr size file",
803 .help = "save to disk virtual memory dump starting at 'addr
' of size 'size
'",
808 @item memsave @var{addr} @var{size} @var{file}
810 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
815 .args_type = "val:l,size:i,filename:s",
816 .params = "addr size file",
817 .help = "save to disk physical memory dump starting at 'addr
' of size 'size
'",
822 @item pmemsave @var{addr} @var{size} @var{file}
824 save to disk physical memory dump starting at @var{addr} of size @var{size}.
829 .args_type = "bootdevice:s",
830 .params = "bootdevice",
831 .help = "define new values for the boot device list",
836 @item boot_set @var{bootdevicelist}
838 Define new values for the boot device list. Those values will override
839 the values specified on the command line through the @code{-boot} option.
841 The values that can be specified here depend on the machine type, but are
842 the same that can be specified in the @code{-boot} command line option.
849 .help = "inject an NMI",
855 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
860 .name = "ringbuf_write",
861 .args_type = "device:s,data:s",
862 .params = "device data",
863 .help = "Write to a ring buffer character device",
864 .cmd = hmp_ringbuf_write,
865 .command_completion = ringbuf_write_completion,
869 @item ringbuf_write @var{device} @var{data}
870 @findex ringbuf_write
871 Write @var{data} to ring buffer character device @var{device}.
872 @var{data} must be a UTF-8 string.
877 .name = "ringbuf_read",
878 .args_type = "device:s,size:i",
879 .params = "device size",
880 .help = "Read from a ring buffer character device",
881 .cmd = hmp_ringbuf_read,
882 .command_completion = ringbuf_write_completion,
886 @item ringbuf_read @var{device}
888 Read and print up to @var{size} bytes from ring buffer character
890 Certain non-printable characters are printed \uXXXX, where XXXX is the
891 character code in hexadecimal. Character \ is printed \\.
892 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
893 NUL characters, after the ring buffer lost data, and when reading
894 stops because the size limit is reached.
900 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
901 .params = "[-d] [-b] [-i] 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)",
912 @item migrate [-d] [-b] [-i] @var{uri}
914 Migrate to @var{uri} (using -d to not wait for completion).
915 -b for migration with full copy of disk
916 -i for migration with incremental copy of disk (base image is shared)
920 .name = "migrate_cancel",
923 .help = "cancel the current VM migration",
924 .cmd = hmp_migrate_cancel,
929 @findex migrate_cancel
930 Cancel the current VM migration.
934 .name = "migrate_continue",
935 .args_type = "state:s",
937 .help = "Continue migration from the given paused state",
938 .cmd = hmp_migrate_continue,
941 @item migrate_continue @var{state}
942 @findex migrate_continue
943 Continue migration from the paused state @var{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 @item migrate_incoming @var{uri}
956 @findex migrate_incoming
957 Continue an incoming migration using the @var{uri} (that has the same syntax
958 as the -incoming option).
963 .name = "migrate_set_cache_size",
964 .args_type = "value:o",
966 .help = "set cache size (in bytes) for XBZRLE migrations,"
967 "the cache size will be rounded down to the nearest "
969 "The cache size affects the number of cache misses."
970 "In case of a high cache miss ratio you need to increase"
972 .cmd = hmp_migrate_set_cache_size,
976 @item migrate_set_cache_size @var{value}
977 @findex migrate_set_cache_size
978 Set cache size to @var{value} (in bytes) for xbzrle migrations.
982 .name = "migrate_set_speed",
983 .args_type = "value:o",
985 .help = "set maximum speed (in bytes) for migrations. "
986 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
987 .cmd = hmp_migrate_set_speed,
991 @item migrate_set_speed @var{value}
992 @findex migrate_set_speed
993 Set maximum speed to @var{value} (in bytes) for migrations.
997 .name = "migrate_set_downtime",
998 .args_type = "value:T",
1000 .help = "set maximum tolerated downtime (in seconds) for migrations",
1001 .cmd = hmp_migrate_set_downtime,
1005 @item migrate_set_downtime @var{second}
1006 @findex migrate_set_downtime
1007 Set maximum tolerated downtime (in seconds) for migration.
1011 .name = "migrate_set_capability",
1012 .args_type = "capability:s,state:b",
1013 .params = "capability state",
1014 .help = "Enable/Disable the usage of a capability for migration",
1015 .cmd = hmp_migrate_set_capability,
1016 .command_completion = migrate_set_capability_completion,
1020 @item migrate_set_capability @var{capability} @var{state}
1021 @findex migrate_set_capability
1022 Enable/Disable the usage of a capability @var{capability} for migration.
1026 .name = "migrate_set_parameter",
1027 .args_type = "parameter:s,value:s",
1028 .params = "parameter value",
1029 .help = "Set the parameter for migration",
1030 .cmd = hmp_migrate_set_parameter,
1031 .command_completion = migrate_set_parameter_completion,
1035 @item migrate_set_parameter @var{parameter} @var{value}
1036 @findex migrate_set_parameter
1037 Set the parameter @var{parameter} for migration.
1041 .name = "migrate_start_postcopy",
1044 .help = "Followup to a migration command to switch the migration"
1045 " to postcopy mode. The postcopy-ram capability must "
1046 "be set on both source and destination before the "
1047 "original migration command .",
1048 .cmd = hmp_migrate_start_postcopy,
1052 @item migrate_start_postcopy
1053 @findex migrate_start_postcopy
1054 Switch in-progress migration to postcopy mode. Ignored after the end of
1055 migration (or once already in postcopy).
1059 .name = "x_colo_lost_heartbeat",
1062 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1063 "a failover or takeover is needed.",
1064 .cmd = hmp_x_colo_lost_heartbeat,
1068 @item x_colo_lost_heartbeat
1069 @findex x_colo_lost_heartbeat
1070 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1074 .name = "client_migrate_info",
1075 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1076 .params = "protocol hostname port tls-port cert-subject",
1077 .help = "set migration information for remote display",
1078 .cmd = hmp_client_migrate_info,
1082 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
1083 @findex client_migrate_info
1084 Set migration information for remote display. This makes the server
1085 ask the client to automatically reconnect using the new parameters
1086 once migration finished successfully. Only implemented for SPICE.
1090 .name = "dump-guest-memory",
1091 .args_type = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
1092 .params = "[-p] [-d] [-z|-l|-s] filename [begin length]",
1093 .help = "dump guest memory into file 'filename
'.\n\t\t\t"
1094 "-p: do paging to get guest's memory mapping
.\n\t\t\t"
1095 "-d
: return immediately (do not wait
for completion
).\n\t\t\t"
1096 "-z
: dump
in kdump
-compressed format
, with zlib compression
.\n\t\t\t"
1097 "-l
: dump
in kdump
-compressed format
, with lzo compression
.\n\t\t\t"
1098 "-s
: dump
in kdump
-compressed format
, with snappy compression
.\n\t\t\t"
1099 "begin
: the starting physical address
.\n\t\t\t"
1100 "length
: the memory size
, in bytes
.",
1101 .cmd = hmp_dump_guest_memory,
1106 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1107 @item dump-guest-memory [-z|-l|-s] @var{filename}
1108 @findex dump-guest-memory
1109 Dump guest memory to @var{protocol}. The file can be processed with crash or
1110 gdb. Without -z|-l|-s, the dump format is ELF.
1111 -p: do paging to get guest's memory mapping.
1112 -z: dump in kdump-compressed format, with zlib compression.
1113 -l: dump in kdump-compressed format, with lzo compression.
1114 -s: dump in kdump-compressed format, with snappy compression.
1115 filename: dump file name.
1116 begin: the starting physical address. It's optional, and should be
1117 specified together with length.
1118 length: the memory size, in bytes. It's optional, and should be specified
1119 together with begin.
1122 #if defined(TARGET_S390X)
1124 .name = "dump
-skeys
",
1125 .args_type = "filename
:F
",
1127 .help = "Save guest storage keys into file
'filename'.\n",
1128 .cmd = hmp_dump_skeys,
1133 @item dump-skeys @var{filename}
1135 Save guest storage keys to a file.
1138 #if defined(TARGET_S390X)
1140 .name = "migration_mode
",
1141 .args_type = "mode
:i
",
1143 .help = "Enables or disables migration mode
\n",
1144 .cmd = hmp_migrationmode,
1149 @item migration_mode @var{mode}
1150 @findex migration_mode
1151 Enables or disables migration mode.
1155 .name = "snapshot_blkdev
",
1156 .args_type = "reuse
:-n
,device
:B
,snapshot
-file
:s?
,format
:s?
",
1157 .params = "[-n
] device
[new-image
-file
] [format
]",
1158 .help = "initiates a live snapshot
\n\t\t\t"
1159 "of device
. If a
new image file is specified
, the
\n\t\t\t"
1160 "new image file will become the
new root image
.\n\t\t\t"
1161 "If format is specified
, the snapshot file will
\n\t\t\t"
1162 "be created
in that format
.\n\t\t\t"
1163 "The
default format is qcow2
. The
-n flag requests QEMU
\n\t\t\t"
1164 "to reuse the image found
in new-image
-file
, instead of
\n\t\t\t"
1165 "recreating it from scratch
.",
1166 .cmd = hmp_snapshot_blkdev,
1170 @item snapshot_blkdev
1171 @findex snapshot_blkdev
1172 Snapshot device, using snapshot file as target if provided
1176 .name = "snapshot_blkdev_internal
",
1177 .args_type = "device
:B
,name
:s
",
1178 .params = "device name
",
1179 .help = "take an internal snapshot of device
.\n\t\t\t"
1180 "The format of the image used by device must
\n\t\t\t"
1181 "support it
, such as qcow2
.\n\t\t\t",
1182 .cmd = hmp_snapshot_blkdev_internal,
1186 @item snapshot_blkdev_internal
1187 @findex snapshot_blkdev_internal
1188 Take an internal snapshot on device if it support
1192 .name = "snapshot_delete_blkdev_internal
",
1193 .args_type = "device
:B
,name
:s
,id
:s?
",
1194 .params = "device name
[id
]",
1195 .help = "delete an internal snapshot of device
.\n\t\t\t"
1196 "If id is specified
, qemu will
try delete
\n\t\t\t"
1197 "the snapshot matching both id and name
.\n\t\t\t"
1198 "The format of the image used by device must
\n\t\t\t"
1199 "support it
, such as qcow2
.\n\t\t\t",
1200 .cmd = hmp_snapshot_delete_blkdev_internal,
1204 @item snapshot_delete_blkdev_internal
1205 @findex snapshot_delete_blkdev_internal
1206 Delete an internal snapshot on device if it support
1210 .name = "drive_mirror
",
1211 .args_type = "reuse
:-n
,full
:-f
,device
:B
,target
:s
,format
:s?
",
1212 .params = "[-n
] [-f
] device target
[format
]",
1213 .help = "initiates live storage
\n\t\t\t"
1214 "migration
for a device
. The device
's contents are\n\t\t\t"
1215 "copied to the new image file, including data that\n\t\t\t"
1216 "is written after the command is started.\n\t\t\t"
1217 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1218 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1219 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1220 "so that the result does not need a backing file.\n\t\t\t",
1221 .cmd = hmp_drive_mirror,
1225 @findex drive_mirror
1226 Start mirroring a block device's writes to a
new destination
,
1227 using the specified target
.
1231 .name
= "drive_backup",
1232 .args_type
= "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1233 .params
= "[-n] [-f] [-c] device target [format]",
1234 .help
= "initiates a point-in-time\n\t\t\t"
1235 "copy for a device. The device's contents are\n\t\t\t"
1236 "copied to the new image file, excluding data that\n\t\t\t"
1237 "is written after the command is started.\n\t\t\t"
1238 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1239 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1240 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1241 "so that the result does not need a backing file.\n\t\t\t"
1242 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1243 "(if the target format supports it).\n\t\t\t",
1244 .cmd
= hmp_drive_backup
,
1248 @findex drive_backup
1249 Start a point
-in-time copy of a block device to a specificed target
.
1253 .name
= "drive_add",
1254 .args_type
= "node:-n,pci_addr:s,opts:s",
1255 .params
= "[-n] [[<domain>:]<bus>:]<slot>\n"
1256 "[file=file][,if=type][,bus=n]\n"
1257 "[,unit=m][,media=d][,index=i]\n"
1258 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1259 "[,snapshot=on|off][,cache=on|off]\n"
1260 "[,readonly=on|off][,copy-on-read=on|off]",
1261 .help
= "add drive to PCI storage controller",
1262 .cmd
= hmp_drive_add
,
1268 Add drive to PCI storage controller
.
1272 .name
= "pcie_aer_inject_error",
1273 .args_type
= "advisory_non_fatal:-a,correctable:-c,"
1274 "id:s,error_status:s,"
1275 "header0:i?,header1:i?,header2:i?,header3:i?,"
1276 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1277 .params
= "[-a] [-c] id "
1278 "<error_status> [<tlp header> [<tlp header prefix>]]",
1279 .help
= "inject pcie aer error\n\t\t\t"
1280 " -a for advisory non fatal error\n\t\t\t"
1281 " -c for correctable error\n\t\t\t"
1282 "<id> = qdev device id\n\t\t\t"
1283 "<error_status> = error string or 32bit\n\t\t\t"
1284 "<tlb header> = 32bit x 4\n\t\t\t"
1285 "<tlb header prefix> = 32bit x 4",
1286 .cmd
= hmp_pcie_aer_inject_error
,
1290 @item pcie_aer_inject_error
1291 @findex pcie_aer_inject_error
1292 Inject PCIe AER error
1296 .name
= "netdev_add",
1297 .args_type
= "netdev:O",
1298 .params
= "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1299 .help
= "add host network device",
1300 .cmd
= hmp_netdev_add
,
1301 .command_completion
= netdev_add_completion
,
1307 Add host network device
.
1311 .name
= "netdev_del",
1312 .args_type
= "id:s",
1314 .help
= "remove host network device",
1315 .cmd
= hmp_netdev_del
,
1316 .command_completion
= netdev_del_completion
,
1322 Remove host network device
.
1326 .name
= "object_add",
1327 .args_type
= "object:O",
1328 .params
= "[qom-type=]type,id=str[,prop=value][,...]",
1329 .help
= "create QOM object",
1330 .cmd
= hmp_object_add
,
1331 .command_completion
= object_add_completion
,
1341 .name
= "object_del",
1342 .args_type
= "id:s",
1344 .help
= "destroy QOM object",
1345 .cmd
= hmp_object_del
,
1346 .command_completion
= object_del_completion
,
1357 .name
= "hostfwd_add",
1358 .args_type
= "arg1:s,arg2:s?,arg3:s?",
1359 .params
= "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1360 .help
= "redirect TCP or UDP connections from host to guest (requires -net user)",
1361 .cmd
= hmp_hostfwd_add
,
1367 Redirect TCP or UDP connections from host to
guest (requires
-net user
).
1372 .name
= "hostfwd_remove",
1373 .args_type
= "arg1:s,arg2:s?,arg3:s?",
1374 .params
= "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1375 .help
= "remove host-to-guest TCP or UDP redirection",
1376 .cmd
= hmp_hostfwd_remove
,
1381 @item hostfwd_remove
1382 @findex hostfwd_remove
1383 Remove host
-to
-guest TCP or UDP redirection
.
1388 .args_type
= "value:M",
1390 .help
= "request VM to change its memory allocation (in MB)",
1395 @item balloon @
var{value
}
1397 Request VM to change its memory allocation to @
var{value
} (in MB
).
1402 .args_type
= "name:s,up:b",
1403 .params
= "name on|off",
1404 .help
= "change the link status of a network adapter",
1405 .cmd
= hmp_set_link
,
1406 .command_completion
= set_link_completion
,
1410 @item set_link @
var{name
} [on|off
]
1412 Switch link @
var{name
} on (i
.e
. up
) or
off (i
.e
. down
).
1416 .name
= "watchdog_action",
1417 .args_type
= "action:s",
1418 .params
= "[reset|shutdown|poweroff|pause|debug|none]",
1419 .help
= "change watchdog action",
1420 .cmd
= hmp_watchdog_action
,
1421 .command_completion
= watchdog_action_completion
,
1425 @item watchdog_action
1426 @findex watchdog_action
1427 Change watchdog action
.
1432 .args_type
= "aclname:s",
1433 .params
= "aclname",
1434 .help
= "list rules in the access control list",
1435 .cmd
= hmp_acl_show
,
1439 @item acl_show @
var{aclname
}
1441 List all the matching rules
in the access control list
, and the
default
1442 policy
. There are currently two named access control lists
,
1443 @
var{vnc
.x509dname
} and @
var{vnc
.username
} matching on the x509 client
1444 certificate distinguished name
, and SASL username respectively
.
1448 .name
= "acl_policy",
1449 .args_type
= "aclname:s,policy:s",
1450 .params
= "aclname allow|deny",
1451 .help
= "set default access control list policy",
1452 .cmd
= hmp_acl_policy
,
1456 @item acl_policy @
var{aclname
} @code
{allow|deny
}
1458 Set the
default access control list policy
, used
in the event that
1459 none of the explicit rules match
. The
default policy at startup is
1465 .args_type
= "aclname:s,match:s,policy:s,index:i?",
1466 .params
= "aclname match allow|deny [index]",
1467 .help
= "add a match rule to the access control list",
1472 @item acl_add @
var{aclname
} @
var{match
} @code
{allow|deny
} [@
var{index
}]
1474 Add a match rule to the access control list
, allowing or denying access
.
1475 The match will normally be an exact username or x509 distinguished name
,
1476 but can optionally include wildcard globs
. eg @code
{*@@EXAMPLE
.COM
} to
1477 allow all users
in the @code
{EXAMPLE
.COM
} kerberos realm
. The match will
1478 normally be appended to the end of the ACL
, but can be inserted
1479 earlier
in the list
if the optional @
var{index
} parameter is supplied
.
1483 .name
= "acl_remove",
1484 .args_type
= "aclname:s,match:s",
1485 .params
= "aclname match",
1486 .help
= "remove a match rule from the access control list",
1487 .cmd
= hmp_acl_remove
,
1491 @item acl_remove @
var{aclname
} @
var{match
}
1493 Remove the specified match rule from the access control list
.
1497 .name
= "acl_reset",
1498 .args_type
= "aclname:s",
1499 .params
= "aclname",
1500 .help
= "reset the access control list",
1501 .cmd
= hmp_acl_reset
,
1505 @item acl_reset @
var{aclname
}
1507 Remove all matches from the access control list
, and set the
default
1508 policy back to @code
{deny
}.
1512 .name
= "nbd_server_start",
1513 .args_type
= "all:-a,writable:-w,uri:s",
1514 .params
= "nbd_server_start [-a] [-w] host:port",
1515 .help
= "serve block devices on the given host and port",
1516 .cmd
= hmp_nbd_server_start
,
1519 @item nbd_server_start @
var{host
}:@
var{port
}
1520 @findex nbd_server_start
1521 Start an NBD server on the given host and
/or port
. If the @option
{-a
}
1522 option is included
, all of the virtual machine
's block devices that
1523 have an inserted media on them are automatically exported; in this case,
1524 the @option{-w} option makes the devices writable too.
1528 .name = "nbd_server_add",
1529 .args_type = "writable:-w,device:B,name:s?",
1530 .params = "nbd_server_add [-w] device [name]",
1531 .help = "export a block device via NBD",
1532 .cmd = hmp_nbd_server_add,
1535 @item nbd_server_add @var{device} [ @var{name} ]
1536 @findex nbd_server_add
1537 Export a block device through QEMU's NBD server
, which must be started
1538 beforehand with @command
{nbd_server_start
}. The @option
{-w
} option makes the
1539 exported device writable too
. The export name is controlled by @
var{name
},
1540 defaulting to @
var{device
}.
1544 .name
= "nbd_server_remove",
1545 .args_type
= "force:-f,name:s",
1546 .params
= "nbd_server_remove [-f] name",
1547 .help
= "remove an export previously exposed via NBD",
1548 .cmd
= hmp_nbd_server_remove
,
1551 @item nbd_server_remove
[-f
] @
var{name
}
1552 @findex nbd_server_remove
1553 Stop exporting a block device through QEMU
's NBD server, which was
1554 previously started with @command{nbd_server_add}. The @option{-f}
1555 option forces the server to drop the export immediately even if
1556 clients are connected; otherwise the command fails unless there are no
1561 .name = "nbd_server_stop",
1563 .params = "nbd_server_stop",
1564 .help = "stop serving block devices using the NBD protocol",
1565 .cmd = hmp_nbd_server_stop,
1568 @item nbd_server_stop
1569 @findex nbd_server_stop
1570 Stop the QEMU embedded NBD server.
1574 #if defined(TARGET_I386)
1578 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1579 .params = "[-b] cpu bank status mcgstatus addr misc",
1580 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1586 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{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",
1600 @item getfd @var{fdname}
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 @var{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 @item closefd @var{fdname}
1618 Close the file descriptor previously assigned to @var{fdname} using the
1619 @code{getfd} command. This is only needed if the file descriptor was never
1620 used by another monitor command.
1624 .name = "block_passwd",
1625 .args_type = "device:B,password:s",
1626 .params = "block_passwd device password",
1627 .help = "set the password of encrypted block devices",
1628 .cmd = hmp_block_passwd,
1632 @item block_passwd @var{device} @var{password}
1633 @findex block_passwd
1634 Set the encrypted device @var{device} password to @var{password}
1636 This command is now obsolete and will always return an error since 2.10
1640 .name = "block_set_io_throttle",
1641 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1642 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1643 .help = "change I/O throttle limits for a block drive",
1644 .cmd = hmp_block_set_io_throttle,
1648 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1649 @findex block_set_io_throttle
1650 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}.
1651 @var{device} can be a block device name, a qdev ID or a QOM path.
1655 .name = "set_password",
1656 .args_type = "protocol:s,password:s,connected:s?",
1657 .params = "protocol password action-if-connected",
1658 .help = "set spice/vnc password",
1659 .cmd = hmp_set_password,
1663 @item set_password [ vnc | spice ] password [ action-if-connected ]
1664 @findex set_password
1665 Change spice/vnc password. Use zero to make the password stay valid
1666 forever. @var{action-if-connected} specifies what should happen in
1667 case a connection is established: @var{fail} makes the password change
1668 fail. @var{disconnect} changes the password and disconnects the
1669 client. @var{keep} changes the password and keeps the connection up.
1670 @var{keep} is the default.
1674 .name = "expire_password",
1675 .args_type = "protocol:s,time:s",
1676 .params = "protocol time",
1677 .help = "set spice/vnc password expire-time",
1678 .cmd = hmp_expire_password,
1682 @item expire_password [ vnc | spice ] expire-time
1683 @findex expire_password
1684 Specify when a password for spice/vnc becomes
1685 invalid. @var{expire-time} accepts:
1689 Invalidate password instantly.
1692 Password stays valid forever.
1695 Password stays valid for @var{nsec} seconds starting now.
1698 Password is invalidated at the given time. @var{nsec} are the seconds
1699 passed since 1970, i.e. unix epoch.
1705 .name = "chardev-add",
1706 .args_type = "args:s",
1708 .help = "add chardev",
1709 .cmd = hmp_chardev_add,
1710 .command_completion = chardev_add_completion,
1714 @item chardev-add args
1716 chardev-add accepts the same parameters as the -chardev command line switch.
1721 .name = "chardev-change",
1722 .args_type = "id:s,args:s",
1723 .params = "id args",
1724 .help = "change chardev",
1725 .cmd = hmp_chardev_change,
1729 @item chardev-change args
1730 @findex chardev-change
1731 chardev-change accepts existing chardev @var{id} and then the same arguments
1732 as the -chardev command line switch (except for "id").
1737 .name = "chardev-remove",
1738 .args_type = "id:s",
1740 .help = "remove chardev",
1741 .cmd = hmp_chardev_remove,
1742 .command_completion = chardev_remove_completion,
1746 @item chardev-remove id
1747 @findex chardev-remove
1748 Removes the chardev @var{id}.
1753 .name = "chardev-send-break",
1754 .args_type = "id:s",
1756 .help = "send a break on chardev",
1757 .cmd = hmp_chardev_send_break,
1758 .command_completion = chardev_remove_completion,
1762 @item chardev-send-break id
1763 @findex chardev-send-break
1764 Send a break on the chardev @var{id}.
1770 .args_type = "device:B,command:s",
1771 .params = "[device] \"[command]\"",
1772 .help = "run a qemu-io command on a block device",
1777 @item qemu-io @var{device} @var{command}
1779 Executes a qemu-io command on the given block device.
1785 .args_type = "id:i",
1792 @item cpu-add @var{id}
1794 Add CPU with id @var{id}
1799 .args_type = "path:s?",
1801 .help = "list QOM properties",
1802 .cmd = hmp_qom_list,
1806 @item qom-list [@var{path}]
1807 Print QOM properties of object at location @var{path}
1812 .args_type = "path:s,property:s,value:s",
1813 .params = "path property value",
1814 .help = "set QOM property",
1819 @item qom-set @var{path} @var{property} @var{value}
1820 Set QOM property @var{property} of object at location @var{path} to value @var{value}
1825 .args_type = "item:s?",
1826 .params = "[subcommand]",
1827 .help = "show various information about the system state",
1828 .cmd = hmp_info_help,
1829 .sub_table = info_cmds,