1 HXCOMM QMP dispatch table and documentation
2 HXCOMM Text between SQMP and EQMP is copied to the QMP documentation 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_quit,
79 -> { "execute": "quit" }
86 .args_type = "force:-f,device:B",
87 .mhandler.cmd_new = qmp_marshal_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_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_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_stop,
185 -> { "execute": "stop" }
193 .mhandler.cmd_new = qmp_marshal_cont,
206 -> { "execute": "cont" }
212 .name = "system_wakeup",
214 .mhandler.cmd_new = qmp_marshal_system_wakeup,
221 Wakeup guest from suspend.
227 -> { "execute": "system_wakeup" }
233 .name = "system_reset",
235 .mhandler.cmd_new = qmp_marshal_system_reset,
248 -> { "execute": "system_reset" }
254 .name = "system_powerdown",
256 .mhandler.cmd_new = qmp_marshal_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 .mhandler.cmd_new = qmp_device_add,
290 - "driver": the name of the new device's driver (json-string)
291 - "bus": the device's parent bus (device tree path, json-string, optional)
292 - "id": the device's ID, must be unique (json-string)
297 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
302 (1) For detailed information about this command, please refer to the
303 'docs/qdev-device-use.txt' file.
305 (2) It's possible to list device properties by running QEMU with the
306 "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
311 .name = "device_del",
313 .mhandler.cmd_new = qmp_marshal_device_del,
324 - "id": the device's ID or QOM path (json-string)
328 -> { "execute": "device_del", "arguments": { "id": "net1" } }
333 -> { "execute": "device_del", "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
340 .args_type = "keys:q,hold-time:i?",
341 .mhandler.cmd_new = qmp_marshal_send_key,
353 - "key": key sequence (a json-array of key union values,
354 union can be number or qcode enum)
356 - hold-time: time to delay key up events, milliseconds. Defaults to 100
361 -> { "execute": "send-key",
362 "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
363 { "type": "qcode", "data": "alt" },
364 { "type": "qcode", "data": "delete" } ] } }
371 .args_type = "index:i",
372 .mhandler.cmd_new = qmp_marshal_cpu,
383 - "index": the CPU's index (json-int)
387 -> { "execute": "cpu", "arguments": { "index": 0 } }
390 Note: CPUs' indexes are obtained with the 'query-cpus' command.
397 .mhandler.cmd_new = qmp_marshal_cpu_add,
408 - "id": cpu id (json-int)
412 -> { "execute": "cpu-add", "arguments": { "id": 2 } }
419 .args_type = "val:l,size:i,filename:s,cpu:i?",
420 .mhandler.cmd_new = qmp_marshal_memsave,
427 Save to disk virtual memory dump starting at 'val' of size 'size'.
431 - "val": the starting address (json-int)
432 - "size": the memory size, in bytes (json-int)
433 - "filename": file path (json-string)
434 - "cpu": virtual CPU index (json-int, optional)
438 -> { "execute": "memsave",
439 "arguments": { "val": 10,
441 "filename": "/tmp/virtual-mem-dump" } }
448 .args_type = "val:l,size:i,filename:s",
449 .mhandler.cmd_new = qmp_marshal_pmemsave,
456 Save to disk physical memory dump starting at 'val' of size 'size'.
460 - "val": the starting address (json-int)
461 - "size": the memory size, in bytes (json-int)
462 - "filename": file path (json-string)
466 -> { "execute": "pmemsave",
467 "arguments": { "val": 10,
469 "filename": "/tmp/physical-mem-dump" } }
475 .name = "inject-nmi",
477 .mhandler.cmd_new = qmp_marshal_inject_nmi,
484 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
490 -> { "execute": "inject-nmi" }
493 Note: inject-nmi fails when the guest doesn't support injecting.
498 .name = "ringbuf-write",
499 .args_type = "device:s,data:s,format:s?",
500 .mhandler.cmd_new = qmp_marshal_ringbuf_write,
507 Write to a ring buffer character device.
511 - "device": ring buffer character device name (json-string)
512 - "data": data to write (json-string)
513 - "format": data format (json-string, optional)
514 - Possible values: "utf8" (default), "base64"
518 -> { "execute": "ringbuf-write",
519 "arguments": { "device": "foo",
527 .name = "ringbuf-read",
528 .args_type = "device:s,size:i,format:s?",
529 .mhandler.cmd_new = qmp_marshal_ringbuf_read,
536 Read from a ring buffer character device.
540 - "device": ring buffer character device name (json-string)
541 - "size": how many bytes to read at most (json-int)
542 - Number of data bytes, not number of characters in encoded data
543 - "format": data format (json-string, optional)
544 - Possible values: "utf8" (default), "base64"
545 - Naturally, format "utf8" works only when the ring buffer
546 contains valid UTF-8 text. Invalid UTF-8 sequences get
547 replaced. Bug: replacement doesn't work. Bug: can screw
548 up on encountering NUL characters, after the ring buffer
549 lost data, and when reading stops because the size limit
554 -> { "execute": "ringbuf-read",
555 "arguments": { "device": "foo",
558 <- {"return": "abcdefgh"}
563 .name = "xen-save-devices-state",
564 .args_type = "filename:F",
565 .mhandler.cmd_new = qmp_marshal_xen_save_devices_state,
569 xen-save-devices-state
572 Save the state of all devices to file. The RAM and the block devices
573 of the VM are not saved by this command.
577 - "filename": the file to save the state of the devices to as binary
578 data. See xen-save-devices-state.txt for a description of the binary
583 -> { "execute": "xen-save-devices-state",
584 "arguments": { "filename": "/tmp/save" } }
590 .name = "xen-load-devices-state",
591 .args_type = "filename:F",
592 .mhandler.cmd_new = qmp_marshal_xen_load_devices_state,
596 xen-load-devices-state
597 ----------------------
599 Load the state of all devices from file. The RAM and the block devices
600 of the VM are not loaded by this command.
604 - "filename": the file to load the state of the devices from as binary
605 data. See xen-save-devices-state.txt for a description of the binary
610 -> { "execute": "xen-load-devices-state",
611 "arguments": { "filename": "/tmp/resume" } }
617 .name = "xen-set-global-dirty-log",
618 .args_type = "enable:b",
619 .mhandler.cmd_new = qmp_marshal_xen_set_global_dirty_log,
623 xen-set-global-dirty-log
626 Enable or disable the global dirty log mode.
630 - "enable": Enable it or disable it.
634 -> { "execute": "xen-set-global-dirty-log",
635 "arguments": { "enable": true } }
642 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
643 .mhandler.cmd_new = qmp_marshal_migrate,
654 - "blk": block migration, full disk copy (json-bool, optional)
655 - "inc": incremental disk copy (json-bool, optional)
656 - "uri": Destination URI (json-string)
660 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
665 (1) The 'query-migrate' command should be used to check migration's progress
666 and final result (this information is provided by the 'status' member)
667 (2) All boolean arguments default to false
668 (3) The user Monitor's "detach" argument is invalid in QMP and should not
674 .name = "migrate_cancel",
676 .mhandler.cmd_new = qmp_marshal_migrate_cancel,
683 Cancel the current migration.
689 -> { "execute": "migrate_cancel" }
695 .name = "migrate-incoming",
696 .args_type = "uri:s",
697 .mhandler.cmd_new = qmp_marshal_migrate_incoming,
704 Continue an incoming migration
708 - "uri": Source/listening URI (json-string)
712 -> { "execute": "migrate-incoming", "arguments": { "uri": "tcp::4446" } }
717 (1) QEMU must be started with -incoming defer to allow migrate-incoming to
719 (2) The uri format is the same as for -incoming
723 .name = "migrate-set-cache-size",
724 .args_type = "value:o",
725 .mhandler.cmd_new = qmp_marshal_migrate_set_cache_size,
729 migrate-set-cache-size
730 ----------------------
732 Set cache size to be used by XBZRLE migration, the cache size will be rounded
733 down to the nearest power of 2
737 - "value": cache size in bytes (json-int)
741 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
746 .name = "migrate-start-postcopy",
748 .mhandler.cmd_new = qmp_marshal_migrate_start_postcopy,
752 migrate-start-postcopy
753 ----------------------
755 Switch an in-progress migration to postcopy mode. Ignored after the end of
756 migration (or once already in postcopy).
759 -> { "execute": "migrate-start-postcopy" }
765 .name = "query-migrate-cache-size",
767 .mhandler.cmd_new = qmp_marshal_query_migrate_cache_size,
771 query-migrate-cache-size
772 ------------------------
774 Show cache size to be used by XBZRLE migration
776 returns a json-object with the following information:
781 -> { "execute": "query-migrate-cache-size" }
782 <- { "return": 67108864 }
787 .name = "migrate_set_speed",
788 .args_type = "value:o",
789 .mhandler.cmd_new = qmp_marshal_migrate_set_speed,
796 Set maximum speed for migrations.
800 - "value": maximum speed, in bytes per second (json-int)
804 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
810 .name = "migrate_set_downtime",
811 .args_type = "value:T",
812 .mhandler.cmd_new = qmp_marshal_migrate_set_downtime,
819 Set maximum tolerated downtime (in seconds) for migrations.
823 - "value": maximum downtime (json-number)
827 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
833 .name = "client_migrate_info",
834 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
835 .params = "protocol hostname port tls-port cert-subject",
836 .help = "set migration information for remote display",
837 .mhandler.cmd_new = qmp_marshal_client_migrate_info,
844 Set migration information for remote display. This makes the server
845 ask the client to automatically reconnect using the new parameters
846 once migration finished successfully. Only implemented for SPICE.
850 - "protocol": must be "spice" (json-string)
851 - "hostname": migration target hostname (json-string)
852 - "port": spice tcp port for plaintext channels (json-int, optional)
853 - "tls-port": spice tcp port for tls-secured channels (json-int, optional)
854 - "cert-subject": server certificate subject (json-string, optional)
858 -> { "execute": "client_migrate_info",
859 "arguments": { "protocol": "spice",
860 "hostname": "virt42.lab.kraxel.org",
867 .name = "dump-guest-memory",
868 .args_type = "paging:b,protocol:s,detach:b?,begin:i?,end:i?,format:s?",
869 .params = "-p protocol [-d] [begin] [length] [format]",
870 .help = "dump guest memory to file",
871 .mhandler.cmd_new = qmp_marshal_dump_guest_memory,
878 Dump guest memory to file. The file can be processed with crash or gdb.
882 - "paging": do paging to get guest's memory mapping (json-bool)
883 - "protocol": destination file(started with "file:") or destination file
884 descriptor (started with "fd:") (json-string)
885 - "detach": if specified, command will return immediately, without waiting
886 for the dump to finish. The user can track progress using
887 "query-dump". (json-bool)
888 - "begin": the starting physical address. It's optional, and should be specified
889 with length together (json-int)
890 - "length": the memory size, in bytes. It's optional, and should be specified
891 with begin together (json-int)
892 - "format": the format of guest memory dump. It's optional, and can be
893 elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
894 conflict with paging and filter, ie. begin and length (json-string)
898 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
903 (1) All boolean arguments default to false
908 .name = "query-dump-guest-memory-capability",
910 .mhandler.cmd_new = qmp_marshal_query_dump_guest_memory_capability,
914 query-dump-guest-memory-capability
917 Show available formats for 'dump-guest-memory'
921 -> { "execute": "query-dump-guest-memory-capability" }
922 <- { "return": { "formats":
923 ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
928 .name = "query-dump",
931 .help = "query background dump status",
932 .mhandler.cmd_new = qmp_marshal_query_dump,
939 Query background dump status.
945 -> { "execute": "query-dump" }
946 <- { "return": { "status": "active", "completed": 1024000,
951 #if defined TARGET_S390X
953 .name = "dump-skeys",
954 .args_type = "filename:F",
955 .mhandler.cmd_new = qmp_marshal_dump_skeys,
963 Save guest storage keys to file.
967 - "filename": file path (json-string)
971 -> { "execute": "dump-skeys", "arguments": { "filename": "/tmp/skeys" } }
977 .name = "netdev_add",
978 .args_type = "netdev:O",
979 .mhandler.cmd_new = qmp_netdev_add,
986 Add host network device.
990 - "type": the device type, "tap", "user", ... (json-string)
991 - "id": the device's ID, must be unique (json-string)
996 -> { "execute": "netdev_add",
997 "arguments": { "type": "user", "id": "netdev1",
998 "dnssearch": "example.org" } }
1001 Note: The supported device options are the same ones supported by the '-netdev'
1002 command-line argument, which are listed in the '-help' output or QEMU's
1008 .name = "netdev_del",
1009 .args_type = "id:s",
1010 .mhandler.cmd_new = qmp_marshal_netdev_del,
1017 Remove host network device.
1021 - "id": the device's ID, must be unique (json-string)
1025 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
1032 .name = "object-add",
1033 .args_type = "qom-type:s,id:s,props:q?",
1034 .mhandler.cmd_new = qmp_marshal_object_add,
1045 - "qom-type": the object's QOM type, i.e. the class name (json-string)
1046 - "id": the object's ID, must be unique (json-string)
1047 - "props": a dictionary of object property values (optional, json-dict)
1051 -> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
1052 "props": { "filename": "/dev/hwrng" } } }
1058 .name = "object-del",
1059 .args_type = "id:s",
1060 .mhandler.cmd_new = qmp_marshal_object_del,
1071 - "id": the object's ID (json-string)
1075 -> { "execute": "object-del", "arguments": { "id": "rng1" } }
1083 .name = "block_resize",
1084 .args_type = "device:s?,node-name:s?,size:o",
1085 .mhandler.cmd_new = qmp_marshal_block_resize,
1092 Resize a block image while a guest is running.
1096 - "device": the device's ID, must be unique (json-string)
1097 - "node-name": the node name in the block driver state graph (json-string)
1102 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
1108 .name = "block-stream",
1109 .args_type = "device:B,base:s?,speed:o?,backing-file:s?,on-error:s?",
1110 .mhandler.cmd_new = qmp_marshal_block_stream,
1117 Copy data from a backing file into a block device.
1121 - "device": The device's ID, must be unique (json-string)
1122 - "base": The file name of the backing image above which copying starts
1123 (json-string, optional)
1124 - "backing-file": The backing file string to write into the active layer. This
1125 filename is not validated.
1127 If a pathname string is such that it cannot be resolved by
1128 QEMU, that means that subsequent QMP or HMP commands must use
1129 node-names for the image in question, as filename lookup
1132 If not specified, QEMU will automatically determine the
1133 backing file string to use, or error out if there is no
1134 obvious choice. Care should be taken when specifying the
1135 string, to specify a valid filename or protocol.
1136 (json-string, optional) (Since 2.1)
1137 - "speed": the maximum speed, in bytes per second (json-int, optional)
1138 - "on-error": the action to take on an error (default 'report'). 'stop' and
1139 'enospc' can only be used if the block device supports io-status.
1140 (json-string, optional) (Since 2.1)
1144 -> { "execute": "block-stream", "arguments": { "device": "virtio0",
1145 "base": "/tmp/master.qcow2" } }
1151 .name = "block-commit",
1152 .args_type = "device:B,base:s?,top:s?,backing-file:s?,speed:o?",
1153 .mhandler.cmd_new = qmp_marshal_block_commit,
1160 Live commit of data from overlay image nodes into backing nodes - i.e., writes
1161 data between 'top' and 'base' into 'base'.
1165 - "device": The device's ID, must be unique (json-string)
1166 - "base": The file name of the backing image to write data into.
1167 If not specified, this is the deepest backing image
1168 (json-string, optional)
1169 - "top": The file name of the backing image within the image chain,
1170 which contains the topmost data to be committed down. If
1171 not specified, this is the active layer. (json-string, optional)
1173 - backing-file: The backing file string to write into the overlay
1174 image of 'top'. If 'top' is the active layer,
1175 specifying a backing file string is an error. This
1176 filename is not validated.
1178 If a pathname string is such that it cannot be
1179 resolved by QEMU, that means that subsequent QMP or
1180 HMP commands must use node-names for the image in
1181 question, as filename lookup methods will fail.
1183 If not specified, QEMU will automatically determine
1184 the backing file string to use, or error out if
1185 there is no obvious choice. Care should be taken
1186 when specifying the string, to specify a valid
1187 filename or protocol.
1188 (json-string, optional) (Since 2.1)
1190 If top == base, that is an error.
1191 If top == active, the job will not be completed by itself,
1192 user needs to complete the job with the block-job-complete
1193 command after getting the ready event. (Since 2.0)
1195 If the base image is smaller than top, then the base image
1196 will be resized to be the same size as top. If top is
1197 smaller than the base image, the base will not be
1198 truncated. If you want the base image size to match the
1199 size of the smaller top, you can safely truncate it
1200 yourself once the commit operation successfully completes.
1202 - "speed": the maximum speed, in bytes per second (json-int, optional)
1207 -> { "execute": "block-commit", "arguments": { "device": "virtio0",
1208 "top": "/tmp/snap1.qcow2" } }
1214 .name = "drive-backup",
1215 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1216 "bitmap:s?,on-source-error:s?,on-target-error:s?",
1217 .mhandler.cmd_new = qmp_marshal_drive_backup,
1224 Start a point-in-time copy of a block device to a new destination. The
1225 status of ongoing drive-backup operations can be checked with
1226 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1227 The operation can be stopped before it has completed using the
1228 block-job-cancel command.
1232 - "device": the name of the device which should be copied.
1234 - "target": the target of the new image. If the file exists, or if it is a
1235 device, the existing file/device will be used as the new
1236 destination. If it does not exist, a new file will be created.
1238 - "format": the format of the new destination, default is to probe if 'mode' is
1239 'existing', else the format of the source
1240 (json-string, optional)
1241 - "sync": what parts of the disk image should be copied to the destination;
1242 possibilities include "full" for all the disk, "top" for only the sectors
1243 allocated in the topmost image, "incremental" for only the dirty sectors in
1244 the bitmap, or "none" to only replicate new I/O (MirrorSyncMode).
1245 - "bitmap": dirty bitmap name for sync==incremental. Must be present if sync
1246 is "incremental", must NOT be present otherwise.
1247 - "mode": whether and how QEMU should create a new image
1248 (NewImageMode, optional, default 'absolute-paths')
1249 - "speed": the maximum speed, in bytes per second (json-int, optional)
1250 - "on-source-error": the action to take on an error on the source, default
1251 'report'. 'stop' and 'enospc' can only be used
1252 if the block device supports io-status.
1253 (BlockdevOnError, optional)
1254 - "on-target-error": the action to take on an error on the target, default
1255 'report' (no limitations, since this applies to
1256 a different block device than device).
1257 (BlockdevOnError, optional)
1260 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
1262 "target": "backup.img" } }
1268 .name = "blockdev-backup",
1269 .args_type = "sync:s,device:B,target:B,speed:i?,"
1270 "on-source-error:s?,on-target-error:s?",
1271 .mhandler.cmd_new = qmp_marshal_blockdev_backup,
1278 The device version of drive-backup: this command takes an existing named device
1283 - "device": the name of the device which should be copied.
1285 - "target": the name of the backup target device. (json-string)
1286 - "sync": what parts of the disk image should be copied to the destination;
1287 possibilities include "full" for all the disk, "top" for only the
1288 sectors allocated in the topmost image, or "none" to only replicate
1289 new I/O (MirrorSyncMode).
1290 - "speed": the maximum speed, in bytes per second (json-int, optional)
1291 - "on-source-error": the action to take on an error on the source, default
1292 'report'. 'stop' and 'enospc' can only be used
1293 if the block device supports io-status.
1294 (BlockdevOnError, optional)
1295 - "on-target-error": the action to take on an error on the target, default
1296 'report' (no limitations, since this applies to
1297 a different block device than device).
1298 (BlockdevOnError, optional)
1301 -> { "execute": "blockdev-backup", "arguments": { "device": "src-id",
1303 "target": "tgt-id" } }
1309 .name = "block-job-set-speed",
1310 .args_type = "device:B,speed:o",
1311 .mhandler.cmd_new = qmp_marshal_block_job_set_speed,
1315 .name = "block-job-cancel",
1316 .args_type = "device:B,force:b?",
1317 .mhandler.cmd_new = qmp_marshal_block_job_cancel,
1320 .name = "block-job-pause",
1321 .args_type = "device:B",
1322 .mhandler.cmd_new = qmp_marshal_block_job_pause,
1325 .name = "block-job-resume",
1326 .args_type = "device:B",
1327 .mhandler.cmd_new = qmp_marshal_block_job_resume,
1330 .name = "block-job-complete",
1331 .args_type = "device:B",
1332 .mhandler.cmd_new = qmp_marshal_block_job_complete,
1335 .name = "transaction",
1336 .args_type = "actions:q,properties:q?",
1337 .mhandler.cmd_new = qmp_marshal_transaction,
1344 Atomically operate on one or more block devices. Operations that are
1345 currently supported:
1349 - blockdev-snapshot-sync
1350 - blockdev-snapshot-internal-sync
1352 - block-dirty-bitmap-add
1353 - block-dirty-bitmap-clear
1355 Refer to the qemu/qapi-schema.json file for minimum required QEMU
1356 versions for these operations. A list of dictionaries is accepted,
1357 that contains the actions to be performed. If there is any failure
1358 performing any of the operations, all operations for the group are
1361 For external snapshots, the dictionary contains the device, the file to use for
1362 the new snapshot, and the format. The default format, if not specified, is
1365 Each new snapshot defaults to being created by QEMU (wiping any
1366 contents if the file already exists), but it is also possible to reuse
1367 an externally-created file. In the latter case, you should ensure that
1368 the new image file has the same contents as the current one; QEMU cannot
1369 perform any meaningful check. Typically this is achieved by using the
1370 current image file as the backing file for the new image.
1372 On failure, the original disks pre-snapshot attempt will be used.
1374 For internal snapshots, the dictionary contains the device and the snapshot's
1375 name. If an internal snapshot matching name already exists, the request will
1376 be rejected. Only some image formats support it, for example, qcow2, rbd,
1379 On failure, qemu will try delete the newly created internal snapshot in the
1380 transaction. When an I/O error occurs during deletion, the user needs to fix
1381 it later with qemu-img or other command.
1386 - "type": the operation to perform (json-string). Possible
1387 values: "drive-backup", "blockdev-backup",
1388 "blockdev-snapshot-sync",
1389 "blockdev-snapshot-internal-sync",
1390 "abort", "block-dirty-bitmap-add",
1391 "block-dirty-bitmap-clear"
1392 - "data": a dictionary. The contents depend on the value
1393 of "type". When "type" is "blockdev-snapshot-sync":
1394 - "device": device name to snapshot (json-string)
1395 - "node-name": graph node name to snapshot (json-string)
1396 - "snapshot-file": name of new image file (json-string)
1397 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1398 - "format": format of new image (json-string, optional)
1399 - "mode": whether and how QEMU should create the snapshot file
1400 (NewImageMode, optional, default "absolute-paths")
1401 When "type" is "blockdev-snapshot-internal-sync":
1402 - "device": device name to snapshot (json-string)
1403 - "name": name of the new snapshot (json-string)
1407 -> { "execute": "transaction",
1408 "arguments": { "actions": [
1409 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
1410 "snapshot-file": "/some/place/my-image",
1411 "format": "qcow2" } },
1412 { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
1413 "snapshot-file": "/some/place/my-image2",
1414 "snapshot-node-name": "node3432",
1416 "format": "qcow2" } },
1417 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
1418 "snapshot-file": "/some/place/my-image2",
1420 "format": "qcow2" } },
1421 { "type": "blockdev-snapshot-internal-sync", "data" : {
1422 "device": "ide-hd2",
1423 "name": "snapshot0" } } ] } }
1429 .name = "block-dirty-bitmap-add",
1430 .args_type = "node:B,name:s,granularity:i?",
1431 .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_add,
1436 block-dirty-bitmap-add
1437 ----------------------
1440 Create a dirty bitmap with a name on the device, and start tracking the writes.
1444 - "node": device/node on which to create dirty bitmap (json-string)
1445 - "name": name of the new dirty bitmap (json-string)
1446 - "granularity": granularity to track writes with (int, optional)
1450 -> { "execute": "block-dirty-bitmap-add", "arguments": { "node": "drive0",
1451 "name": "bitmap0" } }
1457 .name = "block-dirty-bitmap-remove",
1458 .args_type = "node:B,name:s",
1459 .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_remove,
1464 block-dirty-bitmap-remove
1465 -------------------------
1468 Stop write tracking and remove the dirty bitmap that was created with
1469 block-dirty-bitmap-add.
1473 - "node": device/node on which to remove dirty bitmap (json-string)
1474 - "name": name of the dirty bitmap to remove (json-string)
1478 -> { "execute": "block-dirty-bitmap-remove", "arguments": { "node": "drive0",
1479 "name": "bitmap0" } }
1485 .name = "block-dirty-bitmap-clear",
1486 .args_type = "node:B,name:s",
1487 .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_clear,
1492 block-dirty-bitmap-clear
1493 ------------------------
1496 Reset the dirty bitmap associated with a node so that an incremental backup
1497 from this point in time forward will only backup clusters modified after this
1502 - "node": device/node on which to remove dirty bitmap (json-string)
1503 - "name": name of the dirty bitmap to remove (json-string)
1507 -> { "execute": "block-dirty-bitmap-clear", "arguments": { "node": "drive0",
1508 "name": "bitmap0" } }
1514 .name = "blockdev-snapshot-sync",
1515 .args_type = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
1516 .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_sync,
1520 blockdev-snapshot-sync
1521 ----------------------
1523 Synchronous snapshot of a block device. snapshot-file specifies the
1524 target of the new image. If the file exists, or if it is a device, the
1525 snapshot will be created in the existing file/device. If does not
1526 exist, a new file will be created. format specifies the format of the
1527 snapshot image, default is qcow2.
1531 - "device": device name to snapshot (json-string)
1532 - "node-name": graph node name to snapshot (json-string)
1533 - "snapshot-file": name of new image file (json-string)
1534 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1535 - "mode": whether and how QEMU should create the snapshot file
1536 (NewImageMode, optional, default "absolute-paths")
1537 - "format": format of new image (json-string, optional)
1541 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1543 "/some/place/my-image",
1544 "format": "qcow2" } }
1550 .name = "blockdev-snapshot",
1551 .args_type = "node:s,overlay:s",
1552 .mhandler.cmd_new = qmp_marshal_blockdev_snapshot,
1560 Create a snapshot, by installing 'node' as the backing image of
1561 'overlay'. Additionally, if 'node' is associated with a block
1562 device, the block device changes to using 'overlay' as its new active
1567 - "node": device that will have a snapshot created (json-string)
1568 - "overlay": device that will have 'node' as its backing image (json-string)
1572 -> { "execute": "blockdev-add",
1573 "arguments": { "options": { "driver": "qcow2",
1574 "node-name": "node1534",
1575 "file": { "driver": "file",
1576 "filename": "hd1.qcow2" },
1581 -> { "execute": "blockdev-snapshot", "arguments": { "node": "ide-hd0",
1582 "overlay": "node1534" } }
1588 .name = "blockdev-snapshot-internal-sync",
1589 .args_type = "device:B,name:s",
1590 .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_internal_sync,
1594 blockdev-snapshot-internal-sync
1595 -------------------------------
1597 Synchronously take an internal snapshot of a block device when the format of
1598 image used supports it. If the name is an empty string, or a snapshot with
1599 name already exists, the operation will fail.
1603 - "device": device name to snapshot (json-string)
1604 - "name": name of the new snapshot (json-string)
1608 -> { "execute": "blockdev-snapshot-internal-sync",
1609 "arguments": { "device": "ide-hd0",
1610 "name": "snapshot0" }
1617 .name = "blockdev-snapshot-delete-internal-sync",
1618 .args_type = "device:B,id:s?,name:s?",
1620 qmp_marshal_blockdev_snapshot_delete_internal_sync,
1624 blockdev-snapshot-delete-internal-sync
1625 --------------------------------------
1627 Synchronously delete an internal snapshot of a block device when the format of
1628 image used supports it. The snapshot is identified by name or id or both. One
1629 of name or id is required. If the snapshot is not found, the operation will
1634 - "device": device name (json-string)
1635 - "id": ID of the snapshot (json-string, optional)
1636 - "name": name of the snapshot (json-string, optional)
1640 -> { "execute": "blockdev-snapshot-delete-internal-sync",
1641 "arguments": { "device": "ide-hd0",
1642 "name": "snapshot0" }
1646 "name": "snapshot0",
1648 "date-sec": 1000012,
1650 "vm-clock-sec": 100,
1658 .name = "drive-mirror",
1659 .args_type = "job-id:s?,sync:s,device:B,target:s,speed:i?,mode:s?,"
1660 "format:s?,node-name:s?,replaces:s?,"
1661 "on-source-error:s?,on-target-error:s?,"
1663 "granularity:i?,buf-size:i?",
1664 .mhandler.cmd_new = qmp_marshal_drive_mirror,
1671 Start mirroring a block device's writes to a new destination. target
1672 specifies the target of the new image. If the file exists, or if it is
1673 a device, it will be used as the new destination for writes. If it does not
1674 exist, a new file will be created. format specifies the format of the
1675 mirror image, default is to probe if mode='existing', else the format
1680 - "job-id": Identifier for the newly-created block job. If omitted,
1681 the device name will be used. (json-string, optional)
1682 - "device": device name to operate on (json-string)
1683 - "target": name of new image file (json-string)
1684 - "format": format of new image (json-string, optional)
1685 - "node-name": the name of the new block driver state in the node graph
1686 (json-string, optional)
1687 - "replaces": the block driver node name to replace when finished
1688 (json-string, optional)
1689 - "mode": how an image file should be created into the target
1690 file/device (NewImageMode, optional, default 'absolute-paths')
1691 - "speed": maximum speed of the streaming job, in bytes per second
1693 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1694 - "buf-size": maximum amount of data in flight from source to target, in bytes
1695 (json-int, default 10M)
1696 - "sync": what parts of the disk image should be copied to the destination;
1697 possibilities include "full" for all the disk, "top" for only the sectors
1698 allocated in the topmost image, or "none" to only replicate new I/O
1700 - "on-source-error": the action to take on an error on the source
1701 (BlockdevOnError, default 'report')
1702 - "on-target-error": the action to take on an error on the target
1703 (BlockdevOnError, default 'report')
1704 - "unmap": whether the target sectors should be discarded where source has only
1705 zeroes. (json-bool, optional, default true)
1707 The default value of the granularity is the image cluster size clamped
1708 between 4096 and 65536, if the image format defines one. If the format
1709 does not define a cluster size, the default value of the granularity
1715 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1716 "target": "/some/place/my-image",
1718 "format": "qcow2" } }
1724 .name = "blockdev-mirror",
1725 .args_type = "job-id:s?,sync:s,device:B,target:B,replaces:s?,speed:i?,"
1726 "on-source-error:s?,on-target-error:s?,"
1727 "granularity:i?,buf-size:i?",
1728 .mhandler.cmd_new = qmp_marshal_blockdev_mirror,
1735 Start mirroring a block device's writes to another block device. target
1736 specifies the target of mirror operation.
1740 - "job-id": Identifier for the newly-created block job. If omitted,
1741 the device name will be used. (json-string, optional)
1742 - "device": device name to operate on (json-string)
1743 - "target": device name to mirror to (json-string)
1744 - "replaces": the block driver node name to replace when finished
1745 (json-string, optional)
1746 - "speed": maximum speed of the streaming job, in bytes per second
1748 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1749 - "buf_size": maximum amount of data in flight from source to target, in bytes
1750 (json-int, default 10M)
1751 - "sync": what parts of the disk image should be copied to the destination;
1752 possibilities include "full" for all the disk, "top" for only the sectors
1753 allocated in the topmost image, or "none" to only replicate new I/O
1755 - "on-source-error": the action to take on an error on the source
1756 (BlockdevOnError, default 'report')
1757 - "on-target-error": the action to take on an error on the target
1758 (BlockdevOnError, default 'report')
1760 The default value of the granularity is the image cluster size clamped
1761 between 4096 and 65536, if the image format defines one. If the format
1762 does not define a cluster size, the default value of the granularity
1767 -> { "execute": "blockdev-mirror", "arguments": { "device": "ide-hd0",
1768 "target": "target0",
1774 .name = "change-backing-file",
1775 .args_type = "device:s,image-node-name:s,backing-file:s",
1776 .mhandler.cmd_new = qmp_marshal_change_backing_file,
1784 Change the backing file in the image file metadata. This does not cause
1785 QEMU to reopen the image file to reparse the backing filename (it may,
1786 however, perform a reopen to change permissions from r/o -> r/w -> r/o,
1787 if needed). The new backing file string is written into the image file
1788 metadata, and the QEMU internal strings are updated.
1792 - "image-node-name": The name of the block driver state node of the
1793 image to modify. The "device" is argument is used to
1794 verify "image-node-name" is in the chain described by
1796 (json-string, optional)
1798 - "device": The name of the device.
1801 - "backing-file": The string to write as the backing file. This string is
1802 not validated, so care should be taken when specifying
1803 the string or the image chain may not be able to be
1807 Returns: Nothing on success
1808 If "device" does not exist or cannot be determined, DeviceNotFound
1814 .args_type = "value:M",
1815 .mhandler.cmd_new = qmp_marshal_balloon,
1822 Request VM to change its memory allocation (in bytes).
1826 - "value": New memory allocation (json-int)
1830 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1837 .args_type = "name:s,up:b",
1838 .mhandler.cmd_new = qmp_marshal_set_link,
1845 Change the link status of a network adapter.
1849 - "name": network device name (json-string)
1850 - "up": status is up (json-bool)
1854 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1861 .args_type = "fdname:s",
1862 .params = "getfd name",
1863 .help = "receive a file descriptor via SCM rights and assign it a name",
1864 .mhandler.cmd_new = qmp_marshal_getfd,
1871 Receive a file descriptor via SCM rights and assign it a name.
1875 - "fdname": file descriptor name (json-string)
1879 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1884 (1) If the name specified by the "fdname" argument already exists,
1885 the file descriptor assigned to it will be closed and replaced
1886 by the received file descriptor.
1887 (2) The 'closefd' command can be used to explicitly close the file
1888 descriptor when it is no longer needed.
1894 .args_type = "fdname:s",
1895 .params = "closefd name",
1896 .help = "close a file descriptor previously passed via SCM rights",
1897 .mhandler.cmd_new = qmp_marshal_closefd,
1904 Close a file descriptor previously passed via SCM rights.
1908 - "fdname": file descriptor name (json-string)
1912 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1919 .args_type = "fdset-id:i?,opaque:s?",
1920 .params = "add-fd fdset-id opaque",
1921 .help = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1922 .mhandler.cmd_new = qmp_marshal_add_fd,
1929 Add a file descriptor, that was passed via SCM rights, to an fd set.
1933 - "fdset-id": The ID of the fd set to add the file descriptor to.
1934 (json-int, optional)
1935 - "opaque": A free-form string that can be used to describe the fd.
1936 (json-string, optional)
1938 Return a json-object with the following information:
1940 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1941 - "fd": The file descriptor that was received via SCM rights and added to the
1946 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1947 <- { "return": { "fdset-id": 1, "fd": 3 } }
1951 (1) The list of fd sets is shared by all monitor connections.
1952 (2) If "fdset-id" is not specified, a new fd set will be created.
1957 .name = "remove-fd",
1958 .args_type = "fdset-id:i,fd:i?",
1959 .params = "remove-fd fdset-id fd",
1960 .help = "Remove a file descriptor from an fd set",
1961 .mhandler.cmd_new = qmp_marshal_remove_fd,
1968 Remove a file descriptor from an fd set.
1972 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1974 - "fd": The file descriptor that is to be removed. (json-int, optional)
1978 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1983 (1) The list of fd sets is shared by all monitor connections.
1984 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1990 .name = "query-fdsets",
1992 .help = "Return information describing all fd sets",
1993 .mhandler.cmd_new = qmp_marshal_query_fdsets,
2000 Return information describing all fd sets.
2006 -> { "execute": "query-fdsets" }
2012 "opaque": "rdonly:/path/to/file"
2016 "opaque": "rdwr:/path/to/file"
2035 Note: The list of fd sets is shared by all monitor connections.
2040 .name = "block_passwd",
2041 .args_type = "device:s?,node-name:s?,password:s",
2042 .mhandler.cmd_new = qmp_marshal_block_passwd,
2049 Set the password of encrypted block devices.
2053 - "device": device name (json-string)
2054 - "node-name": name in the block driver state graph (json-string)
2055 - "password": password (json-string)
2059 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
2060 "password": "12345" } }
2066 .name = "block_set_io_throttle",
2067 .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?,bps_max_length:l?,bps_rd_max_length:l?,bps_wr_max_length:l?,iops_max_length:l?,iops_rd_max_length:l?,iops_wr_max_length:l?,iops_size:l?,group:s?",
2068 .mhandler.cmd_new = qmp_marshal_block_set_io_throttle,
2072 block_set_io_throttle
2075 Change I/O throttle limits for a block drive.
2079 - "device": device name (json-string)
2080 - "bps": total throughput limit in bytes per second (json-int)
2081 - "bps_rd": read throughput limit in bytes per second (json-int)
2082 - "bps_wr": write throughput limit in bytes per second (json-int)
2083 - "iops": total I/O operations per second (json-int)
2084 - "iops_rd": read I/O operations per second (json-int)
2085 - "iops_wr": write I/O operations per second (json-int)
2086 - "bps_max": total throughput limit during bursts, in bytes (json-int, optional)
2087 - "bps_rd_max": read throughput limit during bursts, in bytes (json-int, optional)
2088 - "bps_wr_max": write throughput limit during bursts, in bytes (json-int, optional)
2089 - "iops_max": total I/O operations per second during bursts (json-int, optional)
2090 - "iops_rd_max": read I/O operations per second during bursts (json-int, optional)
2091 - "iops_wr_max": write I/O operations per second during bursts (json-int, optional)
2092 - "bps_max_length": maximum length of the @bps_max burst period, in seconds (json-int, optional)
2093 - "bps_rd_max_length": maximum length of the @bps_rd_max burst period, in seconds (json-int, optional)
2094 - "bps_wr_max_length": maximum length of the @bps_wr_max burst period, in seconds (json-int, optional)
2095 - "iops_max_length": maximum length of the @iops_max burst period, in seconds (json-int, optional)
2096 - "iops_rd_max_length": maximum length of the @iops_rd_max burst period, in seconds (json-int, optional)
2097 - "iops_wr_max_length": maximum length of the @iops_wr_max burst period, in seconds (json-int, optional)
2098 - "iops_size": I/O size in bytes when limiting (json-int, optional)
2099 - "group": throttle group name (json-string, optional)
2103 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
2116 "bps_max_length": 60,
2123 .name = "set_password",
2124 .args_type = "protocol:s,password:s,connected:s?",
2125 .mhandler.cmd_new = qmp_marshal_set_password,
2132 Set the password for vnc/spice protocols.
2136 - "protocol": protocol name (json-string)
2137 - "password": password (json-string)
2138 - "connected": [ keep | disconnect | fail ] (json-string, optional)
2142 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
2143 "password": "secret" } }
2149 .name = "expire_password",
2150 .args_type = "protocol:s,time:s",
2151 .mhandler.cmd_new = qmp_marshal_expire_password,
2158 Set the password expire time for vnc/spice protocols.
2162 - "protocol": protocol name (json-string)
2163 - "time": [ now | never | +secs | secs ] (json-string)
2167 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
2174 .name = "add_client",
2175 .args_type = "protocol:s,fdname:s,skipauth:b?,tls:b?",
2176 .mhandler.cmd_new = qmp_marshal_add_client,
2183 Add a graphics client
2187 - "protocol": protocol name (json-string)
2188 - "fdname": file descriptor name (json-string)
2189 - "skipauth": whether to skip authentication (json-bool, optional)
2190 - "tls": whether to perform TLS (json-bool, optional)
2194 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
2195 "fdname": "myclient" } }
2200 .name = "qmp_capabilities",
2203 .help = "enable QMP capabilities",
2204 .mhandler.cmd_new = qmp_capabilities,
2211 Enable QMP capabilities.
2217 -> { "execute": "qmp_capabilities" }
2220 Note: This command must be issued before issuing any other command.
2225 .name = "human-monitor-command",
2226 .args_type = "command-line:s,cpu-index:i?",
2227 .mhandler.cmd_new = qmp_marshal_human_monitor_command,
2231 human-monitor-command
2232 ---------------------
2234 Execute a Human Monitor command.
2238 - command-line: the command name and its arguments, just like the
2239 Human Monitor's shell (json-string)
2240 - cpu-index: select the CPU number to be used by commands which access CPU
2241 data, like 'info registers'. The Monitor selects CPU 0 if this
2242 argument is not provided (json-int, optional)
2246 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
2247 <- { "return": "kvm support: enabled\r\n" }
2251 (1) The Human Monitor is NOT an stable interface, this means that command
2252 names, arguments and responses can change or be removed at ANY time.
2253 Applications that rely on long term stability guarantees should NOT
2258 o This command is stateless, this means that commands that depend
2259 on state information (such as getfd) might not work
2261 o Commands that prompt the user for data (eg. 'cont' when the block
2262 device is encrypted) don't currently work
2267 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
2268 HXCOMM this! We will possibly move query commands definitions inside those
2269 HXCOMM sections, just like regular commands.
2279 Return a json-object with the following information:
2281 - "qemu": A json-object containing three integer values:
2282 - "major": QEMU's major version (json-int)
2283 - "minor": QEMU's minor version (json-int)
2284 - "micro": QEMU's micro version (json-int)
2285 - "package": package's version (json-string)
2289 -> { "execute": "query-version" }
2304 .name = "query-version",
2306 .mhandler.cmd_new = qmp_marshal_query_version,
2313 List QMP available commands.
2315 Each command is represented by a json-object, the returned value is a json-array
2318 Each json-object contain:
2320 - "name": command's name (json-string)
2324 -> { "execute": "query-commands" }
2328 "name":"query-balloon"
2331 "name":"system_powerdown"
2336 Note: This example has been shortened as the real response is too long.
2341 .name = "query-commands",
2343 .mhandler.cmd_new = qmp_marshal_query_commands,
2350 List QMP available events.
2352 Each event is represented by a json-object, the returned value is a json-array
2355 Each json-object contains:
2357 - "name": event's name (json-string)
2361 -> { "execute": "query-events" }
2373 Note: This example has been shortened as the real response is too long.
2378 .name = "query-events",
2380 .mhandler.cmd_new = qmp_marshal_query_events,
2387 Return the QMP wire schema. The returned value is a json-array of
2388 named schema entities. Entities are commands, events and various
2389 types. See docs/qapi-code-gen.txt for information on their structure
2395 .name = "query-qmp-schema",
2397 .mhandler.cmd_new = qmp_query_qmp_schema,
2404 Each device is represented by a json-object. The returned value is a json-array
2407 Each json-object contain the following:
2409 - "label": device's label (json-string)
2410 - "filename": device's file (json-string)
2411 - "frontend-open": open/closed state of the frontend device attached to this
2416 -> { "execute": "query-chardev" }
2420 "label": "charchannel0",
2421 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
2422 "frontend-open": false
2425 "label": "charmonitor",
2426 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
2427 "frontend-open": true
2430 "label": "charserial0",
2431 "filename": "pty:/dev/pts/2",
2432 "frontend-open": true
2440 .name = "query-chardev",
2442 .mhandler.cmd_new = qmp_marshal_query_chardev,
2446 query-chardev-backends
2449 List available character device backends.
2451 Each backend is represented by a json-object, the returned value is a json-array
2454 Each json-object contains:
2456 - "name": backend name (json-string)
2460 -> { "execute": "query-chardev-backends" }
2481 .name = "query-chardev-backends",
2483 .mhandler.cmd_new = qmp_marshal_query_chardev_backends,
2490 Show the block devices.
2492 Each block device information is stored in a json-object and the returned value
2493 is a json-array of all devices.
2495 Each json-object contain the following:
2497 - "device": device name (json-string)
2498 - "type": device type (json-string)
2499 - deprecated, retained for backward compatibility
2500 - Possible values: "unknown"
2501 - "removable": true if the device is removable, false otherwise (json-bool)
2502 - "locked": true if the device is locked, false otherwise (json-bool)
2503 - "tray_open": only present if removable, true if the device has a tray,
2504 and it is open (json-bool)
2505 - "inserted": only present if the device is inserted, it is a json-object
2506 containing the following:
2507 - "file": device file name (json-string)
2508 - "ro": true if read-only, false otherwise (json-bool)
2509 - "drv": driver format name (json-string)
2510 - Possible values: "blkdebug", "bochs", "cloop", "dmg",
2511 "file", "file", "ftp", "ftps", "host_cdrom",
2512 "host_device", "http", "https",
2513 "nbd", "parallels", "qcow", "qcow2", "raw",
2514 "tftp", "vdi", "vmdk", "vpc", "vvfat"
2515 - "backing_file": backing file name (json-string, optional)
2516 - "backing_file_depth": number of files in the backing file chain (json-int)
2517 - "encrypted": true if encrypted, false otherwise (json-bool)
2518 - "bps": limit total bytes per second (json-int)
2519 - "bps_rd": limit read bytes per second (json-int)
2520 - "bps_wr": limit write bytes per second (json-int)
2521 - "iops": limit total I/O operations per second (json-int)
2522 - "iops_rd": limit read operations per second (json-int)
2523 - "iops_wr": limit write operations per second (json-int)
2524 - "bps_max": total max in bytes (json-int)
2525 - "bps_rd_max": read max in bytes (json-int)
2526 - "bps_wr_max": write max in bytes (json-int)
2527 - "iops_max": total I/O operations max (json-int)
2528 - "iops_rd_max": read I/O operations max (json-int)
2529 - "iops_wr_max": write I/O operations max (json-int)
2530 - "iops_size": I/O size when limiting by iops (json-int)
2531 - "detect_zeroes": detect and optimize zero writing (json-string)
2532 - Possible values: "off", "on", "unmap"
2533 - "write_threshold": write offset threshold in bytes, a event will be
2534 emitted if crossed. Zero if disabled (json-int)
2535 - "image": the detail of the image, it is a json-object containing
2537 - "filename": image file name (json-string)
2538 - "format": image format (json-string)
2539 - "virtual-size": image capacity in bytes (json-int)
2540 - "dirty-flag": true if image is not cleanly closed, not present
2541 means clean (json-bool, optional)
2542 - "actual-size": actual size on disk in bytes of the image, not
2543 present when image does not support thin
2544 provision (json-int, optional)
2545 - "cluster-size": size of a cluster in bytes, not present if image
2546 format does not support it (json-int, optional)
2547 - "encrypted": true if the image is encrypted, not present means
2548 false or the image format does not support
2549 encryption (json-bool, optional)
2550 - "backing_file": backing file name, not present means no backing
2551 file is used or the image format does not
2552 support backing file chain
2553 (json-string, optional)
2554 - "full-backing-filename": full path of the backing file, not
2555 present if it equals backing_file or no
2556 backing file is used
2557 (json-string, optional)
2558 - "backing-filename-format": the format of the backing file, not
2559 present means unknown or no backing
2560 file (json-string, optional)
2561 - "snapshots": the internal snapshot info, it is an optional list
2562 of json-object containing the following:
2563 - "id": unique snapshot id (json-string)
2564 - "name": snapshot name (json-string)
2565 - "vm-state-size": size of the VM state in bytes (json-int)
2566 - "date-sec": UTC date of the snapshot in seconds (json-int)
2567 - "date-nsec": fractional part in nanoseconds to be used with
2569 - "vm-clock-sec": VM clock relative to boot in seconds
2571 - "vm-clock-nsec": fractional part in nanoseconds to be used
2572 with vm-clock-sec (json-int)
2573 - "backing-image": the detail of the backing image, it is an
2574 optional json-object only present when a
2575 backing image present for this image
2577 - "io-status": I/O operation status, only present if the device supports it
2578 and the VM is configured to stop on errors. It's always reset
2579 to "ok" when the "cont" command is issued (json_string, optional)
2580 - Possible values: "ok", "failed", "nospace"
2584 -> { "execute": "query-block" }
2589 "device":"ide0-hd0",
2596 "file":"disks/test.qcow2",
2597 "backing_file_depth":1,
2611 "detect_zeroes": "on",
2612 "write_threshold": 0,
2614 "filename":"disks/test.qcow2",
2616 "virtual-size":2048000,
2617 "backing_file":"base.qcow2",
2618 "full-backing-filename":"disks/base.qcow2",
2619 "backing-filename-format":"qcow2",
2623 "name": "snapshot1",
2625 "date-sec": 10000200,
2627 "vm-clock-sec": 206,
2632 "filename":"disks/base.qcow2",
2634 "virtual-size":2048000
2642 "device":"ide1-cd0",
2665 .name = "query-block",
2667 .mhandler.cmd_new = qmp_marshal_query_block,
2674 Show block device statistics.
2676 Each device statistic information is stored in a json-object and the returned
2677 value is a json-array of all devices.
2679 Each json-object contain the following:
2681 - "device": device name (json-string)
2682 - "stats": A json-object with the statistics information, it contains:
2683 - "rd_bytes": bytes read (json-int)
2684 - "wr_bytes": bytes written (json-int)
2685 - "rd_operations": read operations (json-int)
2686 - "wr_operations": write operations (json-int)
2687 - "flush_operations": cache flush operations (json-int)
2688 - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2689 - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2690 - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
2691 - "wr_highest_offset": The offset after the greatest byte written to the
2692 BlockDriverState since it has been opened (json-int)
2693 - "rd_merged": number of read requests that have been merged into
2694 another request (json-int)
2695 - "wr_merged": number of write requests that have been merged into
2696 another request (json-int)
2697 - "idle_time_ns": time since the last I/O operation, in
2698 nanoseconds. If the field is absent it means
2699 that there haven't been any operations yet
2700 (json-int, optional)
2701 - "failed_rd_operations": number of failed read operations
2703 - "failed_wr_operations": number of failed write operations
2705 - "failed_flush_operations": number of failed flush operations
2707 - "invalid_rd_operations": number of invalid read operations
2709 - "invalid_wr_operations": number of invalid write operations
2711 - "invalid_flush_operations": number of invalid flush operations
2713 - "account_invalid": whether invalid operations are included in
2714 the last access statistics (json-bool)
2715 - "account_failed": whether failed operations are included in the
2716 latency and last access statistics
2718 - "timed_stats": A json-array containing statistics collected in
2719 specific intervals, with the following members:
2720 - "interval_length": interval used for calculating the
2721 statistics, in seconds (json-int)
2722 - "min_rd_latency_ns": minimum latency of read operations in
2723 the defined interval, in nanoseconds
2725 - "min_wr_latency_ns": minimum latency of write operations in
2726 the defined interval, in nanoseconds
2728 - "min_flush_latency_ns": minimum latency of flush operations
2729 in the defined interval, in
2730 nanoseconds (json-int)
2731 - "max_rd_latency_ns": maximum latency of read operations in
2732 the defined interval, in nanoseconds
2734 - "max_wr_latency_ns": maximum latency of write operations in
2735 the defined interval, in nanoseconds
2737 - "max_flush_latency_ns": maximum latency of flush operations
2738 in the defined interval, in
2739 nanoseconds (json-int)
2740 - "avg_rd_latency_ns": average latency of read operations in
2741 the defined interval, in nanoseconds
2743 - "avg_wr_latency_ns": average latency of write operations in
2744 the defined interval, in nanoseconds
2746 - "avg_flush_latency_ns": average latency of flush operations
2747 in the defined interval, in
2748 nanoseconds (json-int)
2749 - "avg_rd_queue_depth": average number of pending read
2750 operations in the defined interval
2752 - "avg_wr_queue_depth": average number of pending write
2753 operations in the defined interval
2755 - "parent": Contains recursively the statistics of the underlying
2756 protocol (e.g. the host file for a qcow2 image). If there is
2757 no underlying protocol, this field is omitted
2758 (json-object, optional)
2762 -> { "execute": "query-blockstats" }
2766 "device":"ide0-hd0",
2769 "wr_highest_offset":3686448128,
2771 "wr_operations":751,
2772 "rd_bytes":122567168,
2773 "rd_operations":36772
2774 "wr_total_times_ns":313253456
2775 "rd_total_times_ns":3465673657
2776 "flush_total_times_ns":49653
2777 "flush_operations":61,
2780 "idle_time_ns":2953431879,
2781 "account_invalid":true,
2782 "account_failed":false
2786 "wr_highest_offset":2821110784,
2788 "wr_operations":692,
2789 "rd_bytes":122739200,
2790 "rd_operations":36604
2791 "flush_operations":51,
2792 "wr_total_times_ns":313253456
2793 "rd_total_times_ns":3465673657
2794 "flush_total_times_ns":49653,
2797 "idle_time_ns":2953431879,
2798 "account_invalid":true,
2799 "account_failed":false
2803 "device":"ide1-cd0",
2805 "wr_highest_offset":0,
2810 "flush_operations":0,
2811 "wr_total_times_ns":0
2812 "rd_total_times_ns":0
2813 "flush_total_times_ns":0,
2816 "account_invalid":false,
2817 "account_failed":false
2823 "wr_highest_offset":0,
2828 "flush_operations":0,
2829 "wr_total_times_ns":0
2830 "rd_total_times_ns":0
2831 "flush_total_times_ns":0,
2834 "account_invalid":false,
2835 "account_failed":false
2841 "wr_highest_offset":0,
2846 "flush_operations":0,
2847 "wr_total_times_ns":0
2848 "rd_total_times_ns":0
2849 "flush_total_times_ns":0,
2852 "account_invalid":false,
2853 "account_failed":false
2862 .name = "query-blockstats",
2863 .args_type = "query-nodes:b?",
2864 .mhandler.cmd_new = qmp_marshal_query_blockstats,
2871 Show CPU information.
2873 Return a json-array. Each CPU is represented by a json-object, which contains:
2875 - "CPU": CPU index (json-int)
2876 - "current": true if this is the current CPU, false otherwise (json-bool)
2877 - "halted": true if the cpu is halted, false otherwise (json-bool)
2878 - "qom_path": path to the CPU object in the QOM tree (json-str)
2879 - "arch": architecture of the cpu, which determines what additional
2880 keys will be present (json-str)
2881 - Current program counter. The key's name depends on the architecture:
2882 "pc": i386/x86_64 (json-int)
2883 "nip": PPC (json-int)
2884 "pc" and "npc": sparc (json-int)
2885 "PC": mips (json-int)
2886 - "thread_id": ID of the underlying host thread (json-int)
2890 -> { "execute": "query-cpus" }
2897 "qom_path":"/machine/unattached/device[0]",
2906 "qom_path":"/machine/unattached/device[2]",
2917 .name = "query-cpus",
2919 .mhandler.cmd_new = qmp_marshal_query_cpus,
2926 Returns a list of information about each iothread.
2928 Note this list excludes the QEMU main loop thread, which is not declared
2929 using the -object iothread command-line option. It is always the main thread
2932 Return a json-array. Each iothread is represented by a json-object, which contains:
2934 - "id": name of iothread (json-str)
2935 - "thread-id": ID of the underlying host thread (json-int)
2939 -> { "execute": "query-iothreads" }
2956 .name = "query-iothreads",
2958 .mhandler.cmd_new = qmp_marshal_query_iothreads,
2965 PCI buses and devices information.
2967 The returned value is a json-array of all buses. Each bus is represented by
2968 a json-object, which has a key with a json-array of all PCI devices attached
2969 to it. Each device is represented by a json-object.
2971 The bus json-object contains the following:
2973 - "bus": bus number (json-int)
2974 - "devices": a json-array of json-objects, each json-object represents a
2977 The PCI device json-object contains the following:
2979 - "bus": identical to the parent's bus number (json-int)
2980 - "slot": slot number (json-int)
2981 - "function": function number (json-int)
2982 - "class_info": a json-object containing:
2983 - "desc": device class description (json-string, optional)
2984 - "class": device class number (json-int)
2985 - "id": a json-object containing:
2986 - "device": device ID (json-int)
2987 - "vendor": vendor ID (json-int)
2988 - "irq": device's IRQ if assigned (json-int, optional)
2989 - "qdev_id": qdev id string (json-string)
2990 - "pci_bridge": It's a json-object, only present if this device is a
2991 PCI bridge, contains:
2992 - "bus": bus number (json-int)
2993 - "secondary": secondary bus number (json-int)
2994 - "subordinate": subordinate bus number (json-int)
2995 - "io_range": I/O memory range information, a json-object with the
2997 - "base": base address, in bytes (json-int)
2998 - "limit": limit address, in bytes (json-int)
2999 - "memory_range": memory range information, a json-object with the
3001 - "base": base address, in bytes (json-int)
3002 - "limit": limit address, in bytes (json-int)
3003 - "prefetchable_range": Prefetchable memory range information, a
3004 json-object with the following members:
3005 - "base": base address, in bytes (json-int)
3006 - "limit": limit address, in bytes (json-int)
3007 - "devices": a json-array of PCI devices if there's any attached, each
3008 each element is represented by a json-object, which contains
3009 the same members of the 'PCI device json-object' described
3011 - "regions": a json-array of json-objects, each json-object represents a
3012 memory region of this device
3014 The memory range json-object contains the following:
3016 - "base": base memory address (json-int)
3017 - "limit": limit value (json-int)
3019 The region json-object can be an I/O region or a memory region, an I/O region
3020 json-object contains the following:
3022 - "type": "io" (json-string, fixed)
3023 - "bar": BAR number (json-int)
3024 - "address": memory address (json-int)
3025 - "size": memory size (json-int)
3027 A memory region json-object contains the following:
3029 - "type": "memory" (json-string, fixed)
3030 - "bar": BAR number (json-int)
3031 - "address": memory address (json-int)
3032 - "size": memory size (json-int)
3033 - "mem_type_64": true or false (json-bool)
3034 - "prefetch": true or false (json-bool)
3038 -> { "execute": "query-pci" }
3050 "desc":"Host bridge"
3084 "desc":"IDE controller"
3106 "desc":"VGA controller"
3116 "mem_type_64":false,
3119 "address":4026531840,
3124 "mem_type_64":false,
3127 "address":4060086272,
3132 "mem_type_64":false,
3147 "desc":"RAM controller"
3168 Note: This example has been shortened as the real response is too long.
3173 .name = "query-pci",
3175 .mhandler.cmd_new = qmp_marshal_query_pci,
3182 Show KVM information.
3184 Return a json-object with the following information:
3186 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
3187 - "present": true if QEMU has KVM support, false otherwise (json-bool)
3191 -> { "execute": "query-kvm" }
3192 <- { "return": { "enabled": true, "present": true } }
3197 .name = "query-kvm",
3199 .mhandler.cmd_new = qmp_marshal_query_kvm,
3206 Return a json-object with the following information:
3208 - "running": true if the VM is running, or false if it is paused (json-bool)
3209 - "singlestep": true if the VM is in single step mode,
3210 false otherwise (json-bool)
3211 - "status": one of the following values (json-string)
3212 "debug" - QEMU is running on a debugger
3213 "inmigrate" - guest is paused waiting for an incoming migration
3214 "internal-error" - An internal error that prevents further guest
3215 execution has occurred
3216 "io-error" - the last IOP has failed and the device is configured
3217 to pause on I/O errors
3218 "paused" - guest has been paused via the 'stop' command
3219 "postmigrate" - guest is paused following a successful 'migrate'
3220 "prelaunch" - QEMU was started with -S and guest has not started
3221 "finish-migrate" - guest is paused to finish the migration process
3222 "restore-vm" - guest is paused to restore VM state
3223 "running" - guest is actively running
3224 "save-vm" - guest is paused to save the VM state
3225 "shutdown" - guest is shut down (and -no-shutdown is in use)
3226 "watchdog" - the watchdog action is configured to pause and
3231 -> { "execute": "query-status" }
3232 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
3237 .name = "query-status",
3239 .mhandler.cmd_new = qmp_marshal_query_status,
3246 Show VM mice information.
3248 Each mouse is represented by a json-object, the returned value is a json-array
3251 The mouse json-object contains the following:
3253 - "name": mouse's name (json-string)
3254 - "index": mouse's index (json-int)
3255 - "current": true if this mouse is receiving events, false otherwise (json-bool)
3256 - "absolute": true if the mouse generates absolute input events (json-bool)
3260 -> { "execute": "query-mice" }
3264 "name":"QEMU Microsoft Mouse",
3270 "name":"QEMU PS/2 Mouse",
3281 .name = "query-mice",
3283 .mhandler.cmd_new = qmp_marshal_query_mice,
3290 Show VNC server information.
3292 Return a json-object with server information. Connected clients are returned
3293 as a json-array of json-objects.
3295 The main json-object contains the following:
3297 - "enabled": true or false (json-bool)
3298 - "host": server's IP address (json-string)
3299 - "family": address family (json-string)
3300 - Possible values: "ipv4", "ipv6", "unix", "unknown"
3301 - "service": server's port number (json-string)
3302 - "auth": authentication method (json-string)
3303 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
3304 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
3305 "vencrypt+plain", "vencrypt+tls+none",
3306 "vencrypt+tls+plain", "vencrypt+tls+sasl",
3307 "vencrypt+tls+vnc", "vencrypt+x509+none",
3308 "vencrypt+x509+plain", "vencrypt+x509+sasl",
3309 "vencrypt+x509+vnc", "vnc"
3310 - "clients": a json-array of all connected clients
3312 Clients are described by a json-object, each one contain the following:
3314 - "host": client's IP address (json-string)
3315 - "family": address family (json-string)
3316 - Possible values: "ipv4", "ipv6", "unix", "unknown"
3317 - "service": client's port number (json-string)
3318 - "x509_dname": TLS dname (json-string, optional)
3319 - "sasl_username": SASL username (json-string, optional)
3323 -> { "execute": "query-vnc" }
3344 .name = "query-vnc",
3346 .mhandler.cmd_new = qmp_marshal_query_vnc,
3349 .name = "query-vnc-servers",
3351 .mhandler.cmd_new = qmp_marshal_query_vnc_servers,
3358 Show SPICE server information.
3360 Return a json-object with server information. Connected clients are returned
3361 as a json-array of json-objects.
3363 The main json-object contains the following:
3365 - "enabled": true or false (json-bool)
3366 - "host": server's IP address (json-string)
3367 - "port": server's port number (json-int, optional)
3368 - "tls-port": server's port number (json-int, optional)
3369 - "auth": authentication method (json-string)
3370 - Possible values: "none", "spice"
3371 - "channels": a json-array of all active channels clients
3373 Channels are described by a json-object, each one contain the following:
3375 - "host": client's IP address (json-string)
3376 - "family": address family (json-string)
3377 - Possible values: "ipv4", "ipv6", "unix", "unknown"
3378 - "port": client's port number (json-string)
3379 - "connection-id": spice connection id. All channels with the same id
3380 belong to the same spice session (json-int)
3381 - "channel-type": channel type. "1" is the main control channel, filter for
3382 this one if you want track spice sessions only (json-int)
3383 - "channel-id": channel id. Usually "0", might be different needed when
3384 multiple channels of the same type exist, such as multiple
3385 display channels in a multihead setup (json-int)
3386 - "tls": whether the channel is encrypted (json-bool)
3390 -> { "execute": "query-spice" }
3403 "connection-id": 1804289383,
3404 "host": "127.0.0.1",
3412 "connection-id": 1804289383,
3413 "host": "127.0.0.1",
3417 [ ... more channels follow ... ]
3424 #if defined(CONFIG_SPICE)
3426 .name = "query-spice",
3428 .mhandler.cmd_new = qmp_marshal_query_spice,
3438 Return a json-object with the following information:
3440 - "name": VM's name (json-string, optional)
3444 -> { "execute": "query-name" }
3445 <- { "return": { "name": "qemu-name" } }
3450 .name = "query-name",
3452 .mhandler.cmd_new = qmp_marshal_query_name,
3461 Return a json-object with the following information:
3463 - "UUID": Universally Unique Identifier (json-string)
3467 -> { "execute": "query-uuid" }
3468 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
3473 .name = "query-uuid",
3475 .mhandler.cmd_new = qmp_marshal_query_uuid,
3479 query-command-line-options
3480 --------------------------
3482 Show command line option schema.
3484 Return a json-array of command line option schema for all options (or for
3485 the given option), returning an error if the given option doesn't exist.
3487 Each array entry contains the following:
3489 - "option": option name (json-string)
3490 - "parameters": a json-array describes all parameters of the option:
3491 - "name": parameter name (json-string)
3492 - "type": parameter type (one of 'string', 'boolean', 'number',
3494 - "help": human readable description of the parameter
3495 (json-string, optional)
3496 - "default": default value string for the parameter
3497 (json-string, optional)
3501 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
3510 "name": "bootindex",
3514 "option": "option-rom"
3522 .name = "query-command-line-options",
3523 .args_type = "option:s?",
3524 .mhandler.cmd_new = qmp_marshal_query_command_line_options,
3533 Return a json-object. If migration is active there will be another json-object
3534 with RAM migration status and if block migration is active another one with
3535 block migration status.
3537 The main json-object contains the following:
3539 - "status": migration status (json-string)
3540 - Possible values: "setup", "active", "completed", "failed", "cancelled"
3541 - "total-time": total amount of ms since migration started. If
3542 migration has ended, it returns the total migration
3544 - "setup-time" amount of setup time in milliseconds _before_ the
3545 iterations begin but _after_ the QMP command is issued.
3546 This is designed to provide an accounting of any activities
3547 (such as RDMA pinning) which may be expensive, but do not
3548 actually occur during the iterative migration rounds
3549 themselves. (json-int)
3550 - "downtime": only present when migration has finished correctly
3551 total amount in ms for downtime that happened (json-int)
3552 - "expected-downtime": only present while migration is active
3553 total amount in ms for downtime that was calculated on
3554 the last bitmap round (json-int)
3555 - "ram": only present if "status" is "active", it is a json-object with the
3556 following RAM information:
3557 - "transferred": amount transferred in bytes (json-int)
3558 - "remaining": amount remaining to transfer in bytes (json-int)
3559 - "total": total amount of memory in bytes (json-int)
3560 - "duplicate": number of pages filled entirely with the same
3562 These are sent over the wire much more efficiently.
3563 - "skipped": number of skipped zero pages (json-int)
3564 - "normal" : number of whole pages transferred. I.e. they
3565 were not sent as duplicate or xbzrle pages (json-int)
3566 - "normal-bytes" : number of bytes transferred in whole
3567 pages. This is just normal pages times size of one page,
3568 but this way upper levels don't need to care about page
3570 - "dirty-sync-count": times that dirty ram was synchronized (json-int)
3571 - "disk": only present if "status" is "active" and it is a block migration,
3572 it is a json-object with the following disk information:
3573 - "transferred": amount transferred in bytes (json-int)
3574 - "remaining": amount remaining to transfer in bytes json-int)
3575 - "total": total disk size in bytes (json-int)
3576 - "xbzrle-cache": only present if XBZRLE is active.
3577 It is a json-object with the following XBZRLE information:
3578 - "cache-size": XBZRLE cache size in bytes
3579 - "bytes": number of bytes transferred for XBZRLE compressed pages
3580 - "pages": number of XBZRLE compressed pages
3581 - "cache-miss": number of XBRZRLE page cache misses
3582 - "cache-miss-rate": rate of XBRZRLE page cache misses
3583 - "overflow": number of times XBZRLE overflows. This means
3584 that the XBZRLE encoding was bigger than just sent the
3585 whole page, and then we sent the whole page instead (as as
3590 1. Before the first migration
3592 -> { "execute": "query-migrate" }
3595 2. Migration is done and has succeeded
3597 -> { "execute": "query-migrate" }
3599 "status": "completed",
3609 "normal-bytes":123456,
3610 "dirty-sync-count":15
3615 3. Migration is done and has failed
3617 -> { "execute": "query-migrate" }
3618 <- { "return": { "status": "failed" } }
3620 4. Migration is being performed and is not a block migration:
3622 -> { "execute": "query-migrate" }
3632 "expected-downtime":12345,
3635 "normal-bytes":123456,
3636 "dirty-sync-count":15
3641 5. Migration is being performed and is a block migration:
3643 -> { "execute": "query-migrate" }
3649 "remaining":1053304,
3653 "expected-downtime":12345,
3656 "normal-bytes":123456,
3657 "dirty-sync-count":15
3661 "remaining":20880384,
3667 6. Migration is being performed and XBZRLE is active:
3669 -> { "execute": "query-migrate" }
3673 "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
3676 "remaining":1053304,
3680 "expected-downtime":12345,
3683 "normal-bytes":3412992,
3684 "dirty-sync-count":15
3687 "cache-size":67108864,
3691 "cache-miss-rate":0.123,
3700 .name = "query-migrate",
3702 .mhandler.cmd_new = qmp_marshal_query_migrate,
3706 migrate-set-capabilities
3707 ------------------------
3709 Enable/Disable migration capabilities
3711 - "xbzrle": XBZRLE support
3712 - "rdma-pin-all": pin all pages when using RDMA during migration
3713 - "auto-converge": throttle down guest to help convergence of migration
3714 - "zero-blocks": compress zero blocks during block migration
3715 - "compress": use multiple compression threads to accelerate live migration
3716 - "events": generate events for each migration state change
3717 - "postcopy-ram": postcopy mode for live migration
3723 -> { "execute": "migrate-set-capabilities" , "arguments":
3724 { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
3729 .name = "migrate-set-capabilities",
3730 .args_type = "capabilities:q",
3731 .params = "capability:s,state:b",
3732 .mhandler.cmd_new = qmp_marshal_migrate_set_capabilities,
3735 query-migrate-capabilities
3736 --------------------------
3738 Query current migration capabilities
3740 - "capabilities": migration capabilities state
3741 - "xbzrle" : XBZRLE state (json-bool)
3742 - "rdma-pin-all" : RDMA Pin Page state (json-bool)
3743 - "auto-converge" : Auto Converge state (json-bool)
3744 - "zero-blocks" : Zero Blocks state (json-bool)
3745 - "compress": Multiple compression threads state (json-bool)
3746 - "events": Migration state change event state (json-bool)
3747 - "postcopy-ram": postcopy ram state (json-bool)
3753 -> { "execute": "query-migrate-capabilities" }
3755 {"state": false, "capability": "xbzrle"},
3756 {"state": false, "capability": "rdma-pin-all"},
3757 {"state": false, "capability": "auto-converge"},
3758 {"state": false, "capability": "zero-blocks"},
3759 {"state": false, "capability": "compress"},
3760 {"state": true, "capability": "events"},
3761 {"state": false, "capability": "postcopy-ram"}
3767 .name = "query-migrate-capabilities",
3769 .mhandler.cmd_new = qmp_marshal_query_migrate_capabilities,
3773 migrate-set-parameters
3774 ----------------------
3776 Set migration parameters
3778 - "compress-level": set compression level during migration (json-int)
3779 - "compress-threads": set compression thread count for migration (json-int)
3780 - "decompress-threads": set decompression thread count for migration (json-int)
3781 - "cpu-throttle-initial": set initial percentage of time guest cpus are
3782 throttled for auto-converge (json-int)
3783 - "cpu-throttle-increment": set throttle increasing percentage for
3784 auto-converge (json-int)
3790 -> { "execute": "migrate-set-parameters" , "arguments":
3791 { "compress-level": 1 } }
3796 .name = "migrate-set-parameters",
3798 "compress-level:i?,compress-threads:i?,decompress-threads:i?,cpu-throttle-initial:i?,cpu-throttle-increment:i?",
3799 .mhandler.cmd_new = qmp_marshal_migrate_set_parameters,
3802 query-migrate-parameters
3803 ------------------------
3805 Query current migration parameters
3807 - "parameters": migration parameters value
3808 - "compress-level" : compression level value (json-int)
3809 - "compress-threads" : compression thread count value (json-int)
3810 - "decompress-threads" : decompression thread count value (json-int)
3811 - "cpu-throttle-initial" : initial percentage of time guest cpus are
3812 throttled (json-int)
3813 - "cpu-throttle-increment" : throttle increasing percentage for
3814 auto-converge (json-int)
3820 -> { "execute": "query-migrate-parameters" }
3823 "decompress-threads": 2,
3824 "cpu-throttle-increment": 10,
3825 "compress-threads": 8,
3826 "compress-level": 1,
3827 "cpu-throttle-initial": 20
3834 .name = "query-migrate-parameters",
3836 .mhandler.cmd_new = qmp_marshal_query_migrate_parameters,
3843 Show balloon information.
3845 Make an asynchronous request for balloon info. When the request completes a
3846 json-object will be returned containing the following data:
3848 - "actual": current balloon value in bytes (json-int)
3852 -> { "execute": "query-balloon" }
3855 "actual":1073741824,
3862 .name = "query-balloon",
3864 .mhandler.cmd_new = qmp_marshal_query_balloon,
3868 .name = "query-block-jobs",
3870 .mhandler.cmd_new = qmp_marshal_query_block_jobs,
3875 .args_type = "path:s",
3876 .mhandler.cmd_new = qmp_marshal_qom_list,
3881 .args_type = "path:s,property:s,value:q",
3882 .mhandler.cmd_new = qmp_marshal_qom_set,
3887 .args_type = "path:s,property:s",
3888 .mhandler.cmd_new = qmp_marshal_qom_get,
3892 .name = "nbd-server-start",
3893 .args_type = "addr:q,tls-creds:s?",
3894 .mhandler.cmd_new = qmp_marshal_nbd_server_start,
3897 .name = "nbd-server-add",
3898 .args_type = "device:B,writable:b?",
3899 .mhandler.cmd_new = qmp_marshal_nbd_server_add,
3902 .name = "nbd-server-stop",
3904 .mhandler.cmd_new = qmp_marshal_nbd_server_stop,
3908 .name = "change-vnc-password",
3909 .args_type = "password:s",
3910 .mhandler.cmd_new = qmp_marshal_change_vnc_password,
3913 .name = "qom-list-types",
3914 .args_type = "implements:s?,abstract:b?",
3915 .mhandler.cmd_new = qmp_marshal_qom_list_types,
3919 .name = "device-list-properties",
3920 .args_type = "typename:s",
3921 .mhandler.cmd_new = qmp_marshal_device_list_properties,
3925 .name = "query-machines",
3927 .mhandler.cmd_new = qmp_marshal_query_machines,
3931 .name = "query-cpu-definitions",
3933 .mhandler.cmd_new = qmp_marshal_query_cpu_definitions,
3937 .name = "query-target",
3939 .mhandler.cmd_new = qmp_marshal_query_target,
3943 .name = "query-tpm",
3945 .mhandler.cmd_new = qmp_marshal_query_tpm,
3952 Return information about the TPM device.
3958 -> { "execute": "query-tpm" }
3961 { "model": "tpm-tis",
3963 { "type": "passthrough",
3965 { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3977 .name = "query-tpm-models",
3979 .mhandler.cmd_new = qmp_marshal_query_tpm_models,
3986 Return a list of supported TPM models.
3992 -> { "execute": "query-tpm-models" }
3993 <- { "return": [ "tpm-tis" ] }
3998 .name = "query-tpm-types",
4000 .mhandler.cmd_new = qmp_marshal_query_tpm_types,
4007 Return a list of supported TPM types.
4013 -> { "execute": "query-tpm-types" }
4014 <- { "return": [ "passthrough" ] }
4019 .name = "chardev-add",
4020 .args_type = "id:s,backend:q",
4021 .mhandler.cmd_new = qmp_marshal_chardev_add,
4032 - "id": the chardev's ID, must be unique (json-string)
4033 - "backend": chardev backend type + parameters
4037 -> { "execute" : "chardev-add",
4038 "arguments" : { "id" : "foo",
4039 "backend" : { "type" : "null", "data" : {} } } }
4042 -> { "execute" : "chardev-add",
4043 "arguments" : { "id" : "bar",
4044 "backend" : { "type" : "file",
4045 "data" : { "out" : "/tmp/bar.log" } } } }
4048 -> { "execute" : "chardev-add",
4049 "arguments" : { "id" : "baz",
4050 "backend" : { "type" : "pty", "data" : {} } } }
4051 <- { "return": { "pty" : "/dev/pty/42" } }
4056 .name = "chardev-remove",
4057 .args_type = "id:s",
4058 .mhandler.cmd_new = qmp_marshal_chardev_remove,
4070 - "id": the chardev's ID, must exist and not be in use (json-string)
4074 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
4079 .name = "query-rx-filter",
4080 .args_type = "name:s?",
4081 .mhandler.cmd_new = qmp_marshal_query_rx_filter,
4088 Show rx-filter information.
4090 Returns a json-array of rx-filter information for all NICs (or for the
4091 given NIC), returning an error if the given NIC doesn't exist, or
4092 given NIC doesn't support rx-filter querying, or given net client
4095 The query will clear the event notification flag of each NIC, then qemu
4096 will start to emit event to QMP monitor.
4098 Each array entry contains the following:
4100 - "name": net client name (json-string)
4101 - "promiscuous": promiscuous mode is enabled (json-bool)
4102 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
4103 - "unicast": unicast receive state (one of 'normal', 'none', 'all')
4104 - "vlan": vlan receive state (one of 'normal', 'none', 'all') (Since 2.0)
4105 - "broadcast-allowed": allow to receive broadcast (json-bool)
4106 - "multicast-overflow": multicast table is overflowed (json-bool)
4107 - "unicast-overflow": unicast table is overflowed (json-bool)
4108 - "main-mac": main macaddr string (json-string)
4109 - "vlan-table": a json-array of active vlan id
4110 - "unicast-table": a json-array of unicast macaddr string
4111 - "multicast-table": a json-array of multicast macaddr string
4115 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
4118 "promiscuous": true,
4120 "main-mac": "52:54:00:12:34:56",
4121 "unicast": "normal",
4129 "multicast": "normal",
4130 "multicast-overflow": false,
4131 "unicast-overflow": false,
4132 "multicast-table": [
4133 "01:00:5e:00:00:01",
4134 "33:33:00:00:00:01",
4137 "broadcast-allowed": false
4145 .name = "blockdev-add",
4146 .args_type = "options:q",
4147 .mhandler.cmd_new = qmp_marshal_blockdev_add,
4156 This command is still a work in progress. It doesn't support all
4157 block drivers among other things. Stay away from it unless you want
4158 to help with its development.
4162 - "options": block driver options
4166 -> { "execute": "blockdev-add",
4167 "arguments": { "options" : { "driver": "qcow2",
4168 "file": { "driver": "file",
4169 "filename": "test.qcow2" } } } }
4174 -> { "execute": "blockdev-add",
4186 "filename": "/tmp/test.qcow2"
4192 "filename": "/dev/fdset/4"
4204 .name = "x-blockdev-del",
4205 .args_type = "id:s?,node-name:s?",
4206 .mhandler.cmd_new = qmp_marshal_x_blockdev_del,
4214 Deletes a block device thas has been added using blockdev-add.
4215 The selected device can be either a block backend or a graph node.
4217 In the former case the backend will be destroyed, along with its
4218 inserted medium if there's any. The command will fail if the backend
4219 or its medium are in use.
4221 In the latter case the node will be destroyed. The command will fail
4222 if the node is attached to a block backend or is otherwise being
4225 One of "id" or "node-name" must be specified, but not both.
4227 This command is still a work in progress and is considered
4228 experimental. Stay away from it unless you want to help with its
4233 - "id": Name of the block backend device to delete (json-string, optional)
4234 - "node-name": Name of the graph node to delete (json-string, optional)
4238 -> { "execute": "blockdev-add",
4245 "filename": "test.qcow2"
4253 -> { "execute": "x-blockdev-del",
4254 "arguments": { "id": "drive0" }
4261 .name = "blockdev-open-tray",
4262 .args_type = "device:s,force:b?",
4263 .mhandler.cmd_new = qmp_marshal_blockdev_open_tray,
4270 Opens a block device's tray. If there is a block driver state tree inserted as a
4271 medium, it will become inaccessible to the guest (but it will remain associated
4272 to the block device, so closing the tray will make it accessible again).
4274 If the tray was already open before, this will be a no-op.
4276 Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
4277 which no such event will be generated, these include:
4278 - if the guest has locked the tray, @force is false and the guest does not
4279 respond to the eject request
4280 - if the BlockBackend denoted by @device does not have a guest device attached
4282 - if the guest device does not have an actual tray and is empty, for instance
4283 for floppy disk drives
4287 - "device": block device name (json-string)
4288 - "force": if false (the default), an eject request will be sent to the guest if
4289 it has locked the tray (and the tray will not be opened immediately);
4290 if true, the tray will be opened regardless of whether it is locked
4291 (json-bool, optional)
4295 -> { "execute": "blockdev-open-tray",
4296 "arguments": { "device": "ide1-cd0" } }
4298 <- { "timestamp": { "seconds": 1418751016,
4299 "microseconds": 716996 },
4300 "event": "DEVICE_TRAY_MOVED",
4301 "data": { "device": "ide1-cd0",
4302 "tray-open": true } }
4309 .name = "blockdev-close-tray",
4310 .args_type = "device:s",
4311 .mhandler.cmd_new = qmp_marshal_blockdev_close_tray,
4318 Closes a block device's tray. If there is a block driver state tree associated
4319 with the block device (which is currently ejected), that tree will be loaded as
4322 If the tray was already closed before, this will be a no-op.
4326 - "device": block device name (json-string)
4330 -> { "execute": "blockdev-close-tray",
4331 "arguments": { "device": "ide1-cd0" } }
4333 <- { "timestamp": { "seconds": 1418751345,
4334 "microseconds": 272147 },
4335 "event": "DEVICE_TRAY_MOVED",
4336 "data": { "device": "ide1-cd0",
4337 "tray-open": false } }
4344 .name = "x-blockdev-remove-medium",
4345 .args_type = "device:s",
4346 .mhandler.cmd_new = qmp_marshal_x_blockdev_remove_medium,
4350 x-blockdev-remove-medium
4351 ------------------------
4353 Removes a medium (a block driver state tree) from a block device. That block
4354 device's tray must currently be open (unless there is no attached guest device).
4356 If the tray is open and there is no medium inserted, this will be a no-op.
4358 This command is still a work in progress and is considered experimental.
4359 Stay away from it unless you want to help with its development.
4363 - "device": block device name (json-string)
4367 -> { "execute": "x-blockdev-remove-medium",
4368 "arguments": { "device": "ide1-cd0" } }
4370 <- { "error": { "class": "GenericError",
4371 "desc": "Tray of device 'ide1-cd0' is not open" } }
4373 -> { "execute": "blockdev-open-tray",
4374 "arguments": { "device": "ide1-cd0" } }
4376 <- { "timestamp": { "seconds": 1418751627,
4377 "microseconds": 549958 },
4378 "event": "DEVICE_TRAY_MOVED",
4379 "data": { "device": "ide1-cd0",
4380 "tray-open": true } }
4384 -> { "execute": "x-blockdev-remove-medium",
4385 "arguments": { "device": "ide1-cd0" } }
4392 .name = "x-blockdev-insert-medium",
4393 .args_type = "device:s,node-name:s",
4394 .mhandler.cmd_new = qmp_marshal_x_blockdev_insert_medium,
4398 x-blockdev-insert-medium
4399 ------------------------
4401 Inserts a medium (a block driver state tree) into a block device. That block
4402 device's tray must currently be open (unless there is no attached guest device)
4403 and there must be no medium inserted already.
4405 This command is still a work in progress and is considered experimental.
4406 Stay away from it unless you want to help with its development.
4410 - "device": block device name (json-string)
4411 - "node-name": root node of the BDS tree to insert into the block device
4415 -> { "execute": "blockdev-add",
4416 "arguments": { "options": { "node-name": "node0",
4418 "file": { "driver": "file",
4419 "filename": "fedora.iso" } } } }
4423 -> { "execute": "x-blockdev-insert-medium",
4424 "arguments": { "device": "ide1-cd0",
4425 "node-name": "node0" } }
4432 .name = "x-blockdev-change",
4433 .args_type = "parent:B,child:B?,node:B?",
4434 .mhandler.cmd_new = qmp_marshal_x_blockdev_change,
4441 Dynamically reconfigure the block driver state graph. It can be used
4442 to add, remove, insert or replace a graph node. Currently only the
4443 Quorum driver implements this feature to add or remove its child. This
4444 is useful to fix a broken quorum child.
4446 If @node is specified, it will be inserted under @parent. @child
4447 may not be specified in this case. If both @parent and @child are
4448 specified but @node is not, @child will be detached from @parent.
4451 - "parent": the id or name of the parent node (json-string)
4452 - "child": the name of a child under the given parent node (json-string, optional)
4453 - "node": the name of the node that will be added (json-string, optional)
4455 Note: this command is experimental, and not a stable API. It doesn't
4456 support all kinds of operations, all kinds of children, nor all block
4459 Warning: The data in a new quorum child MUST be consistent with that of
4460 the rest of the array.
4464 Add a new node to a quorum
4465 -> { "execute": "blockdev-add",
4466 "arguments": { "options": { "driver": "raw",
4467 "node-name": "new_node",
4468 "file": { "driver": "file",
4469 "filename": "test.raw" } } } }
4471 -> { "execute": "x-blockdev-change",
4472 "arguments": { "parent": "disk1",
4473 "node": "new_node" } }
4476 Delete a quorum's node
4477 -> { "execute": "x-blockdev-change",
4478 "arguments": { "parent": "disk1",
4479 "child": "children.1" } }
4485 .name = "query-named-block-nodes",
4487 .mhandler.cmd_new = qmp_marshal_query_named_block_nodes,
4491 @query-named-block-nodes
4492 ------------------------
4494 Return a list of BlockDeviceInfo for all the named block driver nodes
4498 -> { "execute": "query-named-block-nodes" }
4499 <- { "return": [ { "ro":false,
4502 "file":"disks/test.qcow2",
4503 "node-name": "my-node",
4504 "backing_file_depth":1,
4518 "write_threshold": 0,
4520 "filename":"disks/test.qcow2",
4522 "virtual-size":2048000,
4523 "backing_file":"base.qcow2",
4524 "full-backing-filename":"disks/base.qcow2",
4525 "backing-filename-format":"qcow2",
4529 "name": "snapshot1",
4531 "date-sec": 10000200,
4533 "vm-clock-sec": 206,
4538 "filename":"disks/base.qcow2",
4540 "virtual-size":2048000
4547 .name = "blockdev-change-medium",
4548 .args_type = "device:B,filename:F,format:s?,read-only-mode:s?",
4549 .mhandler.cmd_new = qmp_marshal_blockdev_change_medium,
4553 blockdev-change-medium
4554 ----------------------
4556 Changes the medium inserted into a block device by ejecting the current medium
4557 and loading a new image file which is inserted as the new medium.
4561 - "device": device name (json-string)
4562 - "filename": filename of the new image (json-string)
4563 - "format": format of the new image (json-string, optional)
4564 - "read-only-mode": new read-only mode (json-string, optional)
4565 - Possible values: "retain" (default), "read-only", "read-write"
4569 1. Change a removable medium
4571 -> { "execute": "blockdev-change-medium",
4572 "arguments": { "device": "ide1-cd0",
4573 "filename": "/srv/images/Fedora-12-x86_64-DVD.iso",
4577 2. Load a read-only medium into a writable drive
4579 -> { "execute": "blockdev-change-medium",
4580 "arguments": { "device": "isa-fd0",
4581 "filename": "/srv/images/ro.img",
4583 "read-only-mode": "retain" } }
4586 { "class": "GenericError",
4587 "desc": "Could not open '/srv/images/ro.img': Permission denied" } }
4589 -> { "execute": "blockdev-change-medium",
4590 "arguments": { "device": "isa-fd0",
4591 "filename": "/srv/images/ro.img",
4593 "read-only-mode": "read-only" } }
4600 .name = "query-memdev",
4602 .mhandler.cmd_new = qmp_marshal_query_memdev,
4609 Show memory devices information.
4614 -> { "execute": "query-memdev" }
4621 "host-nodes": [0, 1],
4629 "host-nodes": [2, 3],
4630 "policy": "preferred"
4638 .name = "query-memory-devices",
4640 .mhandler.cmd_new = qmp_marshal_query_memory_devices,
4644 @query-memory-devices
4645 --------------------
4647 Return a list of memory devices.
4650 -> { "execute": "query-memory-devices" }
4651 <- { "return": [ { "data":
4652 { "addr": 5368709120,
4653 "hotpluggable": true,
4656 "memdev": "/objects/memX",
4665 .name = "query-acpi-ospm-status",
4667 .mhandler.cmd_new = qmp_marshal_query_acpi_ospm_status,
4671 @query-acpi-ospm-status
4672 --------------------
4674 Return list of ACPIOSTInfo for devices that support status reporting
4675 via ACPI _OST method.
4678 -> { "execute": "query-acpi-ospm-status" }
4679 <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
4680 { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
4681 { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
4682 { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
4686 #if defined TARGET_I386
4688 .name = "rtc-reset-reinjection",
4690 .mhandler.cmd_new = qmp_marshal_rtc_reset_reinjection,
4695 rtc-reset-reinjection
4696 ---------------------
4698 Reset the RTC interrupt reinjection backlog.
4704 -> { "execute": "rtc-reset-reinjection" }
4709 .name = "trace-event-get-state",
4710 .args_type = "name:s",
4711 .mhandler.cmd_new = qmp_marshal_trace_event_get_state,
4715 trace-event-get-state
4716 ---------------------
4718 Query the state of events.
4722 -> { "execute": "trace-event-get-state", "arguments": { "name": "qemu_memalign" } }
4723 <- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
4727 .name = "trace-event-set-state",
4728 .args_type = "name:s,enable:b,ignore-unavailable:b?",
4729 .mhandler.cmd_new = qmp_marshal_trace_event_set_state,
4733 trace-event-set-state
4734 ---------------------
4736 Set the state of events.
4740 -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } }
4745 .name = "input-send-event",
4746 .args_type = "console:i?,events:q",
4747 .mhandler.cmd_new = qmp_marshal_input_send_event,
4754 Send input event to guest.
4758 - "device": display device (json-string, optional)
4759 - "head": display head (json-int, optional)
4760 - "events": list of input events
4762 The consoles are visible in the qom tree, under
4763 /backend/console[$index]. They have a device link and head property, so
4764 it is possible to map which console belongs to which device and display.
4766 Note: this command is experimental, and not a stable API.
4770 Press left mouse button.
4772 -> { "execute": "input-send-event",
4773 "arguments": { "device": "video0",
4774 "events": [ { "type": "btn",
4775 "data" : { "down": true, "button": "left" } } ] } }
4778 -> { "execute": "input-send-event",
4779 "arguments": { "device": "video0",
4780 "events": [ { "type": "btn",
4781 "data" : { "down": false, "button": "left" } } ] } }
4788 -> { "execute": "input-send-event",
4789 "arguments": { "events": [
4790 { "type": "key", "data" : { "down": true,
4791 "key": {"type": "qcode", "data": "ctrl" } } },
4792 { "type": "key", "data" : { "down": true,
4793 "key": {"type": "qcode", "data": "alt" } } },
4794 { "type": "key", "data" : { "down": true,
4795 "key": {"type": "qcode", "data": "delete" } } } ] } }
4800 Move mouse pointer to absolute coordinates (20000, 400).
4802 -> { "execute": "input-send-event" ,
4803 "arguments": { "events": [
4804 { "type": "abs", "data" : { "axis": "x", "value" : 20000 } },
4805 { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
4811 .name = "block-set-write-threshold",
4812 .args_type = "node-name:s,write-threshold:l",
4813 .mhandler.cmd_new = qmp_marshal_block_set_write_threshold,
4817 block-set-write-threshold
4820 Change the write threshold for a block drive. The threshold is an offset,
4821 thus must be non-negative. Default is no write threshold.
4822 Setting the threshold to zero disables it.
4826 - "node-name": the node name in the block driver state graph (json-string)
4827 - "write-threshold": the write threshold in bytes (json-int)
4831 -> { "execute": "block-set-write-threshold",
4832 "arguments": { "node-name": "mydev",
4833 "write-threshold": 17179869184 } }
4839 .name = "query-rocker",
4840 .args_type = "name:s",
4841 .mhandler.cmd_new = qmp_marshal_query_rocker,
4850 - "name": switch name
4854 -> { "execute": "query-rocker", "arguments": { "name": "sw1" } }
4855 <- { "return": {"name": "sw1", "ports": 2, "id": 1327446905938}}
4860 .name = "query-rocker-ports",
4861 .args_type = "name:s",
4862 .mhandler.cmd_new = qmp_marshal_query_rocker_ports,
4866 Show rocker switch ports
4867 ------------------------
4871 - "name": switch name
4875 -> { "execute": "query-rocker-ports", "arguments": { "name": "sw1" } }
4876 <- { "return": [ {"duplex": "full", "enabled": true, "name": "sw1.1",
4877 "autoneg": "off", "link-up": true, "speed": 10000},
4878 {"duplex": "full", "enabled": true, "name": "sw1.2",
4879 "autoneg": "off", "link-up": true, "speed": 10000}
4885 .name = "query-rocker-of-dpa-flows",
4886 .args_type = "name:s,tbl-id:i?",
4887 .mhandler.cmd_new = qmp_marshal_query_rocker_of_dpa_flows,
4891 Show rocker switch OF-DPA flow tables
4892 -------------------------------------
4896 - "name": switch name
4897 - "tbl-id": (optional) flow table ID
4901 -> { "execute": "query-rocker-of-dpa-flows", "arguments": { "name": "sw1" } }
4902 <- { "return": [ {"key": {"in-pport": 0, "priority": 1, "tbl-id": 0},
4905 "action": {"goto-tbl": 10},
4906 "mask": {"in-pport": 4294901760}
4914 .name = "query-rocker-of-dpa-groups",
4915 .args_type = "name:s,type:i?",
4916 .mhandler.cmd_new = qmp_marshal_query_rocker_of_dpa_groups,
4920 Show rocker OF-DPA group tables
4921 -------------------------------
4925 - "name": switch name
4926 - "type": (optional) group type
4930 -> { "execute": "query-rocker-of-dpa-groups", "arguments": { "name": "sw1" } }
4931 <- { "return": [ {"type": 0, "out-pport": 2, "pport": 2, "vlan-id": 3841,
4932 "pop-vlan": 1, "id": 251723778},
4933 {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3841,
4934 "pop-vlan": 1, "id": 251723776},
4935 {"type": 0, "out-pport": 1, "pport": 1, "vlan-id": 3840,
4936 "pop-vlan": 1, "id": 251658241},
4937 {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3840,
4938 "pop-vlan": 1, "id": 251658240}
4943 #if defined TARGET_ARM
4945 .name = "query-gic-capabilities",
4947 .mhandler.cmd_new = qmp_marshal_query_gic_capabilities,
4952 query-gic-capabilities
4955 Return a list of GICCapability objects, describing supported GIC
4956 (Generic Interrupt Controller) versions.
4962 -> { "execute": "query-gic-capabilities" }
4963 <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
4964 { "version": 3, "emulated": false, "kernel": true } ] }
4969 .name = "query-hotpluggable-cpus",
4971 .mhandler.cmd_new = qmp_marshal_query_hotpluggable_cpus,
4975 Show existing/possible CPUs
4976 ---------------------------
4980 Example for pseries machine type started with
4981 -smp 2,cores=2,maxcpus=4 -cpu POWER8:
4983 -> { "execute": "query-hotpluggable-cpus" }
4985 { "props": { "core-id": 8 }, "type": "POWER8-spapr-cpu-core",
4987 { "props": { "core-id": 0 }, "type": "POWER8-spapr-cpu-core",
4988 "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"}