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 (json-string)
328 -> { "execute": "device_del", "arguments": { "id": "net1" } }
335 .args_type = "keys:q,hold-time:i?",
336 .mhandler.cmd_new = qmp_marshal_send_key,
348 - "key": key sequence (a json-array of key union values,
349 union can be number or qcode enum)
351 - hold-time: time to delay key up events, milliseconds. Defaults to 100
356 -> { "execute": "send-key",
357 "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
358 { "type": "qcode", "data": "alt" },
359 { "type": "qcode", "data": "delete" } ] } }
366 .args_type = "index:i",
367 .mhandler.cmd_new = qmp_marshal_cpu,
378 - "index": the CPU's index (json-int)
382 -> { "execute": "cpu", "arguments": { "index": 0 } }
385 Note: CPUs' indexes are obtained with the 'query-cpus' command.
392 .mhandler.cmd_new = qmp_marshal_cpu_add,
403 - "id": cpu id (json-int)
407 -> { "execute": "cpu-add", "arguments": { "id": 2 } }
414 .args_type = "val:l,size:i,filename:s,cpu:i?",
415 .mhandler.cmd_new = qmp_marshal_memsave,
422 Save to disk virtual memory dump starting at 'val' of size 'size'.
426 - "val": the starting address (json-int)
427 - "size": the memory size, in bytes (json-int)
428 - "filename": file path (json-string)
429 - "cpu": virtual CPU index (json-int, optional)
433 -> { "execute": "memsave",
434 "arguments": { "val": 10,
436 "filename": "/tmp/virtual-mem-dump" } }
443 .args_type = "val:l,size:i,filename:s",
444 .mhandler.cmd_new = qmp_marshal_pmemsave,
451 Save to disk physical memory dump starting at 'val' of size 'size'.
455 - "val": the starting address (json-int)
456 - "size": the memory size, in bytes (json-int)
457 - "filename": file path (json-string)
461 -> { "execute": "pmemsave",
462 "arguments": { "val": 10,
464 "filename": "/tmp/physical-mem-dump" } }
470 .name = "inject-nmi",
472 .mhandler.cmd_new = qmp_marshal_inject_nmi,
479 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
485 -> { "execute": "inject-nmi" }
488 Note: inject-nmi fails when the guest doesn't support injecting.
493 .name = "ringbuf-write",
494 .args_type = "device:s,data:s,format:s?",
495 .mhandler.cmd_new = qmp_marshal_ringbuf_write,
502 Write to a ring buffer character device.
506 - "device": ring buffer character device name (json-string)
507 - "data": data to write (json-string)
508 - "format": data format (json-string, optional)
509 - Possible values: "utf8" (default), "base64"
510 Bug: invalid base64 is currently not rejected.
511 Whitespace *is* invalid.
515 -> { "execute": "ringbuf-write",
516 "arguments": { "device": "foo",
524 .name = "ringbuf-read",
525 .args_type = "device:s,size:i,format:s?",
526 .mhandler.cmd_new = qmp_marshal_ringbuf_read,
533 Read from a ring buffer character device.
537 - "device": ring buffer character device name (json-string)
538 - "size": how many bytes to read at most (json-int)
539 - Number of data bytes, not number of characters in encoded data
540 - "format": data format (json-string, optional)
541 - Possible values: "utf8" (default), "base64"
542 - Naturally, format "utf8" works only when the ring buffer
543 contains valid UTF-8 text. Invalid UTF-8 sequences get
544 replaced. Bug: replacement doesn't work. Bug: can screw
545 up on encountering NUL characters, after the ring buffer
546 lost data, and when reading stops because the size limit
551 -> { "execute": "ringbuf-read",
552 "arguments": { "device": "foo",
555 <- {"return": "abcdefgh"}
560 .name = "xen-save-devices-state",
561 .args_type = "filename:F",
562 .mhandler.cmd_new = qmp_marshal_xen_save_devices_state,
566 xen-save-devices-state
569 Save the state of all devices to file. The RAM and the block devices
570 of the VM are not saved by this command.
574 - "filename": the file to save the state of the devices to as binary
575 data. See xen-save-devices-state.txt for a description of the binary
580 -> { "execute": "xen-save-devices-state",
581 "arguments": { "filename": "/tmp/save" } }
587 .name = "xen-set-global-dirty-log",
588 .args_type = "enable:b",
589 .mhandler.cmd_new = qmp_marshal_xen_set_global_dirty_log,
593 xen-set-global-dirty-log
596 Enable or disable the global dirty log mode.
600 - "enable": Enable it or disable it.
604 -> { "execute": "xen-set-global-dirty-log",
605 "arguments": { "enable": true } }
612 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
613 .mhandler.cmd_new = qmp_marshal_migrate,
624 - "blk": block migration, full disk copy (json-bool, optional)
625 - "inc": incremental disk copy (json-bool, optional)
626 - "uri": Destination URI (json-string)
630 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
635 (1) The 'query-migrate' command should be used to check migration's progress
636 and final result (this information is provided by the 'status' member)
637 (2) All boolean arguments default to false
638 (3) The user Monitor's "detach" argument is invalid in QMP and should not
644 .name = "migrate_cancel",
646 .mhandler.cmd_new = qmp_marshal_migrate_cancel,
653 Cancel the current migration.
659 -> { "execute": "migrate_cancel" }
665 .name = "migrate-incoming",
666 .args_type = "uri:s",
667 .mhandler.cmd_new = qmp_marshal_migrate_incoming,
674 Continue an incoming migration
678 - "uri": Source/listening URI (json-string)
682 -> { "execute": "migrate-incoming", "arguments": { "uri": "tcp::4446" } }
687 (1) QEMU must be started with -incoming defer to allow migrate-incoming to
689 (2) The uri format is the same as for -incoming
693 .name = "migrate-set-cache-size",
694 .args_type = "value:o",
695 .mhandler.cmd_new = qmp_marshal_migrate_set_cache_size,
699 migrate-set-cache-size
700 ----------------------
702 Set cache size to be used by XBZRLE migration, the cache size will be rounded
703 down to the nearest power of 2
707 - "value": cache size in bytes (json-int)
711 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
716 .name = "query-migrate-cache-size",
718 .mhandler.cmd_new = qmp_marshal_query_migrate_cache_size,
722 query-migrate-cache-size
723 ------------------------
725 Show cache size to be used by XBZRLE migration
727 returns a json-object with the following information:
732 -> { "execute": "query-migrate-cache-size" }
733 <- { "return": 67108864 }
738 .name = "migrate_set_speed",
739 .args_type = "value:o",
740 .mhandler.cmd_new = qmp_marshal_migrate_set_speed,
747 Set maximum speed for migrations.
751 - "value": maximum speed, in bytes per second (json-int)
755 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
761 .name = "migrate_set_downtime",
762 .args_type = "value:T",
763 .mhandler.cmd_new = qmp_marshal_migrate_set_downtime,
770 Set maximum tolerated downtime (in seconds) for migrations.
774 - "value": maximum downtime (json-number)
778 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
784 .name = "client_migrate_info",
785 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
786 .params = "protocol hostname port tls-port cert-subject",
787 .help = "set migration information for remote display",
788 .mhandler.cmd_new = qmp_marshal_client_migrate_info,
795 Set migration information for remote display. This makes the server
796 ask the client to automatically reconnect using the new parameters
797 once migration finished successfully. Only implemented for SPICE.
801 - "protocol": must be "spice" (json-string)
802 - "hostname": migration target hostname (json-string)
803 - "port": spice tcp port for plaintext channels (json-int, optional)
804 - "tls-port": spice tcp port for tls-secured channels (json-int, optional)
805 - "cert-subject": server certificate subject (json-string, optional)
809 -> { "execute": "client_migrate_info",
810 "arguments": { "protocol": "spice",
811 "hostname": "virt42.lab.kraxel.org",
818 .name = "dump-guest-memory",
819 .args_type = "paging:b,protocol:s,begin:i?,end:i?,format:s?",
820 .params = "-p protocol [begin] [length] [format]",
821 .help = "dump guest memory to file",
822 .mhandler.cmd_new = qmp_marshal_dump_guest_memory,
829 Dump guest memory to file. The file can be processed with crash or gdb.
833 - "paging": do paging to get guest's memory mapping (json-bool)
834 - "protocol": destination file(started with "file:") or destination file
835 descriptor (started with "fd:") (json-string)
836 - "begin": the starting physical address. It's optional, and should be specified
837 with length together (json-int)
838 - "length": the memory size, in bytes. It's optional, and should be specified
839 with begin together (json-int)
840 - "format": the format of guest memory dump. It's optional, and can be
841 elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
842 conflict with paging and filter, ie. begin and length (json-string)
846 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
851 (1) All boolean arguments default to false
856 .name = "query-dump-guest-memory-capability",
858 .mhandler.cmd_new = qmp_marshal_query_dump_guest_memory_capability,
862 query-dump-guest-memory-capability
865 Show available formats for 'dump-guest-memory'
869 -> { "execute": "query-dump-guest-memory-capability" }
870 <- { "return": { "formats":
871 ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
875 #if defined TARGET_S390X
877 .name = "dump-skeys",
878 .args_type = "filename:F",
879 .mhandler.cmd_new = qmp_marshal_dump_skeys,
887 Save guest storage keys to file.
891 - "filename": file path (json-string)
895 -> { "execute": "dump-skeys", "arguments": { "filename": "/tmp/skeys" } }
901 .name = "netdev_add",
902 .args_type = "netdev:O",
903 .mhandler.cmd_new = qmp_netdev_add,
910 Add host network device.
914 - "type": the device type, "tap", "user", ... (json-string)
915 - "id": the device's ID, must be unique (json-string)
920 -> { "execute": "netdev_add",
921 "arguments": { "type": "user", "id": "netdev1",
922 "dnssearch": "example.org" } }
925 Note: The supported device options are the same ones supported by the '-netdev'
926 command-line argument, which are listed in the '-help' output or QEMU's
932 .name = "netdev_del",
934 .mhandler.cmd_new = qmp_marshal_netdev_del,
941 Remove host network device.
945 - "id": the device's ID, must be unique (json-string)
949 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
956 .name = "object-add",
957 .args_type = "qom-type:s,id:s,props:q?",
958 .mhandler.cmd_new = qmp_marshal_object_add,
969 - "qom-type": the object's QOM type, i.e. the class name (json-string)
970 - "id": the object's ID, must be unique (json-string)
971 - "props": a dictionary of object property values (optional, json-dict)
975 -> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
976 "props": { "filename": "/dev/hwrng" } } }
982 .name = "object-del",
984 .mhandler.cmd_new = qmp_marshal_object_del,
995 - "id": the object's ID (json-string)
999 -> { "execute": "object-del", "arguments": { "id": "rng1" } }
1007 .name = "block_resize",
1008 .args_type = "device:s?,node-name:s?,size:o",
1009 .mhandler.cmd_new = qmp_marshal_block_resize,
1016 Resize a block image while a guest is running.
1020 - "device": the device's ID, must be unique (json-string)
1021 - "node-name": the node name in the block driver state graph (json-string)
1026 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
1032 .name = "block-stream",
1033 .args_type = "device:B,base:s?,speed:o?,backing-file:s?,on-error:s?",
1034 .mhandler.cmd_new = qmp_marshal_block_stream,
1041 Copy data from a backing file into a block device.
1045 - "device": The device's ID, must be unique (json-string)
1046 - "base": The file name of the backing image above which copying starts
1047 (json-string, optional)
1048 - "backing-file": The backing file string to write into the active layer. This
1049 filename is not validated.
1051 If a pathname string is such that it cannot be resolved by
1052 QEMU, that means that subsequent QMP or HMP commands must use
1053 node-names for the image in question, as filename lookup
1056 If not specified, QEMU will automatically determine the
1057 backing file string to use, or error out if there is no
1058 obvious choice. Care should be taken when specifying the
1059 string, to specify a valid filename or protocol.
1060 (json-string, optional) (Since 2.1)
1061 - "speed": the maximum speed, in bytes per second (json-int, optional)
1062 - "on-error": the action to take on an error (default 'report'). 'stop' and
1063 'enospc' can only be used if the block device supports io-status.
1064 (json-string, optional) (Since 2.1)
1068 -> { "execute": "block-stream", "arguments": { "device": "virtio0",
1069 "base": "/tmp/master.qcow2" } }
1075 .name = "block-commit",
1076 .args_type = "device:B,base:s?,top:s?,backing-file:s?,speed:o?",
1077 .mhandler.cmd_new = qmp_marshal_block_commit,
1084 Live commit of data from overlay image nodes into backing nodes - i.e., writes
1085 data between 'top' and 'base' into 'base'.
1089 - "device": The device's ID, must be unique (json-string)
1090 - "base": The file name of the backing image to write data into.
1091 If not specified, this is the deepest backing image
1092 (json-string, optional)
1093 - "top": The file name of the backing image within the image chain,
1094 which contains the topmost data to be committed down. If
1095 not specified, this is the active layer. (json-string, optional)
1097 - backing-file: The backing file string to write into the overlay
1098 image of 'top'. If 'top' is the active layer,
1099 specifying a backing file string is an error. This
1100 filename is not validated.
1102 If a pathname string is such that it cannot be
1103 resolved by QEMU, that means that subsequent QMP or
1104 HMP commands must use node-names for the image in
1105 question, as filename lookup methods will fail.
1107 If not specified, QEMU will automatically determine
1108 the backing file string to use, or error out if
1109 there is no obvious choice. Care should be taken
1110 when specifying the string, to specify a valid
1111 filename or protocol.
1112 (json-string, optional) (Since 2.1)
1114 If top == base, that is an error.
1115 If top == active, the job will not be completed by itself,
1116 user needs to complete the job with the block-job-complete
1117 command after getting the ready event. (Since 2.0)
1119 If the base image is smaller than top, then the base image
1120 will be resized to be the same size as top. If top is
1121 smaller than the base image, the base will not be
1122 truncated. If you want the base image size to match the
1123 size of the smaller top, you can safely truncate it
1124 yourself once the commit operation successfully completes.
1126 - "speed": the maximum speed, in bytes per second (json-int, optional)
1131 -> { "execute": "block-commit", "arguments": { "device": "virtio0",
1132 "top": "/tmp/snap1.qcow2" } }
1138 .name = "drive-backup",
1139 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1140 "bitmap:s?,on-source-error:s?,on-target-error:s?",
1141 .mhandler.cmd_new = qmp_marshal_drive_backup,
1148 Start a point-in-time copy of a block device to a new destination. The
1149 status of ongoing drive-backup operations can be checked with
1150 query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1151 The operation can be stopped before it has completed using the
1152 block-job-cancel command.
1156 - "device": the name of the device which should be copied.
1158 - "target": the target of the new image. If the file exists, or if it is a
1159 device, the existing file/device will be used as the new
1160 destination. If it does not exist, a new file will be created.
1162 - "format": the format of the new destination, default is to probe if 'mode' is
1163 'existing', else the format of the source
1164 (json-string, optional)
1165 - "sync": what parts of the disk image should be copied to the destination;
1166 possibilities include "full" for all the disk, "top" for only the sectors
1167 allocated in the topmost image, "incremental" for only the dirty sectors in
1168 the bitmap, or "none" to only replicate new I/O (MirrorSyncMode).
1169 - "bitmap": dirty bitmap name for sync==incremental. Must be present if sync
1170 is "incremental", must NOT be present otherwise.
1171 - "mode": whether and how QEMU should create a new image
1172 (NewImageMode, optional, default 'absolute-paths')
1173 - "speed": the maximum speed, in bytes per second (json-int, optional)
1174 - "on-source-error": the action to take on an error on the source, default
1175 'report'. 'stop' and 'enospc' can only be used
1176 if the block device supports io-status.
1177 (BlockdevOnError, optional)
1178 - "on-target-error": the action to take on an error on the target, default
1179 'report' (no limitations, since this applies to
1180 a different block device than device).
1181 (BlockdevOnError, optional)
1184 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
1186 "target": "backup.img" } }
1192 .name = "blockdev-backup",
1193 .args_type = "sync:s,device:B,target:B,speed:i?,"
1194 "on-source-error:s?,on-target-error:s?",
1195 .mhandler.cmd_new = qmp_marshal_blockdev_backup,
1202 The device version of drive-backup: this command takes an existing named device
1207 - "device": the name of the device which should be copied.
1209 - "target": the name of the backup target device. (json-string)
1210 - "sync": what parts of the disk image should be copied to the destination;
1211 possibilities include "full" for all the disk, "top" for only the
1212 sectors allocated in the topmost image, or "none" to only replicate
1213 new I/O (MirrorSyncMode).
1214 - "speed": the maximum speed, in bytes per second (json-int, optional)
1215 - "on-source-error": the action to take on an error on the source, default
1216 'report'. 'stop' and 'enospc' can only be used
1217 if the block device supports io-status.
1218 (BlockdevOnError, optional)
1219 - "on-target-error": the action to take on an error on the target, default
1220 'report' (no limitations, since this applies to
1221 a different block device than device).
1222 (BlockdevOnError, optional)
1225 -> { "execute": "blockdev-backup", "arguments": { "device": "src-id",
1227 "target": "tgt-id" } }
1233 .name = "block-job-set-speed",
1234 .args_type = "device:B,speed:o",
1235 .mhandler.cmd_new = qmp_marshal_block_job_set_speed,
1239 .name = "block-job-cancel",
1240 .args_type = "device:B,force:b?",
1241 .mhandler.cmd_new = qmp_marshal_block_job_cancel,
1244 .name = "block-job-pause",
1245 .args_type = "device:B",
1246 .mhandler.cmd_new = qmp_marshal_block_job_pause,
1249 .name = "block-job-resume",
1250 .args_type = "device:B",
1251 .mhandler.cmd_new = qmp_marshal_block_job_resume,
1254 .name = "block-job-complete",
1255 .args_type = "device:B",
1256 .mhandler.cmd_new = qmp_marshal_block_job_complete,
1259 .name = "transaction",
1260 .args_type = "actions:q",
1261 .mhandler.cmd_new = qmp_marshal_transaction,
1268 Atomically operate on one or more block devices. The only supported operations
1269 for now are drive-backup, internal and external snapshotting. A list of
1270 dictionaries is accepted, that contains the actions to be performed.
1271 If there is any failure performing any of the operations, all operations
1272 for the group are abandoned.
1274 For external snapshots, the dictionary contains the device, the file to use for
1275 the new snapshot, and the format. The default format, if not specified, is
1278 Each new snapshot defaults to being created by QEMU (wiping any
1279 contents if the file already exists), but it is also possible to reuse
1280 an externally-created file. In the latter case, you should ensure that
1281 the new image file has the same contents as the current one; QEMU cannot
1282 perform any meaningful check. Typically this is achieved by using the
1283 current image file as the backing file for the new image.
1285 On failure, the original disks pre-snapshot attempt will be used.
1287 For internal snapshots, the dictionary contains the device and the snapshot's
1288 name. If an internal snapshot matching name already exists, the request will
1289 be rejected. Only some image formats support it, for example, qcow2, rbd,
1292 On failure, qemu will try delete the newly created internal snapshot in the
1293 transaction. When an I/O error occurs during deletion, the user needs to fix
1294 it later with qemu-img or other command.
1299 - "type": the operation to perform. The only supported
1300 value is "blockdev-snapshot-sync". (json-string)
1301 - "data": a dictionary. The contents depend on the value
1302 of "type". When "type" is "blockdev-snapshot-sync":
1303 - "device": device name to snapshot (json-string)
1304 - "node-name": graph node name to snapshot (json-string)
1305 - "snapshot-file": name of new image file (json-string)
1306 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1307 - "format": format of new image (json-string, optional)
1308 - "mode": whether and how QEMU should create the snapshot file
1309 (NewImageMode, optional, default "absolute-paths")
1310 When "type" is "blockdev-snapshot-internal-sync":
1311 - "device": device name to snapshot (json-string)
1312 - "name": name of the new snapshot (json-string)
1316 -> { "execute": "transaction",
1317 "arguments": { "actions": [
1318 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
1319 "snapshot-file": "/some/place/my-image",
1320 "format": "qcow2" } },
1321 { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
1322 "snapshot-file": "/some/place/my-image2",
1323 "snapshot-node-name": "node3432",
1325 "format": "qcow2" } },
1326 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
1327 "snapshot-file": "/some/place/my-image2",
1329 "format": "qcow2" } },
1330 { "type": "blockdev-snapshot-internal-sync", "data" : {
1331 "device": "ide-hd2",
1332 "name": "snapshot0" } } ] } }
1338 .name = "block-dirty-bitmap-add",
1339 .args_type = "node:B,name:s,granularity:i?",
1340 .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_add,
1345 block-dirty-bitmap-add
1346 ----------------------
1349 Create a dirty bitmap with a name on the device, and start tracking the writes.
1353 - "node": device/node on which to create dirty bitmap (json-string)
1354 - "name": name of the new dirty bitmap (json-string)
1355 - "granularity": granularity to track writes with (int, optional)
1359 -> { "execute": "block-dirty-bitmap-add", "arguments": { "node": "drive0",
1360 "name": "bitmap0" } }
1366 .name = "block-dirty-bitmap-remove",
1367 .args_type = "node:B,name:s",
1368 .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_remove,
1373 block-dirty-bitmap-remove
1374 -------------------------
1377 Stop write tracking and remove the dirty bitmap that was created with
1378 block-dirty-bitmap-add.
1382 - "node": device/node on which to remove dirty bitmap (json-string)
1383 - "name": name of the dirty bitmap to remove (json-string)
1387 -> { "execute": "block-dirty-bitmap-remove", "arguments": { "node": "drive0",
1388 "name": "bitmap0" } }
1394 .name = "block-dirty-bitmap-clear",
1395 .args_type = "node:B,name:s",
1396 .mhandler.cmd_new = qmp_marshal_block_dirty_bitmap_clear,
1401 block-dirty-bitmap-clear
1402 ------------------------
1405 Reset the dirty bitmap associated with a node so that an incremental backup
1406 from this point in time forward will only backup clusters modified after this
1411 - "node": device/node on which to remove dirty bitmap (json-string)
1412 - "name": name of the dirty bitmap to remove (json-string)
1416 -> { "execute": "block-dirty-bitmap-clear", "arguments": { "node": "drive0",
1417 "name": "bitmap0" } }
1423 .name = "blockdev-snapshot-sync",
1424 .args_type = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
1425 .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_sync,
1429 blockdev-snapshot-sync
1430 ----------------------
1432 Synchronous snapshot of a block device. snapshot-file specifies the
1433 target of the new image. If the file exists, or if it is a device, the
1434 snapshot will be created in the existing file/device. If does not
1435 exist, a new file will be created. format specifies the format of the
1436 snapshot image, default is qcow2.
1440 - "device": device name to snapshot (json-string)
1441 - "node-name": graph node name to snapshot (json-string)
1442 - "snapshot-file": name of new image file (json-string)
1443 - "snapshot-node-name": graph node name of the new snapshot (json-string)
1444 - "mode": whether and how QEMU should create the snapshot file
1445 (NewImageMode, optional, default "absolute-paths")
1446 - "format": format of new image (json-string, optional)
1450 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1452 "/some/place/my-image",
1453 "format": "qcow2" } }
1459 .name = "blockdev-snapshot-internal-sync",
1460 .args_type = "device:B,name:s",
1461 .mhandler.cmd_new = qmp_marshal_blockdev_snapshot_internal_sync,
1465 blockdev-snapshot-internal-sync
1466 -------------------------------
1468 Synchronously take an internal snapshot of a block device when the format of
1469 image used supports it. If the name is an empty string, or a snapshot with
1470 name already exists, the operation will fail.
1474 - "device": device name to snapshot (json-string)
1475 - "name": name of the new snapshot (json-string)
1479 -> { "execute": "blockdev-snapshot-internal-sync",
1480 "arguments": { "device": "ide-hd0",
1481 "name": "snapshot0" }
1488 .name = "blockdev-snapshot-delete-internal-sync",
1489 .args_type = "device:B,id:s?,name:s?",
1491 qmp_marshal_blockdev_snapshot_delete_internal_sync,
1495 blockdev-snapshot-delete-internal-sync
1496 --------------------------------------
1498 Synchronously delete an internal snapshot of a block device when the format of
1499 image used supports it. The snapshot is identified by name or id or both. One
1500 of name or id is required. If the snapshot is not found, the operation will
1505 - "device": device name (json-string)
1506 - "id": ID of the snapshot (json-string, optional)
1507 - "name": name of the snapshot (json-string, optional)
1511 -> { "execute": "blockdev-snapshot-delete-internal-sync",
1512 "arguments": { "device": "ide-hd0",
1513 "name": "snapshot0" }
1517 "name": "snapshot0",
1519 "date-sec": 1000012,
1521 "vm-clock-sec": 100,
1529 .name = "drive-mirror",
1530 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1531 "node-name:s?,replaces:s?,"
1532 "on-source-error:s?,on-target-error:s?,"
1534 "granularity:i?,buf-size:i?",
1535 .mhandler.cmd_new = qmp_marshal_drive_mirror,
1542 Start mirroring a block device's writes to a new destination. target
1543 specifies the target of the new image. If the file exists, or if it is
1544 a device, it will be used as the new destination for writes. If it does not
1545 exist, a new file will be created. format specifies the format of the
1546 mirror image, default is to probe if mode='existing', else the format
1551 - "device": device name to operate on (json-string)
1552 - "target": name of new image file (json-string)
1553 - "format": format of new image (json-string, optional)
1554 - "node-name": the name of the new block driver state in the node graph
1555 (json-string, optional)
1556 - "replaces": the block driver node name to replace when finished
1557 (json-string, optional)
1558 - "mode": how an image file should be created into the target
1559 file/device (NewImageMode, optional, default 'absolute-paths')
1560 - "speed": maximum speed of the streaming job, in bytes per second
1562 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1563 - "buf_size": maximum amount of data in flight from source to target, in bytes
1564 (json-int, default 10M)
1565 - "sync": what parts of the disk image should be copied to the destination;
1566 possibilities include "full" for all the disk, "top" for only the sectors
1567 allocated in the topmost image, or "none" to only replicate new I/O
1569 - "on-source-error": the action to take on an error on the source
1570 (BlockdevOnError, default 'report')
1571 - "on-target-error": the action to take on an error on the target
1572 (BlockdevOnError, default 'report')
1573 - "unmap": whether the target sectors should be discarded where source has only
1574 zeroes. (json-bool, optional, default true)
1576 The default value of the granularity is the image cluster size clamped
1577 between 4096 and 65536, if the image format defines one. If the format
1578 does not define a cluster size, the default value of the granularity
1584 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1585 "target": "/some/place/my-image",
1587 "format": "qcow2" } }
1593 .name = "change-backing-file",
1594 .args_type = "device:s,image-node-name:s,backing-file:s",
1595 .mhandler.cmd_new = qmp_marshal_change_backing_file,
1603 Change the backing file in the image file metadata. This does not cause
1604 QEMU to reopen the image file to reparse the backing filename (it may,
1605 however, perform a reopen to change permissions from r/o -> r/w -> r/o,
1606 if needed). The new backing file string is written into the image file
1607 metadata, and the QEMU internal strings are updated.
1611 - "image-node-name": The name of the block driver state node of the
1612 image to modify. The "device" is argument is used to
1613 verify "image-node-name" is in the chain described by
1615 (json-string, optional)
1617 - "device": The name of the device.
1620 - "backing-file": The string to write as the backing file. This string is
1621 not validated, so care should be taken when specifying
1622 the string or the image chain may not be able to be
1626 Returns: Nothing on success
1627 If "device" does not exist or cannot be determined, DeviceNotFound
1633 .args_type = "value:M",
1634 .mhandler.cmd_new = qmp_marshal_balloon,
1641 Request VM to change its memory allocation (in bytes).
1645 - "value": New memory allocation (json-int)
1649 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1656 .args_type = "name:s,up:b",
1657 .mhandler.cmd_new = qmp_marshal_set_link,
1664 Change the link status of a network adapter.
1668 - "name": network device name (json-string)
1669 - "up": status is up (json-bool)
1673 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1680 .args_type = "fdname:s",
1681 .params = "getfd name",
1682 .help = "receive a file descriptor via SCM rights and assign it a name",
1683 .mhandler.cmd_new = qmp_marshal_getfd,
1690 Receive a file descriptor via SCM rights and assign it a name.
1694 - "fdname": file descriptor name (json-string)
1698 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1703 (1) If the name specified by the "fdname" argument already exists,
1704 the file descriptor assigned to it will be closed and replaced
1705 by the received file descriptor.
1706 (2) The 'closefd' command can be used to explicitly close the file
1707 descriptor when it is no longer needed.
1713 .args_type = "fdname:s",
1714 .params = "closefd name",
1715 .help = "close a file descriptor previously passed via SCM rights",
1716 .mhandler.cmd_new = qmp_marshal_closefd,
1723 Close a file descriptor previously passed via SCM rights.
1727 - "fdname": file descriptor name (json-string)
1731 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1738 .args_type = "fdset-id:i?,opaque:s?",
1739 .params = "add-fd fdset-id opaque",
1740 .help = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1741 .mhandler.cmd_new = qmp_marshal_add_fd,
1748 Add a file descriptor, that was passed via SCM rights, to an fd set.
1752 - "fdset-id": The ID of the fd set to add the file descriptor to.
1753 (json-int, optional)
1754 - "opaque": A free-form string that can be used to describe the fd.
1755 (json-string, optional)
1757 Return a json-object with the following information:
1759 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1760 - "fd": The file descriptor that was received via SCM rights and added to the
1765 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1766 <- { "return": { "fdset-id": 1, "fd": 3 } }
1770 (1) The list of fd sets is shared by all monitor connections.
1771 (2) If "fdset-id" is not specified, a new fd set will be created.
1776 .name = "remove-fd",
1777 .args_type = "fdset-id:i,fd:i?",
1778 .params = "remove-fd fdset-id fd",
1779 .help = "Remove a file descriptor from an fd set",
1780 .mhandler.cmd_new = qmp_marshal_remove_fd,
1787 Remove a file descriptor from an fd set.
1791 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1793 - "fd": The file descriptor that is to be removed. (json-int, optional)
1797 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1802 (1) The list of fd sets is shared by all monitor connections.
1803 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1809 .name = "query-fdsets",
1811 .help = "Return information describing all fd sets",
1812 .mhandler.cmd_new = qmp_marshal_query_fdsets,
1819 Return information describing all fd sets.
1825 -> { "execute": "query-fdsets" }
1831 "opaque": "rdonly:/path/to/file"
1835 "opaque": "rdwr:/path/to/file"
1854 Note: The list of fd sets is shared by all monitor connections.
1859 .name = "block_passwd",
1860 .args_type = "device:s?,node-name:s?,password:s",
1861 .mhandler.cmd_new = qmp_marshal_block_passwd,
1868 Set the password of encrypted block devices.
1872 - "device": device name (json-string)
1873 - "node-name": name in the block driver state graph (json-string)
1874 - "password": password (json-string)
1878 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1879 "password": "12345" } }
1885 .name = "block_set_io_throttle",
1886 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l,bps_max:l?,bps_rd_max:l?,bps_wr_max:l?,iops_max:l?,iops_rd_max:l?,iops_wr_max:l?,iops_size:l?,group:s?",
1887 .mhandler.cmd_new = qmp_marshal_block_set_io_throttle,
1891 block_set_io_throttle
1894 Change I/O throttle limits for a block drive.
1898 - "device": device name (json-string)
1899 - "bps": total throughput limit in bytes per second (json-int)
1900 - "bps_rd": read throughput limit in bytes per second (json-int)
1901 - "bps_wr": write throughput limit in bytes per second (json-int)
1902 - "iops": total I/O operations per second (json-int)
1903 - "iops_rd": read I/O operations per second (json-int)
1904 - "iops_wr": write I/O operations per second (json-int)
1905 - "bps_max": total max in bytes (json-int)
1906 - "bps_rd_max": read max in bytes (json-int)
1907 - "bps_wr_max": write max in bytes (json-int)
1908 - "iops_max": total I/O operations max (json-int)
1909 - "iops_rd_max": read I/O operations max (json-int)
1910 - "iops_wr_max": write I/O operations max (json-int)
1911 - "iops_size": I/O size in bytes when limiting (json-int)
1912 - "group": throttle group name (json-string)
1916 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
1935 .name = "set_password",
1936 .args_type = "protocol:s,password:s,connected:s?",
1937 .mhandler.cmd_new = qmp_marshal_set_password,
1944 Set the password for vnc/spice protocols.
1948 - "protocol": protocol name (json-string)
1949 - "password": password (json-string)
1950 - "connected": [ keep | disconnect | fail ] (json-string, optional)
1954 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
1955 "password": "secret" } }
1961 .name = "expire_password",
1962 .args_type = "protocol:s,time:s",
1963 .mhandler.cmd_new = qmp_marshal_expire_password,
1970 Set the password expire time for vnc/spice protocols.
1974 - "protocol": protocol name (json-string)
1975 - "time": [ now | never | +secs | secs ] (json-string)
1979 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1986 .name = "add_client",
1987 .args_type = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1988 .mhandler.cmd_new = qmp_marshal_add_client,
1995 Add a graphics client
1999 - "protocol": protocol name (json-string)
2000 - "fdname": file descriptor name (json-string)
2001 - "skipauth": whether to skip authentication (json-bool, optional)
2002 - "tls": whether to perform TLS (json-bool, optional)
2006 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
2007 "fdname": "myclient" } }
2012 .name = "qmp_capabilities",
2015 .help = "enable QMP capabilities",
2016 .mhandler.cmd_new = qmp_capabilities,
2023 Enable QMP capabilities.
2029 -> { "execute": "qmp_capabilities" }
2032 Note: This command must be issued before issuing any other command.
2037 .name = "human-monitor-command",
2038 .args_type = "command-line:s,cpu-index:i?",
2039 .mhandler.cmd_new = qmp_marshal_human_monitor_command,
2043 human-monitor-command
2044 ---------------------
2046 Execute a Human Monitor command.
2050 - command-line: the command name and its arguments, just like the
2051 Human Monitor's shell (json-string)
2052 - cpu-index: select the CPU number to be used by commands which access CPU
2053 data, like 'info registers'. The Monitor selects CPU 0 if this
2054 argument is not provided (json-int, optional)
2058 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
2059 <- { "return": "kvm support: enabled\r\n" }
2063 (1) The Human Monitor is NOT an stable interface, this means that command
2064 names, arguments and responses can change or be removed at ANY time.
2065 Applications that rely on long term stability guarantees should NOT
2070 o This command is stateless, this means that commands that depend
2071 on state information (such as getfd) might not work
2073 o Commands that prompt the user for data (eg. 'cont' when the block
2074 device is encrypted) don't currently work
2079 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
2080 HXCOMM this! We will possibly move query commands definitions inside those
2081 HXCOMM sections, just like regular commands.
2091 Return a json-object with the following information:
2093 - "qemu": A json-object containing three integer values:
2094 - "major": QEMU's major version (json-int)
2095 - "minor": QEMU's minor version (json-int)
2096 - "micro": QEMU's micro version (json-int)
2097 - "package": package's version (json-string)
2101 -> { "execute": "query-version" }
2116 .name = "query-version",
2118 .mhandler.cmd_new = qmp_marshal_query_version,
2125 List QMP available commands.
2127 Each command is represented by a json-object, the returned value is a json-array
2130 Each json-object contain:
2132 - "name": command's name (json-string)
2136 -> { "execute": "query-commands" }
2140 "name":"query-balloon"
2143 "name":"system_powerdown"
2148 Note: This example has been shortened as the real response is too long.
2153 .name = "query-commands",
2155 .mhandler.cmd_new = qmp_marshal_query_commands,
2162 List QMP available events.
2164 Each event is represented by a json-object, the returned value is a json-array
2167 Each json-object contains:
2169 - "name": event's name (json-string)
2173 -> { "execute": "query-events" }
2185 Note: This example has been shortened as the real response is too long.
2190 .name = "query-events",
2192 .mhandler.cmd_new = qmp_marshal_query_events,
2199 Return the QMP wire schema. The returned value is a json-array of
2200 named schema entities. Entities are commands, events and various
2201 types. See docs/qapi-code-gen.txt for information on their structure
2207 .name = "query-qmp-schema",
2209 .mhandler.cmd_new = qmp_query_qmp_schema,
2216 Each device is represented by a json-object. The returned value is a json-array
2219 Each json-object contain the following:
2221 - "label": device's label (json-string)
2222 - "filename": device's file (json-string)
2223 - "frontend-open": open/closed state of the frontend device attached to this
2228 -> { "execute": "query-chardev" }
2232 "label": "charchannel0",
2233 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
2234 "frontend-open": false
2237 "label": "charmonitor",
2238 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
2239 "frontend-open": true
2242 "label": "charserial0",
2243 "filename": "pty:/dev/pts/2",
2244 "frontend-open": true
2252 .name = "query-chardev",
2254 .mhandler.cmd_new = qmp_marshal_query_chardev,
2258 query-chardev-backends
2261 List available character device backends.
2263 Each backend is represented by a json-object, the returned value is a json-array
2266 Each json-object contains:
2268 - "name": backend name (json-string)
2272 -> { "execute": "query-chardev-backends" }
2293 .name = "query-chardev-backends",
2295 .mhandler.cmd_new = qmp_marshal_query_chardev_backends,
2302 Show the block devices.
2304 Each block device information is stored in a json-object and the returned value
2305 is a json-array of all devices.
2307 Each json-object contain the following:
2309 - "device": device name (json-string)
2310 - "type": device type (json-string)
2311 - deprecated, retained for backward compatibility
2312 - Possible values: "unknown"
2313 - "removable": true if the device is removable, false otherwise (json-bool)
2314 - "locked": true if the device is locked, false otherwise (json-bool)
2315 - "tray_open": only present if removable, true if the device has a tray,
2316 and it is open (json-bool)
2317 - "inserted": only present if the device is inserted, it is a json-object
2318 containing the following:
2319 - "file": device file name (json-string)
2320 - "ro": true if read-only, false otherwise (json-bool)
2321 - "drv": driver format name (json-string)
2322 - Possible values: "blkdebug", "bochs", "cloop", "dmg",
2323 "file", "file", "ftp", "ftps", "host_cdrom",
2324 "host_device", "http", "https",
2325 "nbd", "parallels", "qcow", "qcow2", "raw",
2326 "tftp", "vdi", "vmdk", "vpc", "vvfat"
2327 - "backing_file": backing file name (json-string, optional)
2328 - "backing_file_depth": number of files in the backing file chain (json-int)
2329 - "encrypted": true if encrypted, false otherwise (json-bool)
2330 - "bps": limit total bytes per second (json-int)
2331 - "bps_rd": limit read bytes per second (json-int)
2332 - "bps_wr": limit write bytes per second (json-int)
2333 - "iops": limit total I/O operations per second (json-int)
2334 - "iops_rd": limit read operations per second (json-int)
2335 - "iops_wr": limit write operations per second (json-int)
2336 - "bps_max": total max in bytes (json-int)
2337 - "bps_rd_max": read max in bytes (json-int)
2338 - "bps_wr_max": write max in bytes (json-int)
2339 - "iops_max": total I/O operations max (json-int)
2340 - "iops_rd_max": read I/O operations max (json-int)
2341 - "iops_wr_max": write I/O operations max (json-int)
2342 - "iops_size": I/O size when limiting by iops (json-int)
2343 - "detect_zeroes": detect and optimize zero writing (json-string)
2344 - Possible values: "off", "on", "unmap"
2345 - "write_threshold": write offset threshold in bytes, a event will be
2346 emitted if crossed. Zero if disabled (json-int)
2347 - "image": the detail of the image, it is a json-object containing
2349 - "filename": image file name (json-string)
2350 - "format": image format (json-string)
2351 - "virtual-size": image capacity in bytes (json-int)
2352 - "dirty-flag": true if image is not cleanly closed, not present
2353 means clean (json-bool, optional)
2354 - "actual-size": actual size on disk in bytes of the image, not
2355 present when image does not support thin
2356 provision (json-int, optional)
2357 - "cluster-size": size of a cluster in bytes, not present if image
2358 format does not support it (json-int, optional)
2359 - "encrypted": true if the image is encrypted, not present means
2360 false or the image format does not support
2361 encryption (json-bool, optional)
2362 - "backing_file": backing file name, not present means no backing
2363 file is used or the image format does not
2364 support backing file chain
2365 (json-string, optional)
2366 - "full-backing-filename": full path of the backing file, not
2367 present if it equals backing_file or no
2368 backing file is used
2369 (json-string, optional)
2370 - "backing-filename-format": the format of the backing file, not
2371 present means unknown or no backing
2372 file (json-string, optional)
2373 - "snapshots": the internal snapshot info, it is an optional list
2374 of json-object containing the following:
2375 - "id": unique snapshot id (json-string)
2376 - "name": snapshot name (json-string)
2377 - "vm-state-size": size of the VM state in bytes (json-int)
2378 - "date-sec": UTC date of the snapshot in seconds (json-int)
2379 - "date-nsec": fractional part in nanoseconds to be used with
2381 - "vm-clock-sec": VM clock relative to boot in seconds
2383 - "vm-clock-nsec": fractional part in nanoseconds to be used
2384 with vm-clock-sec (json-int)
2385 - "backing-image": the detail of the backing image, it is an
2386 optional json-object only present when a
2387 backing image present for this image
2389 - "io-status": I/O operation status, only present if the device supports it
2390 and the VM is configured to stop on errors. It's always reset
2391 to "ok" when the "cont" command is issued (json_string, optional)
2392 - Possible values: "ok", "failed", "nospace"
2396 -> { "execute": "query-block" }
2401 "device":"ide0-hd0",
2408 "file":"disks/test.qcow2",
2409 "backing_file_depth":1,
2423 "detect_zeroes": "on",
2424 "write_threshold": 0,
2426 "filename":"disks/test.qcow2",
2428 "virtual-size":2048000,
2429 "backing_file":"base.qcow2",
2430 "full-backing-filename":"disks/base.qcow2",
2431 "backing-filename-format":"qcow2",
2435 "name": "snapshot1",
2437 "date-sec": 10000200,
2439 "vm-clock-sec": 206,
2444 "filename":"disks/base.qcow2",
2446 "virtual-size":2048000
2454 "device":"ide1-cd0",
2477 .name = "query-block",
2479 .mhandler.cmd_new = qmp_marshal_query_block,
2486 Show block device statistics.
2488 Each device statistic information is stored in a json-object and the returned
2489 value is a json-array of all devices.
2491 Each json-object contain the following:
2493 - "device": device name (json-string)
2494 - "stats": A json-object with the statistics information, it contains:
2495 - "rd_bytes": bytes read (json-int)
2496 - "wr_bytes": bytes written (json-int)
2497 - "rd_operations": read operations (json-int)
2498 - "wr_operations": write operations (json-int)
2499 - "flush_operations": cache flush operations (json-int)
2500 - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2501 - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2502 - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
2503 - "wr_highest_offset": Highest offset of a sector written since the
2504 BlockDriverState has been opened (json-int)
2505 - "rd_merged": number of read requests that have been merged into
2506 another request (json-int)
2507 - "wr_merged": number of write requests that have been merged into
2508 another request (json-int)
2509 - "parent": Contains recursively the statistics of the underlying
2510 protocol (e.g. the host file for a qcow2 image). If there is
2511 no underlying protocol, this field is omitted
2512 (json-object, optional)
2516 -> { "execute": "query-blockstats" }
2520 "device":"ide0-hd0",
2523 "wr_highest_offset":3686448128,
2525 "wr_operations":751,
2526 "rd_bytes":122567168,
2527 "rd_operations":36772
2528 "wr_total_times_ns":313253456
2529 "rd_total_times_ns":3465673657
2530 "flush_total_times_ns":49653
2531 "flush_operations":61,
2537 "wr_highest_offset":2821110784,
2539 "wr_operations":692,
2540 "rd_bytes":122739200,
2541 "rd_operations":36604
2542 "flush_operations":51,
2543 "wr_total_times_ns":313253456
2544 "rd_total_times_ns":3465673657
2545 "flush_total_times_ns":49653,
2551 "device":"ide1-cd0",
2553 "wr_highest_offset":0,
2558 "flush_operations":0,
2559 "wr_total_times_ns":0
2560 "rd_total_times_ns":0
2561 "flush_total_times_ns":0,
2569 "wr_highest_offset":0,
2574 "flush_operations":0,
2575 "wr_total_times_ns":0
2576 "rd_total_times_ns":0
2577 "flush_total_times_ns":0,
2585 "wr_highest_offset":0,
2590 "flush_operations":0,
2591 "wr_total_times_ns":0
2592 "rd_total_times_ns":0
2593 "flush_total_times_ns":0,
2604 .name = "query-blockstats",
2605 .args_type = "query-nodes:b?",
2606 .mhandler.cmd_new = qmp_marshal_query_blockstats,
2613 Show CPU information.
2615 Return a json-array. Each CPU is represented by a json-object, which contains:
2617 - "CPU": CPU index (json-int)
2618 - "current": true if this is the current CPU, false otherwise (json-bool)
2619 - "halted": true if the cpu is halted, false otherwise (json-bool)
2620 - "qom_path": path to the CPU object in the QOM tree (json-str)
2621 - Current program counter. The key's name depends on the architecture:
2622 "pc": i386/x86_64 (json-int)
2623 "nip": PPC (json-int)
2624 "pc" and "npc": sparc (json-int)
2625 "PC": mips (json-int)
2626 - "thread_id": ID of the underlying host thread (json-int)
2630 -> { "execute": "query-cpus" }
2637 "qom_path":"/machine/unattached/device[0]",
2645 "qom_path":"/machine/unattached/device[2]",
2655 .name = "query-cpus",
2657 .mhandler.cmd_new = qmp_marshal_query_cpus,
2664 Returns a list of information about each iothread.
2666 Note this list excludes the QEMU main loop thread, which is not declared
2667 using the -object iothread command-line option. It is always the main thread
2670 Return a json-array. Each iothread is represented by a json-object, which contains:
2672 - "id": name of iothread (json-str)
2673 - "thread-id": ID of the underlying host thread (json-int)
2677 -> { "execute": "query-iothreads" }
2694 .name = "query-iothreads",
2696 .mhandler.cmd_new = qmp_marshal_query_iothreads,
2703 PCI buses and devices information.
2705 The returned value is a json-array of all buses. Each bus is represented by
2706 a json-object, which has a key with a json-array of all PCI devices attached
2707 to it. Each device is represented by a json-object.
2709 The bus json-object contains the following:
2711 - "bus": bus number (json-int)
2712 - "devices": a json-array of json-objects, each json-object represents a
2715 The PCI device json-object contains the following:
2717 - "bus": identical to the parent's bus number (json-int)
2718 - "slot": slot number (json-int)
2719 - "function": function number (json-int)
2720 - "class_info": a json-object containing:
2721 - "desc": device class description (json-string, optional)
2722 - "class": device class number (json-int)
2723 - "id": a json-object containing:
2724 - "device": device ID (json-int)
2725 - "vendor": vendor ID (json-int)
2726 - "irq": device's IRQ if assigned (json-int, optional)
2727 - "qdev_id": qdev id string (json-string)
2728 - "pci_bridge": It's a json-object, only present if this device is a
2729 PCI bridge, contains:
2730 - "bus": bus number (json-int)
2731 - "secondary": secondary bus number (json-int)
2732 - "subordinate": subordinate bus number (json-int)
2733 - "io_range": I/O memory range information, a json-object with the
2735 - "base": base address, in bytes (json-int)
2736 - "limit": limit address, in bytes (json-int)
2737 - "memory_range": memory range information, a json-object with the
2739 - "base": base address, in bytes (json-int)
2740 - "limit": limit address, in bytes (json-int)
2741 - "prefetchable_range": Prefetchable memory range information, a
2742 json-object with the following members:
2743 - "base": base address, in bytes (json-int)
2744 - "limit": limit address, in bytes (json-int)
2745 - "devices": a json-array of PCI devices if there's any attached, each
2746 each element is represented by a json-object, which contains
2747 the same members of the 'PCI device json-object' described
2749 - "regions": a json-array of json-objects, each json-object represents a
2750 memory region of this device
2752 The memory range json-object contains the following:
2754 - "base": base memory address (json-int)
2755 - "limit": limit value (json-int)
2757 The region json-object can be an I/O region or a memory region, an I/O region
2758 json-object contains the following:
2760 - "type": "io" (json-string, fixed)
2761 - "bar": BAR number (json-int)
2762 - "address": memory address (json-int)
2763 - "size": memory size (json-int)
2765 A memory region json-object contains the following:
2767 - "type": "memory" (json-string, fixed)
2768 - "bar": BAR number (json-int)
2769 - "address": memory address (json-int)
2770 - "size": memory size (json-int)
2771 - "mem_type_64": true or false (json-bool)
2772 - "prefetch": true or false (json-bool)
2776 -> { "execute": "query-pci" }
2788 "desc":"Host bridge"
2822 "desc":"IDE controller"
2844 "desc":"VGA controller"
2854 "mem_type_64":false,
2857 "address":4026531840,
2862 "mem_type_64":false,
2865 "address":4060086272,
2870 "mem_type_64":false,
2885 "desc":"RAM controller"
2906 Note: This example has been shortened as the real response is too long.
2911 .name = "query-pci",
2913 .mhandler.cmd_new = qmp_marshal_query_pci,
2920 Show KVM information.
2922 Return a json-object with the following information:
2924 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
2925 - "present": true if QEMU has KVM support, false otherwise (json-bool)
2929 -> { "execute": "query-kvm" }
2930 <- { "return": { "enabled": true, "present": true } }
2935 .name = "query-kvm",
2937 .mhandler.cmd_new = qmp_marshal_query_kvm,
2944 Return a json-object with the following information:
2946 - "running": true if the VM is running, or false if it is paused (json-bool)
2947 - "singlestep": true if the VM is in single step mode,
2948 false otherwise (json-bool)
2949 - "status": one of the following values (json-string)
2950 "debug" - QEMU is running on a debugger
2951 "inmigrate" - guest is paused waiting for an incoming migration
2952 "internal-error" - An internal error that prevents further guest
2953 execution has occurred
2954 "io-error" - the last IOP has failed and the device is configured
2955 to pause on I/O errors
2956 "paused" - guest has been paused via the 'stop' command
2957 "postmigrate" - guest is paused following a successful 'migrate'
2958 "prelaunch" - QEMU was started with -S and guest has not started
2959 "finish-migrate" - guest is paused to finish the migration process
2960 "restore-vm" - guest is paused to restore VM state
2961 "running" - guest is actively running
2962 "save-vm" - guest is paused to save the VM state
2963 "shutdown" - guest is shut down (and -no-shutdown is in use)
2964 "watchdog" - the watchdog action is configured to pause and
2969 -> { "execute": "query-status" }
2970 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
2975 .name = "query-status",
2977 .mhandler.cmd_new = qmp_marshal_query_status,
2984 Show VM mice information.
2986 Each mouse is represented by a json-object, the returned value is a json-array
2989 The mouse json-object contains the following:
2991 - "name": mouse's name (json-string)
2992 - "index": mouse's index (json-int)
2993 - "current": true if this mouse is receiving events, false otherwise (json-bool)
2994 - "absolute": true if the mouse generates absolute input events (json-bool)
2998 -> { "execute": "query-mice" }
3002 "name":"QEMU Microsoft Mouse",
3008 "name":"QEMU PS/2 Mouse",
3019 .name = "query-mice",
3021 .mhandler.cmd_new = qmp_marshal_query_mice,
3028 Show VNC server information.
3030 Return a json-object with server information. Connected clients are returned
3031 as a json-array of json-objects.
3033 The main json-object contains the following:
3035 - "enabled": true or false (json-bool)
3036 - "host": server's IP address (json-string)
3037 - "family": address family (json-string)
3038 - Possible values: "ipv4", "ipv6", "unix", "unknown"
3039 - "service": server's port number (json-string)
3040 - "auth": authentication method (json-string)
3041 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
3042 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
3043 "vencrypt+plain", "vencrypt+tls+none",
3044 "vencrypt+tls+plain", "vencrypt+tls+sasl",
3045 "vencrypt+tls+vnc", "vencrypt+x509+none",
3046 "vencrypt+x509+plain", "vencrypt+x509+sasl",
3047 "vencrypt+x509+vnc", "vnc"
3048 - "clients": a json-array of all connected clients
3050 Clients are described by a json-object, each one contain the following:
3052 - "host": client's IP address (json-string)
3053 - "family": address family (json-string)
3054 - Possible values: "ipv4", "ipv6", "unix", "unknown"
3055 - "service": client's port number (json-string)
3056 - "x509_dname": TLS dname (json-string, optional)
3057 - "sasl_username": SASL username (json-string, optional)
3061 -> { "execute": "query-vnc" }
3082 .name = "query-vnc",
3084 .mhandler.cmd_new = qmp_marshal_query_vnc,
3087 .name = "query-vnc-servers",
3089 .mhandler.cmd_new = qmp_marshal_query_vnc_servers,
3096 Show SPICE server information.
3098 Return a json-object with server information. Connected clients are returned
3099 as a json-array of json-objects.
3101 The main json-object contains the following:
3103 - "enabled": true or false (json-bool)
3104 - "host": server's IP address (json-string)
3105 - "port": server's port number (json-int, optional)
3106 - "tls-port": server's port number (json-int, optional)
3107 - "auth": authentication method (json-string)
3108 - Possible values: "none", "spice"
3109 - "channels": a json-array of all active channels clients
3111 Channels are described by a json-object, each one contain the following:
3113 - "host": client's IP address (json-string)
3114 - "family": address family (json-string)
3115 - Possible values: "ipv4", "ipv6", "unix", "unknown"
3116 - "port": client's port number (json-string)
3117 - "connection-id": spice connection id. All channels with the same id
3118 belong to the same spice session (json-int)
3119 - "channel-type": channel type. "1" is the main control channel, filter for
3120 this one if you want track spice sessions only (json-int)
3121 - "channel-id": channel id. Usually "0", might be different needed when
3122 multiple channels of the same type exist, such as multiple
3123 display channels in a multihead setup (json-int)
3124 - "tls": whether the channel is encrypted (json-bool)
3128 -> { "execute": "query-spice" }
3141 "connection-id": 1804289383,
3142 "host": "127.0.0.1",
3150 "connection-id": 1804289383,
3151 "host": "127.0.0.1",
3155 [ ... more channels follow ... ]
3162 #if defined(CONFIG_SPICE)
3164 .name = "query-spice",
3166 .mhandler.cmd_new = qmp_marshal_query_spice,
3176 Return a json-object with the following information:
3178 - "name": VM's name (json-string, optional)
3182 -> { "execute": "query-name" }
3183 <- { "return": { "name": "qemu-name" } }
3188 .name = "query-name",
3190 .mhandler.cmd_new = qmp_marshal_query_name,
3199 Return a json-object with the following information:
3201 - "UUID": Universally Unique Identifier (json-string)
3205 -> { "execute": "query-uuid" }
3206 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
3211 .name = "query-uuid",
3213 .mhandler.cmd_new = qmp_marshal_query_uuid,
3217 query-command-line-options
3218 --------------------------
3220 Show command line option schema.
3222 Return a json-array of command line option schema for all options (or for
3223 the given option), returning an error if the given option doesn't exist.
3225 Each array entry contains the following:
3227 - "option": option name (json-string)
3228 - "parameters": a json-array describes all parameters of the option:
3229 - "name": parameter name (json-string)
3230 - "type": parameter type (one of 'string', 'boolean', 'number',
3232 - "help": human readable description of the parameter
3233 (json-string, optional)
3234 - "default": default value string for the parameter
3235 (json-string, optional)
3239 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
3248 "name": "bootindex",
3252 "option": "option-rom"
3260 .name = "query-command-line-options",
3261 .args_type = "option:s?",
3262 .mhandler.cmd_new = qmp_marshal_query_command_line_options,
3271 Return a json-object. If migration is active there will be another json-object
3272 with RAM migration status and if block migration is active another one with
3273 block migration status.
3275 The main json-object contains the following:
3277 - "status": migration status (json-string)
3278 - Possible values: "setup", "active", "completed", "failed", "cancelled"
3279 - "total-time": total amount of ms since migration started. If
3280 migration has ended, it returns the total migration
3282 - "setup-time" amount of setup time in milliseconds _before_ the
3283 iterations begin but _after_ the QMP command is issued.
3284 This is designed to provide an accounting of any activities
3285 (such as RDMA pinning) which may be expensive, but do not
3286 actually occur during the iterative migration rounds
3287 themselves. (json-int)
3288 - "downtime": only present when migration has finished correctly
3289 total amount in ms for downtime that happened (json-int)
3290 - "expected-downtime": only present while migration is active
3291 total amount in ms for downtime that was calculated on
3292 the last bitmap round (json-int)
3293 - "ram": only present if "status" is "active", it is a json-object with the
3294 following RAM information:
3295 - "transferred": amount transferred in bytes (json-int)
3296 - "remaining": amount remaining to transfer in bytes (json-int)
3297 - "total": total amount of memory in bytes (json-int)
3298 - "duplicate": number of pages filled entirely with the same
3300 These are sent over the wire much more efficiently.
3301 - "skipped": number of skipped zero pages (json-int)
3302 - "normal" : number of whole pages transferred. I.e. they
3303 were not sent as duplicate or xbzrle pages (json-int)
3304 - "normal-bytes" : number of bytes transferred in whole
3305 pages. This is just normal pages times size of one page,
3306 but this way upper levels don't need to care about page
3308 - "dirty-sync-count": times that dirty ram was synchronized (json-int)
3309 - "disk": only present if "status" is "active" and it is a block migration,
3310 it is a json-object with the following disk information:
3311 - "transferred": amount transferred in bytes (json-int)
3312 - "remaining": amount remaining to transfer in bytes json-int)
3313 - "total": total disk size in bytes (json-int)
3314 - "xbzrle-cache": only present if XBZRLE is active.
3315 It is a json-object with the following XBZRLE information:
3316 - "cache-size": XBZRLE cache size in bytes
3317 - "bytes": number of bytes transferred for XBZRLE compressed pages
3318 - "pages": number of XBZRLE compressed pages
3319 - "cache-miss": number of XBRZRLE page cache misses
3320 - "cache-miss-rate": rate of XBRZRLE page cache misses
3321 - "overflow": number of times XBZRLE overflows. This means
3322 that the XBZRLE encoding was bigger than just sent the
3323 whole page, and then we sent the whole page instead (as as
3328 1. Before the first migration
3330 -> { "execute": "query-migrate" }
3333 2. Migration is done and has succeeded
3335 -> { "execute": "query-migrate" }
3337 "status": "completed",
3347 "normal-bytes":123456,
3348 "dirty-sync-count":15
3353 3. Migration is done and has failed
3355 -> { "execute": "query-migrate" }
3356 <- { "return": { "status": "failed" } }
3358 4. Migration is being performed and is not a block migration:
3360 -> { "execute": "query-migrate" }
3370 "expected-downtime":12345,
3373 "normal-bytes":123456,
3374 "dirty-sync-count":15
3379 5. Migration is being performed and is a block migration:
3381 -> { "execute": "query-migrate" }
3387 "remaining":1053304,
3391 "expected-downtime":12345,
3394 "normal-bytes":123456,
3395 "dirty-sync-count":15
3399 "remaining":20880384,
3405 6. Migration is being performed and XBZRLE is active:
3407 -> { "execute": "query-migrate" }
3411 "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
3414 "remaining":1053304,
3418 "expected-downtime":12345,
3421 "normal-bytes":3412992,
3422 "dirty-sync-count":15
3425 "cache-size":67108864,
3429 "cache-miss-rate":0.123,
3438 .name = "query-migrate",
3440 .mhandler.cmd_new = qmp_marshal_query_migrate,
3444 migrate-set-capabilities
3445 ------------------------
3447 Enable/Disable migration capabilities
3449 - "xbzrle": XBZRLE support
3450 - "rdma-pin-all": pin all pages when using RDMA during migration
3451 - "auto-converge": throttle down guest to help convergence of migration
3452 - "zero-blocks": compress zero blocks during block migration
3453 - "events": generate events for each migration state change
3459 -> { "execute": "migrate-set-capabilities" , "arguments":
3460 { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
3465 .name = "migrate-set-capabilities",
3466 .args_type = "capabilities:q",
3467 .params = "capability:s,state:b",
3468 .mhandler.cmd_new = qmp_marshal_migrate_set_capabilities,
3471 query-migrate-capabilities
3472 --------------------------
3474 Query current migration capabilities
3476 - "capabilities": migration capabilities state
3477 - "xbzrle" : XBZRLE state (json-bool)
3478 - "rdma-pin-all" : RDMA Pin Page state (json-bool)
3479 - "auto-converge" : Auto Converge state (json-bool)
3480 - "zero-blocks" : Zero Blocks state (json-bool)
3486 -> { "execute": "query-migrate-capabilities" }
3487 <- { "return": [ { "state": false, "capability": "xbzrle" } ] }
3492 .name = "query-migrate-capabilities",
3494 .mhandler.cmd_new = qmp_marshal_query_migrate_capabilities,
3498 migrate-set-parameters
3499 ----------------------
3501 Set migration parameters
3503 - "compress-level": set compression level during migration (json-int)
3504 - "compress-threads": set compression thread count for migration (json-int)
3505 - "decompress-threads": set decompression thread count for migration (json-int)
3511 -> { "execute": "migrate-set-parameters" , "arguments":
3512 { "compress-level": 1 } }
3517 .name = "migrate-set-parameters",
3519 "compress-level:i?,compress-threads:i?,decompress-threads:i?",
3520 .mhandler.cmd_new = qmp_marshal_migrate_set_parameters,
3523 query-migrate-parameters
3524 ------------------------
3526 Query current migration parameters
3528 - "parameters": migration parameters value
3529 - "compress-level" : compression level value (json-int)
3530 - "compress-threads" : compression thread count value (json-int)
3531 - "decompress-threads" : decompression thread count value (json-int)
3537 -> { "execute": "query-migrate-parameters" }
3540 "decompress-threads", 2,
3541 "compress-threads", 8,
3549 .name = "query-migrate-parameters",
3551 .mhandler.cmd_new = qmp_marshal_query_migrate_parameters,
3558 Show balloon information.
3560 Make an asynchronous request for balloon info. When the request completes a
3561 json-object will be returned containing the following data:
3563 - "actual": current balloon value in bytes (json-int)
3567 -> { "execute": "query-balloon" }
3570 "actual":1073741824,
3577 .name = "query-balloon",
3579 .mhandler.cmd_new = qmp_marshal_query_balloon,
3583 .name = "query-block-jobs",
3585 .mhandler.cmd_new = qmp_marshal_query_block_jobs,
3590 .args_type = "path:s",
3591 .mhandler.cmd_new = qmp_marshal_qom_list,
3596 .args_type = "path:s,property:s,value:q",
3597 .mhandler.cmd_new = qmp_marshal_qom_set,
3602 .args_type = "path:s,property:s",
3603 .mhandler.cmd_new = qmp_marshal_qom_get,
3607 .name = "nbd-server-start",
3608 .args_type = "addr:q",
3609 .mhandler.cmd_new = qmp_marshal_nbd_server_start,
3612 .name = "nbd-server-add",
3613 .args_type = "device:B,writable:b?",
3614 .mhandler.cmd_new = qmp_marshal_nbd_server_add,
3617 .name = "nbd-server-stop",
3619 .mhandler.cmd_new = qmp_marshal_nbd_server_stop,
3623 .name = "change-vnc-password",
3624 .args_type = "password:s",
3625 .mhandler.cmd_new = qmp_marshal_change_vnc_password,
3628 .name = "qom-list-types",
3629 .args_type = "implements:s?,abstract:b?",
3630 .mhandler.cmd_new = qmp_marshal_qom_list_types,
3634 .name = "device-list-properties",
3635 .args_type = "typename:s",
3636 .mhandler.cmd_new = qmp_marshal_device_list_properties,
3640 .name = "query-machines",
3642 .mhandler.cmd_new = qmp_marshal_query_machines,
3646 .name = "query-cpu-definitions",
3648 .mhandler.cmd_new = qmp_marshal_query_cpu_definitions,
3652 .name = "query-target",
3654 .mhandler.cmd_new = qmp_marshal_query_target,
3658 .name = "query-tpm",
3660 .mhandler.cmd_new = qmp_marshal_query_tpm,
3667 Return information about the TPM device.
3673 -> { "execute": "query-tpm" }
3676 { "model": "tpm-tis",
3678 { "type": "passthrough",
3680 { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3692 .name = "query-tpm-models",
3694 .mhandler.cmd_new = qmp_marshal_query_tpm_models,
3701 Return a list of supported TPM models.
3707 -> { "execute": "query-tpm-models" }
3708 <- { "return": [ "tpm-tis" ] }
3713 .name = "query-tpm-types",
3715 .mhandler.cmd_new = qmp_marshal_query_tpm_types,
3722 Return a list of supported TPM types.
3728 -> { "execute": "query-tpm-types" }
3729 <- { "return": [ "passthrough" ] }
3734 .name = "chardev-add",
3735 .args_type = "id:s,backend:q",
3736 .mhandler.cmd_new = qmp_marshal_chardev_add,
3747 - "id": the chardev's ID, must be unique (json-string)
3748 - "backend": chardev backend type + parameters
3752 -> { "execute" : "chardev-add",
3753 "arguments" : { "id" : "foo",
3754 "backend" : { "type" : "null", "data" : {} } } }
3757 -> { "execute" : "chardev-add",
3758 "arguments" : { "id" : "bar",
3759 "backend" : { "type" : "file",
3760 "data" : { "out" : "/tmp/bar.log" } } } }
3763 -> { "execute" : "chardev-add",
3764 "arguments" : { "id" : "baz",
3765 "backend" : { "type" : "pty", "data" : {} } } }
3766 <- { "return": { "pty" : "/dev/pty/42" } }
3771 .name = "chardev-remove",
3772 .args_type = "id:s",
3773 .mhandler.cmd_new = qmp_marshal_chardev_remove,
3785 - "id": the chardev's ID, must exist and not be in use (json-string)
3789 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
3794 .name = "query-rx-filter",
3795 .args_type = "name:s?",
3796 .mhandler.cmd_new = qmp_marshal_query_rx_filter,
3803 Show rx-filter information.
3805 Returns a json-array of rx-filter information for all NICs (or for the
3806 given NIC), returning an error if the given NIC doesn't exist, or
3807 given NIC doesn't support rx-filter querying, or given net client
3810 The query will clear the event notification flag of each NIC, then qemu
3811 will start to emit event to QMP monitor.
3813 Each array entry contains the following:
3815 - "name": net client name (json-string)
3816 - "promiscuous": promiscuous mode is enabled (json-bool)
3817 - "multicast": multicast receive state (one of 'normal', 'none', 'all')
3818 - "unicast": unicast receive state (one of 'normal', 'none', 'all')
3819 - "vlan": vlan receive state (one of 'normal', 'none', 'all') (Since 2.0)
3820 - "broadcast-allowed": allow to receive broadcast (json-bool)
3821 - "multicast-overflow": multicast table is overflowed (json-bool)
3822 - "unicast-overflow": unicast table is overflowed (json-bool)
3823 - "main-mac": main macaddr string (json-string)
3824 - "vlan-table": a json-array of active vlan id
3825 - "unicast-table": a json-array of unicast macaddr string
3826 - "multicast-table": a json-array of multicast macaddr string
3830 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
3833 "promiscuous": true,
3835 "main-mac": "52:54:00:12:34:56",
3836 "unicast": "normal",
3844 "multicast": "normal",
3845 "multicast-overflow": false,
3846 "unicast-overflow": false,
3847 "multicast-table": [
3848 "01:00:5e:00:00:01",
3849 "33:33:00:00:00:01",
3852 "broadcast-allowed": false
3860 .name = "blockdev-add",
3861 .args_type = "options:q",
3862 .mhandler.cmd_new = qmp_marshal_blockdev_add,
3871 This command is still a work in progress. It doesn't support all
3872 block drivers, it lacks a matching blockdev-del, and more. Stay away
3873 from it unless you want to help with its development.
3877 - "options": block driver options
3881 -> { "execute": "blockdev-add",
3882 "arguments": { "options" : { "driver": "qcow2",
3883 "file": { "driver": "file",
3884 "filename": "test.qcow2" } } } }
3889 -> { "execute": "blockdev-add",
3901 "filename": "/tmp/test.qcow2"
3907 "filename": "/dev/fdset/4"
3919 .name = "query-named-block-nodes",
3921 .mhandler.cmd_new = qmp_marshal_query_named_block_nodes,
3925 @query-named-block-nodes
3926 ------------------------
3928 Return a list of BlockDeviceInfo for all the named block driver nodes
3932 -> { "execute": "query-named-block-nodes" }
3933 <- { "return": [ { "ro":false,
3936 "file":"disks/test.qcow2",
3937 "node-name": "my-node",
3938 "backing_file_depth":1,
3952 "write_threshold": 0,
3954 "filename":"disks/test.qcow2",
3956 "virtual-size":2048000,
3957 "backing_file":"base.qcow2",
3958 "full-backing-filename":"disks/base.qcow2",
3959 "backing-filename-format":"qcow2",
3963 "name": "snapshot1",
3965 "date-sec": 10000200,
3967 "vm-clock-sec": 206,
3972 "filename":"disks/base.qcow2",
3974 "virtual-size":2048000
3981 .name = "query-memdev",
3983 .mhandler.cmd_new = qmp_marshal_query_memdev,
3990 Show memory devices information.
3995 -> { "execute": "query-memdev" }
4002 "host-nodes": [0, 1],
4010 "host-nodes": [2, 3],
4011 "policy": "preferred"
4019 .name = "query-memory-devices",
4021 .mhandler.cmd_new = qmp_marshal_query_memory_devices,
4025 @query-memory-devices
4026 --------------------
4028 Return a list of memory devices.
4031 -> { "execute": "query-memory-devices" }
4032 <- { "return": [ { "data":
4033 { "addr": 5368709120,
4034 "hotpluggable": true,
4037 "memdev": "/objects/memX",
4046 .name = "query-acpi-ospm-status",
4048 .mhandler.cmd_new = qmp_marshal_query_acpi_ospm_status,
4052 @query-acpi-ospm-status
4053 --------------------
4055 Return list of ACPIOSTInfo for devices that support status reporting
4056 via ACPI _OST method.
4059 -> { "execute": "query-acpi-ospm-status" }
4060 <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
4061 { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
4062 { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
4063 { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
4067 #if defined TARGET_I386
4069 .name = "rtc-reset-reinjection",
4071 .mhandler.cmd_new = qmp_marshal_rtc_reset_reinjection,
4076 rtc-reset-reinjection
4077 ---------------------
4079 Reset the RTC interrupt reinjection backlog.
4085 -> { "execute": "rtc-reset-reinjection" }
4090 .name = "trace-event-get-state",
4091 .args_type = "name:s",
4092 .mhandler.cmd_new = qmp_marshal_trace_event_get_state,
4096 trace-event-get-state
4097 ---------------------
4099 Query the state of events.
4103 -> { "execute": "trace-event-get-state", "arguments": { "name": "qemu_memalign" } }
4104 <- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
4108 .name = "trace-event-set-state",
4109 .args_type = "name:s,enable:b,ignore-unavailable:b?",
4110 .mhandler.cmd_new = qmp_marshal_trace_event_set_state,
4114 trace-event-set-state
4115 ---------------------
4117 Set the state of events.
4121 -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } }
4126 .name = "x-input-send-event",
4127 .args_type = "console:i?,events:q",
4128 .mhandler.cmd_new = qmp_marshal_x_input_send_event,
4135 Send input event to guest.
4139 - "console": console index. (json-int, optional)
4140 - "events": list of input events.
4142 The consoles are visible in the qom tree, under
4143 /backend/console[$index]. They have a device link and head property, so
4144 it is possible to map which console belongs to which device and display.
4146 Note: this command is experimental, and not a stable API.
4150 Press left mouse button.
4152 -> { "execute": "x-input-send-event",
4153 "arguments": { "console": 0,
4154 "events": [ { "type": "btn",
4155 "data" : { "down": true, "button": "Left" } } ] } }
4158 -> { "execute": "x-input-send-event",
4159 "arguments": { "console": 0,
4160 "events": [ { "type": "btn",
4161 "data" : { "down": false, "button": "Left" } } ] } }
4168 -> { "execute": "x-input-send-event",
4169 "arguments": { "console": 0, "events": [
4170 { "type": "key", "data" : { "down": true,
4171 "key": {"type": "qcode", "data": "ctrl" } } },
4172 { "type": "key", "data" : { "down": true,
4173 "key": {"type": "qcode", "data": "alt" } } },
4174 { "type": "key", "data" : { "down": true,
4175 "key": {"type": "qcode", "data": "delete" } } } ] } }
4180 Move mouse pointer to absolute coordinates (20000, 400).
4182 -> { "execute": "x-input-send-event" ,
4183 "arguments": { "console": 0, "events": [
4184 { "type": "abs", "data" : { "axis": "X", "value" : 20000 } },
4185 { "type": "abs", "data" : { "axis": "Y", "value" : 400 } } ] } }
4191 .name = "block-set-write-threshold",
4192 .args_type = "node-name:s,write-threshold:l",
4193 .mhandler.cmd_new = qmp_marshal_block_set_write_threshold,
4197 block-set-write-threshold
4200 Change the write threshold for a block drive. The threshold is an offset,
4201 thus must be non-negative. Default is no write threshold.
4202 Setting the threshold to zero disables it.
4206 - "node-name": the node name in the block driver state graph (json-string)
4207 - "write-threshold": the write threshold in bytes (json-int)
4211 -> { "execute": "block-set-write-threshold",
4212 "arguments": { "node-name": "mydev",
4213 "write-threshold": 17179869184 } }
4219 .name = "query-rocker",
4220 .args_type = "name:s",
4221 .mhandler.cmd_new = qmp_marshal_query_rocker,
4230 - "name": switch name
4234 -> { "execute": "query-rocker", "arguments": { "name": "sw1" } }
4235 <- { "return": {"name": "sw1", "ports": 2, "id": 1327446905938}}
4240 .name = "query-rocker-ports",
4241 .args_type = "name:s",
4242 .mhandler.cmd_new = qmp_marshal_query_rocker_ports,
4246 Show rocker switch ports
4247 ------------------------
4251 - "name": switch name
4255 -> { "execute": "query-rocker-ports", "arguments": { "name": "sw1" } }
4256 <- { "return": [ {"duplex": "full", "enabled": true, "name": "sw1.1",
4257 "autoneg": "off", "link-up": true, "speed": 10000},
4258 {"duplex": "full", "enabled": true, "name": "sw1.2",
4259 "autoneg": "off", "link-up": true, "speed": 10000}
4265 .name = "query-rocker-of-dpa-flows",
4266 .args_type = "name:s,tbl-id:i?",
4267 .mhandler.cmd_new = qmp_marshal_query_rocker_of_dpa_flows,
4271 Show rocker switch OF-DPA flow tables
4272 -------------------------------------
4276 - "name": switch name
4277 - "tbl-id": (optional) flow table ID
4281 -> { "execute": "query-rocker-of-dpa-flows", "arguments": { "name": "sw1" } }
4282 <- { "return": [ {"key": {"in-pport": 0, "priority": 1, "tbl-id": 0},
4285 "action": {"goto-tbl": 10},
4286 "mask": {"in-pport": 4294901760}
4294 .name = "query-rocker-of-dpa-groups",
4295 .args_type = "name:s,type:i?",
4296 .mhandler.cmd_new = qmp_marshal_query_rocker_of_dpa_groups,
4300 Show rocker OF-DPA group tables
4301 -------------------------------
4305 - "name": switch name
4306 - "type": (optional) group type
4310 -> { "execute": "query-rocker-of-dpa-groups", "arguments": { "name": "sw1" } }
4311 <- { "return": [ {"type": 0, "out-pport": 2, "pport": 2, "vlan-id": 3841,
4312 "pop-vlan": 1, "id": 251723778},
4313 {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3841,
4314 "pop-vlan": 1, "id": 251723776},
4315 {"type": 0, "out-pport": 1, "pport": 1, "vlan-id": 3840,
4316 "pop-vlan": 1, "id": 251658241},
4317 {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3840,
4318 "pop-vlan": 1, "id": 251658240}