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 = "job-id:s?,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 - "job-id": Identifier for the newly-created block job. If omitted,
1122 the device name will be used. (json-string, optional)
1123 - "device": The device's ID, must be unique (json-string)
1124 - "base": The file name of the backing image above which copying starts
1125 (json-string, optional)
1126 - "backing-file": The backing file string to write into the active layer. This
1127 filename is not validated.
1129 If a pathname string is such that it cannot be resolved by
1130 QEMU, that means that subsequent QMP or HMP commands must use
1131 node-names for the image in question, as filename lookup
1134 If not specified, QEMU will automatically determine the
1135 backing file string to use, or error out if there is no
1136 obvious choice. Care should be taken when specifying the
1137 string, to specify a valid filename or protocol.
1138 (json-string, optional) (Since 2.1)
1139 - "speed": the maximum speed, in bytes per second (json-int, optional)
1140 - "on-error": the action to take on an error (default 'report'). 'stop' and
1141 'enospc' can only be used if the block device supports io-status.
1142 (json-string, optional) (Since 2.1)
1146 -> { "execute": "block-stream", "arguments": { "device": "virtio0",
1147 "base": "/tmp/master.qcow2" } }
1153 .name = "block-commit",
1154 .args_type = "device:B,base:s?,top:s?,backing-file:s?,speed:o?",
1155 .mhandler.cmd_new = qmp_marshal_block_commit,
1162 Live commit of data from overlay image nodes into backing nodes - i.e., writes
1163 data between 'top' and 'base' into 'base'.
1167 - "device": The device's ID, must be unique (json-string)
1168 - "base": The file name of the backing image to write data into.
1169 If not specified, this is the deepest backing image
1170 (json-string, optional)
1171 - "top": The file name of the backing image within the image chain,
1172 which contains the topmost data to be committed down. If
1173 not specified, this is the active layer. (json-string, optional)
1175 - backing-file: The backing file string to write into the overlay
1176 image of 'top'. If 'top' is the active layer,
1177 specifying a backing file string is an error. This
1178 filename is not validated.
1180 If a pathname string is such that it cannot be
1181 resolved by QEMU, that means that subsequent QMP or
1182 HMP commands must use node-names for the image in
1183 question, as filename lookup methods will fail.
1185 If not specified, QEMU will automatically determine
1186 the backing file string to use, or error out if
1187 there is no obvious choice. Care should be taken
1188 when specifying the string, to specify a valid
1189 filename or protocol.
1190 (json-string, optional) (Since 2.1)
1192 If top == base, that is an error.
1193 If top == active, the job will not be completed by itself,
1194 user needs to complete the job with the block-job-complete
1195 command after getting the ready event. (Since 2.0)
1197 If the base image is smaller than top, then the base image
1198 will be resized to be the same size as top. If top is
1199 smaller than the base image, the base will not be
1200 truncated. If you want the base image size to match the
1201 size of the smaller top, you can safely truncate it
1202 yourself once the commit operation successfully completes.
1204 - "speed": the maximum speed, in bytes per second (json-int, optional)
1209 -> { "execute": "block-commit", "arguments": { "device": "virtio0",
1210 "top": "/tmp/snap1.qcow2" } }
1216 .name = "drive-backup",
1217 .args_type = "job-id:s?,sync:s,device:B,target:s,speed:i?,mode:s?,"
1218 "format:s?,bitmap:s?,on-source-error:s?,on-target-error:s?",
1219 .mhandler.cmd_new = qmp_marshal_drive_backup,
1226 Start a point-in-time copy of a block device to a new destination. The
1227 status of ongoing drive-backup operations can be checked with
1228 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1229 The operation can be stopped before it has completed using the
1230 block-job-cancel command.
1234 - "job-id": Identifier for the newly-created block job. If omitted,
1235 the device name will be used. (json-string, optional)
1236 - "device": the name of the device which should be copied.
1238 - "target": the target of the new image. If the file exists, or if it is a
1239 device, the existing file/device will be used as the new
1240 destination. If it does not exist, a new file will be created.
1242 - "format": the format of the new destination, default is to probe if 'mode' is
1243 'existing', else the format of the source
1244 (json-string, optional)
1245 - "sync": what parts of the disk image should be copied to the destination;
1246 possibilities include "full" for all the disk, "top" for only the sectors
1247 allocated in the topmost image, "incremental" for only the dirty sectors in
1248 the bitmap, or "none" to only replicate new I/O (MirrorSyncMode).
1249 - "bitmap": dirty bitmap name for sync==incremental. Must be present if sync
1250 is "incremental", must NOT be present otherwise.
1251 - "mode": whether and how QEMU should create a new image
1252 (NewImageMode, optional, default 'absolute-paths')
1253 - "speed": the maximum speed, in bytes per second (json-int, optional)
1254 - "on-source-error": the action to take on an error on the source, default
1255 'report'. 'stop' and 'enospc' can only be used
1256 if the block device supports io-status.
1257 (BlockdevOnError, optional)
1258 - "on-target-error": the action to take on an error on the target, default
1259 'report' (no limitations, since this applies to
1260 a different block device than device).
1261 (BlockdevOnError, optional)
1264 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
1266 "target": "backup.img" } }
1272 .name = "blockdev-backup",
1273 .args_type = "job-id:s?,sync:s,device:B,target:B,speed:i?,"
1274 "on-source-error:s?,on-target-error:s?",
1275 .mhandler.cmd_new = qmp_marshal_blockdev_backup,
1282 The device version of drive-backup: this command takes an existing named device
1287 - "job-id": Identifier for the newly-created block job. If omitted,
1288 the device name will be used. (json-string, optional)
1289 - "device": the name of the device which should be copied.
1291 - "target": the name of the backup target device. (json-string)
1292 - "sync": what parts of the disk image should be copied to the destination;
1293 possibilities include "full" for all the disk, "top" for only the
1294 sectors allocated in the topmost image, or "none" to only replicate
1295 new I/O (MirrorSyncMode).
1296 - "speed": the maximum speed, in bytes per second (json-int, optional)
1297 - "on-source-error": the action to take on an error on the source, default
1298 'report'. 'stop' and 'enospc' can only be used
1299 if the block device supports io-status.
1300 (BlockdevOnError, optional)
1301 - "on-target-error": the action to take on an error on the target, default
1302 'report' (no limitations, since this applies to
1303 a different block device than device).
1304 (BlockdevOnError, optional)
1307 -> { "execute": "blockdev-backup", "arguments": { "device": "src-id",
1309 "target": "tgt-id" } }
1315 .name = "block-job-set-speed",
1316 .args_type = "device:B,speed:o",
1317 .mhandler.cmd_new = qmp_marshal_block_job_set_speed,
1321 .name = "block-job-cancel",
1322 .args_type = "device:B,force:b?",
1323 .mhandler.cmd_new = qmp_marshal_block_job_cancel,
1326 .name = "block-job-pause",
1327 .args_type = "device:B",
1328 .mhandler.cmd_new = qmp_marshal_block_job_pause,
1331 .name = "block-job-resume",
1332 .args_type = "device:B",
1333 .mhandler.cmd_new = qmp_marshal_block_job_resume,
1336 .name = "block-job-complete",
1337 .args_type = "device:B",
1338 .mhandler.cmd_new = qmp_marshal_block_job_complete,
1341 .name = "transaction",
1342 .args_type = "actions:q,properties:q?",
1343 .mhandler.cmd_new = qmp_marshal_transaction,
1350 Atomically operate on one or more block devices. Operations that are
1351 currently supported:
1355 - blockdev-snapshot-sync
1356 - blockdev-snapshot-internal-sync
1358 - block-dirty-bitmap-add
1359 - block-dirty-bitmap-clear
1361 Refer to the qemu/qapi-schema.json file for minimum required QEMU
1362 versions for these operations. A list of dictionaries is accepted,
1363 that contains the actions to be performed. If there is any failure
1364 performing any of the operations, all operations for the group are
1367 For external snapshots, the dictionary contains the device, the file to use for
1368 the new snapshot, and the format. The default format, if not specified, is
1371 Each new snapshot defaults to being created by QEMU (wiping any
1372 contents if the file already exists), but it is also possible to reuse
1373 an externally-created file. In the latter case, you should ensure that
1374 the new image file has the same contents as the current one; QEMU cannot
1375 perform any meaningful check. Typically this is achieved by using the
1376 current image file as the backing file for the new image.
1378 On failure, the original disks pre-snapshot attempt will be used.
1380 For internal snapshots, the dictionary contains the device and the snapshot's
1381 name. If an internal snapshot matching name already exists, the request will
1382 be rejected. Only some image formats support it, for example, qcow2, rbd,
1385 On failure, qemu will try delete the newly created internal snapshot in the
1386 transaction. When an I/O error occurs during deletion, the user needs to fix
1387 it later with qemu-img or other command.
1392 - "type": the operation to perform (json-string). Possible
1393 values: "drive-backup", "blockdev-backup",
1394 "blockdev-snapshot-sync",
1395 "blockdev-snapshot-internal-sync",
1396 "abort", "block-dirty-bitmap-add",
1397 "block-dirty-bitmap-clear"
1398 - "data": a dictionary. The contents depend on the value
1399 of "type". When "type" is "blockdev-snapshot-sync":
1400 - "device": device name to snapshot (json-string)
1401 - "node-name": graph node name to snapshot (json-string)
1402 - "snapshot-file": name of new image file (json-string)
1403 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1404 - "format": format of new image (json-string, optional)
1405 - "mode": whether and how QEMU should create the snapshot file
1406 (NewImageMode, optional, default "absolute-paths")
1407 When "type" is "blockdev-snapshot-internal-sync":
1408 - "device": device name to snapshot (json-string)
1409 - "name": name of the new snapshot (json-string)
1413 -> { "execute": "transaction",
1414 "arguments": { "actions": [
1415 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
1416 "snapshot-file": "/some/place/my-image",
1417 "format": "qcow2" } },
1418 { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
1419 "snapshot-file": "/some/place/my-image2",
1420 "snapshot-node-name": "node3432",
1422 "format": "qcow2" } },
1423 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
1424 "snapshot-file": "/some/place/my-image2",
1426 "format": "qcow2" } },
1427 { "type": "blockdev-snapshot-internal-sync", "data" : {
1428 "device": "ide-hd2",
1429 "name": "snapshot0" } } ] } }
1435 .name = "block-dirty-bitmap-add",
1436 .args_type = "node:B,name:s,granularity:i?",
1437 .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_add,
1442 block-dirty-bitmap-add
1443 ----------------------
1446 Create a dirty bitmap with a name on the device, and start tracking the writes.
1450 - "node": device/node on which to create dirty bitmap (json-string)
1451 - "name": name of the new dirty bitmap (json-string)
1452 - "granularity": granularity to track writes with (int, optional)
1456 -> { "execute": "block-dirty-bitmap-add", "arguments": { "node": "drive0",
1457 "name": "bitmap0" } }
1463 .name = "block-dirty-bitmap-remove",
1464 .args_type = "node:B,name:s",
1465 .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_remove,
1470 block-dirty-bitmap-remove
1471 -------------------------
1474 Stop write tracking and remove the dirty bitmap that was created with
1475 block-dirty-bitmap-add.
1479 - "node": device/node on which to remove dirty bitmap (json-string)
1480 - "name": name of the dirty bitmap to remove (json-string)
1484 -> { "execute": "block-dirty-bitmap-remove", "arguments": { "node": "drive0",
1485 "name": "bitmap0" } }
1491 .name = "block-dirty-bitmap-clear",
1492 .args_type = "node:B,name:s",
1493 .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_clear,
1498 block-dirty-bitmap-clear
1499 ------------------------
1502 Reset the dirty bitmap associated with a node so that an incremental backup
1503 from this point in time forward will only backup clusters modified after this
1508 - "node": device/node on which to remove dirty bitmap (json-string)
1509 - "name": name of the dirty bitmap to remove (json-string)
1513 -> { "execute": "block-dirty-bitmap-clear", "arguments": { "node": "drive0",
1514 "name": "bitmap0" } }
1520 .name = "blockdev-snapshot-sync",
1521 .args_type = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
1522 .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_sync,
1526 blockdev-snapshot-sync
1527 ----------------------
1529 Synchronous snapshot of a block device. snapshot-file specifies the
1530 target of the new image. If the file exists, or if it is a device, the
1531 snapshot will be created in the existing file/device. If does not
1532 exist, a new file will be created. format specifies the format of the
1533 snapshot image, default is qcow2.
1537 - "device": device name to snapshot (json-string)
1538 - "node-name": graph node name to snapshot (json-string)
1539 - "snapshot-file": name of new image file (json-string)
1540 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1541 - "mode": whether and how QEMU should create the snapshot file
1542 (NewImageMode, optional, default "absolute-paths")
1543 - "format": format of new image (json-string, optional)
1547 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1549 "/some/place/my-image",
1550 "format": "qcow2" } }
1556 .name = "blockdev-snapshot",
1557 .args_type = "node:s,overlay:s",
1558 .mhandler.cmd_new = qmp_marshal_blockdev_snapshot,
1566 Create a snapshot, by installing 'node' as the backing image of
1567 'overlay'. Additionally, if 'node' is associated with a block
1568 device, the block device changes to using 'overlay' as its new active
1573 - "node": device that will have a snapshot created (json-string)
1574 - "overlay": device that will have 'node' as its backing image (json-string)
1578 -> { "execute": "blockdev-add",
1579 "arguments": { "options": { "driver": "qcow2",
1580 "node-name": "node1534",
1581 "file": { "driver": "file",
1582 "filename": "hd1.qcow2" },
1587 -> { "execute": "blockdev-snapshot", "arguments": { "node": "ide-hd0",
1588 "overlay": "node1534" } }
1594 .name = "blockdev-snapshot-internal-sync",
1595 .args_type = "device:B,name:s",
1596 .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_internal_sync,
1600 blockdev-snapshot-internal-sync
1601 -------------------------------
1603 Synchronously take an internal snapshot of a block device when the format of
1604 image used supports it. If the name is an empty string, or a snapshot with
1605 name already exists, the operation will fail.
1609 - "device": device name to snapshot (json-string)
1610 - "name": name of the new snapshot (json-string)
1614 -> { "execute": "blockdev-snapshot-internal-sync",
1615 "arguments": { "device": "ide-hd0",
1616 "name": "snapshot0" }
1623 .name = "blockdev-snapshot-delete-internal-sync",
1624 .args_type = "device:B,id:s?,name:s?",
1626 qmp_marshal_blockdev_snapshot_delete_internal_sync,
1630 blockdev-snapshot-delete-internal-sync
1631 --------------------------------------
1633 Synchronously delete an internal snapshot of a block device when the format of
1634 image used supports it. The snapshot is identified by name or id or both. One
1635 of name or id is required. If the snapshot is not found, the operation will
1640 - "device": device name (json-string)
1641 - "id": ID of the snapshot (json-string, optional)
1642 - "name": name of the snapshot (json-string, optional)
1646 -> { "execute": "blockdev-snapshot-delete-internal-sync",
1647 "arguments": { "device": "ide-hd0",
1648 "name": "snapshot0" }
1652 "name": "snapshot0",
1654 "date-sec": 1000012,
1656 "vm-clock-sec": 100,
1664 .name = "drive-mirror",
1665 .args_type = "job-id:s?,sync:s,device:B,target:s,speed:i?,mode:s?,"
1666 "format:s?,node-name:s?,replaces:s?,"
1667 "on-source-error:s?,on-target-error:s?,"
1669 "granularity:i?,buf-size:i?",
1670 .mhandler.cmd_new = qmp_marshal_drive_mirror,
1677 Start mirroring a block device's writes to a new destination. target
1678 specifies the target of the new image. If the file exists, or if it is
1679 a device, it will be used as the new destination for writes. If it does not
1680 exist, a new file will be created. format specifies the format of the
1681 mirror image, default is to probe if mode='existing', else the format
1686 - "job-id": Identifier for the newly-created block job. If omitted,
1687 the device name will be used. (json-string, optional)
1688 - "device": device name to operate on (json-string)
1689 - "target": name of new image file (json-string)
1690 - "format": format of new image (json-string, optional)
1691 - "node-name": the name of the new block driver state in the node graph
1692 (json-string, optional)
1693 - "replaces": the block driver node name to replace when finished
1694 (json-string, optional)
1695 - "mode": how an image file should be created into the target
1696 file/device (NewImageMode, optional, default 'absolute-paths')
1697 - "speed": maximum speed of the streaming job, in bytes per second
1699 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1700 - "buf-size": maximum amount of data in flight from source to target, in bytes
1701 (json-int, default 10M)
1702 - "sync": what parts of the disk image should be copied to the destination;
1703 possibilities include "full" for all the disk, "top" for only the sectors
1704 allocated in the topmost image, or "none" to only replicate new I/O
1706 - "on-source-error": the action to take on an error on the source
1707 (BlockdevOnError, default 'report')
1708 - "on-target-error": the action to take on an error on the target
1709 (BlockdevOnError, default 'report')
1710 - "unmap": whether the target sectors should be discarded where source has only
1711 zeroes. (json-bool, optional, default true)
1713 The default value of the granularity is the image cluster size clamped
1714 between 4096 and 65536, if the image format defines one. If the format
1715 does not define a cluster size, the default value of the granularity
1721 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1722 "target": "/some/place/my-image",
1724 "format": "qcow2" } }
1730 .name = "blockdev-mirror",
1731 .args_type = "job-id:s?,sync:s,device:B,target:B,replaces:s?,speed:i?,"
1732 "on-source-error:s?,on-target-error:s?,"
1733 "granularity:i?,buf-size:i?",
1734 .mhandler.cmd_new = qmp_marshal_blockdev_mirror,
1741 Start mirroring a block device's writes to another block device. target
1742 specifies the target of mirror operation.
1746 - "job-id": Identifier for the newly-created block job. If omitted,
1747 the device name will be used. (json-string, optional)
1748 - "device": device name to operate on (json-string)
1749 - "target": device name to mirror to (json-string)
1750 - "replaces": the block driver node name to replace when finished
1751 (json-string, optional)
1752 - "speed": maximum speed of the streaming job, in bytes per second
1754 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1755 - "buf_size": maximum amount of data in flight from source to target, in bytes
1756 (json-int, default 10M)
1757 - "sync": what parts of the disk image should be copied to the destination;
1758 possibilities include "full" for all the disk, "top" for only the sectors
1759 allocated in the topmost image, or "none" to only replicate new I/O
1761 - "on-source-error": the action to take on an error on the source
1762 (BlockdevOnError, default 'report')
1763 - "on-target-error": the action to take on an error on the target
1764 (BlockdevOnError, default 'report')
1766 The default value of the granularity is the image cluster size clamped
1767 between 4096 and 65536, if the image format defines one. If the format
1768 does not define a cluster size, the default value of the granularity
1773 -> { "execute": "blockdev-mirror", "arguments": { "device": "ide-hd0",
1774 "target": "target0",
1780 .name = "change-backing-file",
1781 .args_type = "device:s,image-node-name:s,backing-file:s",
1782 .mhandler.cmd_new = qmp_marshal_change_backing_file,
1790 Change the backing file in the image file metadata. This does not cause
1791 QEMU to reopen the image file to reparse the backing filename (it may,
1792 however, perform a reopen to change permissions from r/o -> r/w -> r/o,
1793 if needed). The new backing file string is written into the image file
1794 metadata, and the QEMU internal strings are updated.
1798 - "image-node-name": The name of the block driver state node of the
1799 image to modify. The "device" is argument is used to
1800 verify "image-node-name" is in the chain described by
1802 (json-string, optional)
1804 - "device": The name of the device.
1807 - "backing-file": The string to write as the backing file. This string is
1808 not validated, so care should be taken when specifying
1809 the string or the image chain may not be able to be
1813 Returns: Nothing on success
1814 If "device" does not exist or cannot be determined, DeviceNotFound
1820 .args_type = "value:M",
1821 .mhandler.cmd_new = qmp_marshal_balloon,
1828 Request VM to change its memory allocation (in bytes).
1832 - "value": New memory allocation (json-int)
1836 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1843 .args_type = "name:s,up:b",
1844 .mhandler.cmd_new = qmp_marshal_set_link,
1851 Change the link status of a network adapter.
1855 - "name": network device name (json-string)
1856 - "up": status is up (json-bool)
1860 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1867 .args_type = "fdname:s",
1868 .params = "getfd name",
1869 .help = "receive a file descriptor via SCM rights and assign it a name",
1870 .mhandler.cmd_new = qmp_marshal_getfd,
1877 Receive a file descriptor via SCM rights and assign it a name.
1881 - "fdname": file descriptor name (json-string)
1885 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1890 (1) If the name specified by the "fdname" argument already exists,
1891 the file descriptor assigned to it will be closed and replaced
1892 by the received file descriptor.
1893 (2) The 'closefd' command can be used to explicitly close the file
1894 descriptor when it is no longer needed.
1900 .args_type = "fdname:s",
1901 .params = "closefd name",
1902 .help = "close a file descriptor previously passed via SCM rights",
1903 .mhandler.cmd_new = qmp_marshal_closefd,
1910 Close a file descriptor previously passed via SCM rights.
1914 - "fdname": file descriptor name (json-string)
1918 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1925 .args_type = "fdset-id:i?,opaque:s?",
1926 .params = "add-fd fdset-id opaque",
1927 .help = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1928 .mhandler.cmd_new = qmp_marshal_add_fd,
1935 Add a file descriptor, that was passed via SCM rights, to an fd set.
1939 - "fdset-id": The ID of the fd set to add the file descriptor to.
1940 (json-int, optional)
1941 - "opaque": A free-form string that can be used to describe the fd.
1942 (json-string, optional)
1944 Return a json-object with the following information:
1946 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1947 - "fd": The file descriptor that was received via SCM rights and added to the
1952 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1953 <- { "return": { "fdset-id": 1, "fd": 3 } }
1957 (1) The list of fd sets is shared by all monitor connections.
1958 (2) If "fdset-id" is not specified, a new fd set will be created.
1963 .name = "remove-fd",
1964 .args_type = "fdset-id:i,fd:i?",
1965 .params = "remove-fd fdset-id fd",
1966 .help = "Remove a file descriptor from an fd set",
1967 .mhandler.cmd_new = qmp_marshal_remove_fd,
1974 Remove a file descriptor from an fd set.
1978 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1980 - "fd": The file descriptor that is to be removed. (json-int, optional)
1984 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1989 (1) The list of fd sets is shared by all monitor connections.
1990 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1996 .name = "query-fdsets",
1998 .help = "Return information describing all fd sets",
1999 .mhandler.cmd_new = qmp_marshal_query_fdsets,
2006 Return information describing all fd sets.
2012 -> { "execute": "query-fdsets" }
2018 "opaque": "rdonly:/path/to/file"
2022 "opaque": "rdwr:/path/to/file"
2041 Note: The list of fd sets is shared by all monitor connections.
2046 .name = "block_passwd",
2047 .args_type = "device:s?,node-name:s?,password:s",
2048 .mhandler.cmd_new = qmp_marshal_block_passwd,
2055 Set the password of encrypted block devices.
2059 - "device": device name (json-string)
2060 - "node-name": name in the block driver state graph (json-string)
2061 - "password": password (json-string)
2065 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
2066 "password": "12345" } }
2072 .name = "block_set_io_throttle",
2073 .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?",
2074 .mhandler.cmd_new = qmp_marshal_block_set_io_throttle,
2078 block_set_io_throttle
2081 Change I/O throttle limits for a block drive.
2085 - "device": device name (json-string)
2086 - "bps": total throughput limit in bytes per second (json-int)
2087 - "bps_rd": read throughput limit in bytes per second (json-int)
2088 - "bps_wr": write throughput limit in bytes per second (json-int)
2089 - "iops": total I/O operations per second (json-int)
2090 - "iops_rd": read I/O operations per second (json-int)
2091 - "iops_wr": write I/O operations per second (json-int)
2092 - "bps_max": total throughput limit during bursts, in bytes (json-int, optional)
2093 - "bps_rd_max": read throughput limit during bursts, in bytes (json-int, optional)
2094 - "bps_wr_max": write throughput limit during bursts, in bytes (json-int, optional)
2095 - "iops_max": total I/O operations per second during bursts (json-int, optional)
2096 - "iops_rd_max": read I/O operations per second during bursts (json-int, optional)
2097 - "iops_wr_max": write I/O operations per second during bursts (json-int, optional)
2098 - "bps_max_length": maximum length of the @bps_max burst period, in seconds (json-int, optional)
2099 - "bps_rd_max_length": maximum length of the @bps_rd_max burst period, in seconds (json-int, optional)
2100 - "bps_wr_max_length": maximum length of the @bps_wr_max burst period, in seconds (json-int, optional)
2101 - "iops_max_length": maximum length of the @iops_max burst period, in seconds (json-int, optional)
2102 - "iops_rd_max_length": maximum length of the @iops_rd_max burst period, in seconds (json-int, optional)
2103 - "iops_wr_max_length": maximum length of the @iops_wr_max burst period, in seconds (json-int, optional)
2104 - "iops_size": I/O size in bytes when limiting (json-int, optional)
2105 - "group": throttle group name (json-string, optional)
2109 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
2122 "bps_max_length": 60,
2129 .name = "set_password",
2130 .args_type = "protocol:s,password:s,connected:s?",
2131 .mhandler.cmd_new = qmp_marshal_set_password,
2138 Set the password for vnc/spice protocols.
2142 - "protocol": protocol name (json-string)
2143 - "password": password (json-string)
2144 - "connected": [ keep | disconnect | fail ] (json-string, optional)
2148 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
2149 "password": "secret" } }
2155 .name = "expire_password",
2156 .args_type = "protocol:s,time:s",
2157 .mhandler.cmd_new = qmp_marshal_expire_password,
2164 Set the password expire time for vnc/spice protocols.
2168 - "protocol": protocol name (json-string)
2169 - "time": [ now | never | +secs | secs ] (json-string)
2173 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
2180 .name = "add_client",
2181 .args_type = "protocol:s,fdname:s,skipauth:b?,tls:b?",
2182 .mhandler.cmd_new = qmp_marshal_add_client,
2189 Add a graphics client
2193 - "protocol": protocol name (json-string)
2194 - "fdname": file descriptor name (json-string)
2195 - "skipauth": whether to skip authentication (json-bool, optional)
2196 - "tls": whether to perform TLS (json-bool, optional)
2200 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
2201 "fdname": "myclient" } }
2206 .name = "qmp_capabilities",
2209 .help = "enable QMP capabilities",
2210 .mhandler.cmd_new = qmp_capabilities,
2217 Enable QMP capabilities.
2223 -> { "execute": "qmp_capabilities" }
2226 Note: This command must be issued before issuing any other command.
2231 .name = "human-monitor-command",
2232 .args_type = "command-line:s,cpu-index:i?",
2233 .mhandler.cmd_new = qmp_marshal_human_monitor_command,
2237 human-monitor-command
2238 ---------------------
2240 Execute a Human Monitor command.
2244 - command-line: the command name and its arguments, just like the
2245 Human Monitor's shell (json-string)
2246 - cpu-index: select the CPU number to be used by commands which access CPU
2247 data, like 'info registers'. The Monitor selects CPU 0 if this
2248 argument is not provided (json-int, optional)
2252 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
2253 <- { "return": "kvm support: enabled\r\n" }
2257 (1) The Human Monitor is NOT an stable interface, this means that command
2258 names, arguments and responses can change or be removed at ANY time.
2259 Applications that rely on long term stability guarantees should NOT
2264 o This command is stateless, this means that commands that depend
2265 on state information (such as getfd) might not work
2267 o Commands that prompt the user for data (eg. 'cont' when the block
2268 device is encrypted) don't currently work
2273 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
2274 HXCOMM this! We will possibly move query commands definitions inside those
2275 HXCOMM sections, just like regular commands.
2285 Return a json-object with the following information:
2287 - "qemu": A json-object containing three integer values:
2288 - "major": QEMU's major version (json-int)
2289 - "minor": QEMU's minor version (json-int)
2290 - "micro": QEMU's micro version (json-int)
2291 - "package": package's version (json-string)
2295 -> { "execute": "query-version" }
2310 .name = "query-version",
2312 .mhandler.cmd_new = qmp_marshal_query_version,
2319 List QMP available commands.
2321 Each command is represented by a json-object, the returned value is a json-array
2324 Each json-object contain:
2326 - "name": command's name (json-string)
2330 -> { "execute": "query-commands" }
2334 "name":"query-balloon"
2337 "name":"system_powerdown"
2342 Note: This example has been shortened as the real response is too long.
2347 .name = "query-commands",
2349 .mhandler.cmd_new = qmp_marshal_query_commands,
2356 List QMP available events.
2358 Each event is represented by a json-object, the returned value is a json-array
2361 Each json-object contains:
2363 - "name": event's name (json-string)
2367 -> { "execute": "query-events" }
2379 Note: This example has been shortened as the real response is too long.
2384 .name = "query-events",
2386 .mhandler.cmd_new = qmp_marshal_query_events,
2393 Return the QMP wire schema. The returned value is a json-array of
2394 named schema entities. Entities are commands, events and various
2395 types. See docs/qapi-code-gen.txt for information on their structure
2401 .name = "query-qmp-schema",
2403 .mhandler.cmd_new = qmp_query_qmp_schema,
2410 Each device is represented by a json-object. The returned value is a json-array
2413 Each json-object contain the following:
2415 - "label": device's label (json-string)
2416 - "filename": device's file (json-string)
2417 - "frontend-open": open/closed state of the frontend device attached to this
2422 -> { "execute": "query-chardev" }
2426 "label": "charchannel0",
2427 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
2428 "frontend-open": false
2431 "label": "charmonitor",
2432 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
2433 "frontend-open": true
2436 "label": "charserial0",
2437 "filename": "pty:/dev/pts/2",
2438 "frontend-open": true
2446 .name = "query-chardev",
2448 .mhandler.cmd_new = qmp_marshal_query_chardev,
2452 query-chardev-backends
2455 List available character device backends.
2457 Each backend is represented by a json-object, the returned value is a json-array
2460 Each json-object contains:
2462 - "name": backend name (json-string)
2466 -> { "execute": "query-chardev-backends" }
2487 .name = "query-chardev-backends",
2489 .mhandler.cmd_new = qmp_marshal_query_chardev_backends,
2496 Show the block devices.
2498 Each block device information is stored in a json-object and the returned value
2499 is a json-array of all devices.
2501 Each json-object contain the following:
2503 - "device": device name (json-string)
2504 - "type": device type (json-string)
2505 - deprecated, retained for backward compatibility
2506 - Possible values: "unknown"
2507 - "removable": true if the device is removable, false otherwise (json-bool)
2508 - "locked": true if the device is locked, false otherwise (json-bool)
2509 - "tray_open": only present if removable, true if the device has a tray,
2510 and it is open (json-bool)
2511 - "inserted": only present if the device is inserted, it is a json-object
2512 containing the following:
2513 - "file": device file name (json-string)
2514 - "ro": true if read-only, false otherwise (json-bool)
2515 - "drv": driver format name (json-string)
2516 - Possible values: "blkdebug", "bochs", "cloop", "dmg",
2517 "file", "file", "ftp", "ftps", "host_cdrom",
2518 "host_device", "http", "https",
2519 "nbd", "parallels", "qcow", "qcow2", "raw",
2520 "tftp", "vdi", "vmdk", "vpc", "vvfat"
2521 - "backing_file": backing file name (json-string, optional)
2522 - "backing_file_depth": number of files in the backing file chain (json-int)
2523 - "encrypted": true if encrypted, false otherwise (json-bool)
2524 - "bps": limit total bytes per second (json-int)
2525 - "bps_rd": limit read bytes per second (json-int)
2526 - "bps_wr": limit write bytes per second (json-int)
2527 - "iops": limit total I/O operations per second (json-int)
2528 - "iops_rd": limit read operations per second (json-int)
2529 - "iops_wr": limit write operations per second (json-int)
2530 - "bps_max": total max in bytes (json-int)
2531 - "bps_rd_max": read max in bytes (json-int)
2532 - "bps_wr_max": write max in bytes (json-int)
2533 - "iops_max": total I/O operations max (json-int)
2534 - "iops_rd_max": read I/O operations max (json-int)
2535 - "iops_wr_max": write I/O operations max (json-int)
2536 - "iops_size": I/O size when limiting by iops (json-int)
2537 - "detect_zeroes": detect and optimize zero writing (json-string)
2538 - Possible values: "off", "on", "unmap"
2539 - "write_threshold": write offset threshold in bytes, a event will be
2540 emitted if crossed. Zero if disabled (json-int)
2541 - "image": the detail of the image, it is a json-object containing
2543 - "filename": image file name (json-string)
2544 - "format": image format (json-string)
2545 - "virtual-size": image capacity in bytes (json-int)
2546 - "dirty-flag": true if image is not cleanly closed, not present
2547 means clean (json-bool, optional)
2548 - "actual-size": actual size on disk in bytes of the image, not
2549 present when image does not support thin
2550 provision (json-int, optional)
2551 - "cluster-size": size of a cluster in bytes, not present if image
2552 format does not support it (json-int, optional)
2553 - "encrypted": true if the image is encrypted, not present means
2554 false or the image format does not support
2555 encryption (json-bool, optional)
2556 - "backing_file": backing file name, not present means no backing
2557 file is used or the image format does not
2558 support backing file chain
2559 (json-string, optional)
2560 - "full-backing-filename": full path of the backing file, not
2561 present if it equals backing_file or no
2562 backing file is used
2563 (json-string, optional)
2564 - "backing-filename-format": the format of the backing file, not
2565 present means unknown or no backing
2566 file (json-string, optional)
2567 - "snapshots": the internal snapshot info, it is an optional list
2568 of json-object containing the following:
2569 - "id": unique snapshot id (json-string)
2570 - "name": snapshot name (json-string)
2571 - "vm-state-size": size of the VM state in bytes (json-int)
2572 - "date-sec": UTC date of the snapshot in seconds (json-int)
2573 - "date-nsec": fractional part in nanoseconds to be used with
2575 - "vm-clock-sec": VM clock relative to boot in seconds
2577 - "vm-clock-nsec": fractional part in nanoseconds to be used
2578 with vm-clock-sec (json-int)
2579 - "backing-image": the detail of the backing image, it is an
2580 optional json-object only present when a
2581 backing image present for this image
2583 - "io-status": I/O operation status, only present if the device supports it
2584 and the VM is configured to stop on errors. It's always reset
2585 to "ok" when the "cont" command is issued (json_string, optional)
2586 - Possible values: "ok", "failed", "nospace"
2590 -> { "execute": "query-block" }
2595 "device":"ide0-hd0",
2602 "file":"disks/test.qcow2",
2603 "backing_file_depth":1,
2617 "detect_zeroes": "on",
2618 "write_threshold": 0,
2620 "filename":"disks/test.qcow2",
2622 "virtual-size":2048000,
2623 "backing_file":"base.qcow2",
2624 "full-backing-filename":"disks/base.qcow2",
2625 "backing-filename-format":"qcow2",
2629 "name": "snapshot1",
2631 "date-sec": 10000200,
2633 "vm-clock-sec": 206,
2638 "filename":"disks/base.qcow2",
2640 "virtual-size":2048000
2648 "device":"ide1-cd0",
2671 .name = "query-block",
2673 .mhandler.cmd_new = qmp_marshal_query_block,
2680 Show block device statistics.
2682 Each device statistic information is stored in a json-object and the returned
2683 value is a json-array of all devices.
2685 Each json-object contain the following:
2687 - "device": device name (json-string)
2688 - "stats": A json-object with the statistics information, it contains:
2689 - "rd_bytes": bytes read (json-int)
2690 - "wr_bytes": bytes written (json-int)
2691 - "rd_operations": read operations (json-int)
2692 - "wr_operations": write operations (json-int)
2693 - "flush_operations": cache flush operations (json-int)
2694 - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2695 - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2696 - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
2697 - "wr_highest_offset": The offset after the greatest byte written to the
2698 BlockDriverState since it has been opened (json-int)
2699 - "rd_merged": number of read requests that have been merged into
2700 another request (json-int)
2701 - "wr_merged": number of write requests that have been merged into
2702 another request (json-int)
2703 - "idle_time_ns": time since the last I/O operation, in
2704 nanoseconds. If the field is absent it means
2705 that there haven't been any operations yet
2706 (json-int, optional)
2707 - "failed_rd_operations": number of failed read operations
2709 - "failed_wr_operations": number of failed write operations
2711 - "failed_flush_operations": number of failed flush operations
2713 - "invalid_rd_operations": number of invalid read operations
2715 - "invalid_wr_operations": number of invalid write operations
2717 - "invalid_flush_operations": number of invalid flush operations
2719 - "account_invalid": whether invalid operations are included in
2720 the last access statistics (json-bool)
2721 - "account_failed": whether failed operations are included in the
2722 latency and last access statistics
2724 - "timed_stats": A json-array containing statistics collected in
2725 specific intervals, with the following members:
2726 - "interval_length": interval used for calculating the
2727 statistics, in seconds (json-int)
2728 - "min_rd_latency_ns": minimum latency of read operations in
2729 the defined interval, in nanoseconds
2731 - "min_wr_latency_ns": minimum latency of write operations in
2732 the defined interval, in nanoseconds
2734 - "min_flush_latency_ns": minimum latency of flush operations
2735 in the defined interval, in
2736 nanoseconds (json-int)
2737 - "max_rd_latency_ns": maximum latency of read operations in
2738 the defined interval, in nanoseconds
2740 - "max_wr_latency_ns": maximum latency of write operations in
2741 the defined interval, in nanoseconds
2743 - "max_flush_latency_ns": maximum latency of flush operations
2744 in the defined interval, in
2745 nanoseconds (json-int)
2746 - "avg_rd_latency_ns": average latency of read operations in
2747 the defined interval, in nanoseconds
2749 - "avg_wr_latency_ns": average latency of write operations in
2750 the defined interval, in nanoseconds
2752 - "avg_flush_latency_ns": average latency of flush operations
2753 in the defined interval, in
2754 nanoseconds (json-int)
2755 - "avg_rd_queue_depth": average number of pending read
2756 operations in the defined interval
2758 - "avg_wr_queue_depth": average number of pending write
2759 operations in the defined interval
2761 - "parent": Contains recursively the statistics of the underlying
2762 protocol (e.g. the host file for a qcow2 image). If there is
2763 no underlying protocol, this field is omitted
2764 (json-object, optional)
2768 -> { "execute": "query-blockstats" }
2772 "device":"ide0-hd0",
2775 "wr_highest_offset":3686448128,
2777 "wr_operations":751,
2778 "rd_bytes":122567168,
2779 "rd_operations":36772
2780 "wr_total_times_ns":313253456
2781 "rd_total_times_ns":3465673657
2782 "flush_total_times_ns":49653
2783 "flush_operations":61,
2786 "idle_time_ns":2953431879,
2787 "account_invalid":true,
2788 "account_failed":false
2792 "wr_highest_offset":2821110784,
2794 "wr_operations":692,
2795 "rd_bytes":122739200,
2796 "rd_operations":36604
2797 "flush_operations":51,
2798 "wr_total_times_ns":313253456
2799 "rd_total_times_ns":3465673657
2800 "flush_total_times_ns":49653,
2803 "idle_time_ns":2953431879,
2804 "account_invalid":true,
2805 "account_failed":false
2809 "device":"ide1-cd0",
2811 "wr_highest_offset":0,
2816 "flush_operations":0,
2817 "wr_total_times_ns":0
2818 "rd_total_times_ns":0
2819 "flush_total_times_ns":0,
2822 "account_invalid":false,
2823 "account_failed":false
2829 "wr_highest_offset":0,
2834 "flush_operations":0,
2835 "wr_total_times_ns":0
2836 "rd_total_times_ns":0
2837 "flush_total_times_ns":0,
2840 "account_invalid":false,
2841 "account_failed":false
2847 "wr_highest_offset":0,
2852 "flush_operations":0,
2853 "wr_total_times_ns":0
2854 "rd_total_times_ns":0
2855 "flush_total_times_ns":0,
2858 "account_invalid":false,
2859 "account_failed":false
2868 .name = "query-blockstats",
2869 .args_type = "query-nodes:b?",
2870 .mhandler.cmd_new = qmp_marshal_query_blockstats,
2877 Show CPU information.
2879 Return a json-array. Each CPU is represented by a json-object, which contains:
2881 - "CPU": CPU index (json-int)
2882 - "current": true if this is the current CPU, false otherwise (json-bool)
2883 - "halted": true if the cpu is halted, false otherwise (json-bool)
2884 - "qom_path": path to the CPU object in the QOM tree (json-str)
2885 - "arch": architecture of the cpu, which determines what additional
2886 keys will be present (json-str)
2887 - Current program counter. The key's name depends on the architecture:
2888 "pc": i386/x86_64 (json-int)
2889 "nip": PPC (json-int)
2890 "pc" and "npc": sparc (json-int)
2891 "PC": mips (json-int)
2892 - "thread_id": ID of the underlying host thread (json-int)
2896 -> { "execute": "query-cpus" }
2903 "qom_path":"/machine/unattached/device[0]",
2912 "qom_path":"/machine/unattached/device[2]",
2923 .name = "query-cpus",
2925 .mhandler.cmd_new = qmp_marshal_query_cpus,
2932 Returns a list of information about each iothread.
2934 Note this list excludes the QEMU main loop thread, which is not declared
2935 using the -object iothread command-line option. It is always the main thread
2938 Return a json-array. Each iothread is represented by a json-object, which contains:
2940 - "id": name of iothread (json-str)
2941 - "thread-id": ID of the underlying host thread (json-int)
2945 -> { "execute": "query-iothreads" }
2962 .name = "query-iothreads",
2964 .mhandler.cmd_new = qmp_marshal_query_iothreads,
2971 PCI buses and devices information.
2973 The returned value is a json-array of all buses. Each bus is represented by
2974 a json-object, which has a key with a json-array of all PCI devices attached
2975 to it. Each device is represented by a json-object.
2977 The bus json-object contains the following:
2979 - "bus": bus number (json-int)
2980 - "devices": a json-array of json-objects, each json-object represents a
2983 The PCI device json-object contains the following:
2985 - "bus": identical to the parent's bus number (json-int)
2986 - "slot": slot number (json-int)
2987 - "function": function number (json-int)
2988 - "class_info": a json-object containing:
2989 - "desc": device class description (json-string, optional)
2990 - "class": device class number (json-int)
2991 - "id": a json-object containing:
2992 - "device": device ID (json-int)
2993 - "vendor": vendor ID (json-int)
2994 - "irq": device's IRQ if assigned (json-int, optional)
2995 - "qdev_id": qdev id string (json-string)
2996 - "pci_bridge": It's a json-object, only present if this device is a
2997 PCI bridge, contains:
2998 - "bus": bus number (json-int)
2999 - "secondary": secondary bus number (json-int)
3000 - "subordinate": subordinate bus number (json-int)
3001 - "io_range": I/O memory range information, a json-object with the
3003 - "base": base address, in bytes (json-int)
3004 - "limit": limit address, in bytes (json-int)
3005 - "memory_range": memory range information, a json-object with the
3007 - "base": base address, in bytes (json-int)
3008 - "limit": limit address, in bytes (json-int)
3009 - "prefetchable_range": Prefetchable memory range information, a
3010 json-object with the following members:
3011 - "base": base address, in bytes (json-int)
3012 - "limit": limit address, in bytes (json-int)
3013 - "devices": a json-array of PCI devices if there's any attached, each
3014 each element is represented by a json-object, which contains
3015 the same members of the 'PCI device json-object' described
3017 - "regions": a json-array of json-objects, each json-object represents a
3018 memory region of this device
3020 The memory range json-object contains the following:
3022 - "base": base memory address (json-int)
3023 - "limit": limit value (json-int)
3025 The region json-object can be an I/O region or a memory region, an I/O region
3026 json-object contains the following:
3028 - "type": "io" (json-string, fixed)
3029 - "bar": BAR number (json-int)
3030 - "address": memory address (json-int)
3031 - "size": memory size (json-int)
3033 A memory region json-object contains the following:
3035 - "type": "memory" (json-string, fixed)
3036 - "bar": BAR number (json-int)
3037 - "address": memory address (json-int)
3038 - "size": memory size (json-int)
3039 - "mem_type_64": true or false (json-bool)
3040 - "prefetch": true or false (json-bool)
3044 -> { "execute": "query-pci" }
3056 "desc":"Host bridge"
3090 "desc":"IDE controller"
3112 "desc":"VGA controller"
3122 "mem_type_64":false,
3125 "address":4026531840,
3130 "mem_type_64":false,
3133 "address":4060086272,
3138 "mem_type_64":false,
3153 "desc":"RAM controller"
3174 Note: This example has been shortened as the real response is too long.
3179 .name = "query-pci",
3181 .mhandler.cmd_new = qmp_marshal_query_pci,
3188 Show KVM information.
3190 Return a json-object with the following information:
3192 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
3193 - "present": true if QEMU has KVM support, false otherwise (json-bool)
3197 -> { "execute": "query-kvm" }
3198 <- { "return": { "enabled": true, "present": true } }
3203 .name = "query-kvm",
3205 .mhandler.cmd_new = qmp_marshal_query_kvm,
3212 Return a json-object with the following information:
3214 - "running": true if the VM is running, or false if it is paused (json-bool)
3215 - "singlestep": true if the VM is in single step mode,
3216 false otherwise (json-bool)
3217 - "status": one of the following values (json-string)
3218 "debug" - QEMU is running on a debugger
3219 "inmigrate" - guest is paused waiting for an incoming migration
3220 "internal-error" - An internal error that prevents further guest
3221 execution has occurred
3222 "io-error" - the last IOP has failed and the device is configured
3223 to pause on I/O errors
3224 "paused" - guest has been paused via the 'stop' command
3225 "postmigrate" - guest is paused following a successful 'migrate'
3226 "prelaunch" - QEMU was started with -S and guest has not started
3227 "finish-migrate" - guest is paused to finish the migration process
3228 "restore-vm" - guest is paused to restore VM state
3229 "running" - guest is actively running
3230 "save-vm" - guest is paused to save the VM state
3231 "shutdown" - guest is shut down (and -no-shutdown is in use)
3232 "watchdog" - the watchdog action is configured to pause and
3237 -> { "execute": "query-status" }
3238 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
3243 .name = "query-status",
3245 .mhandler.cmd_new = qmp_marshal_query_status,
3252 Show VM mice information.
3254 Each mouse is represented by a json-object, the returned value is a json-array
3257 The mouse json-object contains the following:
3259 - "name": mouse's name (json-string)
3260 - "index": mouse's index (json-int)
3261 - "current": true if this mouse is receiving events, false otherwise (json-bool)
3262 - "absolute": true if the mouse generates absolute input events (json-bool)
3266 -> { "execute": "query-mice" }
3270 "name":"QEMU Microsoft Mouse",
3276 "name":"QEMU PS/2 Mouse",
3287 .name = "query-mice",
3289 .mhandler.cmd_new = qmp_marshal_query_mice,
3296 Show VNC server information.
3298 Return a json-object with server information. Connected clients are returned
3299 as a json-array of json-objects.
3301 The main json-object contains the following:
3303 - "enabled": true or false (json-bool)
3304 - "host": server's IP address (json-string)
3305 - "family": address family (json-string)
3306 - Possible values: "ipv4", "ipv6", "unix", "unknown"
3307 - "service": server's port number (json-string)
3308 - "auth": authentication method (json-string)
3309 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
3310 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
3311 "vencrypt+plain", "vencrypt+tls+none",
3312 "vencrypt+tls+plain", "vencrypt+tls+sasl",
3313 "vencrypt+tls+vnc", "vencrypt+x509+none",
3314 "vencrypt+x509+plain", "vencrypt+x509+sasl",
3315 "vencrypt+x509+vnc", "vnc"
3316 - "clients": a json-array of all connected clients
3318 Clients are described by a json-object, each one contain the following:
3320 - "host": client's IP address (json-string)
3321 - "family": address family (json-string)
3322 - Possible values: "ipv4", "ipv6", "unix", "unknown"
3323 - "service": client's port number (json-string)
3324 - "x509_dname": TLS dname (json-string, optional)
3325 - "sasl_username": SASL username (json-string, optional)
3329 -> { "execute": "query-vnc" }
3350 .name = "query-vnc",
3352 .mhandler.cmd_new = qmp_marshal_query_vnc,
3355 .name = "query-vnc-servers",
3357 .mhandler.cmd_new = qmp_marshal_query_vnc_servers,
3364 Show SPICE server information.
3366 Return a json-object with server information. Connected clients are returned
3367 as a json-array of json-objects.
3369 The main json-object contains the following:
3371 - "enabled": true or false (json-bool)
3372 - "host": server's IP address (json-string)
3373 - "port": server's port number (json-int, optional)
3374 - "tls-port": server's port number (json-int, optional)
3375 - "auth": authentication method (json-string)
3376 - Possible values: "none", "spice"
3377 - "channels": a json-array of all active channels clients
3379 Channels are described by a json-object, each one contain the following:
3381 - "host": client's IP address (json-string)
3382 - "family": address family (json-string)
3383 - Possible values: "ipv4", "ipv6", "unix", "unknown"
3384 - "port": client's port number (json-string)
3385 - "connection-id": spice connection id. All channels with the same id
3386 belong to the same spice session (json-int)
3387 - "channel-type": channel type. "1" is the main control channel, filter for
3388 this one if you want track spice sessions only (json-int)
3389 - "channel-id": channel id. Usually "0", might be different needed when
3390 multiple channels of the same type exist, such as multiple
3391 display channels in a multihead setup (json-int)
3392 - "tls": whether the channel is encrypted (json-bool)
3396 -> { "execute": "query-spice" }
3409 "connection-id": 1804289383,
3410 "host": "127.0.0.1",
3418 "connection-id": 1804289383,
3419 "host": "127.0.0.1",
3423 [ ... more channels follow ... ]
3430 #if defined(CONFIG_SPICE)
3432 .name = "query-spice",
3434 .mhandler.cmd_new = qmp_marshal_query_spice,
3444 Return a json-object with the following information:
3446 - "name": VM's name (json-string, optional)
3450 -> { "execute": "query-name" }
3451 <- { "return": { "name": "qemu-name" } }
3456 .name = "query-name",
3458 .mhandler.cmd_new = qmp_marshal_query_name,
3467 Return a json-object with the following information:
3469 - "UUID": Universally Unique Identifier (json-string)
3473 -> { "execute": "query-uuid" }
3474 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
3479 .name = "query-uuid",
3481 .mhandler.cmd_new = qmp_marshal_query_uuid,
3485 query-command-line-options
3486 --------------------------
3488 Show command line option schema.
3490 Return a json-array of command line option schema for all options (or for
3491 the given option), returning an error if the given option doesn't exist.
3493 Each array entry contains the following:
3495 - "option": option name (json-string)
3496 - "parameters": a json-array describes all parameters of the option:
3497 - "name": parameter name (json-string)
3498 - "type": parameter type (one of 'string', 'boolean', 'number',
3500 - "help": human readable description of the parameter
3501 (json-string, optional)
3502 - "default": default value string for the parameter
3503 (json-string, optional)
3507 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
3516 "name": "bootindex",
3520 "option": "option-rom"
3528 .name = "query-command-line-options",
3529 .args_type = "option:s?",
3530 .mhandler.cmd_new = qmp_marshal_query_command_line_options,
3539 Return a json-object. If migration is active there will be another json-object
3540 with RAM migration status and if block migration is active another one with
3541 block migration status.
3543 The main json-object contains the following:
3545 - "status": migration status (json-string)
3546 - Possible values: "setup", "active", "completed", "failed", "cancelled"
3547 - "total-time": total amount of ms since migration started. If
3548 migration has ended, it returns the total migration
3550 - "setup-time" amount of setup time in milliseconds _before_ the
3551 iterations begin but _after_ the QMP command is issued.
3552 This is designed to provide an accounting of any activities
3553 (such as RDMA pinning) which may be expensive, but do not
3554 actually occur during the iterative migration rounds
3555 themselves. (json-int)
3556 - "downtime": only present when migration has finished correctly
3557 total amount in ms for downtime that happened (json-int)
3558 - "expected-downtime": only present while migration is active
3559 total amount in ms for downtime that was calculated on
3560 the last bitmap round (json-int)
3561 - "ram": only present if "status" is "active", it is a json-object with the
3562 following RAM information:
3563 - "transferred": amount transferred in bytes (json-int)
3564 - "remaining": amount remaining to transfer in bytes (json-int)
3565 - "total": total amount of memory in bytes (json-int)
3566 - "duplicate": number of pages filled entirely with the same
3568 These are sent over the wire much more efficiently.
3569 - "skipped": number of skipped zero pages (json-int)
3570 - "normal" : number of whole pages transferred. I.e. they
3571 were not sent as duplicate or xbzrle pages (json-int)
3572 - "normal-bytes" : number of bytes transferred in whole
3573 pages. This is just normal pages times size of one page,
3574 but this way upper levels don't need to care about page
3576 - "dirty-sync-count": times that dirty ram was synchronized (json-int)
3577 - "disk": only present if "status" is "active" and it is a block migration,
3578 it is a json-object with the following disk information:
3579 - "transferred": amount transferred in bytes (json-int)
3580 - "remaining": amount remaining to transfer in bytes json-int)
3581 - "total": total disk size in bytes (json-int)
3582 - "xbzrle-cache": only present if XBZRLE is active.
3583 It is a json-object with the following XBZRLE information:
3584 - "cache-size": XBZRLE cache size in bytes
3585 - "bytes": number of bytes transferred for XBZRLE compressed pages
3586 - "pages": number of XBZRLE compressed pages
3587 - "cache-miss": number of XBRZRLE page cache misses
3588 - "cache-miss-rate": rate of XBRZRLE page cache misses
3589 - "overflow": number of times XBZRLE overflows. This means
3590 that the XBZRLE encoding was bigger than just sent the
3591 whole page, and then we sent the whole page instead (as as
3596 1. Before the first migration
3598 -> { "execute": "query-migrate" }
3601 2. Migration is done and has succeeded
3603 -> { "execute": "query-migrate" }
3605 "status": "completed",
3615 "normal-bytes":123456,
3616 "dirty-sync-count":15
3621 3. Migration is done and has failed
3623 -> { "execute": "query-migrate" }
3624 <- { "return": { "status": "failed" } }
3626 4. Migration is being performed and is not a block migration:
3628 -> { "execute": "query-migrate" }
3638 "expected-downtime":12345,
3641 "normal-bytes":123456,
3642 "dirty-sync-count":15
3647 5. Migration is being performed and is a block migration:
3649 -> { "execute": "query-migrate" }
3655 "remaining":1053304,
3659 "expected-downtime":12345,
3662 "normal-bytes":123456,
3663 "dirty-sync-count":15
3667 "remaining":20880384,
3673 6. Migration is being performed and XBZRLE is active:
3675 -> { "execute": "query-migrate" }
3679 "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
3682 "remaining":1053304,
3686 "expected-downtime":12345,
3689 "normal-bytes":3412992,
3690 "dirty-sync-count":15
3693 "cache-size":67108864,
3697 "cache-miss-rate":0.123,
3706 .name = "query-migrate",
3708 .mhandler.cmd_new = qmp_marshal_query_migrate,
3712 migrate-set-capabilities
3713 ------------------------
3715 Enable/Disable migration capabilities
3717 - "xbzrle": XBZRLE support
3718 - "rdma-pin-all": pin all pages when using RDMA during migration
3719 - "auto-converge": throttle down guest to help convergence of migration
3720 - "zero-blocks": compress zero blocks during block migration
3721 - "compress": use multiple compression threads to accelerate live migration
3722 - "events": generate events for each migration state change
3723 - "postcopy-ram": postcopy mode for live migration
3729 -> { "execute": "migrate-set-capabilities" , "arguments":
3730 { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
3735 .name = "migrate-set-capabilities",
3736 .args_type = "capabilities:q",
3737 .params = "capability:s,state:b",
3738 .mhandler.cmd_new = qmp_marshal_migrate_set_capabilities,
3741 query-migrate-capabilities
3742 --------------------------
3744 Query current migration capabilities
3746 - "capabilities": migration capabilities state
3747 - "xbzrle" : XBZRLE state (json-bool)
3748 - "rdma-pin-all" : RDMA Pin Page state (json-bool)
3749 - "auto-converge" : Auto Converge state (json-bool)
3750 - "zero-blocks" : Zero Blocks state (json-bool)
3751 - "compress": Multiple compression threads state (json-bool)
3752 - "events": Migration state change event state (json-bool)
3753 - "postcopy-ram": postcopy ram state (json-bool)
3759 -> { "execute": "query-migrate-capabilities" }
3761 {"state": false, "capability": "xbzrle"},
3762 {"state": false, "capability": "rdma-pin-all"},
3763 {"state": false, "capability": "auto-converge"},
3764 {"state": false, "capability": "zero-blocks"},
3765 {"state": false, "capability": "compress"},
3766 {"state": true, "capability": "events"},
3767 {"state": false, "capability": "postcopy-ram"}
3773 .name = "query-migrate-capabilities",
3775 .mhandler.cmd_new = qmp_marshal_query_migrate_capabilities,
3779 migrate-set-parameters
3780 ----------------------
3782 Set migration parameters
3784 - "compress-level": set compression level during migration (json-int)
3785 - "compress-threads": set compression thread count for migration (json-int)
3786 - "decompress-threads": set decompression thread count for migration (json-int)
3787 - "cpu-throttle-initial": set initial percentage of time guest cpus are
3788 throttled for auto-converge (json-int)
3789 - "cpu-throttle-increment": set throttle increasing percentage for
3790 auto-converge (json-int)
3796 -> { "execute": "migrate-set-parameters" , "arguments":
3797 { "compress-level": 1 } }
3802 .name = "migrate-set-parameters",
3804 "compress-level:i?,compress-threads:i?,decompress-threads:i?,cpu-throttle-initial:i?,cpu-throttle-increment:i?",
3805 .mhandler.cmd_new = qmp_marshal_migrate_set_parameters,
3808 query-migrate-parameters
3809 ------------------------
3811 Query current migration parameters
3813 - "parameters": migration parameters value
3814 - "compress-level" : compression level value (json-int)
3815 - "compress-threads" : compression thread count value (json-int)
3816 - "decompress-threads" : decompression thread count value (json-int)
3817 - "cpu-throttle-initial" : initial percentage of time guest cpus are
3818 throttled (json-int)
3819 - "cpu-throttle-increment" : throttle increasing percentage for
3820 auto-converge (json-int)
3826 -> { "execute": "query-migrate-parameters" }
3829 "decompress-threads": 2,
3830 "cpu-throttle-increment": 10,
3831 "compress-threads": 8,
3832 "compress-level": 1,
3833 "cpu-throttle-initial": 20
3840 .name = "query-migrate-parameters",
3842 .mhandler.cmd_new = qmp_marshal_query_migrate_parameters,
3849 Show balloon information.
3851 Make an asynchronous request for balloon info. When the request completes a
3852 json-object will be returned containing the following data:
3854 - "actual": current balloon value in bytes (json-int)
3858 -> { "execute": "query-balloon" }
3861 "actual":1073741824,
3868 .name = "query-balloon",
3870 .mhandler.cmd_new = qmp_marshal_query_balloon,
3874 .name = "query-block-jobs",
3876 .mhandler.cmd_new = qmp_marshal_query_block_jobs,
3881 .args_type = "path:s",
3882 .mhandler.cmd_new = qmp_marshal_qom_list,
3887 .args_type = "path:s,property:s,value:q",
3888 .mhandler.cmd_new = qmp_marshal_qom_set,
3893 .args_type = "path:s,property:s",
3894 .mhandler.cmd_new = qmp_marshal_qom_get,
3898 .name = "nbd-server-start",
3899 .args_type = "addr:q,tls-creds:s?",
3900 .mhandler.cmd_new = qmp_marshal_nbd_server_start,
3903 .name = "nbd-server-add",
3904 .args_type = "device:B,writable:b?",
3905 .mhandler.cmd_new = qmp_marshal_nbd_server_add,
3908 .name = "nbd-server-stop",
3910 .mhandler.cmd_new = qmp_marshal_nbd_server_stop,
3914 .name = "change-vnc-password",
3915 .args_type = "password:s",
3916 .mhandler.cmd_new = qmp_marshal_change_vnc_password,
3919 .name = "qom-list-types",
3920 .args_type = "implements:s?,abstract:b?",
3921 .mhandler.cmd_new = qmp_marshal_qom_list_types,
3925 .name = "device-list-properties",
3926 .args_type = "typename:s",
3927 .mhandler.cmd_new = qmp_marshal_device_list_properties,
3931 .name = "query-machines",
3933 .mhandler.cmd_new = qmp_marshal_query_machines,
3937 .name = "query-cpu-definitions",
3939 .mhandler.cmd_new = qmp_marshal_query_cpu_definitions,
3943 .name = "query-target",
3945 .mhandler.cmd_new = qmp_marshal_query_target,
3949 .name = "query-tpm",
3951 .mhandler.cmd_new = qmp_marshal_query_tpm,
3958 Return information about the TPM device.
3964 -> { "execute": "query-tpm" }
3967 { "model": "tpm-tis",
3969 { "type": "passthrough",
3971 { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3983 .name = "query-tpm-models",
3985 .mhandler.cmd_new = qmp_marshal_query_tpm_models,
3992 Return a list of supported TPM models.
3998 -> { "execute": "query-tpm-models" }
3999 <- { "return": [ "tpm-tis" ] }
4004 .name = "query-tpm-types",
4006 .mhandler.cmd_new = qmp_marshal_query_tpm_types,
4013 Return a list of supported TPM types.
4019 -> { "execute": "query-tpm-types" }
4020 <- { "return": [ "passthrough" ] }
4025 .name = "chardev-add",
4026 .args_type = "id:s,backend:q",
4027 .mhandler.cmd_new = qmp_marshal_chardev_add,
4038 - "id": the chardev's ID, must be unique (json-string)
4039 - "backend": chardev backend type + parameters
4043 -> { "execute" : "chardev-add",
4044 "arguments" : { "id" : "foo",
4045 "backend" : { "type" : "null", "data" : {} } } }
4048 -> { "execute" : "chardev-add",
4049 "arguments" : { "id" : "bar",
4050 "backend" : { "type" : "file",
4051 "data" : { "out" : "/tmp/bar.log" } } } }
4054 -> { "execute" : "chardev-add",
4055 "arguments" : { "id" : "baz",
4056 "backend" : { "type" : "pty", "data" : {} } } }
4057 <- { "return": { "pty" : "/dev/pty/42" } }
4062 .name = "chardev-remove",
4063 .args_type = "id:s",
4064 .mhandler.cmd_new = qmp_marshal_chardev_remove,
4076 - "id": the chardev's ID, must exist and not be in use (json-string)
4080 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
4085 .name = "query-rx-filter",
4086 .args_type = "name:s?",
4087 .mhandler.cmd_new = qmp_marshal_query_rx_filter,
4094 Show rx-filter information.
4096 Returns a json-array of rx-filter information for all NICs (or for the
4097 given NIC), returning an error if the given NIC doesn't exist, or
4098 given NIC doesn't support rx-filter querying, or given net client
4101 The query will clear the event notification flag of each NIC, then qemu
4102 will start to emit event to QMP monitor.
4104 Each array entry contains the following:
4106 - "name": net client name (json-string)
4107 - "promiscuous": promiscuous mode is enabled (json-bool)
4108 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
4109 - "unicast": unicast receive state (one of 'normal', 'none', 'all')
4110 - "vlan": vlan receive state (one of 'normal', 'none', 'all') (Since 2.0)
4111 - "broadcast-allowed": allow to receive broadcast (json-bool)
4112 - "multicast-overflow": multicast table is overflowed (json-bool)
4113 - "unicast-overflow": unicast table is overflowed (json-bool)
4114 - "main-mac": main macaddr string (json-string)
4115 - "vlan-table": a json-array of active vlan id
4116 - "unicast-table": a json-array of unicast macaddr string
4117 - "multicast-table": a json-array of multicast macaddr string
4121 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
4124 "promiscuous": true,
4126 "main-mac": "52:54:00:12:34:56",
4127 "unicast": "normal",
4135 "multicast": "normal",
4136 "multicast-overflow": false,
4137 "unicast-overflow": false,
4138 "multicast-table": [
4139 "01:00:5e:00:00:01",
4140 "33:33:00:00:00:01",
4143 "broadcast-allowed": false
4151 .name = "blockdev-add",
4152 .args_type = "options:q",
4153 .mhandler.cmd_new = qmp_marshal_blockdev_add,
4162 This command is still a work in progress. It doesn't support all
4163 block drivers among other things. Stay away from it unless you want
4164 to help with its development.
4168 - "options": block driver options
4172 -> { "execute": "blockdev-add",
4173 "arguments": { "options" : { "driver": "qcow2",
4174 "file": { "driver": "file",
4175 "filename": "test.qcow2" } } } }
4180 -> { "execute": "blockdev-add",
4192 "filename": "/tmp/test.qcow2"
4198 "filename": "/dev/fdset/4"
4210 .name = "x-blockdev-del",
4211 .args_type = "id:s?,node-name:s?",
4212 .mhandler.cmd_new = qmp_marshal_x_blockdev_del,
4220 Deletes a block device thas has been added using blockdev-add.
4221 The selected device can be either a block backend or a graph node.
4223 In the former case the backend will be destroyed, along with its
4224 inserted medium if there's any. The command will fail if the backend
4225 or its medium are in use.
4227 In the latter case the node will be destroyed. The command will fail
4228 if the node is attached to a block backend or is otherwise being
4231 One of "id" or "node-name" must be specified, but not both.
4233 This command is still a work in progress and is considered
4234 experimental. Stay away from it unless you want to help with its
4239 - "id": Name of the block backend device to delete (json-string, optional)
4240 - "node-name": Name of the graph node to delete (json-string, optional)
4244 -> { "execute": "blockdev-add",
4251 "filename": "test.qcow2"
4259 -> { "execute": "x-blockdev-del",
4260 "arguments": { "id": "drive0" }
4267 .name = "blockdev-open-tray",
4268 .args_type = "device:s,force:b?",
4269 .mhandler.cmd_new = qmp_marshal_blockdev_open_tray,
4276 Opens a block device's tray. If there is a block driver state tree inserted as a
4277 medium, it will become inaccessible to the guest (but it will remain associated
4278 to the block device, so closing the tray will make it accessible again).
4280 If the tray was already open before, this will be a no-op.
4282 Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
4283 which no such event will be generated, these include:
4284 - if the guest has locked the tray, @force is false and the guest does not
4285 respond to the eject request
4286 - if the BlockBackend denoted by @device does not have a guest device attached
4288 - if the guest device does not have an actual tray and is empty, for instance
4289 for floppy disk drives
4293 - "device": block device name (json-string)
4294 - "force": if false (the default), an eject request will be sent to the guest if
4295 it has locked the tray (and the tray will not be opened immediately);
4296 if true, the tray will be opened regardless of whether it is locked
4297 (json-bool, optional)
4301 -> { "execute": "blockdev-open-tray",
4302 "arguments": { "device": "ide1-cd0" } }
4304 <- { "timestamp": { "seconds": 1418751016,
4305 "microseconds": 716996 },
4306 "event": "DEVICE_TRAY_MOVED",
4307 "data": { "device": "ide1-cd0",
4308 "tray-open": true } }
4315 .name = "blockdev-close-tray",
4316 .args_type = "device:s",
4317 .mhandler.cmd_new = qmp_marshal_blockdev_close_tray,
4324 Closes a block device's tray. If there is a block driver state tree associated
4325 with the block device (which is currently ejected), that tree will be loaded as
4328 If the tray was already closed before, this will be a no-op.
4332 - "device": block device name (json-string)
4336 -> { "execute": "blockdev-close-tray",
4337 "arguments": { "device": "ide1-cd0" } }
4339 <- { "timestamp": { "seconds": 1418751345,
4340 "microseconds": 272147 },
4341 "event": "DEVICE_TRAY_MOVED",
4342 "data": { "device": "ide1-cd0",
4343 "tray-open": false } }
4350 .name = "x-blockdev-remove-medium",
4351 .args_type = "device:s",
4352 .mhandler.cmd_new = qmp_marshal_x_blockdev_remove_medium,
4356 x-blockdev-remove-medium
4357 ------------------------
4359 Removes a medium (a block driver state tree) from a block device. That block
4360 device's tray must currently be open (unless there is no attached guest device).
4362 If the tray is open and there is no medium inserted, this will be a no-op.
4364 This command is still a work in progress and is considered experimental.
4365 Stay away from it unless you want to help with its development.
4369 - "device": block device name (json-string)
4373 -> { "execute": "x-blockdev-remove-medium",
4374 "arguments": { "device": "ide1-cd0" } }
4376 <- { "error": { "class": "GenericError",
4377 "desc": "Tray of device 'ide1-cd0' is not open" } }
4379 -> { "execute": "blockdev-open-tray",
4380 "arguments": { "device": "ide1-cd0" } }
4382 <- { "timestamp": { "seconds": 1418751627,
4383 "microseconds": 549958 },
4384 "event": "DEVICE_TRAY_MOVED",
4385 "data": { "device": "ide1-cd0",
4386 "tray-open": true } }
4390 -> { "execute": "x-blockdev-remove-medium",
4391 "arguments": { "device": "ide1-cd0" } }
4398 .name = "x-blockdev-insert-medium",
4399 .args_type = "device:s,node-name:s",
4400 .mhandler.cmd_new = qmp_marshal_x_blockdev_insert_medium,
4404 x-blockdev-insert-medium
4405 ------------------------
4407 Inserts a medium (a block driver state tree) into a block device. That block
4408 device's tray must currently be open (unless there is no attached guest device)
4409 and there must be no medium inserted already.
4411 This command is still a work in progress and is considered experimental.
4412 Stay away from it unless you want to help with its development.
4416 - "device": block device name (json-string)
4417 - "node-name": root node of the BDS tree to insert into the block device
4421 -> { "execute": "blockdev-add",
4422 "arguments": { "options": { "node-name": "node0",
4424 "file": { "driver": "file",
4425 "filename": "fedora.iso" } } } }
4429 -> { "execute": "x-blockdev-insert-medium",
4430 "arguments": { "device": "ide1-cd0",
4431 "node-name": "node0" } }
4438 .name = "x-blockdev-change",
4439 .args_type = "parent:B,child:B?,node:B?",
4440 .mhandler.cmd_new = qmp_marshal_x_blockdev_change,
4447 Dynamically reconfigure the block driver state graph. It can be used
4448 to add, remove, insert or replace a graph node. Currently only the
4449 Quorum driver implements this feature to add or remove its child. This
4450 is useful to fix a broken quorum child.
4452 If @node is specified, it will be inserted under @parent. @child
4453 may not be specified in this case. If both @parent and @child are
4454 specified but @node is not, @child will be detached from @parent.
4457 - "parent": the id or name of the parent node (json-string)
4458 - "child": the name of a child under the given parent node (json-string, optional)
4459 - "node": the name of the node that will be added (json-string, optional)
4461 Note: this command is experimental, and not a stable API. It doesn't
4462 support all kinds of operations, all kinds of children, nor all block
4465 Warning: The data in a new quorum child MUST be consistent with that of
4466 the rest of the array.
4470 Add a new node to a quorum
4471 -> { "execute": "blockdev-add",
4472 "arguments": { "options": { "driver": "raw",
4473 "node-name": "new_node",
4474 "file": { "driver": "file",
4475 "filename": "test.raw" } } } }
4477 -> { "execute": "x-blockdev-change",
4478 "arguments": { "parent": "disk1",
4479 "node": "new_node" } }
4482 Delete a quorum's node
4483 -> { "execute": "x-blockdev-change",
4484 "arguments": { "parent": "disk1",
4485 "child": "children.1" } }
4491 .name = "query-named-block-nodes",
4493 .mhandler.cmd_new = qmp_marshal_query_named_block_nodes,
4497 @query-named-block-nodes
4498 ------------------------
4500 Return a list of BlockDeviceInfo for all the named block driver nodes
4504 -> { "execute": "query-named-block-nodes" }
4505 <- { "return": [ { "ro":false,
4508 "file":"disks/test.qcow2",
4509 "node-name": "my-node",
4510 "backing_file_depth":1,
4524 "write_threshold": 0,
4526 "filename":"disks/test.qcow2",
4528 "virtual-size":2048000,
4529 "backing_file":"base.qcow2",
4530 "full-backing-filename":"disks/base.qcow2",
4531 "backing-filename-format":"qcow2",
4535 "name": "snapshot1",
4537 "date-sec": 10000200,
4539 "vm-clock-sec": 206,
4544 "filename":"disks/base.qcow2",
4546 "virtual-size":2048000
4553 .name = "blockdev-change-medium",
4554 .args_type = "device:B,filename:F,format:s?,read-only-mode:s?",
4555 .mhandler.cmd_new = qmp_marshal_blockdev_change_medium,
4559 blockdev-change-medium
4560 ----------------------
4562 Changes the medium inserted into a block device by ejecting the current medium
4563 and loading a new image file which is inserted as the new medium.
4567 - "device": device name (json-string)
4568 - "filename": filename of the new image (json-string)
4569 - "format": format of the new image (json-string, optional)
4570 - "read-only-mode": new read-only mode (json-string, optional)
4571 - Possible values: "retain" (default), "read-only", "read-write"
4575 1. Change a removable medium
4577 -> { "execute": "blockdev-change-medium",
4578 "arguments": { "device": "ide1-cd0",
4579 "filename": "/srv/images/Fedora-12-x86_64-DVD.iso",
4583 2. Load a read-only medium into a writable drive
4585 -> { "execute": "blockdev-change-medium",
4586 "arguments": { "device": "isa-fd0",
4587 "filename": "/srv/images/ro.img",
4589 "read-only-mode": "retain" } }
4592 { "class": "GenericError",
4593 "desc": "Could not open '/srv/images/ro.img': Permission denied" } }
4595 -> { "execute": "blockdev-change-medium",
4596 "arguments": { "device": "isa-fd0",
4597 "filename": "/srv/images/ro.img",
4599 "read-only-mode": "read-only" } }
4606 .name = "query-memdev",
4608 .mhandler.cmd_new = qmp_marshal_query_memdev,
4615 Show memory devices information.
4620 -> { "execute": "query-memdev" }
4627 "host-nodes": [0, 1],
4635 "host-nodes": [2, 3],
4636 "policy": "preferred"
4644 .name = "query-memory-devices",
4646 .mhandler.cmd_new = qmp_marshal_query_memory_devices,
4650 @query-memory-devices
4651 --------------------
4653 Return a list of memory devices.
4656 -> { "execute": "query-memory-devices" }
4657 <- { "return": [ { "data":
4658 { "addr": 5368709120,
4659 "hotpluggable": true,
4662 "memdev": "/objects/memX",
4671 .name = "query-acpi-ospm-status",
4673 .mhandler.cmd_new = qmp_marshal_query_acpi_ospm_status,
4677 @query-acpi-ospm-status
4678 --------------------
4680 Return list of ACPIOSTInfo for devices that support status reporting
4681 via ACPI _OST method.
4684 -> { "execute": "query-acpi-ospm-status" }
4685 <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
4686 { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
4687 { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
4688 { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
4692 #if defined TARGET_I386
4694 .name = "rtc-reset-reinjection",
4696 .mhandler.cmd_new = qmp_marshal_rtc_reset_reinjection,
4701 rtc-reset-reinjection
4702 ---------------------
4704 Reset the RTC interrupt reinjection backlog.
4710 -> { "execute": "rtc-reset-reinjection" }
4715 .name = "trace-event-get-state",
4716 .args_type = "name:s",
4717 .mhandler.cmd_new = qmp_marshal_trace_event_get_state,
4721 trace-event-get-state
4722 ---------------------
4724 Query the state of events.
4728 -> { "execute": "trace-event-get-state", "arguments": { "name": "qemu_memalign" } }
4729 <- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
4733 .name = "trace-event-set-state",
4734 .args_type = "name:s,enable:b,ignore-unavailable:b?",
4735 .mhandler.cmd_new = qmp_marshal_trace_event_set_state,
4739 trace-event-set-state
4740 ---------------------
4742 Set the state of events.
4746 -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } }
4751 .name = "input-send-event",
4752 .args_type = "console:i?,events:q",
4753 .mhandler.cmd_new = qmp_marshal_input_send_event,
4760 Send input event to guest.
4764 - "device": display device (json-string, optional)
4765 - "head": display head (json-int, optional)
4766 - "events": list of input events
4768 The consoles are visible in the qom tree, under
4769 /backend/console[$index]. They have a device link and head property, so
4770 it is possible to map which console belongs to which device and display.
4772 Note: this command is experimental, and not a stable API.
4776 Press left mouse button.
4778 -> { "execute": "input-send-event",
4779 "arguments": { "device": "video0",
4780 "events": [ { "type": "btn",
4781 "data" : { "down": true, "button": "left" } } ] } }
4784 -> { "execute": "input-send-event",
4785 "arguments": { "device": "video0",
4786 "events": [ { "type": "btn",
4787 "data" : { "down": false, "button": "left" } } ] } }
4794 -> { "execute": "input-send-event",
4795 "arguments": { "events": [
4796 { "type": "key", "data" : { "down": true,
4797 "key": {"type": "qcode", "data": "ctrl" } } },
4798 { "type": "key", "data" : { "down": true,
4799 "key": {"type": "qcode", "data": "alt" } } },
4800 { "type": "key", "data" : { "down": true,
4801 "key": {"type": "qcode", "data": "delete" } } } ] } }
4806 Move mouse pointer to absolute coordinates (20000, 400).
4808 -> { "execute": "input-send-event" ,
4809 "arguments": { "events": [
4810 { "type": "abs", "data" : { "axis": "x", "value" : 20000 } },
4811 { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
4817 .name = "block-set-write-threshold",
4818 .args_type = "node-name:s,write-threshold:l",
4819 .mhandler.cmd_new = qmp_marshal_block_set_write_threshold,
4823 block-set-write-threshold
4826 Change the write threshold for a block drive. The threshold is an offset,
4827 thus must be non-negative. Default is no write threshold.
4828 Setting the threshold to zero disables it.
4832 - "node-name": the node name in the block driver state graph (json-string)
4833 - "write-threshold": the write threshold in bytes (json-int)
4837 -> { "execute": "block-set-write-threshold",
4838 "arguments": { "node-name": "mydev",
4839 "write-threshold": 17179869184 } }
4845 .name = "query-rocker",
4846 .args_type = "name:s",
4847 .mhandler.cmd_new = qmp_marshal_query_rocker,
4856 - "name": switch name
4860 -> { "execute": "query-rocker", "arguments": { "name": "sw1" } }
4861 <- { "return": {"name": "sw1", "ports": 2, "id": 1327446905938}}
4866 .name = "query-rocker-ports",
4867 .args_type = "name:s",
4868 .mhandler.cmd_new = qmp_marshal_query_rocker_ports,
4872 Show rocker switch ports
4873 ------------------------
4877 - "name": switch name
4881 -> { "execute": "query-rocker-ports", "arguments": { "name": "sw1" } }
4882 <- { "return": [ {"duplex": "full", "enabled": true, "name": "sw1.1",
4883 "autoneg": "off", "link-up": true, "speed": 10000},
4884 {"duplex": "full", "enabled": true, "name": "sw1.2",
4885 "autoneg": "off", "link-up": true, "speed": 10000}
4891 .name = "query-rocker-of-dpa-flows",
4892 .args_type = "name:s,tbl-id:i?",
4893 .mhandler.cmd_new = qmp_marshal_query_rocker_of_dpa_flows,
4897 Show rocker switch OF-DPA flow tables
4898 -------------------------------------
4902 - "name": switch name
4903 - "tbl-id": (optional) flow table ID
4907 -> { "execute": "query-rocker-of-dpa-flows", "arguments": { "name": "sw1" } }
4908 <- { "return": [ {"key": {"in-pport": 0, "priority": 1, "tbl-id": 0},
4911 "action": {"goto-tbl": 10},
4912 "mask": {"in-pport": 4294901760}
4920 .name = "query-rocker-of-dpa-groups",
4921 .args_type = "name:s,type:i?",
4922 .mhandler.cmd_new = qmp_marshal_query_rocker_of_dpa_groups,
4926 Show rocker OF-DPA group tables
4927 -------------------------------
4931 - "name": switch name
4932 - "type": (optional) group type
4936 -> { "execute": "query-rocker-of-dpa-groups", "arguments": { "name": "sw1" } }
4937 <- { "return": [ {"type": 0, "out-pport": 2, "pport": 2, "vlan-id": 3841,
4938 "pop-vlan": 1, "id": 251723778},
4939 {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3841,
4940 "pop-vlan": 1, "id": 251723776},
4941 {"type": 0, "out-pport": 1, "pport": 1, "vlan-id": 3840,
4942 "pop-vlan": 1, "id": 251658241},
4943 {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3840,
4944 "pop-vlan": 1, "id": 251658240}
4949 #if defined TARGET_ARM
4951 .name = "query-gic-capabilities",
4953 .mhandler.cmd_new = qmp_marshal_query_gic_capabilities,
4958 query-gic-capabilities
4961 Return a list of GICCapability objects, describing supported GIC
4962 (Generic Interrupt Controller) versions.
4968 -> { "execute": "query-gic-capabilities" }
4969 <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
4970 { "version": 3, "emulated": false, "kernel": true } ] }
4975 .name = "query-hotpluggable-cpus",
4977 .mhandler.cmd_new = qmp_marshal_query_hotpluggable_cpus,
4981 Show existing/possible CPUs
4982 ---------------------------
4986 Example for pseries machine type started with
4987 -smp 2,cores=2,maxcpus=4 -cpu POWER8:
4989 -> { "execute": "query-hotpluggable-cpus" }
4991 { "props": { "core-id": 8 }, "type": "POWER8-spapr-cpu-core",
4993 { "props": { "core-id": 0 }, "type": "POWER8-spapr-cpu-core",
4994 "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"}