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
.
67 .help
= "quit the emulator",
68 .user_print
= monitor_user_noop
,
69 .mhandler
.cmd_new
= do_quit
,
82 -> { "execute": "quit" }
89 .args_type
= "force:-f,device:B",
90 .params
= "[-f] device",
91 .help
= "eject a removable medium (use -f to force it)",
92 .user_print
= monitor_user_noop
,
93 .mhandler
.cmd_new
= do_eject
,
100 Eject a removable medium
.
104 - force
: force
ejection (json
-bool
, optional
)
105 - device
: device
name (json
-string
)
109 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
112 Note
: The
"force" argument defaults to
false.
118 .args_type
= "device:B,target:F,arg:s?",
119 .params
= "device filename [format]",
120 .help
= "change a removable medium, optional format",
121 .user_print
= monitor_user_noop
,
122 .mhandler
.cmd_new
= do_change
,
129 Change a removable medium or VNC configuration
.
133 - "device": device
name (json
-string
)
134 - "target": filename or
item (json
-string
)
135 - "arg": additional
argument (json
-string
, optional
)
139 1. Change a removable medium
141 -> { "execute": "change",
142 "arguments": { "device": "ide1-cd0",
143 "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
146 2. Change VNC password
148 -> { "execute": "change",
149 "arguments": { "device": "vnc", "target": "password",
156 .name
= "screendump",
157 .args_type
= "filename:F",
158 .params
= "filename",
159 .help
= "save screen into PPM image 'filename'",
160 .user_print
= monitor_user_noop
,
161 .mhandler
.cmd_new
= do_screen_dump
,
168 Save screen into PPM image
.
172 - "filename": file
path (json
-string
)
176 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
185 .help
= "stop emulation",
186 .user_print
= monitor_user_noop
,
187 .mhandler
.cmd_new
= do_stop
,
200 -> { "execute": "stop" }
209 .help
= "resume emulation",
210 .user_print
= monitor_user_noop
,
211 .mhandler
.cmd_new
= do_cont
,
224 -> { "execute": "cont" }
230 .name
= "system_reset",
233 .help
= "reset the system",
234 .user_print
= monitor_user_noop
,
235 .mhandler
.cmd_new
= do_system_reset
,
248 -> { "execute": "system_reset" }
254 .name
= "system_powerdown",
257 .help
= "send system power down event",
258 .user_print
= monitor_user_noop
,
259 .mhandler
.cmd_new
= do_system_powerdown
,
266 Send system power down event
.
272 -> { "execute": "system_powerdown" }
278 .name
= "device_add",
279 .args_type
= "device:O",
280 .params
= "driver[,prop=value][,...]",
281 .help
= "add device, like -device on the command line",
282 .user_print
= monitor_user_noop
,
283 .mhandler
.cmd_new
= do_device_add
,
294 - "driver": the name of the
new device
's driver (json-string)
295 - "bus": the device's parent
bus (device tree path
, json
-string
, optional
)
296 - "id": the device
's ID, must be unique (json-string)
301 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
306 (1) For detailed information about this command, please refer to the
307 'docs
/qdev
-device
-use
.txt
' file.
309 (2) It's possible to list device properties by running QEMU with the
310 "-device DEVICE,\?" command
-line argument
, where DEVICE is the device
's name
315 .name = "device_del",
318 .help = "remove device",
319 .user_print = monitor_user_noop,
320 .mhandler.cmd_new = do_device_del,
331 - "id": the device's
ID (json
-string
)
335 -> { "execute": "device_del", "arguments": { "id": "net1" } }
342 .args_type
= "index:i",
344 .help
= "set the default CPU",
345 .user_print
= monitor_user_noop
,
346 .mhandler
.cmd_new
= do_cpu_set
,
357 - "index": the CPU
's index (json-int)
361 -> { "execute": "cpu", "arguments": { "index": 0 } }
364 Note: CPUs' indexes are obtained with the
'query-cpus' command
.
370 .args_type
= "val:l,size:i,filename:s",
371 .params
= "addr size file",
372 .help
= "save to disk virtual memory dump starting at 'addr' of size 'size'",
373 .user_print
= monitor_user_noop
,
374 .mhandler
.cmd_new
= do_memory_save
,
381 Save to disk virtual memory dump starting at
'val' of size
'size'.
385 - "val": the starting
address (json
-int
)
386 - "size": the memory size
, in bytes (json
-int
)
387 - "filename": file
path (json
-string
)
391 -> { "execute": "memsave",
392 "arguments": { "val": 10,
394 "filename": "/tmp/virtual-mem-dump" } }
397 Note
: Depends on the current CPU
.
403 .args_type
= "val:l,size:i,filename:s",
404 .params
= "addr size file",
405 .help
= "save to disk physical memory dump starting at 'addr' of size 'size'",
406 .user_print
= monitor_user_noop
,
407 .mhandler
.cmd_new
= do_physical_memory_save
,
414 Save to disk physical memory dump starting at
'val' of size
'size'.
418 - "val": the starting
address (json
-int
)
419 - "size": the memory size
, in bytes (json
-int
)
420 - "filename": file
path (json
-string
)
424 -> { "execute": "pmemsave",
425 "arguments": { "val": 10,
427 "filename": "/tmp/physical-mem-dump" } }
433 .name
= "inject-nmi",
437 .user_print
= monitor_user_noop
,
438 .mhandler
.cmd_new
= do_inject_nmi
,
445 Inject an NMI on guest
's CPUs.
451 -> { "execute": "inject-nmi" }
454 Note: inject-nmi is only supported for x86 guest currently, it will
455 returns "Unsupported" error for non-x86 guest.
461 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
462 .params = "[-d] [-b] [-i] uri",
463 .help = "migrate to URI (using -d to not wait for completion)"
464 "\n\t\t\t -b for migration without shared storage with"
465 " full copy of disk\n\t\t\t -i for migration without "
466 "shared storage with incremental copy of disk "
467 "(base image shared between src and destination)",
468 .user_print = monitor_user_noop,
469 .mhandler.cmd_new = do_migrate,
480 - "blk": block migration, full disk copy (json-bool, optional)
481 - "inc": incremental disk copy (json-bool, optional)
482 - "uri": Destination URI (json-string)
486 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
491 (1) The 'query
-migrate
' command should be used to check migration's progress
492 and final
result (this information is provided by the
'status' member
)
493 (2) All boolean arguments
default to
false
494 (3) The user Monitor
's "detach" argument is invalid in QMP and should not
500 .name = "migrate_cancel",
503 .help = "cancel the current VM migration",
504 .user_print = monitor_user_noop,
505 .mhandler.cmd_new = do_migrate_cancel,
512 Cancel the current migration.
518 -> { "execute": "migrate_cancel" }
524 .name = "migrate_set_speed",
525 .args_type = "value:o",
527 .help = "set maximum speed (in bytes) for migrations",
528 .user_print = monitor_user_noop,
529 .mhandler.cmd_new = do_migrate_set_speed,
536 Set maximum speed for migrations.
540 - "value": maximum speed, in bytes per second (json-int)
544 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
550 .name = "migrate_set_downtime",
551 .args_type = "value:T",
553 .help = "set maximum tolerated downtime (in seconds) for migrations",
554 .user_print = monitor_user_noop,
555 .mhandler.cmd_new = do_migrate_set_downtime,
562 Set maximum tolerated downtime (in seconds) for migrations.
566 - "value": maximum downtime (json-number)
570 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
576 .name = "client_migrate_info",
577 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
578 .params = "protocol hostname port tls-port cert-subject",
579 .help = "send migration info to spice/vnc client",
580 .user_print = monitor_user_noop,
581 .mhandler.cmd_new = client_migrate_info,
588 Set the spice/vnc connection info for the migration target. The spice/vnc
589 server will ask the spice/vnc client to automatically reconnect using the
590 new parameters (if specified) once the vm migration finished successfully.
594 - "protocol": protocol: "spice" or "vnc" (json-string)
595 - "hostname": migration target hostname (json-string)
596 - "port": spice/vnc tcp port for plaintext channels (json-int, optional)
597 - "tls-port": spice tcp port for tls-secured channels (json-int, optional)
598 - "cert-subject": server certificate subject (json-string, optional)
602 -> { "execute": "client_migrate_info",
603 "arguments": { "protocol": "spice",
604 "hostname": "virt42.lab.kraxel.org",
611 .name = "netdev_add",
612 .args_type = "netdev:O",
613 .params = "[user|tap|socket],id=str[,prop=value][,...]",
614 .help = "add host network device",
615 .user_print = monitor_user_noop,
616 .mhandler.cmd_new = do_netdev_add,
623 Add host network device.
627 - "type": the device type, "tap", "user", ... (json-string)
628 - "id": the device's ID
, must be
unique (json
-string
)
633 -> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
636 Note
: The supported device options are the same ones supported by the
'-net'
637 command
-line argument
, which are listed
in the
'-help' output or QEMU
's
643 .name = "netdev_del",
646 .help = "remove host network device",
647 .user_print = monitor_user_noop,
648 .mhandler.cmd_new = do_netdev_del,
655 Remove host network device.
659 - "id": the device's ID
, must be
unique (json
-string
)
663 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
670 .name
= "block_resize",
671 .args_type
= "device:B,size:o",
672 .params
= "device size",
673 .help
= "resize a block image",
674 .user_print
= monitor_user_noop
,
675 .mhandler
.cmd_new
= do_block_resize
,
682 Resize a block image
while a guest is running
.
686 - "device": the device
's ID, must be unique (json-string)
691 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
697 .name = "blockdev-snapshot-sync",
698 .args_type = "device:B,snapshot-file:s?,format:s?",
699 .params = "device [new-image-file] [format]",
700 .user_print = monitor_user_noop,
701 .mhandler.cmd_new = do_snapshot_blkdev,
705 blockdev-snapshot-sync
706 ----------------------
708 Synchronous snapshot of a block device. snapshot-file specifies the
709 target of the new image. If the file exists, or if it is a device, the
710 snapshot will be created in the existing file/device. If does not
711 exist, a new file will be created. format specifies the format of the
712 snapshot image, default is qcow2.
716 - "device": device name to snapshot (json-string)
717 - "snapshot-file": name of new image file (json-string)
718 - "format": format of new image (json-string, optional)
722 -> { "execute": "blockdev-snapshot", "arguments": { "device": "ide-hd0",
724 "/some/place/my-image",
725 "format": "qcow2" } }
732 .args_type = "value:M",
734 .help = "request VM to change its memory allocation (in MB)",
735 .user_print = monitor_user_noop,
736 .mhandler.cmd_async = do_balloon,
737 .flags = MONITOR_CMD_ASYNC,
744 Request VM to change its memory allocation (in bytes).
748 - "value": New memory allocation (json-int)
752 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
759 .args_type = "name:s,up:b",
760 .params = "name on|off",
761 .help = "change the link status of a network adapter",
762 .user_print = monitor_user_noop,
763 .mhandler.cmd_new = do_set_link,
770 Change the link status of a network adapter.
774 - "name": network device name (json-string)
775 - "up": status is up (json-bool)
779 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
786 .args_type = "fdname:s",
787 .params = "getfd name",
788 .help = "receive a file descriptor via SCM rights and assign it a name",
789 .user_print = monitor_user_noop,
790 .mhandler.cmd_new = do_getfd,
797 Receive a file descriptor via SCM rights and assign it a name.
801 - "fdname": file descriptor name (json-string)
805 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
812 .args_type = "fdname:s",
813 .params = "closefd name",
814 .help = "close a file descriptor previously passed via SCM rights",
815 .user_print = monitor_user_noop,
816 .mhandler.cmd_new = do_closefd,
823 Close a file descriptor previously passed via SCM rights.
827 - "fdname": file descriptor name (json-string)
831 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
837 .name = "block_passwd",
838 .args_type = "device:B,password:s",
839 .params = "block_passwd device password",
840 .help = "set the password of encrypted block devices",
841 .user_print = monitor_user_noop,
842 .mhandler.cmd_new = do_block_set_passwd,
849 Set the password of encrypted block devices.
853 - "device": device name (json-string)
854 - "password": password (json-string)
858 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
859 "password": "12345" } }
865 .name = "set_password",
866 .args_type = "protocol:s,password:s,connected:s?",
867 .params = "protocol password action-if-connected",
868 .help = "set spice/vnc password",
869 .user_print = monitor_user_noop,
870 .mhandler.cmd_new = set_password,
877 Set the password for vnc/spice protocols.
881 - "protocol": protocol name (json-string)
882 - "password": password (json-string)
883 - "connected": [ keep | disconnect | fail ] (josn-string, optional)
887 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
888 "password": "secret" } }
894 .name = "expire_password",
895 .args_type = "protocol:s,time:s",
896 .params = "protocol time",
897 .help = "set spice/vnc password expire-time",
898 .user_print = monitor_user_noop,
899 .mhandler.cmd_new = expire_password,
906 Set the password expire time for vnc/spice protocols.
910 - "protocol": protocol name (json-string)
911 - "time": [ now | never | +secs | secs ] (json-string)
915 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
922 .name = "add_client",
923 .args_type = "protocol:s,fdname:s,skipauth:b?",
924 .params = "protocol fdname skipauth",
925 .help = "add a graphics client",
926 .user_print = monitor_user_noop,
927 .mhandler.cmd_new = add_graphics_client,
934 Add a graphics client
938 - "protocol": protocol name (json-string)
939 - "fdname": file descriptor name (json-string)
943 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
944 "fdname": "myclient" } }
949 .name = "qmp_capabilities",
952 .help = "enable QMP capabilities",
953 .user_print = monitor_user_noop,
954 .mhandler.cmd_new = do_qmp_capabilities,
961 Enable QMP capabilities.
967 -> { "execute": "qmp_capabilities" }
970 Note: This command must be issued before issuing any other command.
975 .name = "human-monitor-command",
976 .args_type = "command-line:s,cpu-index:i?",
979 .user_print = monitor_user_noop,
980 .mhandler.cmd_new = do_hmp_passthrough,
984 human-monitor-command
985 ---------------------
987 Execute a Human Monitor command.
991 - command-line: the command name and its arguments, just like the
992 Human Monitor's
shell (json
-string
)
993 - cpu
-index
: select the CPU number to be used by commands which access CPU
994 data
, like
'info registers'. The Monitor selects CPU
0 if this
995 argument is not
provided (json
-int
, optional
)
999 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
1000 <- { "return": "kvm support: enabled\r\n" }
1004 (1) The Human Monitor is NOT an stable
interface, this means that command
1005 names
, arguments and responses can change or be removed at ANY time
.
1006 Applications that rely on long term stability guarantees should NOT
1011 o This command is stateless
, this means that commands that depend
1012 on state
information (such as getfd
) might not work
1014 o Commands that prompt the user
for data (eg
. 'cont' when the block
1015 device is encrypted
) don
't currently work
1020 HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
1021 HXCOMM this! We will possibly move query commands definitions inside those
1022 HXCOMM sections, just like regular commands.
1032 Return a json-object with the following information:
1034 - "qemu": A json-object containing three integer values:
1035 - "major": QEMU's major
version (json
-int
)
1036 - "minor": QEMU
's minor version (json-int)
1037 - "micro": QEMU's micro
version (json
-int
)
1038 - "package": package's version (json-string)
1042 -> { "execute": "query-version" }
1057 .name = "query-version",
1059 .mhandler.cmd_new = qmp_marshal_input_query_version,
1066 List QMP available commands.
1068 Each command is represented by a json-object, the returned value is a json-array
1071 Each json-object contain:
1073 - "name": command's
name (json
-string
)
1077 -> { "execute": "query-commands" }
1081 "name":"query-balloon"
1084 "name":"system_powerdown"
1089 Note
: This example has been shortened as the real response is too long
.
1097 Each device is represented by a json
-object
. The returned value is a json
-array
1100 Each json
-object contain the following
:
1102 - "label": device
's label (json-string)
1103 - "filename": device's
file (json
-string
)
1107 -> { "execute": "query-chardev" }
1124 .name
= "query-chardev",
1126 .mhandler
.cmd_new
= qmp_marshal_input_query_chardev
,
1133 Show the block devices
.
1135 Each block device information is stored
in a json
-object and the returned value
1136 is a json
-array of all devices
.
1138 Each json
-object contain the following
:
1140 - "device": device
name (json
-string
)
1141 - "type": device
type (json
-string
)
1142 - deprecated
, retained
for backward compatibility
1143 - Possible values
: "unknown"
1144 - "removable": true if the device is removable
, false otherwise (json
-bool
)
1145 - "locked": true if the device is locked
, false otherwise (json
-bool
)
1146 - "tray-open": only present
if removable
, true if the device has a tray
,
1147 and it is
open (json
-bool
)
1148 - "inserted": only present
if the device is inserted
, it is a json
-object
1149 containing the following
:
1150 - "file": device file
name (json
-string
)
1151 - "ro": true if read
-only
, false otherwise (json
-bool
)
1152 - "drv": driver format
name (json
-string
)
1153 - Possible values
: "blkdebug", "bochs", "cloop", "cow", "dmg",
1154 "file", "file", "ftp", "ftps", "host_cdrom",
1155 "host_device", "host_floppy", "http", "https",
1156 "nbd", "parallels", "qcow", "qcow2", "raw",
1157 "tftp", "vdi", "vmdk", "vpc", "vvfat"
1158 - "backing_file": backing file
name (json
-string
, optional
)
1159 - "encrypted": true if encrypted
, false otherwise (json
-bool
)
1163 -> { "execute": "query-block" }
1167 "device":"ide0-hd0",
1174 "file":"disks/test.img"
1179 "device":"ide1-cd0",
1205 Show block device statistics
.
1207 Each device statistic information is stored
in a json
-object and the returned
1208 value is a json
-array of all devices
.
1210 Each json
-object contain the following
:
1212 - "device": device
name (json
-string
)
1213 - "stats": A json
-object with the statistics information
, it contains
:
1214 - "rd_bytes": bytes
read (json
-int
)
1215 - "wr_bytes": bytes
written (json
-int
)
1216 - "rd_operations": read
operations (json
-int
)
1217 - "wr_operations": write
operations (json
-int
)
1218 - "flush_operations": cache flush
operations (json
-int
)
1219 - "wr_total_time_ns": total time spend on writes
in nano
-seconds (json
-int
)
1220 - "rd_total_time_ns": total time spend on reads
in nano
-seconds (json
-int
)
1221 - "flush_total_time_ns": total time spend on cache flushes
in nano
-seconds (json
-int
)
1222 - "wr_highest_offset": Highest offset of a sector written since the
1223 BlockDriverState has been
opened (json
-int
)
1224 - "parent": Contains recursively the statistics of the underlying
1225 protocol (e
.g
. the host file
for a qcow2 image
). If there is
1226 no underlying protocol
, this field is omitted
1227 (json
-object
, optional
)
1231 -> { "execute": "query-blockstats" }
1235 "device":"ide0-hd0",
1238 "wr_highest_offset":3686448128,
1240 "wr_operations":751,
1241 "rd_bytes":122567168,
1242 "rd_operations":36772
1243 "wr_total_times_ns":313253456
1244 "rd_total_times_ns":3465673657
1245 "flush_total_times_ns":49653
1246 "flush_operations":61,
1250 "wr_highest_offset":2821110784,
1252 "wr_operations":692,
1253 "rd_bytes":122739200,
1254 "rd_operations":36604
1255 "flush_operations":51,
1256 "wr_total_times_ns":313253456
1257 "rd_total_times_ns":3465673657
1258 "flush_total_times_ns":49653
1262 "device":"ide1-cd0",
1264 "wr_highest_offset":0,
1269 "flush_operations":0,
1270 "wr_total_times_ns":0
1271 "rd_total_times_ns":0
1272 "flush_total_times_ns":0
1278 "wr_highest_offset":0,
1283 "flush_operations":0,
1284 "wr_total_times_ns":0
1285 "rd_total_times_ns":0
1286 "flush_total_times_ns":0
1292 "wr_highest_offset":0,
1297 "flush_operations":0,
1298 "wr_total_times_ns":0
1299 "rd_total_times_ns":0
1300 "flush_total_times_ns":0
1312 Show CPU information
.
1314 Return a json
-array
. Each CPU is represented by a json
-object
, which contains
:
1316 - "CPU": CPU
index (json
-int
)
1317 - "current": true if this is the current CPU
, false otherwise (json
-bool
)
1318 - "halted": true if the cpu is halted
, false otherwise (json
-bool
)
1319 - Current program counter
. The key
's name depends on the architecture:
1320 "pc": i386/x86_64 (json-int)
1321 "nip": PPC (json-int)
1322 "pc" and "npc": sparc (json-int)
1323 "PC": mips (json-int)
1324 - "thread_id": ID of the underlying host thread (json-int)
1328 -> { "execute": "query-cpus" }
1354 PCI buses and devices information.
1356 The returned value is a json-array of all buses. Each bus is represented by
1357 a json-object, which has a key with a json-array of all PCI devices attached
1358 to it. Each device is represented by a json-object.
1360 The bus json-object contains the following:
1362 - "bus": bus number (json-int)
1363 - "devices": a json-array of json-objects, each json-object represents a
1366 The PCI device json-object contains the following:
1368 - "bus": identical to the parent's bus
number (json
-int
)
1369 - "slot": slot
number (json
-int
)
1370 - "function": function number (json
-int
)
1371 - "class_info": a json
-object containing
:
1372 - "desc": device
class description (json
-string
, optional
)
1373 - "class": device
class number (json
-int
)
1374 - "id": a json
-object containing
:
1375 - "device": device
ID (json
-int
)
1376 - "vendor": vendor
ID (json
-int
)
1377 - "irq": device
's IRQ if assigned (json-int, optional)
1378 - "qdev_id": qdev id string (json-string)
1379 - "pci_bridge": It's a json
-object
, only present
if this device is a
1380 PCI bridge
, contains
:
1381 - "bus": bus
number (json
-int
)
1382 - "secondary": secondary bus
number (json
-int
)
1383 - "subordinate": subordinate bus
number (json
-int
)
1384 - "io_range": I
/O memory range information
, a json
-object with the
1386 - "base": base address
, in bytes (json
-int
)
1387 - "limit": limit address
, in bytes (json
-int
)
1388 - "memory_range": memory range information
, a json
-object with the
1390 - "base": base address
, in bytes (json
-int
)
1391 - "limit": limit address
, in bytes (json
-int
)
1392 - "prefetchable_range": Prefetchable memory range information
, a
1393 json
-object with the following members
:
1394 - "base": base address
, in bytes (json
-int
)
1395 - "limit": limit address
, in bytes (json
-int
)
1396 - "devices": a json
-array of PCI devices
if there
's any attached, each
1397 each element is represented by a json-object, which contains
1398 the same members of the 'PCI device json
-object
' described
1400 - "regions": a json-array of json-objects, each json-object represents a
1401 memory region of this device
1403 The memory range json-object contains the following:
1405 - "base": base memory address (json-int)
1406 - "limit": limit value (json-int)
1408 The region json-object can be an I/O region or a memory region, an I/O region
1409 json-object contains the following:
1411 - "type": "io" (json-string, fixed)
1412 - "bar": BAR number (json-int)
1413 - "address": memory address (json-int)
1414 - "size": memory size (json-int)
1416 A memory region json-object contains the following:
1418 - "type": "memory" (json-string, fixed)
1419 - "bar": BAR number (json-int)
1420 - "address": memory address (json-int)
1421 - "size": memory size (json-int)
1422 - "mem_type_64": true or false (json-bool)
1423 - "prefetch": true or false (json-bool)
1427 -> { "execute": "query-pci" }
1439 "desc":"Host bridge"
1473 "desc":"IDE controller"
1495 "desc":"VGA controller"
1505 "mem_type_64":false,
1508 "address":4026531840,
1513 "mem_type_64":false,
1516 "address":4060086272,
1521 "mem_type_64":false,
1536 "desc":"RAM controller"
1557 Note: This example has been shortened as the real response is too long.
1565 Show KVM information.
1567 Return a json-object with the following information:
1569 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
1570 - "present": true if QEMU has KVM support, false otherwise (json-bool)
1574 -> { "execute": "query-kvm" }
1575 <- { "return": { "enabled": true, "present": true } }
1580 .name = "query-kvm",
1582 .mhandler.cmd_new = qmp_marshal_input_query_kvm,
1589 Return a json-object with the following information:
1591 - "running": true if the VM is running, or false if it is paused (json-bool)
1592 - "singlestep": true if the VM is in single step mode,
1593 false otherwise (json-bool)
1594 - "status": one of the following values (json-string)
1595 "debug" - QEMU is running on a debugger
1596 "inmigrate" - guest is paused waiting for an incoming migration
1597 "internal-error" - An internal error that prevents further guest
1598 execution has occurred
1599 "io-error" - the last IOP has failed and the device is configured
1600 to pause on I/O errors
1601 "paused" - guest has been paused via the 'stop
' command
1602 "postmigrate" - guest is paused following a successful 'migrate
'
1603 "prelaunch" - QEMU was started with -S and guest has not started
1604 "finish-migrate" - guest is paused to finish the migration process
1605 "restore-vm" - guest is paused to restore VM state
1606 "running" - guest is actively running
1607 "save-vm" - guest is paused to save the VM state
1608 "shutdown" - guest is shut down (and -no-shutdown is in use)
1609 "watchdog" - the watchdog action is configured to pause and
1614 -> { "execute": "query-status" }
1615 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
1620 .name = "query-status",
1622 .mhandler.cmd_new = qmp_marshal_input_query_status,
1629 Show VM mice information.
1631 Each mouse is represented by a json-object, the returned value is a json-array
1634 The mouse json-object contains the following:
1636 - "name": mouse's
name (json
-string
)
1637 - "index": mouse
's index (json-int)
1638 - "current": true if this mouse is receiving events, false otherwise (json-bool)
1639 - "absolute": true if the mouse generates absolute input events (json-bool)
1643 -> { "execute": "query-mice" }
1647 "name":"QEMU Microsoft Mouse",
1653 "name":"QEMU PS/2 Mouse",
1667 Show VNC server information.
1669 Return a json-object with server information. Connected clients are returned
1670 as a json-array of json-objects.
1672 The main json-object contains the following:
1674 - "enabled": true or false (json-bool)
1675 - "host": server's IP
address (json
-string
)
1676 - "family": address
family (json
-string
)
1677 - Possible values
: "ipv4", "ipv6", "unix", "unknown"
1678 - "service": server
's port number (json-string)
1679 - "auth": authentication method (json-string)
1680 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
1681 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
1682 "vencrypt+plain", "vencrypt+tls+none",
1683 "vencrypt+tls+plain", "vencrypt+tls+sasl",
1684 "vencrypt+tls+vnc", "vencrypt+x509+none",
1685 "vencrypt+x509+plain", "vencrypt+x509+sasl",
1686 "vencrypt+x509+vnc", "vnc"
1687 - "clients": a json-array of all connected clients
1689 Clients are described by a json-object, each one contain the following:
1691 - "host": client's IP
address (json
-string
)
1692 - "family": address
family (json
-string
)
1693 - Possible values
: "ipv4", "ipv6", "unix", "unknown"
1694 - "service": client
's port number (json-string)
1695 - "x509_dname": TLS dname (json-string, optional)
1696 - "sasl_username": SASL username (json-string, optional)
1700 -> { "execute": "query-vnc" }
1724 Show SPICE server information.
1726 Return a json-object with server information. Connected clients are returned
1727 as a json-array of json-objects.
1729 The main json-object contains the following:
1731 - "enabled": true or false (json-bool)
1732 - "host": server's IP
address (json
-string
)
1733 - "port": server
's port number (json-int, optional)
1734 - "tls-port": server's port
number (json
-int
, optional
)
1735 - "auth": authentication
method (json
-string
)
1736 - Possible values
: "none", "spice"
1737 - "channels": a json
-array of all active channels clients
1739 Channels are described by a json
-object
, each one contain the following
:
1741 - "host": client
's IP address (json-string)
1742 - "family": address family (json-string)
1743 - Possible values: "ipv4", "ipv6", "unix", "unknown"
1744 - "port": client's port
number (json
-string
)
1745 - "connection-id": spice connection id
. All channels with the same id
1746 belong to the same spice
session (json
-int
)
1747 - "channel-type": channel type
. "1" is the main control channel
, filter
for
1748 this one
if you want track spice sessions
only (json
-int
)
1749 - "channel-id": channel id
. Usually
"0", might be different needed when
1750 multiple channels of the same type exist
, such as multiple
1751 display channels
in a multihead
setup (json
-int
)
1752 - "tls": whevener the channel is
encrypted (json
-bool
)
1756 -> { "execute": "query-spice" }
1769 "connection-id": 1804289383,
1770 "host": "127.0.0.1",
1778 "connection-id": 1804289383,
1779 "host": "127.0.0.1",
1783 [ ... more channels follow
... ]
1796 Return a json
-object with the following information
:
1798 - "name": VM
's name (json-string, optional)
1802 -> { "execute": "query-name" }
1803 <- { "return": { "name": "qemu-name" } }
1808 .name = "query-name",
1810 .mhandler.cmd_new = qmp_marshal_input_query_name,
1819 Return a json-object with the following information:
1821 - "UUID": Universally Unique Identifier (json-string)
1825 -> { "execute": "query-uuid" }
1826 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
1831 .name = "query-uuid",
1833 .mhandler.cmd_new = qmp_marshal_input_query_uuid,
1842 Return a json-object. If migration is active there will be another json-object
1843 with RAM migration status and if block migration is active another one with
1844 block migration status.
1846 The main json-object contains the following:
1848 - "status": migration status (json-string)
1849 - Possible values: "active", "completed", "failed", "cancelled"
1850 - "ram": only present if "status" is "active", it is a json-object with the
1851 following RAM information (in bytes):
1852 - "transferred": amount transferred (json-int)
1853 - "remaining": amount remaining (json-int)
1854 - "total": total (json-int)
1855 - "disk": only present if "status" is "active" and it is a block migration,
1856 it is a json-object with the following disk information (in bytes):
1857 - "transferred": amount transferred (json-int)
1858 - "remaining": amount remaining (json-int)
1859 - "total": total (json-int)
1863 1. Before the first migration
1865 -> { "execute": "query-migrate" }
1868 2. Migration is done and has succeeded
1870 -> { "execute": "query-migrate" }
1871 <- { "return": { "status": "completed" } }
1873 3. Migration is done and has failed
1875 -> { "execute": "query-migrate" }
1876 <- { "return": { "status": "failed" } }
1878 4. Migration is being performed and is not a block migration:
1880 -> { "execute": "query-migrate" }
1892 5. Migration is being performed and is a block migration:
1894 -> { "execute": "query-migrate" }
1900 "remaining":1053304,
1905 "remaining":20880384,
1917 Show balloon information.
1919 Make an asynchronous request for balloon info. When the request completes a
1920 json-object will be returned containing the following data:
1922 - "actual": current balloon value in bytes (json-int)
1923 - "mem_swapped_in": Amount of memory swapped in bytes (json-int, optional)
1924 - "mem_swapped_out": Amount of memory swapped out in bytes (json-int, optional)
1925 - "major_page_faults": Number of major faults (json-int, optional)
1926 - "minor_page_faults": Number of minor faults (json-int, optional)
1927 - "free_mem": Total amount of free and unused memory in
1928 bytes (json-int, optional)
1929 - "total_mem": Total amount of available memory in bytes (json-int, optional)
1933 -> { "execute": "query-balloon" }
1936 "actual":1073741824,
1938 "mem_swapped_out":0,
1939 "major_page_faults":142,
1940 "minor_page_faults":239245,
1941 "free_mem":1014185984,
1942 "total_mem":1044668416