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",
57 .name = "exit_preconfig",
60 .help = "exit the preconfig state",
61 .cmd = hmp_exit_preconfig,
67 This command makes QEMU exit the preconfig state and proceed with
68 VM initialization using configuration data provided on the command line
69 and via the QMP monitor during the preconfig state. The command is only
70 available during the preconfig state (i.e. when the --preconfig command
71 line option was in use).
75 .name = "block_resize",
76 .args_type = "device:B,size:o",
77 .params = "device size",
78 .help = "resize a block image",
79 .cmd = hmp_block_resize,
85 Resize a block image while a guest is running. Usually requires guest
86 action to see the updated size. Resize to a lower size is supported,
87 but should be used with extreme caution. Note that this command only
88 resizes image files, it can not resize block devices like LVM volumes.
92 .name = "block_stream",
93 .args_type = "device:B,speed:o?,base:s?",
94 .params = "device [speed [base]]",
95 .help = "copy data from a backing file into a block device",
96 .cmd = hmp_block_stream,
101 Copy data from a backing file into a block device.
105 .name = "block_job_set_speed",
106 .args_type = "device:B,speed:o",
107 .params = "device speed",
108 .help = "set maximum speed for a background block operation",
109 .cmd = hmp_block_job_set_speed,
113 ``block_job_set_speed``
114 Set maximum speed for a background block operation.
118 .name = "block_job_cancel",
119 .args_type = "force:-f,device:B",
120 .params = "[-f] device",
121 .help = "stop an active background block operation (use -f"
122 "\n\t\t\t if you want to abort the operation immediately"
123 "\n\t\t\t instead of keep running until data is in sync)",
124 .cmd = hmp_block_job_cancel,
129 Stop an active background block operation (streaming, mirroring).
133 .name = "block_job_complete",
134 .args_type = "device:B",
136 .help = "stop an active background block operation",
137 .cmd = hmp_block_job_complete,
141 ``block_job_complete``
142 Manually trigger completion of an active background block operation.
143 For mirroring, this will switch the device to the destination path.
147 .name = "block_job_pause",
148 .args_type = "device:B",
150 .help = "pause an active background block operation",
151 .cmd = hmp_block_job_pause,
156 Pause an active block streaming operation.
160 .name = "block_job_resume",
161 .args_type = "device:B",
163 .help = "resume a paused background block operation",
164 .cmd = hmp_block_job_resume,
169 Resume a paused block streaming operation.
174 .args_type = "force:-f,device:B",
175 .params = "[-f] device",
176 .help = "eject a removable medium (use -f to force it)",
181 ``eject [-f]`` *device*
182 Eject a removable medium (use -f to force it).
189 .help = "remove host block device",
190 .cmd = hmp_drive_del,
194 ``drive_del`` *device*
195 Remove host block device. The result is that guest generated IO is no longer
196 submitted against the host device underlying the disk. Once a drive has
197 been deleted, the QEMU Block layer returns -EIO which results in IO
198 errors in the guest for applications that are reading/writing to the device.
199 These errors are always reported to the guest, regardless of the drive's error
200 actions (drive options rerror, werror).
205 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
206 .params = "device filename [format [read-only-mode]]",
207 .help = "change a removable medium, optional format",
212 ``change`` *device* *setting*
213 Change the configuration of a device.
215 ``change`` *diskdevice* *filename* [*format* [*read-only-mode*]]
216 Change the medium for a removable disk device to point to *filename*. eg::
218 (qemu) change ide1-cd0 /path/to/some.iso
220 *format* is optional.
222 *read-only-mode* may be used to change the read-only status of the device.
223 It accepts the following values:
226 Retains the current status; this is the default.
229 Makes the device read-only.
232 Makes the device writable.
234 ``change vnc password`` [*password*]
236 Change the password associated with the VNC server. If the new password
237 is not supplied, the monitor will prompt for it to be entered. VNC
238 passwords are only significant up to 8 letters. eg::
240 (qemu) change vnc password
246 .name = "screendump",
247 .args_type = "filename:F,device:s?,head:i?",
248 .params = "filename [device [head]]",
249 .help = "save screen from head 'head' of display device 'device' "
250 "into PPM image 'filename'",
251 .cmd = hmp_screendump,
256 ``screendump`` *filename*
257 Save screen into PPM image *filename*.
262 .args_type = "filename:F",
263 .params = "filename",
264 .help = "output logs to 'filename'",
269 ``logfile`` *filename*
270 Output logs to *filename*.
274 .name = "trace-event",
275 .args_type = "name:s,option:b,vcpu:i?",
276 .params = "name on|off [vcpu]",
277 .help = "changes status of a specific trace event "
278 "(vcpu: vCPU to set, default is all)",
279 .cmd = hmp_trace_event,
280 .command_completion = trace_event_completion,
285 changes status of a trace event
288 #if defined(CONFIG_TRACE_SIMPLE)
290 .name = "trace-file",
291 .args_type = "op:s?,arg:F?",
292 .params = "on|off|flush|set [arg]",
293 .help = "open, close, or flush trace file, or set a new file name",
294 .cmd = hmp_trace_file,
298 ``trace-file on|off|flush``
299 Open, close, or flush the trace file. If no argument is given, the
300 status of the trace file is displayed.
306 .args_type = "items:s",
307 .params = "item1[,...]",
308 .help = "activate logging of the specified items",
313 ``log`` *item1*\ [,...]
314 Activate logging of the specified items.
319 .args_type = "name:s?",
321 .help = "save a VM snapshot. If no tag is provided, a new snapshot is created",
327 Create a snapshot of the whole virtual machine. If *tag* is
328 provided, it is used as human readable identifier. If there is already
329 a snapshot with the same tag, it is replaced. More info at
330 :ref:`vm_005fsnapshots`.
332 Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
333 only *tag* as parameter.
338 .args_type = "name:s",
340 .help = "restore a VM snapshot from its tag",
342 .command_completion = loadvm_completion,
347 Set the whole virtual machine to the snapshot identified by the tag
350 Since 4.0, loadvm stopped accepting snapshot id as parameter.
355 .args_type = "name:s",
357 .help = "delete a VM snapshot from its tag",
359 .command_completion = delvm_completion,
364 Delete the snapshot identified by *tag*.
366 Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
367 only *tag* as parameter.
371 .name = "singlestep",
372 .args_type = "option:s?",
373 .params = "[on|off]",
374 .help = "run emulation in singlestep mode or switch to normal mode",
375 .cmd = hmp_singlestep,
380 Run the emulation in single step mode.
381 If called with option off, the emulation returns to normal mode.
388 .help = "stop emulation",
401 .help = "resume emulation",
411 .name = "system_wakeup",
414 .help = "wakeup guest from suspend",
415 .cmd = hmp_system_wakeup,
420 Wakeup guest from suspend.
425 .args_type = "device:s?",
426 .params = "[device]",
427 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
428 .cmd = hmp_gdbserver,
432 ``gdbserver`` [*port*]
433 Start gdbserver session (default *port*\=1234)
438 .args_type = "fmt:/,addr:l",
439 .params = "/fmt addr",
440 .help = "virtual memory dump starting at 'addr'",
441 .cmd = hmp_memory_dump,
446 Virtual memory dump starting at *addr*.
451 .args_type = "fmt:/,addr:l",
452 .params = "/fmt addr",
453 .help = "physical memory dump starting at 'addr'",
454 .cmd = hmp_physical_memory_dump,
458 ``xp /``\ *fmt* *addr*
459 Physical memory dump starting at *addr*.
461 *fmt* is a format which tells the command how to format the
462 data. Its syntax is: ``/{count}{format}{size}``
465 is the number of items to be dumped.
467 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
468 c (char) or i (asm instruction).
470 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
471 ``h`` or ``w`` can be specified with the ``i`` format to
472 respectively select 16 or 32 bit code instruction size.
476 Dump 10 instructions at the current instruction pointer::
481 0x90107065: lea 0x0(%esi,1),%esi
482 0x90107069: lea 0x0(%edi,1),%edi
484 0x90107071: jmp 0x90107080
490 Dump 80 16 bit values at the start of the video memory::
492 (qemu) xp/80hx 0xb8000
493 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
494 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
495 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
496 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
497 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
498 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
499 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
500 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
501 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
502 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
508 .args_type = "addr:l",
510 .help = "print the host virtual address corresponding to a guest physical address",
516 Print the host virtual address at which the guest's physical address *addr*
523 .args_type = "addr:l",
525 .help = "print the host physical address corresponding to a guest physical address",
532 Print the host physical address at which the guest's physical address *addr*
538 .args_type = "addr:l",
540 .help = "print the guest physical address corresponding to a guest virtual address",
546 Print the guest physical address at which the guest's virtual address *addr*
547 is mapped based on the mapping for the current CPU.
552 .args_type = "fmt:/,val:l",
553 .params = "/fmt expr",
554 .help = "print expression value (use $reg for CPU register access)",
559 ``print`` or ``p/``\ *fmt* *expr*
560 Print expression value. Only the *format* part of *fmt* is
566 .args_type = "fmt:/,addr:i,index:i.",
567 .params = "/fmt addr",
568 .help = "I/O port read",
569 .cmd = hmp_ioport_read,
573 ``i/``\ *fmt* *addr* [.\ *index*\ ]
579 .args_type = "fmt:/,addr:i,val:i",
580 .params = "/fmt addr value",
581 .help = "I/O port write",
582 .cmd = hmp_ioport_write,
586 ``o/``\ *fmt* *addr* *val*
592 .args_type = "keys:s,hold-time:i?",
593 .params = "keys [hold_ms]",
594 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
596 .command_completion = sendkey_completion,
601 Send *keys* to the guest. *keys* could be the name of the
602 key or the raw value in hexadecimal format. Use ``-`` to press
603 several keys simultaneously. Example::
607 This command is useful to send keys that your graphical user interface
608 intercepts at low level, such as ``ctrl-alt-f1`` in X Window.
611 .name = "sync-profile",
612 .args_type = "op:s?",
613 .params = "[on|off|reset]",
614 .help = "enable, disable or reset synchronization profiling. "
615 "With no arguments, prints whether profiling is on or off.",
616 .cmd = hmp_sync_profile,
620 ``sync-profile [on|off|reset]``
621 Enable, disable or reset synchronization profiling. With no arguments, prints
622 whether profiling is on or off.
626 .name = "system_reset",
629 .help = "reset the system",
630 .cmd = hmp_system_reset,
639 .name = "system_powerdown",
642 .help = "send system power down event",
643 .cmd = hmp_system_powerdown,
648 Power down the system (if supported).
653 .args_type = "start:i,size:i",
654 .params = "addr size",
655 .help = "compute the checksum of a memory region",
660 ``sum`` *addr* *size*
661 Compute the checksum of a memory region.
665 .name = "device_add",
666 .args_type = "device:O",
667 .params = "driver[,prop=value][,...]",
668 .help = "add device, like -device on the command line",
669 .cmd = hmp_device_add,
670 .command_completion = device_add_completion,
674 ``device_add`` *config*
679 .name = "device_del",
682 .help = "remove device",
683 .cmd = hmp_device_del,
684 .command_completion = device_del_completion,
689 Remove device *id*. *id* may be a short ID
690 or a QOM object path.
695 .args_type = "index:i",
697 .help = "set the default CPU",
707 .name = "mouse_move",
708 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
709 .params = "dx dy [dz]",
710 .help = "send mouse move events",
711 .cmd = hmp_mouse_move,
715 ``mouse_move`` *dx* *dy* [*dz*]
716 Move the active mouse to the specified coordinates *dx* *dy*
717 with optional scroll axis *dz*.
721 .name = "mouse_button",
722 .args_type = "button_state:i",
724 .help = "change mouse button state (1=L, 2=M, 4=R)",
725 .cmd = hmp_mouse_button,
729 ``mouse_button`` *val*
730 Change the active mouse button state *val* (1=L, 2=M, 4=R).
735 .args_type = "index:i",
737 .help = "set which mouse device receives events",
738 .cmd = hmp_mouse_set,
742 ``mouse_set`` *index*
743 Set which mouse device receives events at given *index*, index
744 can be obtained with::
751 .name = "wavcapture",
752 .args_type = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?",
753 .params = "path audiodev [frequency [bits [channels]]]",
754 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
755 .cmd = hmp_wavcapture,
758 ``wavcapture`` *filename* *audiodev* [*frequency* [*bits* [*channels*]]]
759 Capture audio into *filename* from *audiodev*, using sample rate
760 *frequency* bits per sample *bits* and number of channels
765 - Sample rate = 44100 Hz - CD quality
767 - Number of channels = 2 - Stereo
771 .name = "stopcapture",
773 .params = "capture index",
774 .help = "stop capture",
775 .cmd = hmp_stopcapture,
778 ``stopcapture`` *index*
779 Stop capture with a given *index*, index can be obtained with::
787 .args_type = "val:l,size:i,filename:s",
788 .params = "addr size file",
789 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
794 ``memsave`` *addr* *size* *file*
795 save to disk virtual memory dump starting at *addr* of size *size*.
800 .args_type = "val:l,size:i,filename:s",
801 .params = "addr size file",
802 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
807 ``pmemsave`` *addr* *size* *file*
808 save to disk physical memory dump starting at *addr* of size *size*.
813 .args_type = "bootdevice:s",
814 .params = "bootdevice",
815 .help = "define new values for the boot device list",
820 ``boot_set`` *bootdevicelist*
821 Define new values for the boot device list. Those values will override
822 the values specified on the command line through the ``-boot`` option.
824 The values that can be specified here depend on the machine type, but are
825 the same that can be specified in the ``-boot`` command line option.
832 .help = "inject an NMI",
837 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
841 .name = "ringbuf_write",
842 .args_type = "device:s,data:s",
843 .params = "device data",
844 .help = "Write to a ring buffer character device",
845 .cmd = hmp_ringbuf_write,
846 .command_completion = ringbuf_write_completion,
850 ``ringbuf_write`` *device* *data*
851 Write *data* to ring buffer character device *device*.
852 *data* must be a UTF-8 string.
856 .name = "ringbuf_read",
857 .args_type = "device:s,size:i",
858 .params = "device size",
859 .help = "Read from a ring buffer character device",
860 .cmd = hmp_ringbuf_read,
861 .command_completion = ringbuf_write_completion,
865 ``ringbuf_read`` *device*
866 Read and print up to *size* bytes from ring buffer character
868 Certain non-printable characters are printed ``\uXXXX``, where ``XXXX`` is the
869 character code in hexadecimal. Character ``\`` is printed ``\\``.
870 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
871 NUL characters, after the ring buffer lost data, and when reading
872 stops because the size limit is reached.
876 .name = "announce_self",
877 .args_type = "interfaces:s?,id:s?",
878 .params = "[interfaces] [id]",
879 .help = "Trigger GARP/RARP announcements",
880 .cmd = hmp_announce_self,
885 Trigger a round of GARP/RARP broadcasts; this is useful for explicitly
886 updating the network infrastructure after a reconfiguration or some forms
887 of migration. The timings of the round are set by the migration announce
888 parameters. An optional comma separated *interfaces* list restricts the
889 announce to the named set of interfaces. An optional *id* can be used to
890 start a separate announce timer and to change the parameters of it later.
895 .args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
896 .params = "[-d] [-b] [-i] [-r] uri",
897 .help = "migrate to URI (using -d to not wait for completion)"
898 "\n\t\t\t -b for migration without shared storage with"
899 " full copy of disk\n\t\t\t -i for migration without "
900 "shared storage with incremental copy of disk "
901 "(base image shared between src and destination)"
902 "\n\t\t\t -r to resume a paused migration",
908 ``migrate [-d] [-b] [-i]`` *uri*
909 Migrate to *uri* (using -d to not wait for completion).
912 for migration with full copy of disk
914 for migration with incremental copy of disk (base image is shared)
918 .name = "migrate_cancel",
921 .help = "cancel the current VM migration",
922 .cmd = hmp_migrate_cancel,
927 Cancel the current VM migration.
931 .name = "migrate_continue",
932 .args_type = "state:s",
934 .help = "Continue migration from the given paused state",
935 .cmd = hmp_migrate_continue,
938 ``migrate_continue`` *state*
939 Continue migration from the paused state *state*
943 .name = "migrate_incoming",
944 .args_type = "uri:s",
946 .help = "Continue an incoming migration from an -incoming defer",
947 .cmd = hmp_migrate_incoming,
951 ``migrate_incoming`` *uri*
952 Continue an incoming migration using the *uri* (that has the same syntax
953 as the ``-incoming`` option).
957 .name = "migrate_recover",
958 .args_type = "uri:s",
960 .help = "Continue a paused incoming postcopy migration",
961 .cmd = hmp_migrate_recover,
965 ``migrate_recover`` *uri*
966 Continue a paused incoming postcopy migration using the *uri*.
970 .name = "migrate_pause",
973 .help = "Pause an ongoing migration (postcopy-only)",
974 .cmd = hmp_migrate_pause,
979 Pause an ongoing migration. Currently it only supports postcopy.
983 .name = "migrate_set_capability",
984 .args_type = "capability:s,state:b",
985 .params = "capability state",
986 .help = "Enable/Disable the usage of a capability for migration",
987 .cmd = hmp_migrate_set_capability,
988 .command_completion = migrate_set_capability_completion,
992 ``migrate_set_capability`` *capability* *state*
993 Enable/Disable the usage of a capability *capability* for migration.
997 .name = "migrate_set_parameter",
998 .args_type = "parameter:s,value:s",
999 .params = "parameter value",
1000 .help = "Set the parameter for migration",
1001 .cmd = hmp_migrate_set_parameter,
1002 .command_completion = migrate_set_parameter_completion,
1006 ``migrate_set_parameter`` *parameter* *value*
1007 Set the parameter *parameter* for migration.
1011 .name = "migrate_start_postcopy",
1014 .help = "Followup to a migration command to switch the migration"
1015 " to postcopy mode. The postcopy-ram capability must "
1016 "be set on both source and destination before the "
1017 "original migration command .",
1018 .cmd = hmp_migrate_start_postcopy,
1022 ``migrate_start_postcopy``
1023 Switch in-progress migration to postcopy mode. Ignored after the end of
1024 migration (or once already in postcopy).
1028 .name = "x_colo_lost_heartbeat",
1031 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1032 "a failover or takeover is needed.",
1033 .cmd = hmp_x_colo_lost_heartbeat,
1037 ``x_colo_lost_heartbeat``
1038 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1042 .name = "client_migrate_info",
1043 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1044 .params = "protocol hostname port tls-port cert-subject",
1045 .help = "set migration information for remote display",
1046 .cmd = hmp_client_migrate_info,
1050 ``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject*
1051 Set migration information for remote display. This makes the server
1052 ask the client to automatically reconnect using the new parameters
1053 once migration finished successfully. Only implemented for SPICE.
1057 .name = "dump-guest-memory",
1058 .args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
1059 .params = "[-p] [-d] [-z|-l|-s|-w] filename [begin length]",
1060 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1061 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1062 "-d: return immediately (do not wait for completion).\n\t\t\t"
1063 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1064 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1065 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1066 "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
1067 " for Windows x64 guests with vmcoreinfo driver only.\n\t\t\t"
1068 "begin: the starting physical address.\n\t\t\t"
1069 "length: the memory size, in bytes.",
1070 .cmd = hmp_dump_guest_memory,
1074 ``dump-guest-memory [-p]`` *filename* *begin* *length*
1076 ``dump-guest-memory [-z|-l|-s|-w]`` *filename*
1077 Dump guest memory to *protocol*. The file can be processed with crash or
1078 gdb. Without ``-z|-l|-s|-w``, the dump format is ELF.
1081 do paging to get guest's memory mapping.
1083 dump in kdump-compressed format, with zlib compression.
1085 dump in kdump-compressed format, with lzo compression.
1087 dump in kdump-compressed format, with snappy compression.
1089 dump in Windows crashdump format (can be used instead of ELF-dump converting),
1090 for Windows x64 guests with vmcoreinfo driver only
1094 the starting physical address. It's optional, and should be
1095 specified together with *length*.
1097 the memory size, in bytes. It's optional, and should be specified
1098 together with *begin*.
1102 #if defined(TARGET_S390X)
1104 .name = "dump-skeys",
1105 .args_type = "filename:F",
1107 .help = "Save guest storage keys into file 'filename'.\n",
1108 .cmd = hmp_dump_skeys,
1113 ``dump-skeys`` *filename*
1114 Save guest storage keys to a file.
1117 #if defined(TARGET_S390X)
1119 .name = "migration_mode",
1120 .args_type = "mode:i",
1122 .help = "Enables or disables migration mode\n",
1123 .cmd = hmp_migrationmode,
1128 ``migration_mode`` *mode*
1129 Enables or disables migration mode.
1133 .name = "snapshot_blkdev",
1134 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1135 .params = "[-n] device [new-image-file] [format]",
1136 .help = "initiates a live snapshot\n\t\t\t"
1137 "of device. If a new image file is specified, the\n\t\t\t"
1138 "new image file will become the new root image.\n\t\t\t"
1139 "If format is specified, the snapshot file will\n\t\t\t"
1140 "be created in that format.\n\t\t\t"
1141 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1142 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1143 "recreating it from scratch.",
1144 .cmd = hmp_snapshot_blkdev,
1149 Snapshot device, using snapshot file as target if provided
1153 .name = "snapshot_blkdev_internal",
1154 .args_type = "device:B,name:s",
1155 .params = "device name",
1156 .help = "take an internal snapshot of device.\n\t\t\t"
1157 "The format of the image used by device must\n\t\t\t"
1158 "support it, such as qcow2.\n\t\t\t",
1159 .cmd = hmp_snapshot_blkdev_internal,
1163 ``snapshot_blkdev_internal``
1164 Take an internal snapshot on device if it support
1168 .name = "snapshot_delete_blkdev_internal",
1169 .args_type = "device:B,name:s,id:s?",
1170 .params = "device name [id]",
1171 .help = "delete an internal snapshot of device.\n\t\t\t"
1172 "If id is specified, qemu will try delete\n\t\t\t"
1173 "the snapshot matching both id and name.\n\t\t\t"
1174 "The format of the image used by device must\n\t\t\t"
1175 "support it, such as qcow2.\n\t\t\t",
1176 .cmd = hmp_snapshot_delete_blkdev_internal,
1180 ``snapshot_delete_blkdev_internal``
1181 Delete an internal snapshot on device if it support
1185 .name = "drive_mirror",
1186 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1187 .params = "[-n] [-f] device target [format]",
1188 .help = "initiates live storage\n\t\t\t"
1189 "migration for a device. The device's contents are\n\t\t\t"
1190 "copied to the new image file, including data that\n\t\t\t"
1191 "is written after the command is started.\n\t\t\t"
1192 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1193 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1194 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1195 "so that the result does not need a backing file.\n\t\t\t",
1196 .cmd = hmp_drive_mirror,
1200 Start mirroring a block device's writes to a new destination,
1201 using the specified target.
1205 .name = "drive_backup",
1206 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1207 .params = "[-n] [-f] [-c] device target [format]",
1208 .help = "initiates a point-in-time\n\t\t\t"
1209 "copy for a device. The device's contents are\n\t\t\t"
1210 "copied to the new image file, excluding data that\n\t\t\t"
1211 "is written after the command is started.\n\t\t\t"
1212 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1213 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1214 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1215 "so that the result does not need a backing file.\n\t\t\t"
1216 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1217 "(if the target format supports it).\n\t\t\t",
1218 .cmd = hmp_drive_backup,
1222 Start a point-in-time copy of a block device to a specified target.
1226 .name = "drive_add",
1227 .args_type = "node:-n,pci_addr:s,opts:s",
1228 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
1229 "[file=file][,if=type][,bus=n]\n"
1230 "[,unit=m][,media=d][,index=i]\n"
1231 "[,snapshot=on|off][,cache=on|off]\n"
1232 "[,readonly=on|off][,copy-on-read=on|off]",
1233 .help = "add drive to PCI storage controller",
1234 .cmd = hmp_drive_add,
1239 Add drive to PCI storage controller.
1243 .name = "pcie_aer_inject_error",
1244 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1245 "id:s,error_status:s,"
1246 "header0:i?,header1:i?,header2:i?,header3:i?,"
1247 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1248 .params = "[-a] [-c] id "
1249 "<error_status> [<tlp header> [<tlp header prefix>]]",
1250 .help = "inject pcie aer error\n\t\t\t"
1251 " -a for advisory non fatal error\n\t\t\t"
1252 " -c for correctable error\n\t\t\t"
1253 "<id> = qdev device id\n\t\t\t"
1254 "<error_status> = error string or 32bit\n\t\t\t"
1255 "<tlp header> = 32bit x 4\n\t\t\t"
1256 "<tlp header prefix> = 32bit x 4",
1257 .cmd = hmp_pcie_aer_inject_error,
1261 ``pcie_aer_inject_error``
1262 Inject PCIe AER error
1266 .name = "netdev_add",
1267 .args_type = "netdev:O",
1268 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1269 .help = "add host network device",
1270 .cmd = hmp_netdev_add,
1271 .command_completion = netdev_add_completion,
1276 Add host network device.
1280 .name = "netdev_del",
1281 .args_type = "id:s",
1283 .help = "remove host network device",
1284 .cmd = hmp_netdev_del,
1285 .command_completion = netdev_del_completion,
1290 Remove host network device.
1294 .name = "object_add",
1295 .args_type = "object:O",
1296 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1297 .help = "create QOM object",
1298 .cmd = hmp_object_add,
1299 .command_completion = object_add_completion,
1308 .name = "object_del",
1309 .args_type = "id:s",
1311 .help = "destroy QOM object",
1312 .cmd = hmp_object_del,
1313 .command_completion = object_del_completion,
1323 .name = "hostfwd_add",
1324 .args_type = "arg1:s,arg2:s?",
1325 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1326 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1327 .cmd = hmp_hostfwd_add,
1332 Redirect TCP or UDP connections from host to guest (requires -net user).
1337 .name = "hostfwd_remove",
1338 .args_type = "arg1:s,arg2:s?",
1339 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1340 .help = "remove host-to-guest TCP or UDP redirection",
1341 .cmd = hmp_hostfwd_remove,
1347 Remove host-to-guest TCP or UDP redirection.
1352 .args_type = "value:M",
1354 .help = "request VM to change its memory allocation (in MB)",
1360 Request VM to change its memory allocation to *value* (in MB).
1365 .args_type = "name:s,up:b",
1366 .params = "name on|off",
1367 .help = "change the link status of a network adapter",
1368 .cmd = hmp_set_link,
1369 .command_completion = set_link_completion,
1373 ``set_link`` *name* ``[on|off]``
1374 Switch link *name* on (i.e. up) or off (i.e. down).
1378 .name = "watchdog_action",
1379 .args_type = "action:s",
1380 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1381 .help = "change watchdog action",
1382 .cmd = hmp_watchdog_action,
1383 .command_completion = watchdog_action_completion,
1388 Change watchdog action.
1392 .name = "nbd_server_start",
1393 .args_type = "all:-a,writable:-w,uri:s",
1394 .params = "nbd_server_start [-a] [-w] host:port",
1395 .help = "serve block devices on the given host and port",
1396 .cmd = hmp_nbd_server_start,
1399 ``nbd_server_start`` *host*:*port*
1400 Start an NBD server on the given host and/or port. If the ``-a``
1401 option is included, all of the virtual machine's block devices that
1402 have an inserted media on them are automatically exported; in this case,
1403 the ``-w`` option makes the devices writable too.
1407 .name = "nbd_server_add",
1408 .args_type = "writable:-w,device:B,name:s?",
1409 .params = "nbd_server_add [-w] device [name]",
1410 .help = "export a block device via NBD",
1411 .cmd = hmp_nbd_server_add,
1414 ``nbd_server_add`` *device* [ *name* ]
1415 Export a block device through QEMU's NBD server, which must be started
1416 beforehand with ``nbd_server_start``. The ``-w`` option makes the
1417 exported device writable too. The export name is controlled by *name*,
1418 defaulting to *device*.
1422 .name = "nbd_server_remove",
1423 .args_type = "force:-f,name:s",
1424 .params = "nbd_server_remove [-f] name",
1425 .help = "remove an export previously exposed via NBD",
1426 .cmd = hmp_nbd_server_remove,
1429 ``nbd_server_remove [-f]`` *name*
1430 Stop exporting a block device through QEMU's NBD server, which was
1431 previously started with ``nbd_server_add``. The ``-f``
1432 option forces the server to drop the export immediately even if
1433 clients are connected; otherwise the command fails unless there are no
1438 .name = "nbd_server_stop",
1440 .params = "nbd_server_stop",
1441 .help = "stop serving block devices using the NBD protocol",
1442 .cmd = hmp_nbd_server_stop,
1446 Stop the QEMU embedded NBD server.
1450 #if defined(TARGET_I386)
1454 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1455 .params = "[-b] cpu bank status mcgstatus addr misc",
1456 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1462 ``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc*
1463 Inject an MCE on the given CPU (x86 only).
1468 .args_type = "fdname:s",
1469 .params = "getfd name",
1470 .help = "receive a file descriptor via SCM rights and assign it a name",
1476 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1477 mechanism on unix sockets, it is stored using the name *fdname* for
1478 later use by other monitor commands.
1483 .args_type = "fdname:s",
1484 .params = "closefd name",
1485 .help = "close a file descriptor previously passed via SCM rights",
1490 ``closefd`` *fdname*
1491 Close the file descriptor previously assigned to *fdname* using the
1492 ``getfd`` command. This is only needed if the file descriptor was never
1493 used by another monitor command.
1497 .name = "block_passwd",
1498 .args_type = "device:B,password:s",
1499 .params = "block_passwd device password",
1500 .help = "set the password of encrypted block devices",
1501 .cmd = hmp_block_passwd,
1505 ``block_passwd`` *device* *password*
1506 Set the encrypted device *device* password to *password*
1508 This command is now obsolete and will always return an error since 2.10
1512 .name = "block_set_io_throttle",
1513 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1514 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1515 .help = "change I/O throttle limits for a block drive",
1516 .cmd = hmp_block_set_io_throttle,
1520 ``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*
1521 Change I/O throttle limits for a block drive to
1522 *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*.
1523 *device* can be a block device name, a qdev ID or a QOM path.
1527 .name = "set_password",
1528 .args_type = "protocol:s,password:s,connected:s?",
1529 .params = "protocol password action-if-connected",
1530 .help = "set spice/vnc password",
1531 .cmd = hmp_set_password,
1535 ``set_password [ vnc | spice ] password [ action-if-connected ]``
1536 Change spice/vnc password. Use zero to make the password stay valid
1537 forever. *action-if-connected* specifies what should happen in
1538 case a connection is established: *fail* makes the password change
1539 fail. *disconnect* changes the password and disconnects the
1540 client. *keep* changes the password and keeps the connection up.
1541 *keep* is the default.
1545 .name = "expire_password",
1546 .args_type = "protocol:s,time:s",
1547 .params = "protocol time",
1548 .help = "set spice/vnc password expire-time",
1549 .cmd = hmp_expire_password,
1553 ``expire_password [ vnc | spice ]`` *expire-time*
1554 Specify when a password for spice/vnc becomes
1555 invalid. *expire-time* accepts:
1558 Invalidate password instantly.
1560 Password stays valid forever.
1562 Password stays valid for *nsec* seconds starting now.
1564 Password is invalidated at the given time. *nsec* are the seconds
1565 passed since 1970, i.e. unix epoch.
1570 .name = "chardev-add",
1571 .args_type = "args:s",
1573 .help = "add chardev",
1574 .cmd = hmp_chardev_add,
1575 .command_completion = chardev_add_completion,
1579 ``chardev-add`` *args*
1580 chardev-add accepts the same parameters as the -chardev command line switch.
1584 .name = "chardev-change",
1585 .args_type = "id:s,args:s",
1586 .params = "id args",
1587 .help = "change chardev",
1588 .cmd = hmp_chardev_change,
1592 ``chardev-change`` *args*
1593 chardev-change accepts existing chardev *id* and then the same arguments
1594 as the -chardev command line switch (except for "id").
1598 .name = "chardev-remove",
1599 .args_type = "id:s",
1601 .help = "remove chardev",
1602 .cmd = hmp_chardev_remove,
1603 .command_completion = chardev_remove_completion,
1607 ``chardev-remove`` *id*
1608 Removes the chardev *id*.
1612 .name = "chardev-send-break",
1613 .args_type = "id:s",
1615 .help = "send a break on chardev",
1616 .cmd = hmp_chardev_send_break,
1617 .command_completion = chardev_remove_completion,
1621 ``chardev-send-break`` *id*
1622 Send a break on the chardev *id*.
1627 .args_type = "qdev:-d,device:B,command:s",
1628 .params = "[-d] [device] \"[command]\"",
1629 .help = "run a qemu-io command on a block device\n\t\t\t"
1630 "-d: [device] is a device ID rather than a "
1631 "drive ID or node name",
1636 ``qemu-io`` *device* *command*
1637 Executes a qemu-io command on the given block device.
1642 .args_type = "path:s?",
1644 .help = "list QOM properties",
1645 .cmd = hmp_qom_list,
1650 ``qom-list`` [*path*]
1651 Print QOM properties of object at location *path*
1656 .args_type = "path:s,property:s",
1657 .params = "path property",
1658 .help = "print QOM property",
1664 ``qom-get`` *path* *property*
1665 Print QOM property *property* of object at location *path*
1670 .args_type = "json:-j,path:s,property:s,value:S",
1671 .params = "[-j] path property value",
1672 .help = "set QOM property.\n\t\t\t"
1673 "-j: the value is specified in json format.",
1679 ``qom-set`` *path* *property* *value*
1680 Set QOM property *property* of object at location *path* to value *value*
1684 .name = "replay_break",
1685 .args_type = "icount:i",
1687 .help = "set breakpoint at the specified instruction count",
1688 .cmd = hmp_replay_break,
1692 ``replay_break`` *icount*
1693 Set replay breakpoint at instruction count *icount*.
1694 Execution stops when the specified instruction is reached.
1695 There can be at most one breakpoint. When breakpoint is set, any prior
1696 one is removed. The breakpoint may be set only in replay mode and only
1697 "in the future", i.e. at instruction counts greater than the current one.
1698 The current instruction count can be observed with ``info replay``.
1702 .name = "replay_delete_break",
1705 .help = "remove replay breakpoint",
1706 .cmd = hmp_replay_delete_break,
1710 ``replay_delete_break``
1711 Remove replay breakpoint which was previously set with ``replay_break``.
1712 The command is ignored when there are no replay breakpoints.
1716 .name = "replay_seek",
1717 .args_type = "icount:i",
1719 .help = "replay execution to the specified instruction count",
1720 .cmd = hmp_replay_seek,
1724 ``replay_seek`` *icount*
1725 Automatically proceed to the instruction count *icount*, when
1726 replaying the execution. The command automatically loads nearest
1727 snapshot and replays the execution to find the desired instruction.
1728 When there is no preceding snapshot or the execution is not replayed,
1729 then the command fails.
1730 *icount* for the reference may be observed with ``info replay`` command.
1735 .args_type = "item:s?",
1736 .params = "[subcommand]",
1737 .help = "show various information about the system state",
1738 .cmd = hmp_info_help,
1739 .sub_table = hmp_info_cmds,