1 HXCOMM QMP dispatch table and documentation
2 HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
3 HXCOMM does not show up in the other formats.
9 This document describes all commands currently supported by QMP.
11 Most of the time their usage is exactly the same as in the user Monitor, this
12 means that any other document which also describe commands (the manpage,
13 QEMU's manual, etc) can and should be consulted.
15 QMP has two types of commands: regular and query commands. Regular commands
16 usually change the Virtual Machine's state someway, while query commands just
17 return information. The sections below are divided accordingly.
19 It's important to observe that all communication examples are formatted in
20 a reader-friendly way, so that they're easier to understand. However, in real
21 protocol usage, they're emitted as a single line.
23 Also, the following notation is used to denote data flow:
25 -> data issued by the Client
26 <- Server data response
28 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
29 information on the Server command and response formats.
31 NOTE: This document is temporary and will be replaced soon.
33 1. Stability Considerations
34 ===========================
36 The current QMP command set (described in this file) may be useful for a
37 number of use cases, however it's limited and several commands have bad
38 defined semantics, specially with regard to command completion.
40 These problems are going to be solved incrementally in the next QEMU releases
41 and we're going to establish a deprecation policy for badly defined commands.
43 If you're planning to adopt QMP, please observe the following:
45 1. The deprecation policy will take effect and be documented soon, please
46 check the documentation of each used command as soon as a new release of
49 2. DO NOT rely on anything which is not explicit documented
51 3. Errors, in special, are not documented. Applications should NOT check
52 for specific errors classes or data (it's strongly recommended to only
53 check for the "error" key)
58 Server's responses in the examples below are always a success response, please
59 refer to the QMP specification for more details on error responses.
66 .mhandler.cmd_new = qmp_marshal_input_quit,
79 -> { "execute": "quit" }
86 .args_type = "force:-f,device:B",
87 .mhandler.cmd_new = qmp_marshal_input_eject,
94 Eject a removable medium.
98 - force: force ejection (json-bool, optional)
99 - device: device name (json-string)
103 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
106 Note: The "force" argument defaults to false.
112 .args_type = "device:B,target:F,arg:s?",
113 .mhandler.cmd_new = qmp_marshal_input_change,
120 Change a removable medium or VNC configuration.
124 - "device": device name (json-string)
125 - "target": filename or item (json-string)
126 - "arg": additional argument (json-string, optional)
130 1. Change a removable medium
132 -> { "execute": "change",
133 "arguments": { "device": "ide1-cd0",
134 "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
137 2. Change VNC password
139 -> { "execute": "change",
140 "arguments": { "device": "vnc", "target": "password",
147 .name = "screendump",
148 .args_type = "filename:F",
149 .mhandler.cmd_new = qmp_marshal_input_screendump,
156 Save screen into PPM image.
160 - "filename": file path (json-string)
164 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
172 .mhandler.cmd_new = qmp_marshal_input_stop,
185 -> { "execute": "stop" }
193 .mhandler.cmd_new = qmp_marshal_input_cont,
206 -> { "execute": "cont" }
212 .name = "system_wakeup",
214 .mhandler.cmd_new = qmp_marshal_input_system_wakeup,
221 Wakeup guest from suspend.
227 -> { "execute": "system_wakeup" }
233 .name = "system_reset",
235 .mhandler.cmd_new = qmp_marshal_input_system_reset,
248 -> { "execute": "system_reset" }
254 .name = "system_powerdown",
256 .mhandler.cmd_new = qmp_marshal_input_system_powerdown,
263 Send system power down event.
269 -> { "execute": "system_powerdown" }
275 .name = "device_add",
276 .args_type = "device:O",
277 .params = "driver[,prop=value][,...]",
278 .help = "add device, like -device on the command line",
279 .user_print = monitor_user_noop,
280 .mhandler.cmd_new = do_device_add,
291 - "driver": the name of the new device's driver (json-string)
292 - "bus": the device's parent bus (device tree path, json-string, optional)
293 - "id": the device's ID, must be unique (json-string)
298 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
303 (1) For detailed information about this command, please refer to the
304 'docs/qdev-device-use.txt' file.
306 (2) It's possible to list device properties by running QEMU with the
307 "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
312 .name = "device_del",
314 .mhandler.cmd_new = qmp_marshal_input_device_del,
325 - "id": the device's ID (json-string)
329 -> { "execute": "device_del", "arguments": { "id": "net1" } }
336 .args_type = "keys:O,hold-time:i?",
337 .mhandler.cmd_new = qmp_marshal_input_send_key,
349 - "key": key sequence (a json-array of key union values,
350 union can be number or qcode enum)
352 - hold-time: time to delay key up events, milliseconds. Defaults to 100
357 -> { "execute": "send-key",
358 "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
359 { "type": "qcode", "data": "alt" },
360 { "type": "qcode", "data": "delete" } ] } }
367 .args_type = "index:i",
368 .mhandler.cmd_new = qmp_marshal_input_cpu,
379 - "index": the CPU's index (json-int)
383 -> { "execute": "cpu", "arguments": { "index": 0 } }
386 Note: CPUs' indexes are obtained with the 'query-cpus' command.
393 .mhandler.cmd_new = qmp_marshal_input_cpu_add,
404 - "id": cpu id (json-int)
408 -> { "execute": "cpu-add", "arguments": { "id": 2 } }
415 .args_type = "val:l,size:i,filename:s,cpu:i?",
416 .mhandler.cmd_new = qmp_marshal_input_memsave,
423 Save to disk virtual memory dump starting at 'val' of size 'size'.
427 - "val": the starting address (json-int)
428 - "size": the memory size, in bytes (json-int)
429 - "filename": file path (json-string)
430 - "cpu": virtual CPU index (json-int, optional)
434 -> { "execute": "memsave",
435 "arguments": { "val": 10,
437 "filename": "/tmp/virtual-mem-dump" } }
444 .args_type = "val:l,size:i,filename:s",
445 .mhandler.cmd_new = qmp_marshal_input_pmemsave,
452 Save to disk physical memory dump starting at 'val' of size 'size'.
456 - "val": the starting address (json-int)
457 - "size": the memory size, in bytes (json-int)
458 - "filename": file path (json-string)
462 -> { "execute": "pmemsave",
463 "arguments": { "val": 10,
465 "filename": "/tmp/physical-mem-dump" } }
471 .name = "inject-nmi",
473 .mhandler.cmd_new = qmp_marshal_input_inject_nmi,
480 Inject an NMI on guest's CPUs.
486 -> { "execute": "inject-nmi" }
489 Note: inject-nmi fails when the guest doesn't support injecting.
490 Currently, only x86 (NMI) and s390x (RESTART) guests do.
495 .name = "ringbuf-write",
496 .args_type = "device:s,data:s,format:s?",
497 .mhandler.cmd_new = qmp_marshal_input_ringbuf_write,
504 Write to a ring buffer character device.
508 - "device": ring buffer character device name (json-string)
509 - "data": data to write (json-string)
510 - "format": data format (json-string, optional)
511 - Possible values: "utf8" (default), "base64"
512 Bug: invalid base64 is currently not rejected.
513 Whitespace *is* invalid.
517 -> { "execute": "ringbuf-write",
518 "arguments": { "device": "foo",
526 .name = "ringbuf-read",
527 .args_type = "device:s,size:i,format:s?",
528 .mhandler.cmd_new = qmp_marshal_input_ringbuf_read,
535 Read from a ring buffer character device.
539 - "device": ring buffer character device name (json-string)
540 - "size": how many bytes to read at most (json-int)
541 - Number of data bytes, not number of characters in encoded data
542 - "format": data format (json-string, optional)
543 - Possible values: "utf8" (default), "base64"
544 - Naturally, format "utf8" works only when the ring buffer
545 contains valid UTF-8 text. Invalid UTF-8 sequences get
546 replaced. Bug: replacement doesn't work. Bug: can screw
547 up on encountering NUL characters, after the ring buffer
548 lost data, and when reading stops because the size limit
553 -> { "execute": "ringbuf-read",
554 "arguments": { "device": "foo",
557 <- {"return": "abcdefgh"}
562 .name = "xen-save-devices-state",
563 .args_type = "filename:F",
564 .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
568 xen-save-devices-state
571 Save the state of all devices to file. The RAM and the block devices
572 of the VM are not saved by this command.
576 - "filename": the file to save the state of the devices to as binary
577 data. See xen-save-devices-state.txt for a description of the binary
582 -> { "execute": "xen-save-devices-state",
583 "arguments": { "filename": "/tmp/save" } }
589 .name = "xen-set-global-dirty-log",
590 .args_type = "enable:b",
591 .mhandler.cmd_new = qmp_marshal_input_xen_set_global_dirty_log,
595 xen-set-global-dirty-log
598 Enable or disable the global dirty log mode.
602 - "enable": Enable it or disable it.
606 -> { "execute": "xen-set-global-dirty-log",
607 "arguments": { "enable": true } }
614 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
615 .mhandler.cmd_new = qmp_marshal_input_migrate,
626 - "blk": block migration, full disk copy (json-bool, optional)
627 - "inc": incremental disk copy (json-bool, optional)
628 - "uri": Destination URI (json-string)
632 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
637 (1) The 'query-migrate' command should be used to check migration's progress
638 and final result (this information is provided by the 'status' member)
639 (2) All boolean arguments default to false
640 (3) The user Monitor's "detach" argument is invalid in QMP and should not
646 .name = "migrate_cancel",
648 .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
655 Cancel the current migration.
661 -> { "execute": "migrate_cancel" }
666 .name = "migrate-set-cache-size",
667 .args_type = "value:o",
668 .mhandler.cmd_new = qmp_marshal_input_migrate_set_cache_size,
672 migrate-set-cache-size
673 ----------------------
675 Set cache size to be used by XBZRLE migration, the cache size will be rounded
676 down to the nearest power of 2
680 - "value": cache size in bytes (json-int)
684 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
689 .name = "query-migrate-cache-size",
691 .mhandler.cmd_new = qmp_marshal_input_query_migrate_cache_size,
695 query-migrate-cache-size
696 ------------------------
698 Show cache size to be used by XBZRLE migration
700 returns a json-object with the following information:
705 -> { "execute": "query-migrate-cache-size" }
706 <- { "return": 67108864 }
711 .name = "migrate_set_speed",
712 .args_type = "value:o",
713 .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
720 Set maximum speed for migrations.
724 - "value": maximum speed, in bytes per second (json-int)
728 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
734 .name = "migrate_set_downtime",
735 .args_type = "value:T",
736 .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
743 Set maximum tolerated downtime (in seconds) for migrations.
747 - "value": maximum downtime (json-number)
751 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
757 .name = "client_migrate_info",
758 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
759 .params = "protocol hostname port tls-port cert-subject",
760 .help = "send migration info to spice/vnc client",
761 .user_print = monitor_user_noop,
762 .mhandler.cmd_async = client_migrate_info,
763 .flags = MONITOR_CMD_ASYNC,
770 Set the spice/vnc connection info for the migration target. The spice/vnc
771 server will ask the spice/vnc client to automatically reconnect using the
772 new parameters (if specified) once the vm migration finished successfully.
776 - "protocol": protocol: "spice" or "vnc" (json-string)
777 - "hostname": migration target hostname (json-string)
778 - "port": spice/vnc tcp port for plaintext channels (json-int, optional)
779 - "tls-port": spice tcp port for tls-secured channels (json-int, optional)
780 - "cert-subject": server certificate subject (json-string, optional)
784 -> { "execute": "client_migrate_info",
785 "arguments": { "protocol": "spice",
786 "hostname": "virt42.lab.kraxel.org",
793 .name = "dump-guest-memory",
794 .args_type = "paging:b,protocol:s,begin:i?,end:i?,format:s?",
795 .params = "-p protocol [begin] [length] [format]",
796 .help = "dump guest memory to file",
797 .user_print = monitor_user_noop,
798 .mhandler.cmd_new = qmp_marshal_input_dump_guest_memory,
805 Dump guest memory to file. The file can be processed with crash or gdb.
809 - "paging": do paging to get guest's memory mapping (json-bool)
810 - "protocol": destination file(started with "file:") or destination file
811 descriptor (started with "fd:") (json-string)
812 - "begin": the starting physical address. It's optional, and should be specified
813 with length together (json-int)
814 - "length": the memory size, in bytes. It's optional, and should be specified
815 with begin together (json-int)
816 - "format": the format of guest memory dump. It's optional, and can be
817 elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
818 conflict with paging and filter, ie. begin and length (json-string)
822 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
827 (1) All boolean arguments default to false
832 .name = "query-dump-guest-memory-capability",
834 .mhandler.cmd_new = qmp_marshal_input_query_dump_guest_memory_capability,
838 query-dump-guest-memory-capability
841 Show available formats for 'dump-guest-memory'
845 -> { "execute": "query-dump-guest-memory-capability" }
846 <- { "return": { "formats":
847 ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
852 .name = "netdev_add",
853 .args_type = "netdev:O",
854 .mhandler.cmd_new = qmp_netdev_add,
861 Add host network device.
865 - "type": the device type, "tap", "user", ... (json-string)
866 - "id": the device's ID, must be unique (json-string)
871 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
874 Note: The supported device options are the same ones supported by the '-netdev'
875 command-line argument, which are listed in the '-help' output or QEMU's
881 .name = "netdev_del",
883 .mhandler.cmd_new = qmp_marshal_input_netdev_del,
890 Remove host network device.
894 - "id": the device's ID, must be unique (json-string)
898 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
905 .name = "object-add",
906 .args_type = "qom-type:s,id:s,props:q?",
907 .mhandler.cmd_new = qmp_object_add,
918 - "qom-type": the object's QOM type, i.e. the class name (json-string)
919 - "id": the object's ID, must be unique (json-string)
920 - "props": a dictionary of object property values (optional, json-dict)
924 -> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
925 "props": { "filename": "/dev/hwrng" } } }
931 .name = "object-del",
933 .mhandler.cmd_new = qmp_marshal_input_object_del,
944 - "id": the object's ID (json-string)
948 -> { "execute": "object-del", "arguments": { "id": "rng1" } }
956 .name = "block_resize",
957 .args_type = "device:s?,node-name:s?,size:o",
958 .mhandler.cmd_new = qmp_marshal_input_block_resize,
965 Resize a block image while a guest is running.
969 - "device": the device's ID, must be unique (json-string)
970 - "node-name": the node name in the block driver state graph (json-string)
975 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
981 .name = "block-stream",
982 .args_type = "device:B,base:s?,speed:o?,on-error:s?",
983 .mhandler.cmd_new = qmp_marshal_input_block_stream,
987 .name = "block-commit",
988 .args_type = "device:B,base:s?,top:s?,speed:o?",
989 .mhandler.cmd_new = qmp_marshal_input_block_commit,
996 Live commit of data from overlay image nodes into backing nodes - i.e., writes
997 data between 'top' and 'base' into 'base'.
1001 - "device": The device's ID, must be unique (json-string)
1002 - "base": The file name of the backing image to write data into.
1003 If not specified, this is the deepest backing image
1004 (json-string, optional)
1005 - "top": The file name of the backing image within the image chain,
1006 which contains the topmost data to be committed down. If
1007 not specified, this is the active layer. (json-string, optional)
1009 If top == base, that is an error.
1010 If top == active, the job will not be completed by itself,
1011 user needs to complete the job with the block-job-complete
1012 command after getting the ready event. (Since 2.0)
1014 If the base image is smaller than top, then the base image
1015 will be resized to be the same size as top. If top is
1016 smaller than the base image, the base will not be
1017 truncated. If you want the base image size to match the
1018 size of the smaller top, you can safely truncate it
1019 yourself once the commit operation successfully completes.
1021 - "speed": the maximum speed, in bytes per second (json-int, optional)
1026 -> { "execute": "block-commit", "arguments": { "device": "virtio0",
1027 "top": "/tmp/snap1.qcow2" } }
1033 .name = "drive-backup",
1034 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1035 "on-source-error:s?,on-target-error:s?",
1036 .mhandler.cmd_new = qmp_marshal_input_drive_backup,
1043 Start a point-in-time copy of a block device to a new destination. The
1044 status of ongoing drive-backup operations can be checked with
1045 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1046 The operation can be stopped before it has completed using the
1047 block-job-cancel command.
1051 - "device": the name of the device which should be copied.
1053 - "target": the target of the new image. If the file exists, or if it is a
1054 device, the existing file/device will be used as the new
1055 destination. If it does not exist, a new file will be created.
1057 - "format": the format of the new destination, default is to probe if 'mode' is
1058 'existing', else the format of the source
1059 (json-string, optional)
1060 - "sync": what parts of the disk image should be copied to the destination;
1061 possibilities include "full" for all the disk, "top" for only the sectors
1062 allocated in the topmost image, or "none" to only replicate new I/O
1064 - "mode": whether and how QEMU should create a new image
1065 (NewImageMode, optional, default 'absolute-paths')
1066 - "speed": the maximum speed, in bytes per second (json-int, optional)
1067 - "on-source-error": the action to take on an error on the source, default
1068 'report'. 'stop' and 'enospc' can only be used
1069 if the block device supports io-status.
1070 (BlockdevOnError, optional)
1071 - "on-target-error": the action to take on an error on the target, default
1072 'report' (no limitations, since this applies to
1073 a different block device than device).
1074 (BlockdevOnError, optional)
1077 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
1079 "target": "backup.img" } }
1084 .name = "block-job-set-speed",
1085 .args_type = "device:B,speed:o",
1086 .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
1090 .name = "block-job-cancel",
1091 .args_type = "device:B,force:b?",
1092 .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
1095 .name = "block-job-pause",
1096 .args_type = "device:B",
1097 .mhandler.cmd_new = qmp_marshal_input_block_job_pause,
1100 .name = "block-job-resume",
1101 .args_type = "device:B",
1102 .mhandler.cmd_new = qmp_marshal_input_block_job_resume,
1105 .name = "block-job-complete",
1106 .args_type = "device:B",
1107 .mhandler.cmd_new = qmp_marshal_input_block_job_complete,
1110 .name = "transaction",
1111 .args_type = "actions:q",
1112 .mhandler.cmd_new = qmp_marshal_input_transaction,
1119 Atomically operate on one or more block devices. The only supported operations
1120 for now are drive-backup, internal and external snapshotting. A list of
1121 dictionaries is accepted, that contains the actions to be performed.
1122 If there is any failure performing any of the operations, all operations
1123 for the group are abandoned.
1125 For external snapshots, the dictionary contains the device, the file to use for
1126 the new snapshot, and the format. The default format, if not specified, is
1129 Each new snapshot defaults to being created by QEMU (wiping any
1130 contents if the file already exists), but it is also possible to reuse
1131 an externally-created file. In the latter case, you should ensure that
1132 the new image file has the same contents as the current one; QEMU cannot
1133 perform any meaningful check. Typically this is achieved by using the
1134 current image file as the backing file for the new image.
1136 On failure, the original disks pre-snapshot attempt will be used.
1138 For internal snapshots, the dictionary contains the device and the snapshot's
1139 name. If an internal snapshot matching name already exists, the request will
1140 be rejected. Only some image formats support it, for example, qcow2, rbd,
1143 On failure, qemu will try delete the newly created internal snapshot in the
1144 transaction. When an I/O error occurs during deletion, the user needs to fix
1145 it later with qemu-img or other command.
1150 - "type": the operation to perform. The only supported
1151 value is "blockdev-snapshot-sync". (json-string)
1152 - "data": a dictionary. The contents depend on the value
1153 of "type". When "type" is "blockdev-snapshot-sync":
1154 - "device": device name to snapshot (json-string)
1155 - "node-name": graph node name to snapshot (json-string)
1156 - "snapshot-file": name of new image file (json-string)
1157 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1158 - "format": format of new image (json-string, optional)
1159 - "mode": whether and how QEMU should create the snapshot file
1160 (NewImageMode, optional, default "absolute-paths")
1161 When "type" is "blockdev-snapshot-internal-sync":
1162 - "device": device name to snapshot (json-string)
1163 - "name": name of the new snapshot (json-string)
1167 -> { "execute": "transaction",
1168 "arguments": { "actions": [
1169 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
1170 "snapshot-file": "/some/place/my-image",
1171 "format": "qcow2" } },
1172 { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
1173 "snapshot-file": "/some/place/my-image2",
1174 "snapshot-node-name": "node3432",
1176 "format": "qcow2" } },
1177 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
1178 "snapshot-file": "/some/place/my-image2",
1180 "format": "qcow2" } },
1181 { "type": "blockdev-snapshot-internal-sync", "data" : {
1182 "device": "ide-hd2",
1183 "name": "snapshot0" } } ] } }
1189 .name = "blockdev-snapshot-sync",
1190 .args_type = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
1191 .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
1195 blockdev-snapshot-sync
1196 ----------------------
1198 Synchronous snapshot of a block device. snapshot-file specifies the
1199 target of the new image. If the file exists, or if it is a device, the
1200 snapshot will be created in the existing file/device. If does not
1201 exist, a new file will be created. format specifies the format of the
1202 snapshot image, default is qcow2.
1206 - "device": device name to snapshot (json-string)
1207 - "node-name": graph node name to snapshot (json-string)
1208 - "snapshot-file": name of new image file (json-string)
1209 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1210 - "mode": whether and how QEMU should create the snapshot file
1211 (NewImageMode, optional, default "absolute-paths")
1212 - "format": format of new image (json-string, optional)
1216 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1218 "/some/place/my-image",
1219 "format": "qcow2" } }
1225 .name = "blockdev-snapshot-internal-sync",
1226 .args_type = "device:B,name:s",
1227 .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_internal_sync,
1231 blockdev-snapshot-internal-sync
1232 -------------------------------
1234 Synchronously take an internal snapshot of a block device when the format of
1235 image used supports it. If the name is an empty string, or a snapshot with
1236 name already exists, the operation will fail.
1240 - "device": device name to snapshot (json-string)
1241 - "name": name of the new snapshot (json-string)
1245 -> { "execute": "blockdev-snapshot-internal-sync",
1246 "arguments": { "device": "ide-hd0",
1247 "name": "snapshot0" }
1254 .name = "blockdev-snapshot-delete-internal-sync",
1255 .args_type = "device:B,id:s?,name:s?",
1257 qmp_marshal_input_blockdev_snapshot_delete_internal_sync,
1261 blockdev-snapshot-delete-internal-sync
1262 --------------------------------------
1264 Synchronously delete an internal snapshot of a block device when the format of
1265 image used supports it. The snapshot is identified by name or id or both. One
1266 of name or id is required. If the snapshot is not found, the operation will
1271 - "device": device name (json-string)
1272 - "id": ID of the snapshot (json-string, optional)
1273 - "name": name of the snapshot (json-string, optional)
1277 -> { "execute": "blockdev-snapshot-delete-internal-sync",
1278 "arguments": { "device": "ide-hd0",
1279 "name": "snapshot0" }
1283 "name": "snapshot0",
1285 "date-sec": 1000012,
1287 "vm-clock-sec": 100,
1295 .name = "drive-mirror",
1296 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1297 "node-name:s?,replaces:s?,"
1298 "on-source-error:s?,on-target-error:s?,"
1299 "granularity:i?,buf-size:i?",
1300 .mhandler.cmd_new = qmp_marshal_input_drive_mirror,
1307 Start mirroring a block device's writes to a new destination. target
1308 specifies the target of the new image. If the file exists, or if it is
1309 a device, it will be used as the new destination for writes. If it does not
1310 exist, a new file will be created. format specifies the format of the
1311 mirror image, default is to probe if mode='existing', else the format
1316 - "device": device name to operate on (json-string)
1317 - "target": name of new image file (json-string)
1318 - "format": format of new image (json-string, optional)
1319 - "node-name": the name of the new block driver state in the node graph
1320 (json-string, optional)
1321 - "replaces": the block driver node name to replace when finished
1322 (json-string, optional)
1323 - "mode": how an image file should be created into the target
1324 file/device (NewImageMode, optional, default 'absolute-paths')
1325 - "speed": maximum speed of the streaming job, in bytes per second
1327 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1328 - "buf_size": maximum amount of data in flight from source to target, in bytes
1329 (json-int, default 10M)
1330 - "sync": what parts of the disk image should be copied to the destination;
1331 possibilities include "full" for all the disk, "top" for only the sectors
1332 allocated in the topmost image, or "none" to only replicate new I/O
1334 - "on-source-error": the action to take on an error on the source
1335 (BlockdevOnError, default 'report')
1336 - "on-target-error": the action to take on an error on the target
1337 (BlockdevOnError, default 'report')
1339 The default value of the granularity is the image cluster size clamped
1340 between 4096 and 65536, if the image format defines one. If the format
1341 does not define a cluster size, the default value of the granularity
1347 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1348 "target": "/some/place/my-image",
1350 "format": "qcow2" } }
1357 .args_type = "value:M",
1358 .mhandler.cmd_new = qmp_marshal_input_balloon,
1365 Request VM to change its memory allocation (in bytes).
1369 - "value": New memory allocation (json-int)
1373 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1380 .args_type = "name:s,up:b",
1381 .mhandler.cmd_new = qmp_marshal_input_set_link,
1388 Change the link status of a network adapter.
1392 - "name": network device name (json-string)
1393 - "up": status is up (json-bool)
1397 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1404 .args_type = "fdname:s",
1405 .params = "getfd name",
1406 .help = "receive a file descriptor via SCM rights and assign it a name",
1407 .mhandler.cmd_new = qmp_marshal_input_getfd,
1414 Receive a file descriptor via SCM rights and assign it a name.
1418 - "fdname": file descriptor name (json-string)
1422 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1427 (1) If the name specified by the "fdname" argument already exists,
1428 the file descriptor assigned to it will be closed and replaced
1429 by the received file descriptor.
1430 (2) The 'closefd' command can be used to explicitly close the file
1431 descriptor when it is no longer needed.
1437 .args_type = "fdname:s",
1438 .params = "closefd name",
1439 .help = "close a file descriptor previously passed via SCM rights",
1440 .mhandler.cmd_new = qmp_marshal_input_closefd,
1447 Close a file descriptor previously passed via SCM rights.
1451 - "fdname": file descriptor name (json-string)
1455 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1462 .args_type = "fdset-id:i?,opaque:s?",
1463 .params = "add-fd fdset-id opaque",
1464 .help = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1465 .mhandler.cmd_new = qmp_marshal_input_add_fd,
1472 Add a file descriptor, that was passed via SCM rights, to an fd set.
1476 - "fdset-id": The ID of the fd set to add the file descriptor to.
1477 (json-int, optional)
1478 - "opaque": A free-form string that can be used to describe the fd.
1479 (json-string, optional)
1481 Return a json-object with the following information:
1483 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1484 - "fd": The file descriptor that was received via SCM rights and added to the
1489 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1490 <- { "return": { "fdset-id": 1, "fd": 3 } }
1494 (1) The list of fd sets is shared by all monitor connections.
1495 (2) If "fdset-id" is not specified, a new fd set will be created.
1500 .name = "remove-fd",
1501 .args_type = "fdset-id:i,fd:i?",
1502 .params = "remove-fd fdset-id fd",
1503 .help = "Remove a file descriptor from an fd set",
1504 .mhandler.cmd_new = qmp_marshal_input_remove_fd,
1511 Remove a file descriptor from an fd set.
1515 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1517 - "fd": The file descriptor that is to be removed. (json-int, optional)
1521 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1526 (1) The list of fd sets is shared by all monitor connections.
1527 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1533 .name = "query-fdsets",
1535 .help = "Return information describing all fd sets",
1536 .mhandler.cmd_new = qmp_marshal_input_query_fdsets,
1543 Return information describing all fd sets.
1549 -> { "execute": "query-fdsets" }
1555 "opaque": "rdonly:/path/to/file"
1559 "opaque": "rdwr:/path/to/file"
1578 Note: The list of fd sets is shared by all monitor connections.
1583 .name = "block_passwd",
1584 .args_type = "device:s?,node-name:s?,password:s",
1585 .mhandler.cmd_new = qmp_marshal_input_block_passwd,
1592 Set the password of encrypted block devices.
1596 - "device": device name (json-string)
1597 - "node-name": name in the block driver state graph (json-string)
1598 - "password": password (json-string)
1602 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1603 "password": "12345" } }
1609 .name = "block_set_io_throttle",
1610 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l,bps_max:l?,bps_rd_max:l?,bps_wr_max:l?,iops_max:l?,iops_rd_max:l?,iops_wr_max:l?,iops_size:l?",
1611 .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
1615 block_set_io_throttle
1618 Change I/O throttle limits for a block drive.
1622 - "device": device name (json-string)
1623 - "bps": total throughput limit in bytes per second (json-int)
1624 - "bps_rd": read throughput limit in bytes per second (json-int)
1625 - "bps_wr": write throughput limit in bytes per second (json-int)
1626 - "iops": total I/O operations per second (json-int)
1627 - "iops_rd": read I/O operations per second (json-int)
1628 - "iops_wr": write I/O operations per second (json-int)
1629 - "bps_max": total max in bytes (json-int)
1630 - "bps_rd_max": read max in bytes (json-int)
1631 - "bps_wr_max": write max in bytes (json-int)
1632 - "iops_max": total I/O operations max (json-int)
1633 - "iops_rd_max": read I/O operations max (json-int)
1634 - "iops_wr_max": write I/O operations max (json-int)
1635 - "iops_size": I/O size in bytes when limiting (json-int)
1639 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
1658 .name = "set_password",
1659 .args_type = "protocol:s,password:s,connected:s?",
1660 .mhandler.cmd_new = qmp_marshal_input_set_password,
1667 Set the password for vnc/spice protocols.
1671 - "protocol": protocol name (json-string)
1672 - "password": password (json-string)
1673 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
1677 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
1678 "password": "secret" } }
1684 .name = "expire_password",
1685 .args_type = "protocol:s,time:s",
1686 .mhandler.cmd_new = qmp_marshal_input_expire_password,
1693 Set the password expire time for vnc/spice protocols.
1697 - "protocol": protocol name (json-string)
1698 - "time": [ now | never | +secs | secs ] (json-string)
1702 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1709 .name = "add_client",
1710 .args_type = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1711 .mhandler.cmd_new = qmp_marshal_input_add_client,
1718 Add a graphics client
1722 - "protocol": protocol name (json-string)
1723 - "fdname": file descriptor name (json-string)
1724 - "skipauth": whether to skip authentication (json-bool, optional)
1725 - "tls": whether to perform TLS (json-bool, optional)
1729 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1730 "fdname": "myclient" } }
1735 .name = "qmp_capabilities",
1738 .help = "enable QMP capabilities",
1739 .user_print = monitor_user_noop,
1740 .mhandler.cmd_new = do_qmp_capabilities,
1747 Enable QMP capabilities.
1753 -> { "execute": "qmp_capabilities" }
1756 Note: This command must be issued before issuing any other command.
1761 .name = "human-monitor-command",
1762 .args_type = "command-line:s,cpu-index:i?",
1763 .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1767 human-monitor-command
1768 ---------------------
1770 Execute a Human Monitor command.
1774 - command-line: the command name and its arguments, just like the
1775 Human Monitor's shell (json-string)
1776 - cpu-index: select the CPU number to be used by commands which access CPU
1777 data, like 'info registers'. The Monitor selects CPU 0 if this
1778 argument is not provided (json-int, optional)
1782 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1783 <- { "return": "kvm support: enabled\r\n" }
1787 (1) The Human Monitor is NOT an stable interface, this means that command
1788 names, arguments and responses can change or be removed at ANY time.
1789 Applications that rely on long term stability guarantees should NOT
1794 o This command is stateless, this means that commands that depend
1795 on state information (such as getfd) might not work
1797 o Commands that prompt the user for data (eg. 'cont' when the block
1798 device is encrypted) don't currently work
1803 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1804 HXCOMM this! We will possibly move query commands definitions inside those
1805 HXCOMM sections, just like regular commands.
1815 Return a json-object with the following information:
1817 - "qemu": A json-object containing three integer values:
1818 - "major": QEMU's major version (json-int)
1819 - "minor": QEMU's minor version (json-int)
1820 - "micro": QEMU's micro version (json-int)
1821 - "package": package's version (json-string)
1825 -> { "execute": "query-version" }
1840 .name = "query-version",
1842 .mhandler.cmd_new = qmp_marshal_input_query_version,
1849 List QMP available commands.
1851 Each command is represented by a json-object, the returned value is a json-array
1854 Each json-object contain:
1856 - "name": command's name (json-string)
1860 -> { "execute": "query-commands" }
1864 "name":"query-balloon"
1867 "name":"system_powerdown"
1872 Note: This example has been shortened as the real response is too long.
1877 .name = "query-commands",
1879 .mhandler.cmd_new = qmp_marshal_input_query_commands,
1886 List QMP available events.
1888 Each event is represented by a json-object, the returned value is a json-array
1891 Each json-object contains:
1893 - "name": event's name (json-string)
1897 -> { "execute": "query-events" }
1909 Note: This example has been shortened as the real response is too long.
1914 .name = "query-events",
1916 .mhandler.cmd_new = qmp_marshal_input_query_events,
1923 Each device is represented by a json-object. The returned value is a json-array
1926 Each json-object contain the following:
1928 - "label": device's label (json-string)
1929 - "filename": device's file (json-string)
1930 - "frontend-open": open/closed state of the frontend device attached to this
1935 -> { "execute": "query-chardev" }
1939 "label": "charchannel0",
1940 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
1941 "frontend-open": false
1944 "label": "charmonitor",
1945 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
1946 "frontend-open": true
1949 "label": "charserial0",
1950 "filename": "pty:/dev/pts/2",
1951 "frontend-open": true
1959 .name = "query-chardev",
1961 .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1965 query-chardev-backends
1968 List available character device backends.
1970 Each backend is represented by a json-object, the returned value is a json-array
1973 Each json-object contains:
1975 - "name": backend name (json-string)
1979 -> { "execute": "query-chardev-backends" }
2000 .name = "query-chardev-backends",
2002 .mhandler.cmd_new = qmp_marshal_input_query_chardev_backends,
2009 Show the block devices.
2011 Each block device information is stored in a json-object and the returned value
2012 is a json-array of all devices.
2014 Each json-object contain the following:
2016 - "device": device name (json-string)
2017 - "type": device type (json-string)
2018 - deprecated, retained for backward compatibility
2019 - Possible values: "unknown"
2020 - "removable": true if the device is removable, false otherwise (json-bool)
2021 - "locked": true if the device is locked, false otherwise (json-bool)
2022 - "tray_open": only present if removable, true if the device has a tray,
2023 and it is open (json-bool)
2024 - "inserted": only present if the device is inserted, it is a json-object
2025 containing the following:
2026 - "file": device file name (json-string)
2027 - "ro": true if read-only, false otherwise (json-bool)
2028 - "drv": driver format name (json-string)
2029 - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
2030 "file", "file", "ftp", "ftps", "host_cdrom",
2031 "host_device", "host_floppy", "http", "https",
2032 "nbd", "parallels", "qcow", "qcow2", "raw",
2033 "tftp", "vdi", "vmdk", "vpc", "vvfat"
2034 - "backing_file": backing file name (json-string, optional)
2035 - "backing_file_depth": number of files in the backing file chain (json-int)
2036 - "encrypted": true if encrypted, false otherwise (json-bool)
2037 - "bps": limit total bytes per second (json-int)
2038 - "bps_rd": limit read bytes per second (json-int)
2039 - "bps_wr": limit write bytes per second (json-int)
2040 - "iops": limit total I/O operations per second (json-int)
2041 - "iops_rd": limit read operations per second (json-int)
2042 - "iops_wr": limit write operations per second (json-int)
2043 - "bps_max": total max in bytes (json-int)
2044 - "bps_rd_max": read max in bytes (json-int)
2045 - "bps_wr_max": write max in bytes (json-int)
2046 - "iops_max": total I/O operations max (json-int)
2047 - "iops_rd_max": read I/O operations max (json-int)
2048 - "iops_wr_max": write I/O operations max (json-int)
2049 - "iops_size": I/O size when limiting by iops (json-int)
2050 - "detect_zeroes": detect and optimize zero writing (json-string)
2051 - Possible values: "off", "on", "unmap"
2052 - "image": the detail of the image, it is a json-object containing
2054 - "filename": image file name (json-string)
2055 - "format": image format (json-string)
2056 - "virtual-size": image capacity in bytes (json-int)
2057 - "dirty-flag": true if image is not cleanly closed, not present
2058 means clean (json-bool, optional)
2059 - "actual-size": actual size on disk in bytes of the image, not
2060 present when image does not support thin
2061 provision (json-int, optional)
2062 - "cluster-size": size of a cluster in bytes, not present if image
2063 format does not support it (json-int, optional)
2064 - "encrypted": true if the image is encrypted, not present means
2065 false or the image format does not support
2066 encryption (json-bool, optional)
2067 - "backing_file": backing file name, not present means no backing
2068 file is used or the image format does not
2069 support backing file chain
2070 (json-string, optional)
2071 - "full-backing-filename": full path of the backing file, not
2072 present if it equals backing_file or no
2073 backing file is used
2074 (json-string, optional)
2075 - "backing-filename-format": the format of the backing file, not
2076 present means unknown or no backing
2077 file (json-string, optional)
2078 - "snapshots": the internal snapshot info, it is an optional list
2079 of json-object containing the following:
2080 - "id": unique snapshot id (json-string)
2081 - "name": snapshot name (json-string)
2082 - "vm-state-size": size of the VM state in bytes (json-int)
2083 - "date-sec": UTC date of the snapshot in seconds (json-int)
2084 - "date-nsec": fractional part in nanoseconds to be used with
2086 - "vm-clock-sec": VM clock relative to boot in seconds
2088 - "vm-clock-nsec": fractional part in nanoseconds to be used
2089 with vm-clock-sec (json-int)
2090 - "backing-image": the detail of the backing image, it is an
2091 optional json-object only present when a
2092 backing image present for this image
2094 - "io-status": I/O operation status, only present if the device supports it
2095 and the VM is configured to stop on errors. It's always reset
2096 to "ok" when the "cont" command is issued (json_string, optional)
2097 - Possible values: "ok", "failed", "nospace"
2101 -> { "execute": "query-block" }
2106 "device":"ide0-hd0",
2113 "file":"disks/test.qcow2",
2114 "backing_file_depth":1,
2128 "detect_zeroes": "on",
2130 "filename":"disks/test.qcow2",
2132 "virtual-size":2048000,
2133 "backing_file":"base.qcow2",
2134 "full-backing-filename":"disks/base.qcow2",
2135 "backing-filename-format:"qcow2",
2139 "name": "snapshot1",
2141 "date-sec": 10000200,
2143 "vm-clock-sec": 206,
2148 "filename":"disks/base.qcow2",
2150 "virtual-size":2048000
2158 "device":"ide1-cd0",
2181 .name = "query-block",
2183 .mhandler.cmd_new = qmp_marshal_input_query_block,
2190 Show block device statistics.
2192 Each device statistic information is stored in a json-object and the returned
2193 value is a json-array of all devices.
2195 Each json-object contain the following:
2197 - "device": device name (json-string)
2198 - "stats": A json-object with the statistics information, it contains:
2199 - "rd_bytes": bytes read (json-int)
2200 - "wr_bytes": bytes written (json-int)
2201 - "rd_operations": read operations (json-int)
2202 - "wr_operations": write operations (json-int)
2203 - "flush_operations": cache flush operations (json-int)
2204 - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2205 - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2206 - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
2207 - "wr_highest_offset": Highest offset of a sector written since the
2208 BlockDriverState has been opened (json-int)
2209 - "parent": Contains recursively the statistics of the underlying
2210 protocol (e.g. the host file for a qcow2 image). If there is
2211 no underlying protocol, this field is omitted
2212 (json-object, optional)
2216 -> { "execute": "query-blockstats" }
2220 "device":"ide0-hd0",
2223 "wr_highest_offset":3686448128,
2225 "wr_operations":751,
2226 "rd_bytes":122567168,
2227 "rd_operations":36772
2228 "wr_total_times_ns":313253456
2229 "rd_total_times_ns":3465673657
2230 "flush_total_times_ns":49653
2231 "flush_operations":61,
2235 "wr_highest_offset":2821110784,
2237 "wr_operations":692,
2238 "rd_bytes":122739200,
2239 "rd_operations":36604
2240 "flush_operations":51,
2241 "wr_total_times_ns":313253456
2242 "rd_total_times_ns":3465673657
2243 "flush_total_times_ns":49653
2247 "device":"ide1-cd0",
2249 "wr_highest_offset":0,
2254 "flush_operations":0,
2255 "wr_total_times_ns":0
2256 "rd_total_times_ns":0
2257 "flush_total_times_ns":0
2263 "wr_highest_offset":0,
2268 "flush_operations":0,
2269 "wr_total_times_ns":0
2270 "rd_total_times_ns":0
2271 "flush_total_times_ns":0
2277 "wr_highest_offset":0,
2282 "flush_operations":0,
2283 "wr_total_times_ns":0
2284 "rd_total_times_ns":0
2285 "flush_total_times_ns":0
2294 .name = "query-blockstats",
2296 .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
2303 Show CPU information.
2305 Return a json-array. Each CPU is represented by a json-object, which contains:
2307 - "CPU": CPU index (json-int)
2308 - "current": true if this is the current CPU, false otherwise (json-bool)
2309 - "halted": true if the cpu is halted, false otherwise (json-bool)
2310 - Current program counter. The key's name depends on the architecture:
2311 "pc": i386/x86_64 (json-int)
2312 "nip": PPC (json-int)
2313 "pc" and "npc": sparc (json-int)
2314 "PC": mips (json-int)
2315 - "thread_id": ID of the underlying host thread (json-int)
2319 -> { "execute": "query-cpus" }
2342 .name = "query-cpus",
2344 .mhandler.cmd_new = qmp_marshal_input_query_cpus,
2351 Returns a list of information about each iothread.
2353 Note this list excludes the QEMU main loop thread, which is not declared
2354 using the -object iothread command-line option. It is always the main thread
2357 Return a json-array. Each iothread is represented by a json-object, which contains:
2359 - "id": name of iothread (json-str)
2360 - "thread-id": ID of the underlying host thread (json-int)
2364 -> { "execute": "query-iothreads" }
2381 .name = "query-iothreads",
2383 .mhandler.cmd_new = qmp_marshal_input_query_iothreads,
2390 PCI buses and devices information.
2392 The returned value is a json-array of all buses. Each bus is represented by
2393 a json-object, which has a key with a json-array of all PCI devices attached
2394 to it. Each device is represented by a json-object.
2396 The bus json-object contains the following:
2398 - "bus": bus number (json-int)
2399 - "devices": a json-array of json-objects, each json-object represents a
2402 The PCI device json-object contains the following:
2404 - "bus": identical to the parent's bus number (json-int)
2405 - "slot": slot number (json-int)
2406 - "function": function number (json-int)
2407 - "class_info": a json-object containing:
2408 - "desc": device class description (json-string, optional)
2409 - "class": device class number (json-int)
2410 - "id": a json-object containing:
2411 - "device": device ID (json-int)
2412 - "vendor": vendor ID (json-int)
2413 - "irq": device's IRQ if assigned (json-int, optional)
2414 - "qdev_id": qdev id string (json-string)
2415 - "pci_bridge": It's a json-object, only present if this device is a
2416 PCI bridge, contains:
2417 - "bus": bus number (json-int)
2418 - "secondary": secondary bus number (json-int)
2419 - "subordinate": subordinate bus number (json-int)
2420 - "io_range": I/O memory range information, a json-object with the
2422 - "base": base address, in bytes (json-int)
2423 - "limit": limit address, in bytes (json-int)
2424 - "memory_range": memory range information, a json-object with the
2426 - "base": base address, in bytes (json-int)
2427 - "limit": limit address, in bytes (json-int)
2428 - "prefetchable_range": Prefetchable memory range information, a
2429 json-object with the following members:
2430 - "base": base address, in bytes (json-int)
2431 - "limit": limit address, in bytes (json-int)
2432 - "devices": a json-array of PCI devices if there's any attached, each
2433 each element is represented by a json-object, which contains
2434 the same members of the 'PCI device json-object' described
2436 - "regions": a json-array of json-objects, each json-object represents a
2437 memory region of this device
2439 The memory range json-object contains the following:
2441 - "base": base memory address (json-int)
2442 - "limit": limit value (json-int)
2444 The region json-object can be an I/O region or a memory region, an I/O region
2445 json-object contains the following:
2447 - "type": "io" (json-string, fixed)
2448 - "bar": BAR number (json-int)
2449 - "address": memory address (json-int)
2450 - "size": memory size (json-int)
2452 A memory region json-object contains the following:
2454 - "type": "memory" (json-string, fixed)
2455 - "bar": BAR number (json-int)
2456 - "address": memory address (json-int)
2457 - "size": memory size (json-int)
2458 - "mem_type_64": true or false (json-bool)
2459 - "prefetch": true or false (json-bool)
2463 -> { "execute": "query-pci" }
2475 "desc":"Host bridge"
2509 "desc":"IDE controller"
2531 "desc":"VGA controller"
2541 "mem_type_64":false,
2544 "address":4026531840,
2549 "mem_type_64":false,
2552 "address":4060086272,
2557 "mem_type_64":false,
2572 "desc":"RAM controller"
2593 Note: This example has been shortened as the real response is too long.
2598 .name = "query-pci",
2600 .mhandler.cmd_new = qmp_marshal_input_query_pci,
2607 Show KVM information.
2609 Return a json-object with the following information:
2611 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
2612 - "present": true if QEMU has KVM support, false otherwise (json-bool)
2616 -> { "execute": "query-kvm" }
2617 <- { "return": { "enabled": true, "present": true } }
2622 .name = "query-kvm",
2624 .mhandler.cmd_new = qmp_marshal_input_query_kvm,
2631 Return a json-object with the following information:
2633 - "running": true if the VM is running, or false if it is paused (json-bool)
2634 - "singlestep": true if the VM is in single step mode,
2635 false otherwise (json-bool)
2636 - "status": one of the following values (json-string)
2637 "debug" - QEMU is running on a debugger
2638 "inmigrate" - guest is paused waiting for an incoming migration
2639 "internal-error" - An internal error that prevents further guest
2640 execution has occurred
2641 "io-error" - the last IOP has failed and the device is configured
2642 to pause on I/O errors
2643 "paused" - guest has been paused via the 'stop' command
2644 "postmigrate" - guest is paused following a successful 'migrate'
2645 "prelaunch" - QEMU was started with -S and guest has not started
2646 "finish-migrate" - guest is paused to finish the migration process
2647 "restore-vm" - guest is paused to restore VM state
2648 "running" - guest is actively running
2649 "save-vm" - guest is paused to save the VM state
2650 "shutdown" - guest is shut down (and -no-shutdown is in use)
2651 "watchdog" - the watchdog action is configured to pause and
2656 -> { "execute": "query-status" }
2657 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
2662 .name = "query-status",
2664 .mhandler.cmd_new = qmp_marshal_input_query_status,
2671 Show VM mice information.
2673 Each mouse is represented by a json-object, the returned value is a json-array
2676 The mouse json-object contains the following:
2678 - "name": mouse's name (json-string)
2679 - "index": mouse's index (json-int)
2680 - "current": true if this mouse is receiving events, false otherwise (json-bool)
2681 - "absolute": true if the mouse generates absolute input events (json-bool)
2685 -> { "execute": "query-mice" }
2689 "name":"QEMU Microsoft Mouse",
2695 "name":"QEMU PS/2 Mouse",
2706 .name = "query-mice",
2708 .mhandler.cmd_new = qmp_marshal_input_query_mice,
2715 Show VNC server information.
2717 Return a json-object with server information. Connected clients are returned
2718 as a json-array of json-objects.
2720 The main json-object contains the following:
2722 - "enabled": true or false (json-bool)
2723 - "host": server's IP address (json-string)
2724 - "family": address family (json-string)
2725 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2726 - "service": server's port number (json-string)
2727 - "auth": authentication method (json-string)
2728 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2729 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2730 "vencrypt+plain", "vencrypt+tls+none",
2731 "vencrypt+tls+plain", "vencrypt+tls+sasl",
2732 "vencrypt+tls+vnc", "vencrypt+x509+none",
2733 "vencrypt+x509+plain", "vencrypt+x509+sasl",
2734 "vencrypt+x509+vnc", "vnc"
2735 - "clients": a json-array of all connected clients
2737 Clients are described by a json-object, each one contain the following:
2739 - "host": client's IP address (json-string)
2740 - "family": address family (json-string)
2741 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2742 - "service": client's port number (json-string)
2743 - "x509_dname": TLS dname (json-string, optional)
2744 - "sasl_username": SASL username (json-string, optional)
2748 -> { "execute": "query-vnc" }
2769 .name = "query-vnc",
2771 .mhandler.cmd_new = qmp_marshal_input_query_vnc,
2778 Show SPICE server information.
2780 Return a json-object with server information. Connected clients are returned
2781 as a json-array of json-objects.
2783 The main json-object contains the following:
2785 - "enabled": true or false (json-bool)
2786 - "host": server's IP address (json-string)
2787 - "port": server's port number (json-int, optional)
2788 - "tls-port": server's port number (json-int, optional)
2789 - "auth": authentication method (json-string)
2790 - Possible values: "none", "spice"
2791 - "channels": a json-array of all active channels clients
2793 Channels are described by a json-object, each one contain the following:
2795 - "host": client's IP address (json-string)
2796 - "family": address family (json-string)
2797 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2798 - "port": client's port number (json-string)
2799 - "connection-id": spice connection id. All channels with the same id
2800 belong to the same spice session (json-int)
2801 - "channel-type": channel type. "1" is the main control channel, filter for
2802 this one if you want track spice sessions only (json-int)
2803 - "channel-id": channel id. Usually "0", might be different needed when
2804 multiple channels of the same type exist, such as multiple
2805 display channels in a multihead setup (json-int)
2806 - "tls": whevener the channel is encrypted (json-bool)
2810 -> { "execute": "query-spice" }
2823 "connection-id": 1804289383,
2824 "host": "127.0.0.1",
2832 "connection-id": 1804289383,
2833 "host": "127.0.0.1",
2837 [ ... more channels follow ... ]
2844 #if defined(CONFIG_SPICE)
2846 .name = "query-spice",
2848 .mhandler.cmd_new = qmp_marshal_input_query_spice,
2858 Return a json-object with the following information:
2860 - "name": VM's name (json-string, optional)
2864 -> { "execute": "query-name" }
2865 <- { "return": { "name": "qemu-name" } }
2870 .name = "query-name",
2872 .mhandler.cmd_new = qmp_marshal_input_query_name,
2881 Return a json-object with the following information:
2883 - "UUID": Universally Unique Identifier (json-string)
2887 -> { "execute": "query-uuid" }
2888 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2893 .name = "query-uuid",
2895 .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2899 query-command-line-options
2900 --------------------------
2902 Show command line option schema.
2904 Return a json-array of command line option schema for all options (or for
2905 the given option), returning an error if the given option doesn't exist.
2907 Each array entry contains the following:
2909 - "option": option name (json-string)
2910 - "parameters": a json-array describes all parameters of the option:
2911 - "name": parameter name (json-string)
2912 - "type": parameter type (one of 'string', 'boolean', 'number',
2914 - "help": human readable description of the parameter
2915 (json-string, optional)
2916 - "default": default value string for the parameter
2917 (json-string, optional)
2921 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
2930 "name": "bootindex",
2934 "option": "option-rom"
2942 .name = "query-command-line-options",
2943 .args_type = "option:s?",
2944 .mhandler.cmd_new = qmp_marshal_input_query_command_line_options,
2953 Return a json-object. If migration is active there will be another json-object
2954 with RAM migration status and if block migration is active another one with
2955 block migration status.
2957 The main json-object contains the following:
2959 - "status": migration status (json-string)
2960 - Possible values: "setup", "active", "completed", "failed", "cancelled"
2961 - "total-time": total amount of ms since migration started. If
2962 migration has ended, it returns the total migration
2964 - "setup-time" amount of setup time in milliseconds _before_ the
2965 iterations begin but _after_ the QMP command is issued.
2966 This is designed to provide an accounting of any activities
2967 (such as RDMA pinning) which may be expensive, but do not
2968 actually occur during the iterative migration rounds
2969 themselves. (json-int)
2970 - "downtime": only present when migration has finished correctly
2971 total amount in ms for downtime that happened (json-int)
2972 - "expected-downtime": only present while migration is active
2973 total amount in ms for downtime that was calculated on
2974 the last bitmap round (json-int)
2975 - "ram": only present if "status" is "active", it is a json-object with the
2976 following RAM information:
2977 - "transferred": amount transferred in bytes (json-int)
2978 - "remaining": amount remaining to transfer in bytes (json-int)
2979 - "total": total amount of memory in bytes (json-int)
2980 - "duplicate": number of pages filled entirely with the same
2982 These are sent over the wire much more efficiently.
2983 - "skipped": number of skipped zero pages (json-int)
2984 - "normal" : number of whole pages transferred. I.e. they
2985 were not sent as duplicate or xbzrle pages (json-int)
2986 - "normal-bytes" : number of bytes transferred in whole
2987 pages. This is just normal pages times size of one page,
2988 but this way upper levels don't need to care about page
2990 - "dirty-sync-count": times that dirty ram was synchronized (json-int)
2991 - "disk": only present if "status" is "active" and it is a block migration,
2992 it is a json-object with the following disk information:
2993 - "transferred": amount transferred in bytes (json-int)
2994 - "remaining": amount remaining to transfer in bytes json-int)
2995 - "total": total disk size in bytes (json-int)
2996 - "xbzrle-cache": only present if XBZRLE is active.
2997 It is a json-object with the following XBZRLE information:
2998 - "cache-size": XBZRLE cache size in bytes
2999 - "bytes": number of bytes transferred for XBZRLE compressed pages
3000 - "pages": number of XBZRLE compressed pages
3001 - "cache-miss": number of XBRZRLE page cache misses
3002 - "cache-miss-rate": rate of XBRZRLE page cache misses
3003 - "overflow": number of times XBZRLE overflows. This means
3004 that the XBZRLE encoding was bigger than just sent the
3005 whole page, and then we sent the whole page instead (as as
3010 1. Before the first migration
3012 -> { "execute": "query-migrate" }
3015 2. Migration is done and has succeeded
3017 -> { "execute": "query-migrate" }
3019 "status": "completed",
3029 "normal-bytes":123456,
3030 "dirty-sync-count":15
3035 3. Migration is done and has failed
3037 -> { "execute": "query-migrate" }
3038 <- { "return": { "status": "failed" } }
3040 4. Migration is being performed and is not a block migration:
3042 -> { "execute": "query-migrate" }
3052 "expected-downtime":12345,
3055 "normal-bytes":123456,
3056 "dirty-sync-count":15
3061 5. Migration is being performed and is a block migration:
3063 -> { "execute": "query-migrate" }
3069 "remaining":1053304,
3073 "expected-downtime":12345,
3076 "normal-bytes":123456,
3077 "dirty-sync-count":15
3081 "remaining":20880384,
3087 6. Migration is being performed and XBZRLE is active:
3089 -> { "execute": "query-migrate" }
3093 "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
3096 "remaining":1053304,
3100 "expected-downtime":12345,
3103 "normal-bytes":3412992,
3104 "dirty-sync-count":15
3107 "cache-size":67108864,
3111 "cache-miss-rate":0.123,
3120 .name = "query-migrate",
3122 .mhandler.cmd_new = qmp_marshal_input_query_migrate,
3126 migrate-set-capabilities
3127 ------------------------
3129 Enable/Disable migration capabilities
3131 - "xbzrle": XBZRLE support
3137 -> { "execute": "migrate-set-capabilities" , "arguments":
3138 { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
3143 .name = "migrate-set-capabilities",
3144 .args_type = "capabilities:O",
3145 .params = "capability:s,state:b",
3146 .mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
3149 query-migrate-capabilities
3150 --------------------------
3152 Query current migration capabilities
3154 - "capabilities": migration capabilities state
3155 - "xbzrle" : XBZRLE state (json-bool)
3161 -> { "execute": "query-migrate-capabilities" }
3162 <- { "return": [ { "state": false, "capability": "xbzrle" } ] }
3167 .name = "query-migrate-capabilities",
3169 .mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
3176 Show balloon information.
3178 Make an asynchronous request for balloon info. When the request completes a
3179 json-object will be returned containing the following data:
3181 - "actual": current balloon value in bytes (json-int)
3185 -> { "execute": "query-balloon" }
3188 "actual":1073741824,
3195 .name = "query-balloon",
3197 .mhandler.cmd_new = qmp_marshal_input_query_balloon,
3201 .name = "query-block-jobs",
3203 .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
3208 .args_type = "path:s",
3209 .mhandler.cmd_new = qmp_marshal_input_qom_list,
3214 .args_type = "path:s,property:s,value:q",
3215 .mhandler.cmd_new = qmp_qom_set,
3220 .args_type = "path:s,property:s",
3221 .mhandler.cmd_new = qmp_qom_get,
3225 .name = "nbd-server-start",
3226 .args_type = "addr:q",
3227 .mhandler.cmd_new = qmp_marshal_input_nbd_server_start,
3230 .name = "nbd-server-add",
3231 .args_type = "device:B,writable:b?",
3232 .mhandler.cmd_new = qmp_marshal_input_nbd_server_add,
3235 .name = "nbd-server-stop",
3237 .mhandler.cmd_new = qmp_marshal_input_nbd_server_stop,
3241 .name = "change-vnc-password",
3242 .args_type = "password:s",
3243 .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
3246 .name = "qom-list-types",
3247 .args_type = "implements:s?,abstract:b?",
3248 .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
3252 .name = "device-list-properties",
3253 .args_type = "typename:s",
3254 .mhandler.cmd_new = qmp_marshal_input_device_list_properties,
3258 .name = "query-machines",
3260 .mhandler.cmd_new = qmp_marshal_input_query_machines,
3264 .name = "query-cpu-definitions",
3266 .mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
3270 .name = "query-target",
3272 .mhandler.cmd_new = qmp_marshal_input_query_target,
3276 .name = "query-tpm",
3278 .mhandler.cmd_new = qmp_marshal_input_query_tpm,
3285 Return information about the TPM device.
3291 -> { "execute": "query-tpm" }
3294 { "model": "tpm-tis",
3296 { "type": "passthrough",
3298 { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3310 .name = "query-tpm-models",
3312 .mhandler.cmd_new = qmp_marshal_input_query_tpm_models,
3319 Return a list of supported TPM models.
3325 -> { "execute": "query-tpm-models" }
3326 <- { "return": [ "tpm-tis" ] }
3331 .name = "query-tpm-types",
3333 .mhandler.cmd_new = qmp_marshal_input_query_tpm_types,
3340 Return a list of supported TPM types.
3346 -> { "execute": "query-tpm-types" }
3347 <- { "return": [ "passthrough" ] }
3352 .name = "chardev-add",
3353 .args_type = "id:s,backend:q",
3354 .mhandler.cmd_new = qmp_marshal_input_chardev_add,
3365 - "id": the chardev's ID, must be unique (json-string)
3366 - "backend": chardev backend type + parameters
3370 -> { "execute" : "chardev-add",
3371 "arguments" : { "id" : "foo",
3372 "backend" : { "type" : "null", "data" : {} } } }
3375 -> { "execute" : "chardev-add",
3376 "arguments" : { "id" : "bar",
3377 "backend" : { "type" : "file",
3378 "data" : { "out" : "/tmp/bar.log" } } } }
3381 -> { "execute" : "chardev-add",
3382 "arguments" : { "id" : "baz",
3383 "backend" : { "type" : "pty", "data" : {} } } }
3384 <- { "return": { "pty" : "/dev/pty/42" } }
3389 .name = "chardev-remove",
3390 .args_type = "id:s",
3391 .mhandler.cmd_new = qmp_marshal_input_chardev_remove,
3403 - "id": the chardev's ID, must exist and not be in use (json-string)
3407 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
3412 .name = "query-rx-filter",
3413 .args_type = "name:s?",
3414 .mhandler.cmd_new = qmp_marshal_input_query_rx_filter,
3421 Show rx-filter information.
3423 Returns a json-array of rx-filter information for all NICs (or for the
3424 given NIC), returning an error if the given NIC doesn't exist, or
3425 given NIC doesn't support rx-filter querying, or given net client
3428 The query will clear the event notification flag of each NIC, then qemu
3429 will start to emit event to QMP monitor.
3431 Each array entry contains the following:
3433 - "name": net client name (json-string)
3434 - "promiscuous": promiscuous mode is enabled (json-bool)
3435 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
3436 - "unicast": unicast receive state (one of 'normal', 'none', 'all')
3437 - "vlan": vlan receive state (one of 'normal', 'none', 'all') (Since 2.0)
3438 - "broadcast-allowed": allow to receive broadcast (json-bool)
3439 - "multicast-overflow": multicast table is overflowed (json-bool)
3440 - "unicast-overflow": unicast table is overflowed (json-bool)
3441 - "main-mac": main macaddr string (json-string)
3442 - "vlan-table": a json-array of active vlan id
3443 - "unicast-table": a json-array of unicast macaddr string
3444 - "multicast-table": a json-array of multicast macaddr string
3448 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
3451 "promiscuous": true,
3453 "main-mac": "52:54:00:12:34:56",
3454 "unicast": "normal",
3462 "multicast": "normal",
3463 "multicast-overflow": false,
3464 "unicast-overflow": false,
3465 "multicast-table": [
3466 "01:00:5e:00:00:01",
3467 "33:33:00:00:00:01",
3470 "broadcast-allowed": false
3478 .name = "blockdev-add",
3479 .args_type = "options:q",
3480 .mhandler.cmd_new = qmp_marshal_input_blockdev_add,
3491 - "options": block driver options
3495 -> { "execute": "blockdev-add",
3496 "arguments": { "options" : { "driver": "qcow2",
3497 "file": { "driver": "file",
3498 "filename": "test.qcow2" } } } }
3503 -> { "execute": "blockdev-add",
3515 "filename": "/tmp/test.qcow2"
3521 "filename": "/dev/fdset/4"
3533 .name = "query-named-block-nodes",
3535 .mhandler.cmd_new = qmp_marshal_input_query_named_block_nodes,
3539 @query-named-block-nodes
3540 ------------------------
3542 Return a list of BlockDeviceInfo for all the named block driver nodes
3546 -> { "execute": "query-named-block-nodes" }
3547 <- { "return": [ { "ro":false,
3550 "file":"disks/test.qcow2",
3551 "node-name": "my-node",
3552 "backing_file_depth":1,
3567 "filename":"disks/test.qcow2",
3569 "virtual-size":2048000,
3570 "backing_file":"base.qcow2",
3571 "full-backing-filename":"disks/base.qcow2",
3572 "backing-filename-format:"qcow2",
3576 "name": "snapshot1",
3578 "date-sec": 10000200,
3580 "vm-clock-sec": 206,
3585 "filename":"disks/base.qcow2",
3587 "virtual-size":2048000
3594 .name = "query-memdev",
3596 .mhandler.cmd_new = qmp_marshal_input_query_memdev,
3603 Show memory devices information.
3608 -> { "execute": "query-memdev" }
3615 "host-nodes": [0, 1],
3623 "host-nodes": [2, 3],
3624 "policy": "preferred"
3632 .name = "query-memory-devices",
3634 .mhandler.cmd_new = qmp_marshal_input_query_memory_devices,
3638 @query-memory-devices
3639 --------------------
3641 Return a list of memory devices.
3644 -> { "execute": "query-memory-devices" }
3645 <- { "return": [ { "data":
3646 { "addr": 5368709120,
3647 "hotpluggable": true,
3650 "memdev": "/objects/memX",
3659 .name = "query-acpi-ospm-status",
3661 .mhandler.cmd_new = qmp_marshal_input_query_acpi_ospm_status,
3665 @query-acpi-ospm-status
3666 --------------------
3668 Return list of ACPIOSTInfo for devices that support status reporting
3669 via ACPI _OST method.
3672 -> { "execute": "query-acpi-ospm-status" }
3673 <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
3674 { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
3675 { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
3676 { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
3680 #if defined TARGET_I386
3682 .name = "rtc-reset-reinjection",
3684 .mhandler.cmd_new = qmp_marshal_input_rtc_reset_reinjection,
3689 rtc-reset-reinjection
3690 ---------------------
3692 Reset the RTC interrupt reinjection backlog.
3698 -> { "execute": "rtc-reset-reinjection" }