1 HXCOMM QMP dispatch table and documentation
2 HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
3 HXCOMM does not show up in the other formats.
9 This document describes all commands currently supported by QMP.
11 Most of the time their usage is exactly the same as in the user Monitor, this
12 means that any other document which also describe commands (the manpage,
13 QEMU's manual, etc) can and should be consulted.
15 QMP has two types of commands: regular and query commands. Regular commands
16 usually change the Virtual Machine's state someway, while query commands just
17 return information. The sections below are divided accordingly.
19 It's important to observe that all communication examples are formatted in
20 a reader-friendly way, so that they're easier to understand. However, in real
21 protocol usage, they're emitted as a single line.
23 Also, the following notation is used to denote data flow:
25 -> data issued by the Client
26 <- Server data response
28 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
29 information on the Server command and response formats.
31 NOTE: This document is temporary and will be replaced soon.
33 1. Stability Considerations
34 ===========================
36 The current QMP command set (described in this file) may be useful for a
37 number of use cases, however it's limited and several commands have bad
38 defined semantics, specially with regard to command completion.
40 These problems are going to be solved incrementally in the next QEMU releases
41 and we're going to establish a deprecation policy for badly defined commands.
43 If you're planning to adopt QMP, please observe the following:
45 1. The deprecation policy will take effect and be documented soon, please
46 check the documentation of each used command as soon as a new release of
49 2. DO NOT rely on anything which is not explicit documented
51 3. Errors, in special, are not documented. Applications should NOT check
52 for specific errors classes or data (it's strongly recommended to only
53 check for the "error" key)
58 Server's responses in the examples below are always a success response, please
59 refer to the QMP specification for more details on error responses.
66 .mhandler.cmd_new = qmp_marshal_input_quit,
79 -> { "execute": "quit" }
86 .args_type = "force:-f,device:B",
87 .mhandler.cmd_new = qmp_marshal_input_eject,
94 Eject a removable medium.
98 - force: force ejection (json-bool, optional)
99 - device: device name (json-string)
103 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
106 Note: The "force" argument defaults to false.
112 .args_type = "device:B,target:F,arg:s?",
113 .mhandler.cmd_new = qmp_marshal_input_change,
120 Change a removable medium or VNC configuration.
124 - "device": device name (json-string)
125 - "target": filename or item (json-string)
126 - "arg": additional argument (json-string, optional)
130 1. Change a removable medium
132 -> { "execute": "change",
133 "arguments": { "device": "ide1-cd0",
134 "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
137 2. Change VNC password
139 -> { "execute": "change",
140 "arguments": { "device": "vnc", "target": "password",
147 .name = "screendump",
148 .args_type = "filename:F",
149 .mhandler.cmd_new = qmp_marshal_input_screendump,
156 Save screen into PPM image.
160 - "filename": file path (json-string)
164 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
172 .mhandler.cmd_new = qmp_marshal_input_stop,
185 -> { "execute": "stop" }
193 .mhandler.cmd_new = qmp_marshal_input_cont,
206 -> { "execute": "cont" }
212 .name = "system_wakeup",
214 .mhandler.cmd_new = qmp_marshal_input_system_wakeup,
221 Wakeup guest from suspend.
227 -> { "execute": "system_wakeup" }
233 .name = "system_reset",
235 .mhandler.cmd_new = qmp_marshal_input_system_reset,
248 -> { "execute": "system_reset" }
254 .name = "system_powerdown",
256 .mhandler.cmd_new = qmp_marshal_input_system_powerdown,
263 Send system power down event.
269 -> { "execute": "system_powerdown" }
275 .name = "device_add",
276 .args_type = "device:O",
277 .params = "driver[,prop=value][,...]",
278 .help = "add device, like -device on the command line",
279 .user_print = monitor_user_noop,
280 .mhandler.cmd_new = do_device_add,
291 - "driver": the name of the new device's driver (json-string)
292 - "bus": the device's parent bus (device tree path, json-string, optional)
293 - "id": the device's ID, must be unique (json-string)
298 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
303 (1) For detailed information about this command, please refer to the
304 'docs/qdev-device-use.txt' file.
306 (2) It's possible to list device properties by running QEMU with the
307 "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
312 .name = "device_del",
314 .mhandler.cmd_new = qmp_marshal_input_device_del,
325 - "id": the device's ID (json-string)
329 -> { "execute": "device_del", "arguments": { "id": "net1" } }
336 .args_type = "keys:O,hold-time:i?",
337 .mhandler.cmd_new = qmp_marshal_input_send_key,
349 - "key": key sequence (a json-array of key enum values)
351 - hold-time: time to delay key up events, milliseconds. Defaults to 100
356 -> { "execute": "send-key",
357 "arguments": { 'keys': [ 'ctrl', 'alt', 'delete' ] } }
364 .args_type = "index:i",
365 .mhandler.cmd_new = qmp_marshal_input_cpu,
376 - "index": the CPU's index (json-int)
380 -> { "execute": "cpu", "arguments": { "index": 0 } }
383 Note: CPUs' indexes are obtained with the 'query-cpus' command.
389 .args_type = "val:l,size:i,filename:s,cpu:i?",
390 .mhandler.cmd_new = qmp_marshal_input_memsave,
397 Save to disk virtual memory dump starting at 'val' of size 'size'.
401 - "val": the starting address (json-int)
402 - "size": the memory size, in bytes (json-int)
403 - "filename": file path (json-string)
404 - "cpu": virtual CPU index (json-int, optional)
408 -> { "execute": "memsave",
409 "arguments": { "val": 10,
411 "filename": "/tmp/virtual-mem-dump" } }
418 .args_type = "val:l,size:i,filename:s",
419 .mhandler.cmd_new = qmp_marshal_input_pmemsave,
426 Save to disk physical memory dump starting at 'val' of size 'size'.
430 - "val": the starting address (json-int)
431 - "size": the memory size, in bytes (json-int)
432 - "filename": file path (json-string)
436 -> { "execute": "pmemsave",
437 "arguments": { "val": 10,
439 "filename": "/tmp/physical-mem-dump" } }
445 .name = "inject-nmi",
447 .mhandler.cmd_new = qmp_marshal_input_inject_nmi,
454 Inject an NMI on guest's CPUs.
460 -> { "execute": "inject-nmi" }
463 Note: inject-nmi fails when the guest doesn't support injecting.
464 Currently, only x86 guests do.
469 .name = "xen-save-devices-state",
470 .args_type = "filename:F",
471 .mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
475 xen-save-devices-state
478 Save the state of all devices to file. The RAM and the block devices
479 of the VM are not saved by this command.
483 - "filename": the file to save the state of the devices to as binary
484 data. See xen-save-devices-state.txt for a description of the binary
489 -> { "execute": "xen-save-devices-state",
490 "arguments": { "filename": "/tmp/save" } }
496 .name = "xen-set-global-dirty-log",
497 .args_type = "enable:b",
498 .mhandler.cmd_new = qmp_marshal_input_xen_set_global_dirty_log,
502 xen-set-global-dirty-log
505 Enable or disable the global dirty log mode.
509 - "enable": Enable it or disable it.
513 -> { "execute": "xen-set-global-dirty-log",
514 "arguments": { "enable": true } }
521 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
522 .mhandler.cmd_new = qmp_marshal_input_migrate,
533 - "blk": block migration, full disk copy (json-bool, optional)
534 - "inc": incremental disk copy (json-bool, optional)
535 - "uri": Destination URI (json-string)
539 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
544 (1) The 'query-migrate' command should be used to check migration's progress
545 and final result (this information is provided by the 'status' member)
546 (2) All boolean arguments default to false
547 (3) The user Monitor's "detach" argument is invalid in QMP and should not
553 .name = "migrate_cancel",
555 .mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
562 Cancel the current migration.
568 -> { "execute": "migrate_cancel" }
573 .name = "migrate-set-cache-size",
574 .args_type = "value:o",
575 .mhandler.cmd_new = qmp_marshal_input_migrate_set_cache_size,
579 migrate-set-cache-size
580 ---------------------
582 Set cache size to be used by XBZRLE migration, the cache size will be rounded
583 down to the nearest power of 2
587 - "value": cache size in bytes (json-int)
591 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
596 .name = "query-migrate-cache-size",
598 .mhandler.cmd_new = qmp_marshal_input_query_migrate_cache_size,
602 query-migrate-cache-size
603 ---------------------
605 Show cache size to be used by XBZRLE migration
607 returns a json-object with the following information:
612 -> { "execute": "query-migrate-cache-size" }
613 <- { "return": 67108864 }
618 .name = "migrate_set_speed",
619 .args_type = "value:o",
620 .mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
627 Set maximum speed for migrations.
631 - "value": maximum speed, in bytes per second (json-int)
635 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
641 .name = "migrate_set_downtime",
642 .args_type = "value:T",
643 .mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
650 Set maximum tolerated downtime (in seconds) for migrations.
654 - "value": maximum downtime (json-number)
658 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
664 .name = "client_migrate_info",
665 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
666 .params = "protocol hostname port tls-port cert-subject",
667 .help = "send migration info to spice/vnc client",
668 .user_print = monitor_user_noop,
669 .mhandler.cmd_async = client_migrate_info,
670 .flags = MONITOR_CMD_ASYNC,
677 Set the spice/vnc connection info for the migration target. The spice/vnc
678 server will ask the spice/vnc client to automatically reconnect using the
679 new parameters (if specified) once the vm migration finished successfully.
683 - "protocol": protocol: "spice" or "vnc" (json-string)
684 - "hostname": migration target hostname (json-string)
685 - "port": spice/vnc tcp port for plaintext channels (json-int, optional)
686 - "tls-port": spice tcp port for tls-secured channels (json-int, optional)
687 - "cert-subject": server certificate subject (json-string, optional)
691 -> { "execute": "client_migrate_info",
692 "arguments": { "protocol": "spice",
693 "hostname": "virt42.lab.kraxel.org",
700 .name = "dump-guest-memory",
701 .args_type = "paging:b,protocol:s,begin:i?,end:i?",
702 .params = "-p protocol [begin] [length]",
703 .help = "dump guest memory to file",
704 .user_print = monitor_user_noop,
705 .mhandler.cmd_new = qmp_marshal_input_dump_guest_memory,
712 Dump guest memory to file. The file can be processed with crash or gdb.
716 - "paging": do paging to get guest's memory mapping (json-bool)
717 - "protocol": destination file(started with "file:") or destination file
718 descriptor (started with "fd:") (json-string)
719 - "begin": the starting physical address. It's optional, and should be specified
720 with length together (json-int)
721 - "length": the memory size, in bytes. It's optional, and should be specified
722 with begin together (json-int)
726 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
731 (1) All boolean arguments default to false
736 .name = "netdev_add",
737 .args_type = "netdev:O",
738 .mhandler.cmd_new = qmp_netdev_add,
745 Add host network device.
749 - "type": the device type, "tap", "user", ... (json-string)
750 - "id": the device's ID, must be unique (json-string)
755 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
758 Note: The supported device options are the same ones supported by the '-net'
759 command-line argument, which are listed in the '-help' output or QEMU's
765 .name = "netdev_del",
767 .mhandler.cmd_new = qmp_marshal_input_netdev_del,
774 Remove host network device.
778 - "id": the device's ID, must be unique (json-string)
782 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
789 .name = "block_resize",
790 .args_type = "device:B,size:o",
791 .mhandler.cmd_new = qmp_marshal_input_block_resize,
798 Resize a block image while a guest is running.
802 - "device": the device's ID, must be unique (json-string)
807 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
813 .name = "block-stream",
814 .args_type = "device:B,base:s?,speed:o?",
815 .mhandler.cmd_new = qmp_marshal_input_block_stream,
819 .name = "block-job-set-speed",
820 .args_type = "device:B,speed:o",
821 .mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
825 .name = "block-job-cancel",
826 .args_type = "device:B",
827 .mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
830 .name = "transaction",
831 .args_type = "actions:q",
832 .mhandler.cmd_new = qmp_marshal_input_transaction,
839 Atomically operate on one or more block devices. The only supported
840 operation for now is snapshotting. If there is any failure performing
841 any of the operations, all snapshots for the group are abandoned, and
842 the original disks pre-snapshot attempt are used.
844 A list of dictionaries is accepted, that contains the actions to be performed.
845 For snapshots this is the device, the file to use for the new snapshot,
846 and the format. The default format, if not specified, is qcow2.
848 Each new snapshot defaults to being created by QEMU (wiping any
849 contents if the file already exists), but it is also possible to reuse
850 an externally-created file. In the latter case, you should ensure that
851 the new image file has the same contents as the current one; QEMU cannot
852 perform any meaningful check. Typically this is achieved by using the
853 current image file as the backing file for the new image.
858 - "type": the operation to perform. The only supported
859 value is "blockdev-snapshot-sync". (json-string)
860 - "data": a dictionary. The contents depend on the value
861 of "type". When "type" is "blockdev-snapshot-sync":
862 - "device": device name to snapshot (json-string)
863 - "snapshot-file": name of new image file (json-string)
864 - "format": format of new image (json-string, optional)
865 - "mode": whether and how QEMU should create the snapshot file
866 (NewImageMode, optional, default "absolute-paths")
870 -> { "execute": "transaction",
871 "arguments": { "actions": [
872 { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd0",
873 "snapshot-file": "/some/place/my-image",
874 "format": "qcow2" } },
875 { 'type': 'blockdev-snapshot-sync', 'data' : { "device": "ide-hd1",
876 "snapshot-file": "/some/place/my-image2",
878 "format": "qcow2" } } ] } }
884 .name = "blockdev-snapshot-sync",
885 .args_type = "device:B,snapshot-file:s,format:s?,mode:s?",
886 .mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
890 blockdev-snapshot-sync
891 ----------------------
893 Synchronous snapshot of a block device. snapshot-file specifies the
894 target of the new image. If the file exists, or if it is a device, the
895 snapshot will be created in the existing file/device. If does not
896 exist, a new file will be created. format specifies the format of the
897 snapshot image, default is qcow2.
901 - "device": device name to snapshot (json-string)
902 - "snapshot-file": name of new image file (json-string)
903 - "mode": whether and how QEMU should create the snapshot file
904 (NewImageMode, optional, default "absolute-paths")
905 - "format": format of new image (json-string, optional)
909 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
911 "/some/place/my-image",
912 "format": "qcow2" } }
919 .args_type = "value:M",
920 .mhandler.cmd_new = qmp_marshal_input_balloon,
927 Request VM to change its memory allocation (in bytes).
931 - "value": New memory allocation (json-int)
935 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
942 .args_type = "name:s,up:b",
943 .mhandler.cmd_new = qmp_marshal_input_set_link,
950 Change the link status of a network adapter.
954 - "name": network device name (json-string)
955 - "up": status is up (json-bool)
959 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
966 .args_type = "fdname:s",
967 .params = "getfd name",
968 .help = "receive a file descriptor via SCM rights and assign it a name",
969 .mhandler.cmd_new = qmp_marshal_input_getfd,
976 Receive a file descriptor via SCM rights and assign it a name.
980 - "fdname": file descriptor name (json-string)
984 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
989 (1) If the name specified by the "fdname" argument already exists,
990 the file descriptor assigned to it will be closed and replaced
991 by the received file descriptor.
992 (2) The 'closefd' command can be used to explicitly close the file
993 descriptor when it is no longer needed.
999 .args_type = "fdname:s",
1000 .params = "closefd name",
1001 .help = "close a file descriptor previously passed via SCM rights",
1002 .mhandler.cmd_new = qmp_marshal_input_closefd,
1009 Close a file descriptor previously passed via SCM rights.
1013 - "fdname": file descriptor name (json-string)
1017 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1024 .args_type = "fdset-id:i?,opaque:s?",
1025 .params = "add-fd fdset-id opaque",
1026 .help = "Add a file descriptor, that was passed via SCM rights, to an fd set",
1027 .mhandler.cmd_new = qmp_marshal_input_add_fd,
1034 Add a file descriptor, that was passed via SCM rights, to an fd set.
1038 - "fdset-id": The ID of the fd set to add the file descriptor to.
1039 (json-int, optional)
1040 - "opaque": A free-form string that can be used to describe the fd.
1041 (json-string, optional)
1043 Return a json-object with the following information:
1045 - "fdset-id": The ID of the fd set that the fd was added to. (json-int)
1046 - "fd": The file descriptor that was received via SCM rights and added to the
1051 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1052 <- { "return": { "fdset-id": 1, "fd": 3 } }
1056 (1) The list of fd sets is shared by all monitor connections.
1057 (2) If "fdset-id" is not specified, a new fd set will be created.
1062 .name = "remove-fd",
1063 .args_type = "fdset-id:i,fd:i?",
1064 .params = "remove-fd fdset-id fd",
1065 .help = "Remove a file descriptor from an fd set",
1066 .mhandler.cmd_new = qmp_marshal_input_remove_fd,
1073 Remove a file descriptor from an fd set.
1077 - "fdset-id": The ID of the fd set that the file descriptor belongs to.
1079 - "fd": The file descriptor that is to be removed. (json-int, optional)
1083 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1088 (1) The list of fd sets is shared by all monitor connections.
1089 (2) If "fd" is not specified, all file descriptors in "fdset-id" will be
1095 .name = "query-fdsets",
1097 .help = "Return information describing all fd sets",
1098 .mhandler.cmd_new = qmp_marshal_input_query_fdsets,
1105 Return information describing all fd sets.
1111 -> { "execute": "query-fdsets" }
1117 "opaque": "rdonly:/path/to/file"
1121 "opaque": "rdwr:/path/to/file"
1140 Note: The list of fd sets is shared by all monitor connections.
1145 .name = "block_passwd",
1146 .args_type = "device:B,password:s",
1147 .mhandler.cmd_new = qmp_marshal_input_block_passwd,
1154 Set the password of encrypted block devices.
1158 - "device": device name (json-string)
1159 - "password": password (json-string)
1163 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
1164 "password": "12345" } }
1170 .name = "block_set_io_throttle",
1171 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1172 .mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
1176 block_set_io_throttle
1179 Change I/O throttle limits for a block drive.
1183 - "device": device name (json-string)
1184 - "bps": total throughput limit in bytes per second(json-int)
1185 - "bps_rd": read throughput limit in bytes per second(json-int)
1186 - "bps_wr": read throughput limit in bytes per second(json-int)
1187 - "iops": total I/O operations per second(json-int)
1188 - "iops_rd": read I/O operations per second(json-int)
1189 - "iops_wr": write I/O operations per second(json-int)
1193 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
1205 .name = "set_password",
1206 .args_type = "protocol:s,password:s,connected:s?",
1207 .mhandler.cmd_new = qmp_marshal_input_set_password,
1214 Set the password for vnc/spice protocols.
1218 - "protocol": protocol name (json-string)
1219 - "password": password (json-string)
1220 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
1224 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
1225 "password": "secret" } }
1231 .name = "expire_password",
1232 .args_type = "protocol:s,time:s",
1233 .mhandler.cmd_new = qmp_marshal_input_expire_password,
1240 Set the password expire time for vnc/spice protocols.
1244 - "protocol": protocol name (json-string)
1245 - "time": [ now | never | +secs | secs ] (json-string)
1249 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
1256 .name = "add_client",
1257 .args_type = "protocol:s,fdname:s,skipauth:b?,tls:b?",
1258 .params = "protocol fdname skipauth tls",
1259 .help = "add a graphics client",
1260 .user_print = monitor_user_noop,
1261 .mhandler.cmd_new = add_graphics_client,
1268 Add a graphics client
1272 - "protocol": protocol name (json-string)
1273 - "fdname": file descriptor name (json-string)
1274 - "skipauth": whether to skip authentication (json-bool, optional)
1275 - "tls": whether to perform TLS (json-bool, optional)
1279 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
1280 "fdname": "myclient" } }
1285 .name = "qmp_capabilities",
1288 .help = "enable QMP capabilities",
1289 .user_print = monitor_user_noop,
1290 .mhandler.cmd_new = do_qmp_capabilities,
1297 Enable QMP capabilities.
1303 -> { "execute": "qmp_capabilities" }
1306 Note: This command must be issued before issuing any other command.
1311 .name = "human-monitor-command",
1312 .args_type = "command-line:s,cpu-index:i?",
1313 .mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
1317 human-monitor-command
1318 ---------------------
1320 Execute a Human Monitor command.
1324 - command-line: the command name and its arguments, just like the
1325 Human Monitor's shell (json-string)
1326 - cpu-index: select the CPU number to be used by commands which access CPU
1327 data, like 'info registers'. The Monitor selects CPU 0 if this
1328 argument is not provided (json-int, optional)
1332 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1333 <- { "return": "kvm support: enabled\r\n" }
1337 (1) The Human Monitor is NOT an stable interface, this means that command
1338 names, arguments and responses can change or be removed at ANY time.
1339 Applications that rely on long term stability guarantees should NOT
1344 o This command is stateless, this means that commands that depend
1345 on state information (such as getfd) might not work
1347 o Commands that prompt the user for data (eg. 'cont' when the block
1348 device is encrypted) don't currently work
1353 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1354 HXCOMM this! We will possibly move query commands definitions inside those
1355 HXCOMM sections, just like regular commands.
1365 Return a json-object with the following information:
1367 - "qemu": A json-object containing three integer values:
1368 - "major": QEMU's major version (json-int)
1369 - "minor": QEMU's minor version (json-int)
1370 - "micro": QEMU's micro version (json-int)
1371 - "package": package's version (json-string)
1375 -> { "execute": "query-version" }
1390 .name = "query-version",
1392 .mhandler.cmd_new = qmp_marshal_input_query_version,
1399 List QMP available commands.
1401 Each command is represented by a json-object, the returned value is a json-array
1404 Each json-object contain:
1406 - "name": command's name (json-string)
1410 -> { "execute": "query-commands" }
1414 "name":"query-balloon"
1417 "name":"system_powerdown"
1422 Note: This example has been shortened as the real response is too long.
1427 .name = "query-commands",
1429 .mhandler.cmd_new = qmp_marshal_input_query_commands,
1436 List QMP available events.
1438 Each event is represented by a json-object, the returned value is a json-array
1441 Each json-object contains:
1443 - "name": event's name (json-string)
1447 -> { "execute": "query-events" }
1459 Note: This example has been shortened as the real response is too long.
1464 .name = "query-events",
1466 .mhandler.cmd_new = qmp_marshal_input_query_events,
1473 Each device is represented by a json-object. The returned value is a json-array
1476 Each json-object contain the following:
1478 - "label": device's label (json-string)
1479 - "filename": device's file (json-string)
1483 -> { "execute": "query-chardev" }
1500 .name = "query-chardev",
1502 .mhandler.cmd_new = qmp_marshal_input_query_chardev,
1509 Show the block devices.
1511 Each block device information is stored in a json-object and the returned value
1512 is a json-array of all devices.
1514 Each json-object contain the following:
1516 - "device": device name (json-string)
1517 - "type": device type (json-string)
1518 - deprecated, retained for backward compatibility
1519 - Possible values: "unknown"
1520 - "removable": true if the device is removable, false otherwise (json-bool)
1521 - "locked": true if the device is locked, false otherwise (json-bool)
1522 - "tray-open": only present if removable, true if the device has a tray,
1523 and it is open (json-bool)
1524 - "inserted": only present if the device is inserted, it is a json-object
1525 containing the following:
1526 - "file": device file name (json-string)
1527 - "ro": true if read-only, false otherwise (json-bool)
1528 - "drv": driver format name (json-string)
1529 - Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
1530 "file", "file", "ftp", "ftps", "host_cdrom",
1531 "host_device", "host_floppy", "http", "https",
1532 "nbd", "parallels", "qcow", "qcow2", "raw",
1533 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1534 - "backing_file": backing file name (json-string, optional)
1535 - "backing_file_depth": number of files in the backing file chain (json-int)
1536 - "encrypted": true if encrypted, false otherwise (json-bool)
1537 - "bps": limit total bytes per second (json-int)
1538 - "bps_rd": limit read bytes per second (json-int)
1539 - "bps_wr": limit write bytes per second (json-int)
1540 - "iops": limit total I/O operations per second (json-int)
1541 - "iops_rd": limit read operations per second (json-int)
1542 - "iops_wr": limit write operations per second (json-int)
1544 - "io-status": I/O operation status, only present if the device supports it
1545 and the VM is configured to stop on errors. It's always reset
1546 to "ok" when the "cont" command is issued (json_string, optional)
1547 - Possible values: "ok", "failed", "nospace"
1551 -> { "execute": "query-block" }
1556 "device":"ide0-hd0",
1563 "file":"disks/test.img",
1564 "backing_file_depth":0,
1576 "device":"ide1-cd0",
1599 .name = "query-block",
1601 .mhandler.cmd_new = qmp_marshal_input_query_block,
1608 Show block device statistics.
1610 Each device statistic information is stored in a json-object and the returned
1611 value is a json-array of all devices.
1613 Each json-object contain the following:
1615 - "device": device name (json-string)
1616 - "stats": A json-object with the statistics information, it contains:
1617 - "rd_bytes": bytes read (json-int)
1618 - "wr_bytes": bytes written (json-int)
1619 - "rd_operations": read operations (json-int)
1620 - "wr_operations": write operations (json-int)
1621 - "flush_operations": cache flush operations (json-int)
1622 - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
1623 - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
1624 - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
1625 - "wr_highest_offset": Highest offset of a sector written since the
1626 BlockDriverState has been opened (json-int)
1627 - "parent": Contains recursively the statistics of the underlying
1628 protocol (e.g. the host file for a qcow2 image). If there is
1629 no underlying protocol, this field is omitted
1630 (json-object, optional)
1634 -> { "execute": "query-blockstats" }
1638 "device":"ide0-hd0",
1641 "wr_highest_offset":3686448128,
1643 "wr_operations":751,
1644 "rd_bytes":122567168,
1645 "rd_operations":36772
1646 "wr_total_times_ns":313253456
1647 "rd_total_times_ns":3465673657
1648 "flush_total_times_ns":49653
1649 "flush_operations":61,
1653 "wr_highest_offset":2821110784,
1655 "wr_operations":692,
1656 "rd_bytes":122739200,
1657 "rd_operations":36604
1658 "flush_operations":51,
1659 "wr_total_times_ns":313253456
1660 "rd_total_times_ns":3465673657
1661 "flush_total_times_ns":49653
1665 "device":"ide1-cd0",
1667 "wr_highest_offset":0,
1672 "flush_operations":0,
1673 "wr_total_times_ns":0
1674 "rd_total_times_ns":0
1675 "flush_total_times_ns":0
1681 "wr_highest_offset":0,
1686 "flush_operations":0,
1687 "wr_total_times_ns":0
1688 "rd_total_times_ns":0
1689 "flush_total_times_ns":0
1695 "wr_highest_offset":0,
1700 "flush_operations":0,
1701 "wr_total_times_ns":0
1702 "rd_total_times_ns":0
1703 "flush_total_times_ns":0
1712 .name = "query-blockstats",
1714 .mhandler.cmd_new = qmp_marshal_input_query_blockstats,
1721 Show CPU information.
1723 Return a json-array. Each CPU is represented by a json-object, which contains:
1725 - "CPU": CPU index (json-int)
1726 - "current": true if this is the current CPU, false otherwise (json-bool)
1727 - "halted": true if the cpu is halted, false otherwise (json-bool)
1728 - Current program counter. The key's name depends on the architecture:
1729 "pc": i386/x86_64 (json-int)
1730 "nip": PPC (json-int)
1731 "pc" and "npc": sparc (json-int)
1732 "PC": mips (json-int)
1733 - "thread_id": ID of the underlying host thread (json-int)
1737 -> { "execute": "query-cpus" }
1760 .name = "query-cpus",
1762 .mhandler.cmd_new = qmp_marshal_input_query_cpus,
1769 PCI buses and devices information.
1771 The returned value is a json-array of all buses. Each bus is represented by
1772 a json-object, which has a key with a json-array of all PCI devices attached
1773 to it. Each device is represented by a json-object.
1775 The bus json-object contains the following:
1777 - "bus": bus number (json-int)
1778 - "devices": a json-array of json-objects, each json-object represents a
1781 The PCI device json-object contains the following:
1783 - "bus": identical to the parent's bus number (json-int)
1784 - "slot": slot number (json-int)
1785 - "function": function number (json-int)
1786 - "class_info": a json-object containing:
1787 - "desc": device class description (json-string, optional)
1788 - "class": device class number (json-int)
1789 - "id": a json-object containing:
1790 - "device": device ID (json-int)
1791 - "vendor": vendor ID (json-int)
1792 - "irq": device's IRQ if assigned (json-int, optional)
1793 - "qdev_id": qdev id string (json-string)
1794 - "pci_bridge": It's a json-object, only present if this device is a
1795 PCI bridge, contains:
1796 - "bus": bus number (json-int)
1797 - "secondary": secondary bus number (json-int)
1798 - "subordinate": subordinate bus number (json-int)
1799 - "io_range": I/O memory range information, a json-object with the
1801 - "base": base address, in bytes (json-int)
1802 - "limit": limit address, in bytes (json-int)
1803 - "memory_range": memory range information, a json-object with the
1805 - "base": base address, in bytes (json-int)
1806 - "limit": limit address, in bytes (json-int)
1807 - "prefetchable_range": Prefetchable memory range information, a
1808 json-object with the following members:
1809 - "base": base address, in bytes (json-int)
1810 - "limit": limit address, in bytes (json-int)
1811 - "devices": a json-array of PCI devices if there's any attached, each
1812 each element is represented by a json-object, which contains
1813 the same members of the 'PCI device json-object' described
1815 - "regions": a json-array of json-objects, each json-object represents a
1816 memory region of this device
1818 The memory range json-object contains the following:
1820 - "base": base memory address (json-int)
1821 - "limit": limit value (json-int)
1823 The region json-object can be an I/O region or a memory region, an I/O region
1824 json-object contains the following:
1826 - "type": "io" (json-string, fixed)
1827 - "bar": BAR number (json-int)
1828 - "address": memory address (json-int)
1829 - "size": memory size (json-int)
1831 A memory region json-object contains the following:
1833 - "type": "memory" (json-string, fixed)
1834 - "bar": BAR number (json-int)
1835 - "address": memory address (json-int)
1836 - "size": memory size (json-int)
1837 - "mem_type_64": true or false (json-bool)
1838 - "prefetch": true or false (json-bool)
1842 -> { "execute": "query-pci" }
1854 "desc":"Host bridge"
1888 "desc":"IDE controller"
1910 "desc":"VGA controller"
1920 "mem_type_64":false,
1923 "address":4026531840,
1928 "mem_type_64":false,
1931 "address":4060086272,
1936 "mem_type_64":false,
1951 "desc":"RAM controller"
1972 Note: This example has been shortened as the real response is too long.
1977 .name = "query-pci",
1979 .mhandler.cmd_new = qmp_marshal_input_query_pci,
1986 Show KVM information.
1988 Return a json-object with the following information:
1990 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
1991 - "present": true if QEMU has KVM support, false otherwise (json-bool)
1995 -> { "execute": "query-kvm" }
1996 <- { "return": { "enabled": true, "present": true } }
2001 .name = "query-kvm",
2003 .mhandler.cmd_new = qmp_marshal_input_query_kvm,
2010 Return a json-object with the following information:
2012 - "running": true if the VM is running, or false if it is paused (json-bool)
2013 - "singlestep": true if the VM is in single step mode,
2014 false otherwise (json-bool)
2015 - "status": one of the following values (json-string)
2016 "debug" - QEMU is running on a debugger
2017 "inmigrate" - guest is paused waiting for an incoming migration
2018 "internal-error" - An internal error that prevents further guest
2019 execution has occurred
2020 "io-error" - the last IOP has failed and the device is configured
2021 to pause on I/O errors
2022 "paused" - guest has been paused via the 'stop' command
2023 "postmigrate" - guest is paused following a successful 'migrate'
2024 "prelaunch" - QEMU was started with -S and guest has not started
2025 "finish-migrate" - guest is paused to finish the migration process
2026 "restore-vm" - guest is paused to restore VM state
2027 "running" - guest is actively running
2028 "save-vm" - guest is paused to save the VM state
2029 "shutdown" - guest is shut down (and -no-shutdown is in use)
2030 "watchdog" - the watchdog action is configured to pause and
2035 -> { "execute": "query-status" }
2036 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
2041 .name = "query-status",
2043 .mhandler.cmd_new = qmp_marshal_input_query_status,
2050 Show VM mice information.
2052 Each mouse is represented by a json-object, the returned value is a json-array
2055 The mouse json-object contains the following:
2057 - "name": mouse's name (json-string)
2058 - "index": mouse's index (json-int)
2059 - "current": true if this mouse is receiving events, false otherwise (json-bool)
2060 - "absolute": true if the mouse generates absolute input events (json-bool)
2064 -> { "execute": "query-mice" }
2068 "name":"QEMU Microsoft Mouse",
2074 "name":"QEMU PS/2 Mouse",
2085 .name = "query-mice",
2087 .mhandler.cmd_new = qmp_marshal_input_query_mice,
2094 Show VNC server information.
2096 Return a json-object with server information. Connected clients are returned
2097 as a json-array of json-objects.
2099 The main json-object contains the following:
2101 - "enabled": true or false (json-bool)
2102 - "host": server's IP address (json-string)
2103 - "family": address family (json-string)
2104 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2105 - "service": server's port number (json-string)
2106 - "auth": authentication method (json-string)
2107 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
2108 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
2109 "vencrypt+plain", "vencrypt+tls+none",
2110 "vencrypt+tls+plain", "vencrypt+tls+sasl",
2111 "vencrypt+tls+vnc", "vencrypt+x509+none",
2112 "vencrypt+x509+plain", "vencrypt+x509+sasl",
2113 "vencrypt+x509+vnc", "vnc"
2114 - "clients": a json-array of all connected clients
2116 Clients are described by a json-object, each one contain the following:
2118 - "host": client's IP address (json-string)
2119 - "family": address family (json-string)
2120 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2121 - "service": client's port number (json-string)
2122 - "x509_dname": TLS dname (json-string, optional)
2123 - "sasl_username": SASL username (json-string, optional)
2127 -> { "execute": "query-vnc" }
2148 .name = "query-vnc",
2150 .mhandler.cmd_new = qmp_marshal_input_query_vnc,
2157 Show SPICE server information.
2159 Return a json-object with server information. Connected clients are returned
2160 as a json-array of json-objects.
2162 The main json-object contains the following:
2164 - "enabled": true or false (json-bool)
2165 - "host": server's IP address (json-string)
2166 - "port": server's port number (json-int, optional)
2167 - "tls-port": server's port number (json-int, optional)
2168 - "auth": authentication method (json-string)
2169 - Possible values: "none", "spice"
2170 - "channels": a json-array of all active channels clients
2172 Channels are described by a json-object, each one contain the following:
2174 - "host": client's IP address (json-string)
2175 - "family": address family (json-string)
2176 - Possible values: "ipv4", "ipv6", "unix", "unknown"
2177 - "port": client's port number (json-string)
2178 - "connection-id": spice connection id. All channels with the same id
2179 belong to the same spice session (json-int)
2180 - "channel-type": channel type. "1" is the main control channel, filter for
2181 this one if you want track spice sessions only (json-int)
2182 - "channel-id": channel id. Usually "0", might be different needed when
2183 multiple channels of the same type exist, such as multiple
2184 display channels in a multihead setup (json-int)
2185 - "tls": whevener the channel is encrypted (json-bool)
2189 -> { "execute": "query-spice" }
2202 "connection-id": 1804289383,
2203 "host": "127.0.0.1",
2211 "connection-id": 1804289383,
2212 "host": "127.0.0.1",
2216 [ ... more channels follow ... ]
2223 #if defined(CONFIG_SPICE)
2225 .name = "query-spice",
2227 .mhandler.cmd_new = qmp_marshal_input_query_spice,
2237 Return a json-object with the following information:
2239 - "name": VM's name (json-string, optional)
2243 -> { "execute": "query-name" }
2244 <- { "return": { "name": "qemu-name" } }
2249 .name = "query-name",
2251 .mhandler.cmd_new = qmp_marshal_input_query_name,
2260 Return a json-object with the following information:
2262 - "UUID": Universally Unique Identifier (json-string)
2266 -> { "execute": "query-uuid" }
2267 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
2272 .name = "query-uuid",
2274 .mhandler.cmd_new = qmp_marshal_input_query_uuid,
2283 Return a json-object. If migration is active there will be another json-object
2284 with RAM migration status and if block migration is active another one with
2285 block migration status.
2287 The main json-object contains the following:
2289 - "status": migration status (json-string)
2290 - Possible values: "active", "completed", "failed", "cancelled"
2291 - "total-time": total amount of ms since migration started. If
2292 migration has ended, it returns the total migration
2294 - "ram": only present if "status" is "active", it is a json-object with the
2295 following RAM information (in bytes):
2296 - "transferred": amount transferred (json-int)
2297 - "remaining": amount remaining (json-int)
2298 - "total": total (json-int)
2299 - "duplicate": number of duplicated pages (json-int)
2300 - "normal" : number of normal pages transferred (json-int)
2301 - "normal-bytes" : number of normal bytes transferred (json-int)
2302 - "disk": only present if "status" is "active" and it is a block migration,
2303 it is a json-object with the following disk information (in bytes):
2304 - "transferred": amount transferred (json-int)
2305 - "remaining": amount remaining (json-int)
2306 - "total": total (json-int)
2307 - "xbzrle-cache": only present if XBZRLE is active.
2308 It is a json-object with the following XBZRLE information:
2309 - "cache-size": XBZRLE cache size
2310 - "bytes": total XBZRLE bytes transferred
2311 - "pages": number of XBZRLE compressed pages
2312 - "cache-miss": number of cache misses
2313 - "overflow": number of XBZRLE overflows
2316 1. Before the first migration
2318 -> { "execute": "query-migrate" }
2321 2. Migration is done and has succeeded
2323 -> { "execute": "query-migrate" }
2325 "status": "completed",
2333 "normal-bytes":123456
2338 3. Migration is done and has failed
2340 -> { "execute": "query-migrate" }
2341 <- { "return": { "status": "failed" } }
2343 4. Migration is being performed and is not a block migration:
2345 -> { "execute": "query-migrate" }
2356 "normal-bytes":123456
2361 5. Migration is being performed and is a block migration:
2363 -> { "execute": "query-migrate" }
2369 "remaining":1053304,
2374 "normal-bytes":123456
2378 "remaining":20880384,
2384 6. Migration is being performed and XBZRLE is active:
2386 -> { "execute": "query-migrate" }
2390 "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
2393 "remaining":1053304,
2398 "normal-bytes":3412992
2401 "cache-size":67108864,
2413 .name = "query-migrate",
2415 .mhandler.cmd_new = qmp_marshal_input_query_migrate,
2419 migrate-set-capabilities
2422 Enable/Disable migration capabilities
2424 - "xbzrle": xbzrle support
2430 -> { "execute": "migrate-set-capabilities" , "arguments":
2431 { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
2436 .name = "migrate-set-capabilities",
2437 .args_type = "capabilities:O",
2438 .params = "capability:s,state:b",
2439 .mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
2442 query-migrate-capabilities
2445 Query current migration capabilities
2447 - "capabilities": migration capabilities state
2448 - "xbzrle" : XBZRLE state (json-bool)
2454 -> { "execute": "query-migrate-capabilities" }
2456 "capabilities" : [ { "capability" : "xbzrle", "state" : false } ]
2462 .name = "query-migrate-capabilities",
2464 .mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
2471 Show balloon information.
2473 Make an asynchronous request for balloon info. When the request completes a
2474 json-object will be returned containing the following data:
2476 - "actual": current balloon value in bytes (json-int)
2477 - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional)
2478 - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional)
2479 - "major_page_faults": Number of major faults (json-int, optional)
2480 - "minor_page_faults": Number of minor faults (json-int, optional)
2481 - "free_mem": Total amount of free and unused memory in
2482 bytes (json-int, optional)
2483 - "total_mem": Total amount of available memory in bytes (json-int, optional)
2487 -> { "execute": "query-balloon" }
2490 "actual":1073741824,
2492 "mem_swapped_out":0,
2493 "major_page_faults":142,
2494 "minor_page_faults":239245,
2495 "free_mem":1014185984,
2496 "total_mem":1044668416
2503 .name = "query-balloon",
2505 .mhandler.cmd_new = qmp_marshal_input_query_balloon,
2509 .name = "query-block-jobs",
2511 .mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
2516 .args_type = "path:s",
2517 .mhandler.cmd_new = qmp_marshal_input_qom_list,
2522 .args_type = "path:s,property:s,value:q",
2523 .mhandler.cmd_new = qmp_qom_set,
2528 .args_type = "path:s,property:s",
2529 .mhandler.cmd_new = qmp_qom_get,
2533 .name = "change-vnc-password",
2534 .args_type = "password:s",
2535 .mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
2538 .name = "qom-list-types",
2539 .args_type = "implements:s?,abstract:b?",
2540 .mhandler.cmd_new = qmp_marshal_input_qom_list_types,
2544 .name = "device-list-properties",
2545 .args_type = "typename:s",
2546 .mhandler.cmd_new = qmp_marshal_input_device_list_properties,
2550 .name = "query-machines",
2552 .mhandler.cmd_new = qmp_marshal_input_query_machines,
2556 .name = "query-cpu-definitions",
2558 .mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
2562 .name = "query-target",
2564 .mhandler.cmd_new = qmp_marshal_input_query_target,