1 HXCOMM QMP dispatch table and documentation
2 HXCOMM Text between SQMP and EQMP is copied to the QMP documentation file and
3 HXCOMM does not show up
in the other formats
.
9 This document describes all commands currently supported by QMP
.
11 Most of the time their usage is exactly the same as
in the user Monitor
, this
12 means that any other document which also describe
commands (the manpage
,
13 QEMU
's manual, etc) can and should be consulted.
15 QMP has two types of commands: regular and query commands. Regular commands
16 usually change the Virtual Machine's state someway
, while query commands just
17 return information
. The sections below are divided accordingly
.
19 It
's important to observe that all communication examples are formatted in
20 a reader-friendly way, so that they're easier to understand
. However
, in real
21 protocol usage
, they
're emitted as a single line.
23 Also, the following notation is used to denote data flow:
25 -> data issued by the Client
26 <- Server data response
28 Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
29 information on the Server command and response formats.
31 NOTE: This document is temporary and will be replaced soon.
33 1. Stability Considerations
34 ===========================
36 The current QMP command set (described in this file) may be useful for a
37 number of use cases, however it's limited and several commands have bad
38 defined semantics
, specially with regard to command completion
.
40 These problems are going to be solved incrementally
in the next QEMU releases
41 and we
're going to establish a deprecation policy for badly defined commands.
43 If you're planning to adopt QMP
, please observe the following
:
45 1. The deprecation policy will take effect and be documented soon
, please
46 check the documentation of each used command as soon as a
new release of
49 2. DO NOT rely on anything which is not explicit documented
51 3. Errors
, in special
, are not documented
. Applications should NOT check
52 for specific errors classes or
data (it
's strongly recommended to only
53 check for the "error" key)
58 Server's responses
in the examples below are always a success response
, please
59 refer to the QMP specification
for more details on error responses
.
66 .mhandler
.cmd_new
= qmp_marshal_quit
,
79 -> { "execute": "quit" }
86 .args_type
= "force:-f,device:B",
87 .mhandler
.cmd_new
= qmp_marshal_eject
,
94 Eject a removable medium
.
98 - force
: force
ejection (json
-bool
, optional
)
99 - device
: device
name (json
-string
)
103 -> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
106 Note
: The
"force" argument defaults to
false.
112 .args_type
= "device:B,target:F,arg:s?",
113 .mhandler
.cmd_new
= qmp_marshal_change
,
120 Change a removable medium or VNC configuration
.
124 - "device": device
name (json
-string
)
125 - "target": filename or
item (json
-string
)
126 - "arg": additional
argument (json
-string
, optional
)
130 1. Change a removable medium
132 -> { "execute": "change",
133 "arguments": { "device": "ide1-cd0",
134 "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
137 2. Change VNC password
139 -> { "execute": "change",
140 "arguments": { "device": "vnc", "target": "password",
147 .name
= "screendump",
148 .args_type
= "filename:F",
149 .mhandler
.cmd_new
= qmp_marshal_screendump
,
156 Save screen into PPM image
.
160 - "filename": file
path (json
-string
)
164 -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
172 .mhandler
.cmd_new
= qmp_marshal_stop
,
185 -> { "execute": "stop" }
193 .mhandler
.cmd_new
= qmp_marshal_cont
,
206 -> { "execute": "cont" }
212 .name
= "system_wakeup",
214 .mhandler
.cmd_new
= qmp_marshal_system_wakeup
,
221 Wakeup guest from suspend
.
227 -> { "execute": "system_wakeup" }
233 .name
= "system_reset",
235 .mhandler
.cmd_new
= qmp_marshal_system_reset
,
248 -> { "execute": "system_reset" }
254 .name
= "system_powerdown",
256 .mhandler
.cmd_new
= qmp_marshal_system_powerdown
,
263 Send system power down event
.
269 -> { "execute": "system_powerdown" }
275 .name
= "device_add",
276 .args_type
= "device:O",
277 .params
= "driver[,prop=value][,...]",
278 .help
= "add device, like -device on the command line",
279 .mhandler
.cmd_new
= qmp_device_add
,
290 - "driver": the name of the
new device
's driver (json-string)
291 - "bus": the device's parent
bus (device tree path
, json
-string
, optional
)
292 - "id": the device
's ID, must be unique (json-string)
297 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
302 (1) For detailed information about this command, please refer to the
303 'docs
/qdev
-device
-use
.txt
' file.
305 (2) It's possible to list device properties by running QEMU with the
306 "-device DEVICE,\?" command
-line argument
, where DEVICE is the device
's name
311 .name = "device_del",
313 .mhandler.cmd_new = qmp_marshal_device_del,
324 - "id": the device's ID or QOM
path (json
-string
)
328 -> { "execute": "device_del", "arguments": { "id": "net1" } }
333 -> { "execute": "device_del", "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
340 .args_type
= "keys:q,hold-time:i?",
341 .mhandler
.cmd_new
= qmp_marshal_send_key
,
353 - "key": key
sequence (a json
-array of key union values
,
354 union can be number or qcode
enum)
356 - hold
-time
: time to delay key up events
, milliseconds
. Defaults to
100
361 -> { "execute": "send-key",
362 "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
363 { "type": "qcode", "data": "alt" },
364 { "type": "qcode", "data": "delete" } ] } }
371 .args_type
= "index:i",
372 .mhandler
.cmd_new
= qmp_marshal_cpu
,
383 - "index": the CPU
's index (json-int)
387 -> { "execute": "cpu", "arguments": { "index": 0 } }
390 Note: CPUs' indexes are obtained with the
'query-cpus' command
.
397 .mhandler
.cmd_new
= qmp_marshal_cpu_add
,
408 - "id": cpu
id (json
-int
)
412 -> { "execute": "cpu-add", "arguments": { "id": 2 } }
419 .args_type
= "val:l,size:i,filename:s,cpu:i?",
420 .mhandler
.cmd_new
= qmp_marshal_memsave
,
427 Save to disk virtual memory dump starting at
'val' of size
'size'.
431 - "val": the starting
address (json
-int
)
432 - "size": the memory size
, in bytes (json
-int
)
433 - "filename": file
path (json
-string
)
434 - "cpu": virtual CPU
index (json
-int
, optional
)
438 -> { "execute": "memsave",
439 "arguments": { "val": 10,
441 "filename": "/tmp/virtual-mem-dump" } }
448 .args_type
= "val:l,size:i,filename:s",
449 .mhandler
.cmd_new
= qmp_marshal_pmemsave
,
456 Save to disk physical memory dump starting at
'val' of size
'size'.
460 - "val": the starting
address (json
-int
)
461 - "size": the memory size
, in bytes (json
-int
)
462 - "filename": file
path (json
-string
)
466 -> { "execute": "pmemsave",
467 "arguments": { "val": 10,
469 "filename": "/tmp/physical-mem-dump" } }
475 .name
= "inject-nmi",
477 .mhandler
.cmd_new
= qmp_marshal_inject_nmi
,
484 Inject an NMI on the
default CPU (x86
/s390
) or all
CPUs (ppc64
).
490 -> { "execute": "inject-nmi" }
493 Note
: inject
-nmi fails when the guest doesn
't support injecting.
498 .name = "ringbuf-write",
499 .args_type = "device:s,data:s,format:s?",
500 .mhandler.cmd_new = qmp_marshal_ringbuf_write,
507 Write to a ring buffer character device.
511 - "device": ring buffer character device name (json-string)
512 - "data": data to write (json-string)
513 - "format": data format (json-string, optional)
514 - Possible values: "utf8" (default), "base64"
518 -> { "execute": "ringbuf-write",
519 "arguments": { "device": "foo",
527 .name = "ringbuf-read",
528 .args_type = "device:s,size:i,format:s?",
529 .mhandler.cmd_new = qmp_marshal_ringbuf_read,
536 Read from a ring buffer character device.
540 - "device": ring buffer character device name (json-string)
541 - "size": how many bytes to read at most (json-int)
542 - Number of data bytes, not number of characters in encoded data
543 - "format": data format (json-string, optional)
544 - Possible values: "utf8" (default), "base64"
545 - Naturally, format "utf8" works only when the ring buffer
546 contains valid UTF-8 text. Invalid UTF-8 sequences get
547 replaced. Bug: replacement doesn't work
. Bug
: can screw
548 up on encountering NUL characters
, after the ring buffer
549 lost data
, and when reading stops because the size limit
554 -> { "execute": "ringbuf-read",
555 "arguments": { "device": "foo",
558 <- {"return": "abcdefgh"}
563 .name
= "xen-save-devices-state",
564 .args_type
= "filename:F",
565 .mhandler
.cmd_new
= qmp_marshal_xen_save_devices_state
,
569 xen
-save
-devices
-state
572 Save the state of all devices to file
. The RAM and the block devices
573 of the VM are not saved by
this command
.
577 - "filename": the file to save the state of the devices to as binary
578 data
. See xen
-save
-devices
-state
.txt
for a description of the binary
583 -> { "execute": "xen-save-devices-state",
584 "arguments": { "filename": "/tmp/save" } }
590 .name
= "xen-set-global-dirty-log",
591 .args_type
= "enable:b",
592 .mhandler
.cmd_new
= qmp_marshal_xen_set_global_dirty_log
,
596 xen
-set
-global
-dirty
-log
599 Enable or disable the global dirty log mode
.
603 - "enable": Enable it or disable it
.
607 -> { "execute": "xen-set-global-dirty-log",
608 "arguments": { "enable": true } }
615 .args_type
= "detach:-d,blk:-b,inc:-i,uri:s",
616 .mhandler
.cmd_new
= qmp_marshal_migrate
,
627 - "blk": block migration
, full disk
copy (json
-bool
, optional
)
628 - "inc": incremental disk
copy (json
-bool
, optional
)
629 - "uri": Destination
URI (json
-string
)
633 -> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
638 (1) The
'query-migrate' command should be used to check migration
's progress
639 and final result (this information is provided by the 'status
' member)
640 (2) All boolean arguments default to false
641 (3) The user Monitor's
"detach" argument is invalid
in QMP and should not
647 .name
= "migrate_cancel",
649 .mhandler
.cmd_new
= qmp_marshal_migrate_cancel
,
656 Cancel the current migration
.
662 -> { "execute": "migrate_cancel" }
668 .name
= "migrate-incoming",
669 .args_type
= "uri:s",
670 .mhandler
.cmd_new
= qmp_marshal_migrate_incoming
,
677 Continue an incoming migration
681 - "uri": Source
/listening
URI (json
-string
)
685 -> { "execute": "migrate-incoming", "arguments": { "uri": "tcp::4446" } }
690 (1) QEMU must be started with
-incoming defer to allow migrate
-incoming to
692 (2) The uri format is the same as
for -incoming
696 .name
= "migrate-set-cache-size",
697 .args_type
= "value:o",
698 .mhandler
.cmd_new
= qmp_marshal_migrate_set_cache_size
,
702 migrate
-set
-cache
-size
703 ----------------------
705 Set cache size to be used by XBZRLE migration
, the cache size will be rounded
706 down to the nearest power of
2
710 - "value": cache size
in bytes (json
-int
)
714 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
719 .name
= "migrate-start-postcopy",
721 .mhandler
.cmd_new
= qmp_marshal_migrate_start_postcopy
,
725 migrate
-start
-postcopy
726 ----------------------
728 Switch an
in-progress migration to postcopy mode
. Ignored after the end of
729 migration (or once already
in postcopy
).
732 -> { "execute": "migrate-start-postcopy" }
738 .name
= "query-migrate-cache-size",
740 .mhandler
.cmd_new
= qmp_marshal_query_migrate_cache_size
,
744 query
-migrate
-cache
-size
745 ------------------------
747 Show cache size to be used by XBZRLE migration
749 returns a json
-object with the following information
:
754 -> { "execute": "query-migrate-cache-size" }
755 <- { "return": 67108864 }
760 .name
= "migrate_set_speed",
761 .args_type
= "value:o",
762 .mhandler
.cmd_new
= qmp_marshal_migrate_set_speed
,
769 Set maximum speed
for migrations
.
773 - "value": maximum speed
, in bytes per
second (json
-int
)
777 -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
783 .name
= "migrate_set_downtime",
784 .args_type
= "value:T",
785 .mhandler
.cmd_new
= qmp_marshal_migrate_set_downtime
,
792 Set maximum tolerated
downtime (in seconds
) for migrations
.
796 - "value": maximum
downtime (json
-number
)
800 -> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
806 .name
= "client_migrate_info",
807 .args_type
= "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
808 .params
= "protocol hostname port tls-port cert-subject",
809 .help
= "set migration information for remote display",
810 .mhandler
.cmd_new
= qmp_marshal_client_migrate_info
,
817 Set migration information
for remote display
. This makes the server
818 ask the client to automatically reconnect
using the
new parameters
819 once migration finished successfully
. Only implemented
for SPICE
.
823 - "protocol": must be
"spice" (json
-string
)
824 - "hostname": migration target
hostname (json
-string
)
825 - "port": spice tcp port
for plaintext
channels (json
-int
, optional
)
826 - "tls-port": spice tcp port
for tls
-secured
channels (json
-int
, optional
)
827 - "cert-subject": server certificate
subject (json
-string
, optional
)
831 -> { "execute": "client_migrate_info",
832 "arguments": { "protocol": "spice",
833 "hostname": "virt42.lab.kraxel.org",
840 .name
= "dump-guest-memory",
841 .args_type
= "paging:b,protocol:s,detach:b?,begin:i?,end:i?,format:s?",
842 .params
= "-p protocol [-d] [begin] [length] [format]",
843 .help
= "dump guest memory to file",
844 .mhandler
.cmd_new
= qmp_marshal_dump_guest_memory
,
851 Dump guest memory to file
. The file can be processed with crash or gdb
.
855 - "paging": do paging to get guest
's memory mapping (json-bool)
856 - "protocol": destination file(started with "file:") or destination file
857 descriptor (started with "fd:") (json-string)
858 - "detach": if specified, command will return immediately, without waiting
859 for the dump to finish. The user can track progress using
860 "query-dump". (json-bool)
861 - "begin": the starting physical address. It's optional
, and should be specified
862 with length
together (json
-int
)
863 - "length": the memory size
, in bytes
. It
's optional, and should be specified
864 with begin together (json-int)
865 - "format": the format of guest memory dump. It's optional
, and can be
866 elf|kdump
-zlib|kdump
-lzo|kdump
-snappy
, but non
-elf formats will
867 conflict with paging and filter
, ie
. begin and
length (json
-string
)
871 -> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
876 (1) All boolean arguments
default to
false
881 .name
= "query-dump-guest-memory-capability",
883 .mhandler
.cmd_new
= qmp_marshal_query_dump_guest_memory_capability
,
887 query
-dump
-guest
-memory
-capability
890 Show available formats
for 'dump-guest-memory'
894 -> { "execute": "query-dump-guest-memory-capability" }
895 <- { "return": { "formats":
896 ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
901 .name
= "query-dump",
904 .help
= "query background dump status",
905 .mhandler
.cmd_new
= qmp_marshal_query_dump
,
912 Query background dump status
.
918 -> { "execute": "query-dump" }
919 <- { "return": { "status": "active", "completed": 1024000,
924 #
if defined TARGET_S390X
926 .name
= "dump-skeys",
927 .args_type
= "filename:F",
928 .mhandler
.cmd_new
= qmp_marshal_dump_skeys
,
936 Save guest storage keys to file
.
940 - "filename": file
path (json
-string
)
944 -> { "execute": "dump-skeys", "arguments": { "filename": "/tmp/skeys" } }
950 .name
= "netdev_add",
951 .args_type
= "netdev:O",
952 .mhandler
.cmd_new
= qmp_netdev_add
,
959 Add host network device
.
963 - "type": the device type
, "tap", "user", ... (json
-string
)
964 - "id": the device
's ID, must be unique (json-string)
969 -> { "execute": "netdev_add",
970 "arguments": { "type": "user", "id": "netdev1",
971 "dnssearch": "example.org" } }
974 Note: The supported device options are the same ones supported by the '-netdev
'
975 command-line argument, which are listed in the '-help
' output or QEMU's
981 .name
= "netdev_del",
983 .mhandler
.cmd_new
= qmp_marshal_netdev_del
,
990 Remove host network device
.
994 - "id": the device
's ID, must be unique (json-string)
998 -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
1005 .name = "object-add",
1006 .args_type = "qom-type:s,id:s,props:q?",
1007 .mhandler.cmd_new = qmp_marshal_object_add,
1018 - "qom-type": the object's QOM type
, i
.e
. the
class name (json
-string
)
1019 - "id": the object
's ID, must be unique (json-string)
1020 - "props": a dictionary of object property values (optional, json-dict)
1024 -> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
1025 "props": { "filename": "/dev/hwrng" } } }
1031 .name = "object-del",
1032 .args_type = "id:s",
1033 .mhandler.cmd_new = qmp_marshal_object_del,
1044 - "id": the object's
ID (json
-string
)
1048 -> { "execute": "object-del", "arguments": { "id": "rng1" } }
1056 .name
= "block_resize",
1057 .args_type
= "device:s?,node-name:s?,size:o",
1058 .mhandler
.cmd_new
= qmp_marshal_block_resize
,
1065 Resize a block image
while a guest is running
.
1069 - "device": the device
's ID, must be unique (json-string)
1070 - "node-name": the node name in the block driver state graph (json-string)
1075 -> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
1081 .name = "block-stream",
1082 .args_type = "device:B,base:s?,speed:o?,backing-file:s?,on-error:s?",
1083 .mhandler.cmd_new = qmp_marshal_block_stream,
1090 Copy data from a backing file into a block device.
1094 - "device": The device's ID
, must be
unique (json
-string
)
1095 - "base": The file name of the backing image above which copying starts
1096 (json
-string
, optional
)
1097 - "backing-file": The backing file string to write into the active layer
. This
1098 filename is not validated
.
1100 If a pathname string is such that it cannot be resolved by
1101 QEMU
, that means that subsequent QMP or HMP commands must use
1102 node
-names
for the image
in question
, as filename lookup
1105 If not specified
, QEMU will automatically determine the
1106 backing file string to use
, or error out
if there is no
1107 obvious choice
. Care should be taken when specifying the
1108 string
, to specify a valid filename or protocol
.
1109 (json
-string
, optional
) (Since
2.1)
1110 - "speed": the maximum speed
, in bytes per
second (json
-int
, optional
)
1111 - "on-error": the action to take on an
error (default 'report'). 'stop' and
1112 'enospc' can only be used
if the block device supports io
-status
.
1113 (json
-string
, optional
) (Since
2.1)
1117 -> { "execute": "block-stream", "arguments": { "device": "virtio0",
1118 "base": "/tmp/master.qcow2" } }
1124 .name
= "block-commit",
1125 .args_type
= "device:B,base:s?,top:s?,backing-file:s?,speed:o?",
1126 .mhandler
.cmd_new
= qmp_marshal_block_commit
,
1133 Live commit of data from overlay image nodes into backing nodes
- i
.e
., writes
1134 data between
'top' and
'base' into
'base'.
1138 - "device": The device
's ID, must be unique (json-string)
1139 - "base": The file name of the backing image to write data into.
1140 If not specified, this is the deepest backing image
1141 (json-string, optional)
1142 - "top": The file name of the backing image within the image chain,
1143 which contains the topmost data to be committed down. If
1144 not specified, this is the active layer. (json-string, optional)
1146 - backing-file: The backing file string to write into the overlay
1147 image of 'top
'. If 'top
' is the active layer,
1148 specifying a backing file string is an error. This
1149 filename is not validated.
1151 If a pathname string is such that it cannot be
1152 resolved by QEMU, that means that subsequent QMP or
1153 HMP commands must use node-names for the image in
1154 question, as filename lookup methods will fail.
1156 If not specified, QEMU will automatically determine
1157 the backing file string to use, or error out if
1158 there is no obvious choice. Care should be taken
1159 when specifying the string, to specify a valid
1160 filename or protocol.
1161 (json-string, optional) (Since 2.1)
1163 If top == base, that is an error.
1164 If top == active, the job will not be completed by itself,
1165 user needs to complete the job with the block-job-complete
1166 command after getting the ready event. (Since 2.0)
1168 If the base image is smaller than top, then the base image
1169 will be resized to be the same size as top. If top is
1170 smaller than the base image, the base will not be
1171 truncated. If you want the base image size to match the
1172 size of the smaller top, you can safely truncate it
1173 yourself once the commit operation successfully completes.
1175 - "speed": the maximum speed, in bytes per second (json-int, optional)
1180 -> { "execute": "block-commit", "arguments": { "device": "virtio0",
1181 "top": "/tmp/snap1.qcow2" } }
1187 .name = "drive-backup",
1188 .args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1189 "bitmap:s?,on-source-error:s?,on-target-error:s?",
1190 .mhandler.cmd_new = qmp_marshal_drive_backup,
1197 Start a point-in-time copy of a block device to a new destination. The
1198 status of ongoing drive-backup operations can be checked with
1199 query-block-jobs where the BlockJobInfo.type field has the value 'backup
'.
1200 The operation can be stopped before it has completed using the
1201 block-job-cancel command.
1205 - "device": the name of the device which should be copied.
1207 - "target": the target of the new image. If the file exists, or if it is a
1208 device, the existing file/device will be used as the new
1209 destination. If it does not exist, a new file will be created.
1211 - "format": the format of the new destination, default is to probe if 'mode
' is
1212 'existing
', else the format of the source
1213 (json-string, optional)
1214 - "sync": what parts of the disk image should be copied to the destination;
1215 possibilities include "full" for all the disk, "top" for only the sectors
1216 allocated in the topmost image, "incremental" for only the dirty sectors in
1217 the bitmap, or "none" to only replicate new I/O (MirrorSyncMode).
1218 - "bitmap": dirty bitmap name for sync==incremental. Must be present if sync
1219 is "incremental", must NOT be present otherwise.
1220 - "mode": whether and how QEMU should create a new image
1221 (NewImageMode, optional, default 'absolute
-paths
')
1222 - "speed": the maximum speed, in bytes per second (json-int, optional)
1223 - "on-source-error": the action to take on an error on the source, default
1224 'report
'. 'stop
' and 'enospc
' can only be used
1225 if the block device supports io-status.
1226 (BlockdevOnError, optional)
1227 - "on-target-error": the action to take on an error on the target, default
1228 'report
' (no limitations, since this applies to
1229 a different block device than device).
1230 (BlockdevOnError, optional)
1233 -> { "execute": "drive-backup", "arguments": { "device": "drive0",
1235 "target": "backup.img" } }
1241 .name = "blockdev-backup",
1242 .args_type = "sync:s,device:B,target:B,speed:i?,"
1243 "on-source-error:s?,on-target-error:s?",
1244 .mhandler.cmd_new = qmp_marshal_blockdev_backup,
1251 The device version of drive-backup: this command takes an existing named device
1256 - "device": the name of the device which should be copied.
1258 - "target": the name of the backup target device. (json-string)
1259 - "sync": what parts of the disk image should be copied to the destination;
1260 possibilities include "full" for all the disk, "top" for only the
1261 sectors allocated in the topmost image, or "none" to only replicate
1262 new I/O (MirrorSyncMode).
1263 - "speed": the maximum speed, in bytes per second (json-int, optional)
1264 - "on-source-error": the action to take on an error on the source, default
1265 'report
'. 'stop
' and 'enospc
' can only be used
1266 if the block device supports io-status.
1267 (BlockdevOnError, optional)
1268 - "on-target-error": the action to take on an error on the target, default
1269 'report
' (no limitations, since this applies to
1270 a different block device than device).
1271 (BlockdevOnError, optional)
1274 -> { "execute": "blockdev-backup", "arguments": { "device": "src-id",
1276 "target": "tgt-id" } }
1282 .name = "block-job-set-speed",
1283 .args_type = "device:B,speed:o",
1284 .mhandler.cmd_new = qmp_marshal_block_job_set_speed,
1288 .name = "block-job-cancel",
1289 .args_type = "device:B,force:b?",
1290 .mhandler.cmd_new = qmp_marshal_block_job_cancel,
1293 .name = "block-job-pause",
1294 .args_type = "device:B",
1295 .mhandler.cmd_new = qmp_marshal_block_job_pause,
1298 .name = "block-job-resume",
1299 .args_type = "device:B",
1300 .mhandler.cmd_new = qmp_marshal_block_job_resume,
1303 .name = "block-job-complete",
1304 .args_type = "device:B",
1305 .mhandler.cmd_new = qmp_marshal_block_job_complete,
1308 .name = "transaction",
1309 .args_type = "actions:q,properties:q?",
1310 .mhandler.cmd_new = qmp_marshal_transaction,
1317 Atomically operate on one or more block devices. Operations that are
1318 currently supported:
1322 - blockdev-snapshot-sync
1323 - blockdev-snapshot-internal-sync
1325 - block-dirty-bitmap-add
1326 - block-dirty-bitmap-clear
1328 Refer to the qemu/qapi-schema.json file for minimum required QEMU
1329 versions for these operations. A list of dictionaries is accepted,
1330 that contains the actions to be performed. If there is any failure
1331 performing any of the operations, all operations for the group are
1334 For external snapshots, the dictionary contains the device, the file to use for
1335 the new snapshot, and the format. The default format, if not specified, is
1338 Each new snapshot defaults to being created by QEMU (wiping any
1339 contents if the file already exists), but it is also possible to reuse
1340 an externally-created file. In the latter case, you should ensure that
1341 the new image file has the same contents as the current one; QEMU cannot
1342 perform any meaningful check. Typically this is achieved by using the
1343 current image file as the backing file for the new image.
1345 On failure, the original disks pre-snapshot attempt will be used.
1347 For internal snapshots, the dictionary contains the device and the snapshot's
1348 name
. If an internal snapshot matching name already exists
, the request will
1349 be rejected
. Only some image formats support it
, for example
, qcow2
, rbd
,
1352 On failure
, qemu will
try delete the newly created internal snapshot
in the
1353 transaction
. When an I
/O error occurs during deletion
, the user needs to fix
1354 it later with qemu
-img or other command
.
1359 - "type": the operation to
perform (json
-string
). Possible
1360 values
: "drive-backup", "blockdev-backup",
1361 "blockdev-snapshot-sync",
1362 "blockdev-snapshot-internal-sync",
1363 "abort", "block-dirty-bitmap-add",
1364 "block-dirty-bitmap-clear"
1365 - "data": a dictionary
. The contents depend on the value
1366 of
"type". When
"type" is
"blockdev-snapshot-sync":
1367 - "device": device name to
snapshot (json
-string
)
1368 - "node-name": graph node name to
snapshot (json
-string
)
1369 - "snapshot-file": name of
new image
file (json
-string
)
1370 - "snapshot-node-name": graph node name of the
new snapshot (json
-string
)
1371 - "format": format of
new image (json
-string
, optional
)
1372 - "mode": whether and how QEMU should create the snapshot file
1373 (NewImageMode
, optional
, default "absolute-paths")
1374 When
"type" is
"blockdev-snapshot-internal-sync":
1375 - "device": device name to
snapshot (json
-string
)
1376 - "name": name of the
new snapshot (json
-string
)
1380 -> { "execute": "transaction",
1381 "arguments": { "actions": [
1382 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
1383 "snapshot-file": "/some/place/my-image",
1384 "format": "qcow2" } },
1385 { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
1386 "snapshot-file": "/some/place/my-image2",
1387 "snapshot-node-name": "node3432",
1389 "format": "qcow2" } },
1390 { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
1391 "snapshot-file": "/some/place/my-image2",
1393 "format": "qcow2" } },
1394 { "type": "blockdev-snapshot-internal-sync", "data" : {
1395 "device": "ide-hd2",
1396 "name": "snapshot0" } } ] } }
1402 .name
= "block-dirty-bitmap-add",
1403 .args_type
= "node:B,name:s,granularity:i?",
1404 .mhandler
.cmd_new
= qmp_marshal_block_dirty_bitmap_add
,
1409 block
-dirty
-bitmap
-add
1410 ----------------------
1413 Create a dirty bitmap with a name on the device
, and start tracking the writes
.
1417 - "node": device
/node on which to create dirty
bitmap (json
-string
)
1418 - "name": name of the
new dirty
bitmap (json
-string
)
1419 - "granularity": granularity to track writes
with (int
, optional
)
1423 -> { "execute": "block-dirty-bitmap-add", "arguments": { "node": "drive0",
1424 "name": "bitmap0" } }
1430 .name
= "block-dirty-bitmap-remove",
1431 .args_type
= "node:B,name:s",
1432 .mhandler
.cmd_new
= qmp_marshal_block_dirty_bitmap_remove
,
1437 block
-dirty
-bitmap
-remove
1438 -------------------------
1441 Stop write tracking and remove the dirty bitmap that was created with
1442 block
-dirty
-bitmap
-add
.
1446 - "node": device
/node on which to remove dirty
bitmap (json
-string
)
1447 - "name": name of the dirty bitmap to
remove (json
-string
)
1451 -> { "execute": "block-dirty-bitmap-remove", "arguments": { "node": "drive0",
1452 "name": "bitmap0" } }
1458 .name
= "block-dirty-bitmap-clear",
1459 .args_type
= "node:B,name:s",
1460 .mhandler
.cmd_new
= qmp_marshal_block_dirty_bitmap_clear
,
1465 block
-dirty
-bitmap
-clear
1466 ------------------------
1469 Reset the dirty bitmap associated with a node so that an incremental backup
1470 from
this point
in time forward will only backup clusters modified after
this
1475 - "node": device
/node on which to remove dirty
bitmap (json
-string
)
1476 - "name": name of the dirty bitmap to
remove (json
-string
)
1480 -> { "execute": "block-dirty-bitmap-clear", "arguments": { "node": "drive0",
1481 "name": "bitmap0" } }
1487 .name
= "blockdev-snapshot-sync",
1488 .args_type
= "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
1489 .mhandler
.cmd_new
= qmp_marshal_blockdev_snapshot_sync
,
1493 blockdev
-snapshot
-sync
1494 ----------------------
1496 Synchronous snapshot of a block device
. snapshot
-file specifies the
1497 target of the
new image
. If the file exists
, or
if it is a device
, the
1498 snapshot will be created
in the existing file
/device
. If does not
1499 exist
, a
new file will be created
. format specifies the format of the
1500 snapshot image
, default is qcow2
.
1504 - "device": device name to
snapshot (json
-string
)
1505 - "node-name": graph node name to
snapshot (json
-string
)
1506 - "snapshot-file": name of
new image
file (json
-string
)
1507 - "snapshot-node-name": graph node name of the
new snapshot (json
-string
)
1508 - "mode": whether and how QEMU should create the snapshot file
1509 (NewImageMode
, optional
, default "absolute-paths")
1510 - "format": format of
new image (json
-string
, optional
)
1514 -> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
1516 "/some/place/my-image",
1517 "format": "qcow2" } }
1523 .name
= "blockdev-snapshot",
1524 .args_type
= "node:s,overlay:s",
1525 .mhandler
.cmd_new
= qmp_marshal_blockdev_snapshot
,
1533 Create a snapshot
, by installing
'node' as the backing image of
1534 'overlay'. Additionally
, if 'node' is associated with a block
1535 device
, the block device changes to
using 'overlay' as its
new active
1540 - "node": device that will have a snapshot
created (json
-string
)
1541 - "overlay": device that will have
'node' as its backing
image (json
-string
)
1545 -> { "execute": "blockdev-add",
1546 "arguments": { "options": { "driver": "qcow2",
1547 "node-name": "node1534",
1548 "file": { "driver": "file",
1549 "filename": "hd1.qcow2" },
1554 -> { "execute": "blockdev-snapshot", "arguments": { "node": "ide-hd0",
1555 "overlay": "node1534" } }
1561 .name
= "blockdev-snapshot-internal-sync",
1562 .args_type
= "device:B,name:s",
1563 .mhandler
.cmd_new
= qmp_marshal_blockdev_snapshot_internal_sync
,
1567 blockdev
-snapshot
-internal
-sync
1568 -------------------------------
1570 Synchronously take an internal snapshot of a block device when the format of
1571 image used supports it
. If the name is an empty string
, or a snapshot with
1572 name already exists
, the operation will fail
.
1576 - "device": device name to
snapshot (json
-string
)
1577 - "name": name of the
new snapshot (json
-string
)
1581 -> { "execute": "blockdev-snapshot-internal-sync",
1582 "arguments": { "device": "ide-hd0",
1583 "name": "snapshot0" }
1590 .name
= "blockdev-snapshot-delete-internal-sync",
1591 .args_type
= "device:B,id:s?,name:s?",
1593 qmp_marshal_blockdev_snapshot_delete_internal_sync
,
1597 blockdev
-snapshot
-delete
-internal
-sync
1598 --------------------------------------
1600 Synchronously delete an internal snapshot of a block device when the format of
1601 image used supports it
. The snapshot is identified by name or id or both
. One
1602 of name or id is required
. If the snapshot is not found
, the operation will
1607 - "device": device
name (json
-string
)
1608 - "id": ID of the
snapshot (json
-string
, optional
)
1609 - "name": name of the
snapshot (json
-string
, optional
)
1613 -> { "execute": "blockdev-snapshot-delete-internal-sync",
1614 "arguments": { "device": "ide-hd0",
1615 "name": "snapshot0" }
1619 "name": "snapshot0",
1621 "date-sec": 1000012,
1623 "vm-clock-sec": 100,
1631 .name
= "drive-mirror",
1632 .args_type
= "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
1633 "node-name:s?,replaces:s?,"
1634 "on-source-error:s?,on-target-error:s?,"
1636 "granularity:i?,buf-size:i?",
1637 .mhandler
.cmd_new
= qmp_marshal_drive_mirror
,
1644 Start mirroring a block device
's writes to a new destination. target
1645 specifies the target of the new image. If the file exists, or if it is
1646 a device, it will be used as the new destination for writes. If it does not
1647 exist, a new file will be created. format specifies the format of the
1648 mirror image, default is to probe if mode='existing
', else the format
1653 - "device": device name to operate on (json-string)
1654 - "target": name of new image file (json-string)
1655 - "format": format of new image (json-string, optional)
1656 - "node-name": the name of the new block driver state in the node graph
1657 (json-string, optional)
1658 - "replaces": the block driver node name to replace when finished
1659 (json-string, optional)
1660 - "mode": how an image file should be created into the target
1661 file/device (NewImageMode, optional, default 'absolute
-paths
')
1662 - "speed": maximum speed of the streaming job, in bytes per second
1664 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
1665 - "buf-size": maximum amount of data in flight from source to target, in bytes
1666 (json-int, default 10M)
1667 - "sync": what parts of the disk image should be copied to the destination;
1668 possibilities include "full" for all the disk, "top" for only the sectors
1669 allocated in the topmost image, or "none" to only replicate new I/O
1671 - "on-source-error": the action to take on an error on the source
1672 (BlockdevOnError, default 'report
')
1673 - "on-target-error": the action to take on an error on the target
1674 (BlockdevOnError, default 'report
')
1675 - "unmap": whether the target sectors should be discarded where source has only
1676 zeroes. (json-bool, optional, default true)
1678 The default value of the granularity is the image cluster size clamped
1679 between 4096 and 65536, if the image format defines one. If the format
1680 does not define a cluster size, the default value of the granularity
1686 -> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
1687 "target": "/some/place/my-image",
1689 "format": "qcow2" } }
1695 .name = "blockdev-mirror",
1696 .args_type = "sync:s,device:B,target:B,replaces:s?,speed:i?,"
1697 "on-source-error:s?,on-target-error:s?,"
1698 "granularity:i?,buf-size:i?",
1699 .mhandler.cmd_new = qmp_marshal_blockdev_mirror,
1706 Start mirroring a block device's writes to another block device
. target
1707 specifies the target of mirror operation
.
1711 - "device": device name to operate
on (json
-string
)
1712 - "target": device name to mirror
to (json
-string
)
1713 - "replaces": the block driver node name to replace when finished
1714 (json
-string
, optional
)
1715 - "speed": maximum speed of the streaming job
, in bytes per second
1717 - "granularity": granularity of the dirty bitmap
, in bytes (json
-int
, optional
)
1718 - "buf_size": maximum amount of data
in flight from source to target
, in bytes
1719 (json
-int
, default 10M
)
1720 - "sync": what parts of the disk image should be copied to the destination
;
1721 possibilities include
"full" for all the disk
, "top" for only the sectors
1722 allocated
in the topmost image
, or
"none" to only replicate
new I
/O
1724 - "on-source-error": the action to take on an error on the source
1725 (BlockdevOnError
, default 'report')
1726 - "on-target-error": the action to take on an error on the target
1727 (BlockdevOnError
, default 'report')
1729 The
default value of the granularity is the image cluster size clamped
1730 between
4096 and
65536, if the image format defines one
. If the format
1731 does not define a cluster size
, the
default value of the granularity
1736 -> { "execute": "blockdev-mirror", "arguments": { "device": "ide-hd0",
1737 "target": "target0",
1743 .name
= "change-backing-file",
1744 .args_type
= "device:s,image-node-name:s,backing-file:s",
1745 .mhandler
.cmd_new
= qmp_marshal_change_backing_file
,
1753 Change the backing file
in the image file metadata
. This does not cause
1754 QEMU to reopen the image file to reparse the backing
filename (it may
,
1755 however
, perform a reopen to change permissions from r
/o
-> r
/w
-> r
/o
,
1756 if needed
). The
new backing file string is written into the image file
1757 metadata
, and the QEMU internal strings are updated
.
1761 - "image-node-name": The name of the block driver state node of the
1762 image to modify
. The
"device" is argument is used to
1763 verify
"image-node-name" is
in the chain described by
1765 (json
-string
, optional
)
1767 - "device": The name of the device
.
1770 - "backing-file": The string to write as the backing file
. This string is
1771 not validated
, so care should be taken when specifying
1772 the string or the image chain may not be able to be
1776 Returns
: Nothing on success
1777 If
"device" does not exist or cannot be determined
, DeviceNotFound
1783 .args_type
= "value:M",
1784 .mhandler
.cmd_new
= qmp_marshal_balloon
,
1791 Request VM to change its memory
allocation (in bytes
).
1795 - "value": New memory
allocation (json
-int
)
1799 -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1806 .args_type
= "name:s,up:b",
1807 .mhandler
.cmd_new
= qmp_marshal_set_link
,
1814 Change the link status of a network adapter
.
1818 - "name": network device
name (json
-string
)
1819 - "up": status is
up (json
-bool
)
1823 -> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
1830 .args_type
= "fdname:s",
1831 .params
= "getfd name",
1832 .help
= "receive a file descriptor via SCM rights and assign it a name",
1833 .mhandler
.cmd_new
= qmp_marshal_getfd
,
1840 Receive a file descriptor via SCM rights and assign it a name
.
1844 - "fdname": file descriptor
name (json
-string
)
1848 -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1853 (1) If the name specified by the
"fdname" argument already exists
,
1854 the file descriptor assigned to it will be closed and replaced
1855 by the received file descriptor
.
1856 (2) The
'closefd' command can be used to explicitly close the file
1857 descriptor when it is no longer needed
.
1863 .args_type
= "fdname:s",
1864 .params
= "closefd name",
1865 .help
= "close a file descriptor previously passed via SCM rights",
1866 .mhandler
.cmd_new
= qmp_marshal_closefd
,
1873 Close a file descriptor previously passed via SCM rights
.
1877 - "fdname": file descriptor
name (json
-string
)
1881 -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1888 .args_type
= "fdset-id:i?,opaque:s?",
1889 .params
= "add-fd fdset-id opaque",
1890 .help
= "Add a file descriptor, that was passed via SCM rights, to an fd set",
1891 .mhandler
.cmd_new
= qmp_marshal_add_fd
,
1898 Add a file descriptor
, that was passed via SCM rights
, to an fd set
.
1902 - "fdset-id": The ID of the fd set to add the file descriptor to
.
1903 (json
-int
, optional
)
1904 - "opaque": A free
-form string that can be used to describe the fd
.
1905 (json
-string
, optional
)
1907 Return a json
-object with the following information
:
1909 - "fdset-id": The ID of the fd set that the fd was added to
. (json
-int
)
1910 - "fd": The file descriptor that was received via SCM rights and added to the
1915 -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1916 <- { "return": { "fdset-id": 1, "fd": 3 } }
1920 (1) The list of fd sets is shared by all monitor connections
.
1921 (2) If
"fdset-id" is not specified
, a
new fd set will be created
.
1926 .name
= "remove-fd",
1927 .args_type
= "fdset-id:i,fd:i?",
1928 .params
= "remove-fd fdset-id fd",
1929 .help
= "Remove a file descriptor from an fd set",
1930 .mhandler
.cmd_new
= qmp_marshal_remove_fd
,
1937 Remove a file descriptor from an fd set
.
1941 - "fdset-id": The ID of the fd set that the file descriptor belongs to
.
1943 - "fd": The file descriptor that is to be removed
. (json
-int
, optional
)
1947 -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1952 (1) The list of fd sets is shared by all monitor connections
.
1953 (2) If
"fd" is not specified
, all file descriptors
in "fdset-id" will be
1959 .name
= "query-fdsets",
1961 .help
= "Return information describing all fd sets",
1962 .mhandler
.cmd_new
= qmp_marshal_query_fdsets
,
1969 Return information describing all fd sets
.
1975 -> { "execute": "query-fdsets" }
1981 "opaque": "rdonly:/path/to/file"
1985 "opaque": "rdwr:/path/to/file"
2004 Note
: The list of fd sets is shared by all monitor connections
.
2009 .name
= "block_passwd",
2010 .args_type
= "device:s?,node-name:s?,password:s",
2011 .mhandler
.cmd_new
= qmp_marshal_block_passwd
,
2018 Set the password of encrypted block devices
.
2022 - "device": device
name (json
-string
)
2023 - "node-name": name
in the block driver state
graph (json
-string
)
2024 - "password": password (json
-string
)
2028 -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
2029 "password": "12345" } }
2035 .name
= "block_set_io_throttle",
2036 .args_type
= "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l,bps_max:l?,bps_rd_max:l?,bps_wr_max:l?,iops_max:l?,iops_rd_max:l?,iops_wr_max:l?,bps_max_length:l?,bps_rd_max_length:l?,bps_wr_max_length:l?,iops_max_length:l?,iops_rd_max_length:l?,iops_wr_max_length:l?,iops_size:l?,group:s?",
2037 .mhandler
.cmd_new
= qmp_marshal_block_set_io_throttle
,
2041 block_set_io_throttle
2044 Change I
/O throttle limits
for a block drive
.
2048 - "device": device
name (json
-string
)
2049 - "bps": total throughput limit
in bytes per
second (json
-int
)
2050 - "bps_rd": read throughput limit
in bytes per
second (json
-int
)
2051 - "bps_wr": write throughput limit
in bytes per
second (json
-int
)
2052 - "iops": total I
/O operations per
second (json
-int
)
2053 - "iops_rd": read I
/O operations per
second (json
-int
)
2054 - "iops_wr": write I
/O operations per
second (json
-int
)
2055 - "bps_max": total throughput limit during bursts
, in bytes (json
-int
, optional
)
2056 - "bps_rd_max": read throughput limit during bursts
, in bytes (json
-int
, optional
)
2057 - "bps_wr_max": write throughput limit during bursts
, in bytes (json
-int
, optional
)
2058 - "iops_max": total I
/O operations per second during
bursts (json
-int
, optional
)
2059 - "iops_rd_max": read I
/O operations per second during
bursts (json
-int
, optional
)
2060 - "iops_wr_max": write I
/O operations per second during
bursts (json
-int
, optional
)
2061 - "bps_max_length": maximum length of the @bps_max burst period
, in seconds (json
-int
, optional
)
2062 - "bps_rd_max_length": maximum length of the @bps_rd_max burst period
, in seconds (json
-int
, optional
)
2063 - "bps_wr_max_length": maximum length of the @bps_wr_max burst period
, in seconds (json
-int
, optional
)
2064 - "iops_max_length": maximum length of the @iops_max burst period
, in seconds (json
-int
, optional
)
2065 - "iops_rd_max_length": maximum length of the @iops_rd_max burst period
, in seconds (json
-int
, optional
)
2066 - "iops_wr_max_length": maximum length of the @iops_wr_max burst period
, in seconds (json
-int
, optional
)
2067 - "iops_size": I
/O size
in bytes when
limiting (json
-int
, optional
)
2068 - "group": throttle group
name (json
-string
, optional
)
2072 -> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
2085 "bps_max_length": 60,
2092 .name
= "set_password",
2093 .args_type
= "protocol:s,password:s,connected:s?",
2094 .mhandler
.cmd_new
= qmp_marshal_set_password
,
2101 Set the password
for vnc
/spice protocols
.
2105 - "protocol": protocol
name (json
-string
)
2106 - "password": password (json
-string
)
2107 - "connected": [ keep | disconnect | fail
] (json
-string
, optional
)
2111 -> { "execute": "set_password", "arguments": { "protocol": "vnc",
2112 "password": "secret" } }
2118 .name
= "expire_password",
2119 .args_type
= "protocol:s,time:s",
2120 .mhandler
.cmd_new
= qmp_marshal_expire_password
,
2127 Set the password expire time
for vnc
/spice protocols
.
2131 - "protocol": protocol
name (json
-string
)
2132 - "time": [ now |
never |
+secs | secs
] (json
-string
)
2136 -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
2143 .name
= "add_client",
2144 .args_type
= "protocol:s,fdname:s,skipauth:b?,tls:b?",
2145 .mhandler
.cmd_new
= qmp_marshal_add_client
,
2152 Add a graphics client
2156 - "protocol": protocol
name (json
-string
)
2157 - "fdname": file descriptor
name (json
-string
)
2158 - "skipauth": whether to skip
authentication (json
-bool
, optional
)
2159 - "tls": whether to perform
TLS (json
-bool
, optional
)
2163 -> { "execute": "add_client", "arguments": { "protocol": "vnc",
2164 "fdname": "myclient" } }
2169 .name
= "qmp_capabilities",
2172 .help
= "enable QMP capabilities",
2173 .mhandler
.cmd_new
= qmp_capabilities
,
2180 Enable QMP capabilities
.
2186 -> { "execute": "qmp_capabilities" }
2189 Note
: This command must be issued before issuing any other command
.
2194 .name
= "human-monitor-command",
2195 .args_type
= "command-line:s,cpu-index:i?",
2196 .mhandler
.cmd_new
= qmp_marshal_human_monitor_command
,
2200 human
-monitor
-command
2201 ---------------------
2203 Execute a Human Monitor command
.
2207 - command
-line
: the command name and its arguments
, just like the
2208 Human Monitor
's shell (json-string)
2209 - cpu-index: select the CPU number to be used by commands which access CPU
2210 data, like 'info registers
'. The Monitor selects CPU 0 if this
2211 argument is not provided (json-int, optional)
2215 -> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
2216 <- { "return": "kvm support: enabled\r\n" }
2220 (1) The Human Monitor is NOT an stable interface, this means that command
2221 names, arguments and responses can change or be removed at ANY time.
2222 Applications that rely on long term stability guarantees should NOT
2227 o This command is stateless, this means that commands that depend
2228 on state information (such as getfd) might not work
2230 o Commands that prompt the user for data (eg. 'cont
' when the block
2231 device is encrypted) don't currently work
2236 HXCOMM Each query command below is inside a SQMP
/EQMP section
, do NOT change
2237 HXCOMM
this! We will possibly move query commands definitions inside those
2238 HXCOMM sections
, just like regular commands
.
2248 Return a json
-object with the following information
:
2250 - "qemu": A json
-object containing three integer values
:
2251 - "major": QEMU
's major version (json-int)
2252 - "minor": QEMU's minor
version (json
-int
)
2253 - "micro": QEMU
's micro version (json-int)
2254 - "package": package's
version (json
-string
)
2258 -> { "execute": "query-version" }
2273 .name
= "query-version",
2275 .mhandler
.cmd_new
= qmp_marshal_query_version
,
2282 List QMP available commands
.
2284 Each command is represented by a json
-object
, the returned value is a json
-array
2287 Each json
-object contain
:
2289 - "name": command
's name (json-string)
2293 -> { "execute": "query-commands" }
2297 "name":"query-balloon"
2300 "name":"system_powerdown"
2305 Note: This example has been shortened as the real response is too long.
2310 .name = "query-commands",
2312 .mhandler.cmd_new = qmp_marshal_query_commands,
2319 List QMP available events.
2321 Each event is represented by a json-object, the returned value is a json-array
2324 Each json-object contains:
2326 - "name": event's
name (json
-string
)
2330 -> { "execute": "query-events" }
2342 Note
: This example has been shortened as the real response is too long
.
2347 .name
= "query-events",
2349 .mhandler
.cmd_new
= qmp_marshal_query_events
,
2356 Return the QMP wire schema
. The returned value is a json
-array of
2357 named schema entities
. Entities are commands
, events and various
2358 types
. See docs
/qapi
-code
-gen
.txt
for information on their structure
2364 .name
= "query-qmp-schema",
2366 .mhandler
.cmd_new
= qmp_query_qmp_schema
,
2373 Each device is represented by a json
-object
. The returned value is a json
-array
2376 Each json
-object contain the following
:
2378 - "label": device
's label (json-string)
2379 - "filename": device's
file (json
-string
)
2380 - "frontend-open": open
/closed state of the frontend device attached to
this
2385 -> { "execute": "query-chardev" }
2389 "label": "charchannel0",
2390 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server",
2391 "frontend-open": false
2394 "label": "charmonitor",
2395 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server",
2396 "frontend-open": true
2399 "label": "charserial0",
2400 "filename": "pty:/dev/pts/2",
2401 "frontend-open": true
2409 .name
= "query-chardev",
2411 .mhandler
.cmd_new
= qmp_marshal_query_chardev
,
2415 query
-chardev
-backends
2418 List available character device backends
.
2420 Each backend is represented by a json
-object
, the returned value is a json
-array
2423 Each json
-object contains
:
2425 - "name": backend
name (json
-string
)
2429 -> { "execute": "query-chardev-backends" }
2450 .name
= "query-chardev-backends",
2452 .mhandler
.cmd_new
= qmp_marshal_query_chardev_backends
,
2459 Show the block devices
.
2461 Each block device information is stored
in a json
-object and the returned value
2462 is a json
-array of all devices
.
2464 Each json
-object contain the following
:
2466 - "device": device
name (json
-string
)
2467 - "type": device
type (json
-string
)
2468 - deprecated
, retained
for backward compatibility
2469 - Possible values
: "unknown"
2470 - "removable": true if the device is removable
, false otherwise (json
-bool
)
2471 - "locked": true if the device is locked
, false otherwise (json
-bool
)
2472 - "tray_open": only present
if removable
, true if the device has a tray
,
2473 and it is
open (json
-bool
)
2474 - "inserted": only present
if the device is inserted
, it is a json
-object
2475 containing the following
:
2476 - "file": device file
name (json
-string
)
2477 - "ro": true if read
-only
, false otherwise (json
-bool
)
2478 - "drv": driver format
name (json
-string
)
2479 - Possible values
: "blkdebug", "bochs", "cloop", "dmg",
2480 "file", "file", "ftp", "ftps", "host_cdrom",
2481 "host_device", "http", "https",
2482 "nbd", "parallels", "qcow", "qcow2", "raw",
2483 "tftp", "vdi", "vmdk", "vpc", "vvfat"
2484 - "backing_file": backing file
name (json
-string
, optional
)
2485 - "backing_file_depth": number of files
in the backing file
chain (json
-int
)
2486 - "encrypted": true if encrypted
, false otherwise (json
-bool
)
2487 - "bps": limit total bytes per
second (json
-int
)
2488 - "bps_rd": limit read bytes per
second (json
-int
)
2489 - "bps_wr": limit write bytes per
second (json
-int
)
2490 - "iops": limit total I
/O operations per
second (json
-int
)
2491 - "iops_rd": limit read operations per
second (json
-int
)
2492 - "iops_wr": limit write operations per
second (json
-int
)
2493 - "bps_max": total max
in bytes (json
-int
)
2494 - "bps_rd_max": read max
in bytes (json
-int
)
2495 - "bps_wr_max": write max
in bytes (json
-int
)
2496 - "iops_max": total I
/O operations
max (json
-int
)
2497 - "iops_rd_max": read I
/O operations
max (json
-int
)
2498 - "iops_wr_max": write I
/O operations
max (json
-int
)
2499 - "iops_size": I
/O size when limiting by
iops (json
-int
)
2500 - "detect_zeroes": detect and optimize zero
writing (json
-string
)
2501 - Possible values
: "off", "on", "unmap"
2502 - "write_threshold": write offset threshold
in bytes
, a event will be
2503 emitted
if crossed
. Zero
if disabled (json
-int
)
2504 - "image": the detail of the image
, it is a json
-object containing
2506 - "filename": image file
name (json
-string
)
2507 - "format": image
format (json
-string
)
2508 - "virtual-size": image capacity
in bytes (json
-int
)
2509 - "dirty-flag": true if image is not cleanly closed
, not present
2510 means
clean (json
-bool
, optional
)
2511 - "actual-size": actual size on disk
in bytes of the image
, not
2512 present when image does not support thin
2513 provision (json
-int
, optional
)
2514 - "cluster-size": size of a cluster
in bytes
, not present
if image
2515 format does not support
it (json
-int
, optional
)
2516 - "encrypted": true if the image is encrypted
, not present means
2517 false or the image format does not support
2518 encryption (json
-bool
, optional
)
2519 - "backing_file": backing file name
, not present means no backing
2520 file is used or the image format does not
2521 support backing file chain
2522 (json
-string
, optional
)
2523 - "full-backing-filename": full path of the backing file
, not
2524 present
if it equals backing_file or no
2525 backing file is used
2526 (json
-string
, optional
)
2527 - "backing-filename-format": the format of the backing file
, not
2528 present means unknown or no backing
2529 file (json
-string
, optional
)
2530 - "snapshots": the internal snapshot info
, it is an optional list
2531 of json
-object containing the following
:
2532 - "id": unique snapshot
id (json
-string
)
2533 - "name": snapshot
name (json
-string
)
2534 - "vm-state-size": size of the VM state
in bytes (json
-int
)
2535 - "date-sec": UTC date of the snapshot
in seconds (json
-int
)
2536 - "date-nsec": fractional part
in nanoseconds to be used with
2538 - "vm-clock-sec": VM clock relative to boot
in seconds
2540 - "vm-clock-nsec": fractional part
in nanoseconds to be used
2541 with vm
-clock
-sec (json
-int
)
2542 - "backing-image": the detail of the backing image
, it is an
2543 optional json
-object only present when a
2544 backing image present
for this image
2546 - "io-status": I
/O operation status
, only present
if the device supports it
2547 and the VM is configured to stop on errors
. It
's always reset
2548 to "ok" when the "cont" command is issued (json_string, optional)
2549 - Possible values: "ok", "failed", "nospace"
2553 -> { "execute": "query-block" }
2558 "device":"ide0-hd0",
2565 "file":"disks/test.qcow2",
2566 "backing_file_depth":1,
2580 "detect_zeroes": "on",
2581 "write_threshold": 0,
2583 "filename":"disks/test.qcow2",
2585 "virtual-size":2048000,
2586 "backing_file":"base.qcow2",
2587 "full-backing-filename":"disks/base.qcow2",
2588 "backing-filename-format":"qcow2",
2592 "name": "snapshot1",
2594 "date-sec": 10000200,
2596 "vm-clock-sec": 206,
2601 "filename":"disks/base.qcow2",
2603 "virtual-size":2048000
2611 "device":"ide1-cd0",
2634 .name = "query-block",
2636 .mhandler.cmd_new = qmp_marshal_query_block,
2643 Show block device statistics.
2645 Each device statistic information is stored in a json-object and the returned
2646 value is a json-array of all devices.
2648 Each json-object contain the following:
2650 - "device": device name (json-string)
2651 - "stats": A json-object with the statistics information, it contains:
2652 - "rd_bytes": bytes read (json-int)
2653 - "wr_bytes": bytes written (json-int)
2654 - "rd_operations": read operations (json-int)
2655 - "wr_operations": write operations (json-int)
2656 - "flush_operations": cache flush operations (json-int)
2657 - "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
2658 - "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
2659 - "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
2660 - "wr_highest_offset": The offset after the greatest byte written to the
2661 BlockDriverState since it has been opened (json-int)
2662 - "rd_merged": number of read requests that have been merged into
2663 another request (json-int)
2664 - "wr_merged": number of write requests that have been merged into
2665 another request (json-int)
2666 - "idle_time_ns": time since the last I/O operation, in
2667 nanoseconds. If the field is absent it means
2668 that there haven't been any operations yet
2669 (json
-int
, optional
)
2670 - "failed_rd_operations": number of failed read operations
2672 - "failed_wr_operations": number of failed write operations
2674 - "failed_flush_operations": number of failed flush operations
2676 - "invalid_rd_operations": number of invalid read operations
2678 - "invalid_wr_operations": number of invalid write operations
2680 - "invalid_flush_operations": number of invalid flush operations
2682 - "account_invalid": whether invalid operations are included
in
2683 the last access
statistics (json
-bool
)
2684 - "account_failed": whether failed operations are included
in the
2685 latency and last access statistics
2687 - "timed_stats": A json
-array containing statistics collected
in
2688 specific intervals
, with the following members
:
2689 - "interval_length": interval used
for calculating the
2690 statistics
, in seconds (json
-int
)
2691 - "min_rd_latency_ns": minimum latency of read operations
in
2692 the defined interval
, in nanoseconds
2694 - "min_wr_latency_ns": minimum latency of write operations
in
2695 the defined interval
, in nanoseconds
2697 - "min_flush_latency_ns": minimum latency of flush operations
2698 in the defined interval
, in
2699 nanoseconds (json
-int
)
2700 - "max_rd_latency_ns": maximum latency of read operations
in
2701 the defined interval
, in nanoseconds
2703 - "max_wr_latency_ns": maximum latency of write operations
in
2704 the defined interval
, in nanoseconds
2706 - "max_flush_latency_ns": maximum latency of flush operations
2707 in the defined interval
, in
2708 nanoseconds (json
-int
)
2709 - "avg_rd_latency_ns": average latency of read operations
in
2710 the defined interval
, in nanoseconds
2712 - "avg_wr_latency_ns": average latency of write operations
in
2713 the defined interval
, in nanoseconds
2715 - "avg_flush_latency_ns": average latency of flush operations
2716 in the defined interval
, in
2717 nanoseconds (json
-int
)
2718 - "avg_rd_queue_depth": average number of pending read
2719 operations
in the defined interval
2721 - "avg_wr_queue_depth": average number of pending write
2722 operations
in the defined interval
2724 - "parent": Contains recursively the statistics of the underlying
2725 protocol (e
.g
. the host file
for a qcow2 image
). If there is
2726 no underlying protocol
, this field is omitted
2727 (json
-object
, optional
)
2731 -> { "execute": "query-blockstats" }
2735 "device":"ide0-hd0",
2738 "wr_highest_offset":3686448128,
2740 "wr_operations":751,
2741 "rd_bytes":122567168,
2742 "rd_operations":36772
2743 "wr_total_times_ns":313253456
2744 "rd_total_times_ns":3465673657
2745 "flush_total_times_ns":49653
2746 "flush_operations":61,
2749 "idle_time_ns":2953431879,
2750 "account_invalid":true,
2751 "account_failed":false
2755 "wr_highest_offset":2821110784,
2757 "wr_operations":692,
2758 "rd_bytes":122739200,
2759 "rd_operations":36604
2760 "flush_operations":51,
2761 "wr_total_times_ns":313253456
2762 "rd_total_times_ns":3465673657
2763 "flush_total_times_ns":49653,
2766 "idle_time_ns":2953431879,
2767 "account_invalid":true,
2768 "account_failed":false
2772 "device":"ide1-cd0",
2774 "wr_highest_offset":0,
2779 "flush_operations":0,
2780 "wr_total_times_ns":0
2781 "rd_total_times_ns":0
2782 "flush_total_times_ns":0,
2785 "account_invalid":false,
2786 "account_failed":false
2792 "wr_highest_offset":0,
2797 "flush_operations":0,
2798 "wr_total_times_ns":0
2799 "rd_total_times_ns":0
2800 "flush_total_times_ns":0,
2803 "account_invalid":false,
2804 "account_failed":false
2810 "wr_highest_offset":0,
2815 "flush_operations":0,
2816 "wr_total_times_ns":0
2817 "rd_total_times_ns":0
2818 "flush_total_times_ns":0,
2821 "account_invalid":false,
2822 "account_failed":false
2831 .name
= "query-blockstats",
2832 .args_type
= "query-nodes:b?",
2833 .mhandler
.cmd_new
= qmp_marshal_query_blockstats
,
2840 Show CPU information
.
2842 Return a json
-array
. Each CPU is represented by a json
-object
, which contains
:
2844 - "CPU": CPU
index (json
-int
)
2845 - "current": true if this is the current CPU
, false otherwise (json
-bool
)
2846 - "halted": true if the cpu is halted
, false otherwise (json
-bool
)
2847 - "qom_path": path to the CPU object
in the QOM
tree (json
-str
)
2848 - "arch": architecture of the cpu
, which determines what additional
2849 keys will be
present (json
-str
)
2850 - Current program counter
. The key
's name depends on the architecture:
2851 "pc": i386/x86_64 (json-int)
2852 "nip": PPC (json-int)
2853 "pc" and "npc": sparc (json-int)
2854 "PC": mips (json-int)
2855 - "thread_id": ID of the underlying host thread (json-int)
2859 -> { "execute": "query-cpus" }
2866 "qom_path":"/machine/unattached/device[0]",
2875 "qom_path":"/machine/unattached/device[2]",
2886 .name = "query-cpus",
2888 .mhandler.cmd_new = qmp_marshal_query_cpus,
2895 Returns a list of information about each iothread.
2897 Note this list excludes the QEMU main loop thread, which is not declared
2898 using the -object iothread command-line option. It is always the main thread
2901 Return a json-array. Each iothread is represented by a json-object, which contains:
2903 - "id": name of iothread (json-str)
2904 - "thread-id": ID of the underlying host thread (json-int)
2908 -> { "execute": "query-iothreads" }
2925 .name = "query-iothreads",
2927 .mhandler.cmd_new = qmp_marshal_query_iothreads,
2934 PCI buses and devices information.
2936 The returned value is a json-array of all buses. Each bus is represented by
2937 a json-object, which has a key with a json-array of all PCI devices attached
2938 to it. Each device is represented by a json-object.
2940 The bus json-object contains the following:
2942 - "bus": bus number (json-int)
2943 - "devices": a json-array of json-objects, each json-object represents a
2946 The PCI device json-object contains the following:
2948 - "bus": identical to the parent's bus
number (json
-int
)
2949 - "slot": slot
number (json
-int
)
2950 - "function": function number (json
-int
)
2951 - "class_info": a json
-object containing
:
2952 - "desc": device
class description (json
-string
, optional
)
2953 - "class": device
class number (json
-int
)
2954 - "id": a json
-object containing
:
2955 - "device": device
ID (json
-int
)
2956 - "vendor": vendor
ID (json
-int
)
2957 - "irq": device
's IRQ if assigned (json-int, optional)
2958 - "qdev_id": qdev id string (json-string)
2959 - "pci_bridge": It's a json
-object
, only present
if this device is a
2960 PCI bridge
, contains
:
2961 - "bus": bus
number (json
-int
)
2962 - "secondary": secondary bus
number (json
-int
)
2963 - "subordinate": subordinate bus
number (json
-int
)
2964 - "io_range": I
/O memory range information
, a json
-object with the
2966 - "base": base address
, in bytes (json
-int
)
2967 - "limit": limit address
, in bytes (json
-int
)
2968 - "memory_range": memory range information
, a json
-object with the
2970 - "base": base address
, in bytes (json
-int
)
2971 - "limit": limit address
, in bytes (json
-int
)
2972 - "prefetchable_range": Prefetchable memory range information
, a
2973 json
-object with the following members
:
2974 - "base": base address
, in bytes (json
-int
)
2975 - "limit": limit address
, in bytes (json
-int
)
2976 - "devices": a json
-array of PCI devices
if there
's any attached, each
2977 each element is represented by a json-object, which contains
2978 the same members of the 'PCI device json
-object
' described
2980 - "regions": a json-array of json-objects, each json-object represents a
2981 memory region of this device
2983 The memory range json-object contains the following:
2985 - "base": base memory address (json-int)
2986 - "limit": limit value (json-int)
2988 The region json-object can be an I/O region or a memory region, an I/O region
2989 json-object contains the following:
2991 - "type": "io" (json-string, fixed)
2992 - "bar": BAR number (json-int)
2993 - "address": memory address (json-int)
2994 - "size": memory size (json-int)
2996 A memory region json-object contains the following:
2998 - "type": "memory" (json-string, fixed)
2999 - "bar": BAR number (json-int)
3000 - "address": memory address (json-int)
3001 - "size": memory size (json-int)
3002 - "mem_type_64": true or false (json-bool)
3003 - "prefetch": true or false (json-bool)
3007 -> { "execute": "query-pci" }
3019 "desc":"Host bridge"
3053 "desc":"IDE controller"
3075 "desc":"VGA controller"
3085 "mem_type_64":false,
3088 "address":4026531840,
3093 "mem_type_64":false,
3096 "address":4060086272,
3101 "mem_type_64":false,
3116 "desc":"RAM controller"
3137 Note: This example has been shortened as the real response is too long.
3142 .name = "query-pci",
3144 .mhandler.cmd_new = qmp_marshal_query_pci,
3151 Show KVM information.
3153 Return a json-object with the following information:
3155 - "enabled": true if KVM support is enabled, false otherwise (json-bool)
3156 - "present": true if QEMU has KVM support, false otherwise (json-bool)
3160 -> { "execute": "query-kvm" }
3161 <- { "return": { "enabled": true, "present": true } }
3166 .name = "query-kvm",
3168 .mhandler.cmd_new = qmp_marshal_query_kvm,
3175 Return a json-object with the following information:
3177 - "running": true if the VM is running, or false if it is paused (json-bool)
3178 - "singlestep": true if the VM is in single step mode,
3179 false otherwise (json-bool)
3180 - "status": one of the following values (json-string)
3181 "debug" - QEMU is running on a debugger
3182 "inmigrate" - guest is paused waiting for an incoming migration
3183 "internal-error" - An internal error that prevents further guest
3184 execution has occurred
3185 "io-error" - the last IOP has failed and the device is configured
3186 to pause on I/O errors
3187 "paused" - guest has been paused via the 'stop
' command
3188 "postmigrate" - guest is paused following a successful 'migrate
'
3189 "prelaunch" - QEMU was started with -S and guest has not started
3190 "finish-migrate" - guest is paused to finish the migration process
3191 "restore-vm" - guest is paused to restore VM state
3192 "running" - guest is actively running
3193 "save-vm" - guest is paused to save the VM state
3194 "shutdown" - guest is shut down (and -no-shutdown is in use)
3195 "watchdog" - the watchdog action is configured to pause and
3200 -> { "execute": "query-status" }
3201 <- { "return": { "running": true, "singlestep": false, "status": "running" } }
3206 .name = "query-status",
3208 .mhandler.cmd_new = qmp_marshal_query_status,
3215 Show VM mice information.
3217 Each mouse is represented by a json-object, the returned value is a json-array
3220 The mouse json-object contains the following:
3222 - "name": mouse's
name (json
-string
)
3223 - "index": mouse
's index (json-int)
3224 - "current": true if this mouse is receiving events, false otherwise (json-bool)
3225 - "absolute": true if the mouse generates absolute input events (json-bool)
3229 -> { "execute": "query-mice" }
3233 "name":"QEMU Microsoft Mouse",
3239 "name":"QEMU PS/2 Mouse",
3250 .name = "query-mice",
3252 .mhandler.cmd_new = qmp_marshal_query_mice,
3259 Show VNC server information.
3261 Return a json-object with server information. Connected clients are returned
3262 as a json-array of json-objects.
3264 The main json-object contains the following:
3266 - "enabled": true or false (json-bool)
3267 - "host": server's IP
address (json
-string
)
3268 - "family": address
family (json
-string
)
3269 - Possible values
: "ipv4", "ipv6", "unix", "unknown"
3270 - "service": server
's port number (json-string)
3271 - "auth": authentication method (json-string)
3272 - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
3273 "tls", "ultra", "unknown", "vencrypt", "vencrypt",
3274 "vencrypt+plain", "vencrypt+tls+none",
3275 "vencrypt+tls+plain", "vencrypt+tls+sasl",
3276 "vencrypt+tls+vnc", "vencrypt+x509+none",
3277 "vencrypt+x509+plain", "vencrypt+x509+sasl",
3278 "vencrypt+x509+vnc", "vnc"
3279 - "clients": a json-array of all connected clients
3281 Clients are described by a json-object, each one contain the following:
3283 - "host": client's IP
address (json
-string
)
3284 - "family": address
family (json
-string
)
3285 - Possible values
: "ipv4", "ipv6", "unix", "unknown"
3286 - "service": client
's port number (json-string)
3287 - "x509_dname": TLS dname (json-string, optional)
3288 - "sasl_username": SASL username (json-string, optional)
3292 -> { "execute": "query-vnc" }
3313 .name = "query-vnc",
3315 .mhandler.cmd_new = qmp_marshal_query_vnc,
3318 .name = "query-vnc-servers",
3320 .mhandler.cmd_new = qmp_marshal_query_vnc_servers,
3327 Show SPICE server information.
3329 Return a json-object with server information. Connected clients are returned
3330 as a json-array of json-objects.
3332 The main json-object contains the following:
3334 - "enabled": true or false (json-bool)
3335 - "host": server's IP
address (json
-string
)
3336 - "port": server
's port number (json-int, optional)
3337 - "tls-port": server's port
number (json
-int
, optional
)
3338 - "auth": authentication
method (json
-string
)
3339 - Possible values
: "none", "spice"
3340 - "channels": a json
-array of all active channels clients
3342 Channels are described by a json
-object
, each one contain the following
:
3344 - "host": client
's IP address (json-string)
3345 - "family": address family (json-string)
3346 - Possible values: "ipv4", "ipv6", "unix", "unknown"
3347 - "port": client's port
number (json
-string
)
3348 - "connection-id": spice connection id
. All channels with the same id
3349 belong to the same spice
session (json
-int
)
3350 - "channel-type": channel type
. "1" is the main control channel
, filter
for
3351 this one
if you want track spice sessions
only (json
-int
)
3352 - "channel-id": channel id
. Usually
"0", might be different needed when
3353 multiple channels of the same type exist
, such as multiple
3354 display channels
in a multihead
setup (json
-int
)
3355 - "tls": whether the channel is
encrypted (json
-bool
)
3359 -> { "execute": "query-spice" }
3372 "connection-id": 1804289383,
3373 "host": "127.0.0.1",
3381 "connection-id": 1804289383,
3382 "host": "127.0.0.1",
3386 [ ... more channels follow
... ]
3393 #
if defined(CONFIG_SPICE
)
3395 .name
= "query-spice",
3397 .mhandler
.cmd_new
= qmp_marshal_query_spice
,
3407 Return a json
-object with the following information
:
3409 - "name": VM
's name (json-string, optional)
3413 -> { "execute": "query-name" }
3414 <- { "return": { "name": "qemu-name" } }
3419 .name = "query-name",
3421 .mhandler.cmd_new = qmp_marshal_query_name,
3430 Return a json-object with the following information:
3432 - "UUID": Universally Unique Identifier (json-string)
3436 -> { "execute": "query-uuid" }
3437 <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
3442 .name = "query-uuid",
3444 .mhandler.cmd_new = qmp_marshal_query_uuid,
3448 query-command-line-options
3449 --------------------------
3451 Show command line option schema.
3453 Return a json-array of command line option schema for all options (or for
3454 the given option), returning an error if the given option doesn't exist
.
3456 Each array entry contains the following
:
3458 - "option": option
name (json
-string
)
3459 - "parameters": a json
-array describes all parameters of the option
:
3460 - "name": parameter
name (json
-string
)
3461 - "type": parameter
type (one of
'string', 'boolean', 'number',
3463 - "help": human readable description of the parameter
3464 (json
-string
, optional
)
3465 - "default": default value string
for the parameter
3466 (json
-string
, optional
)
3470 -> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
3479 "name": "bootindex",
3483 "option": "option-rom"
3491 .name
= "query-command-line-options",
3492 .args_type
= "option:s?",
3493 .mhandler
.cmd_new
= qmp_marshal_query_command_line_options
,
3502 Return a json
-object
. If migration is active there will be another json
-object
3503 with RAM migration status and
if block migration is active another one with
3504 block migration status
.
3506 The main json
-object contains the following
:
3508 - "status": migration
status (json
-string
)
3509 - Possible values
: "setup", "active", "completed", "failed", "cancelled"
3510 - "total-time": total amount of ms since migration started
. If
3511 migration has ended
, it returns the total migration
3513 - "setup-time" amount of setup time
in milliseconds _before_ the
3514 iterations begin but _after_ the QMP command is issued
.
3515 This is designed to provide an accounting of any activities
3516 (such as RDMA pinning
) which may be expensive
, but
do not
3517 actually occur during the iterative migration rounds
3518 themselves
. (json
-int
)
3519 - "downtime": only present when migration has finished correctly
3520 total amount
in ms
for downtime that
happened (json
-int
)
3521 - "expected-downtime": only present
while migration is active
3522 total amount
in ms
for downtime that was calculated on
3523 the last bitmap
round (json
-int
)
3524 - "ram": only present
if "status" is
"active", it is a json
-object with the
3525 following RAM information
:
3526 - "transferred": amount transferred
in bytes (json
-int
)
3527 - "remaining": amount remaining to transfer
in bytes (json
-int
)
3528 - "total": total amount of memory
in bytes (json
-int
)
3529 - "duplicate": number of pages filled entirely with the same
3531 These are sent over the wire much more efficiently
.
3532 - "skipped": number of skipped zero
pages (json
-int
)
3533 - "normal" : number of whole pages transferred
. I
.e
. they
3534 were not sent as duplicate or xbzrle
pages (json
-int
)
3535 - "normal-bytes" : number of bytes transferred
in whole
3536 pages
. This is just normal pages times size of one page
,
3537 but
this way upper levels don
't need to care about page
3539 - "dirty-sync-count": times that dirty ram was synchronized (json-int)
3540 - "disk": only present if "status" is "active" and it is a block migration,
3541 it is a json-object with the following disk information:
3542 - "transferred": amount transferred in bytes (json-int)
3543 - "remaining": amount remaining to transfer in bytes json-int)
3544 - "total": total disk size in bytes (json-int)
3545 - "xbzrle-cache": only present if XBZRLE is active.
3546 It is a json-object with the following XBZRLE information:
3547 - "cache-size": XBZRLE cache size in bytes
3548 - "bytes": number of bytes transferred for XBZRLE compressed pages
3549 - "pages": number of XBZRLE compressed pages
3550 - "cache-miss": number of XBRZRLE page cache misses
3551 - "cache-miss-rate": rate of XBRZRLE page cache misses
3552 - "overflow": number of times XBZRLE overflows. This means
3553 that the XBZRLE encoding was bigger than just sent the
3554 whole page, and then we sent the whole page instead (as as
3559 1. Before the first migration
3561 -> { "execute": "query-migrate" }
3564 2. Migration is done and has succeeded
3566 -> { "execute": "query-migrate" }
3568 "status": "completed",
3578 "normal-bytes":123456,
3579 "dirty-sync-count":15
3584 3. Migration is done and has failed
3586 -> { "execute": "query-migrate" }
3587 <- { "return": { "status": "failed" } }
3589 4. Migration is being performed and is not a block migration:
3591 -> { "execute": "query-migrate" }
3601 "expected-downtime":12345,
3604 "normal-bytes":123456,
3605 "dirty-sync-count":15
3610 5. Migration is being performed and is a block migration:
3612 -> { "execute": "query-migrate" }
3618 "remaining":1053304,
3622 "expected-downtime":12345,
3625 "normal-bytes":123456,
3626 "dirty-sync-count":15
3630 "remaining":20880384,
3636 6. Migration is being performed and XBZRLE is active:
3638 -> { "execute": "query-migrate" }
3642 "capabilities" : [ { "capability": "xbzrle", "state" : true } ],
3645 "remaining":1053304,
3649 "expected-downtime":12345,
3652 "normal-bytes":3412992,
3653 "dirty-sync-count":15
3656 "cache-size":67108864,
3660 "cache-miss-rate":0.123,
3669 .name = "query-migrate",
3671 .mhandler.cmd_new = qmp_marshal_query_migrate,
3675 migrate-set-capabilities
3676 ------------------------
3678 Enable/Disable migration capabilities
3680 - "xbzrle": XBZRLE support
3681 - "rdma-pin-all": pin all pages when using RDMA during migration
3682 - "auto-converge": throttle down guest to help convergence of migration
3683 - "zero-blocks": compress zero blocks during block migration
3684 - "compress": use multiple compression threads to accelerate live migration
3685 - "events": generate events for each migration state change
3686 - "x-postcopy-ram": postcopy mode for live migration
3692 -> { "execute": "migrate-set-capabilities" , "arguments":
3693 { "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
3698 .name = "migrate-set-capabilities",
3699 .args_type = "capabilities:q",
3700 .params = "capability:s,state:b",
3701 .mhandler.cmd_new = qmp_marshal_migrate_set_capabilities,
3704 query-migrate-capabilities
3705 --------------------------
3707 Query current migration capabilities
3709 - "capabilities": migration capabilities state
3710 - "xbzrle" : XBZRLE state (json-bool)
3711 - "rdma-pin-all" : RDMA Pin Page state (json-bool)
3712 - "auto-converge" : Auto Converge state (json-bool)
3713 - "zero-blocks" : Zero Blocks state (json-bool)
3714 - "compress": Multiple compression threads state (json-bool)
3715 - "events": Migration state change event state (json-bool)
3716 - "x-postcopy-ram": postcopy ram state (json-bool)
3722 -> { "execute": "query-migrate-capabilities" }
3724 {"state": false, "capability": "xbzrle"},
3725 {"state": false, "capability": "rdma-pin-all"},
3726 {"state": false, "capability": "auto-converge"},
3727 {"state": false, "capability": "zero-blocks"},
3728 {"state": false, "capability": "compress"},
3729 {"state": true, "capability": "events"},
3730 {"state": false, "capability": "x-postcopy-ram"}
3736 .name = "query-migrate-capabilities",
3738 .mhandler.cmd_new = qmp_marshal_query_migrate_capabilities,
3742 migrate-set-parameters
3743 ----------------------
3745 Set migration parameters
3747 - "compress-level": set compression level during migration (json-int)
3748 - "compress-threads": set compression thread count for migration (json-int)
3749 - "decompress-threads": set decompression thread count for migration (json-int)
3750 - "x-cpu-throttle-initial": set initial percentage of time guest cpus are
3751 throttled for auto-converge (json-int)
3752 - "x-cpu-throttle-increment": set throttle increasing percentage for
3753 auto-converge (json-int)
3759 -> { "execute": "migrate-set-parameters" , "arguments":
3760 { "compress-level": 1 } }
3765 .name = "migrate-set-parameters",
3767 "compress-level:i?,compress-threads:i?,decompress-threads:i?,x-cpu-throttle-initial:i?,x-cpu-throttle-increment:i?",
3768 .mhandler.cmd_new = qmp_marshal_migrate_set_parameters,
3771 query-migrate-parameters
3772 ------------------------
3774 Query current migration parameters
3776 - "parameters": migration parameters value
3777 - "compress-level" : compression level value (json-int)
3778 - "compress-threads" : compression thread count value (json-int)
3779 - "decompress-threads" : decompression thread count value (json-int)
3780 - "x-cpu-throttle-initial" : initial percentage of time guest cpus are
3781 throttled (json-int)
3782 - "x-cpu-throttle-increment" : throttle increasing percentage for
3783 auto-converge (json-int)
3789 -> { "execute": "query-migrate-parameters" }
3792 "decompress-threads": 2,
3793 "x-cpu-throttle-increment": 10,
3794 "compress-threads": 8,
3795 "compress-level": 1,
3796 "x-cpu-throttle-initial": 20
3803 .name = "query-migrate-parameters",
3805 .mhandler.cmd_new = qmp_marshal_query_migrate_parameters,
3812 Show balloon information.
3814 Make an asynchronous request for balloon info. When the request completes a
3815 json-object will be returned containing the following data:
3817 - "actual": current balloon value in bytes (json-int)
3821 -> { "execute": "query-balloon" }
3824 "actual":1073741824,
3831 .name = "query-balloon",
3833 .mhandler.cmd_new = qmp_marshal_query_balloon,
3837 .name = "query-block-jobs",
3839 .mhandler.cmd_new = qmp_marshal_query_block_jobs,
3844 .args_type = "path:s",
3845 .mhandler.cmd_new = qmp_marshal_qom_list,
3850 .args_type = "path:s,property:s,value:q",
3851 .mhandler.cmd_new = qmp_marshal_qom_set,
3856 .args_type = "path:s,property:s",
3857 .mhandler.cmd_new = qmp_marshal_qom_get,
3861 .name = "nbd-server-start",
3862 .args_type = "addr:q,tls-creds:s?",
3863 .mhandler.cmd_new = qmp_marshal_nbd_server_start,
3866 .name = "nbd-server-add",
3867 .args_type = "device:B,writable:b?",
3868 .mhandler.cmd_new = qmp_marshal_nbd_server_add,
3871 .name = "nbd-server-stop",
3873 .mhandler.cmd_new = qmp_marshal_nbd_server_stop,
3877 .name = "change-vnc-password",
3878 .args_type = "password:s",
3879 .mhandler.cmd_new = qmp_marshal_change_vnc_password,
3882 .name = "qom-list-types",
3883 .args_type = "implements:s?,abstract:b?",
3884 .mhandler.cmd_new = qmp_marshal_qom_list_types,
3888 .name = "device-list-properties",
3889 .args_type = "typename:s",
3890 .mhandler.cmd_new = qmp_marshal_device_list_properties,
3894 .name = "query-machines",
3896 .mhandler.cmd_new = qmp_marshal_query_machines,
3900 .name = "query-cpu-definitions",
3902 .mhandler.cmd_new = qmp_marshal_query_cpu_definitions,
3906 .name = "query-target",
3908 .mhandler.cmd_new = qmp_marshal_query_target,
3912 .name = "query-tpm",
3914 .mhandler.cmd_new = qmp_marshal_query_tpm,
3921 Return information about the TPM device.
3927 -> { "execute": "query-tpm" }
3930 { "model": "tpm-tis",
3932 { "type": "passthrough",
3934 { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
3946 .name = "query-tpm-models",
3948 .mhandler.cmd_new = qmp_marshal_query_tpm_models,
3955 Return a list of supported TPM models.
3961 -> { "execute": "query-tpm-models" }
3962 <- { "return": [ "tpm-tis" ] }
3967 .name = "query-tpm-types",
3969 .mhandler.cmd_new = qmp_marshal_query_tpm_types,
3976 Return a list of supported TPM types.
3982 -> { "execute": "query-tpm-types" }
3983 <- { "return": [ "passthrough" ] }
3988 .name = "chardev-add",
3989 .args_type = "id:s,backend:q",
3990 .mhandler.cmd_new = qmp_marshal_chardev_add,
4001 - "id": the chardev's ID
, must be
unique (json
-string
)
4002 - "backend": chardev backend type
+ parameters
4006 -> { "execute" : "chardev-add",
4007 "arguments" : { "id" : "foo",
4008 "backend" : { "type" : "null", "data" : {} } } }
4011 -> { "execute" : "chardev-add",
4012 "arguments" : { "id" : "bar",
4013 "backend" : { "type" : "file",
4014 "data" : { "out" : "/tmp/bar.log" } } } }
4017 -> { "execute" : "chardev-add",
4018 "arguments" : { "id" : "baz",
4019 "backend" : { "type" : "pty", "data" : {} } } }
4020 <- { "return": { "pty" : "/dev/pty/42" } }
4025 .name
= "chardev-remove",
4026 .args_type
= "id:s",
4027 .mhandler
.cmd_new
= qmp_marshal_chardev_remove
,
4039 - "id": the chardev
's ID, must exist and not be in use (json-string)
4043 -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
4048 .name = "query-rx-filter",
4049 .args_type = "name:s?",
4050 .mhandler.cmd_new = qmp_marshal_query_rx_filter,
4057 Show rx-filter information.
4059 Returns a json-array of rx-filter information for all NICs (or for the
4060 given NIC), returning an error if the given NIC doesn't exist
, or
4061 given NIC doesn
't support rx-filter querying, or given net client
4064 The query will clear the event notification flag of each NIC
, then qemu
4065 will start to emit event to QMP monitor
.
4067 Each array entry contains the following
:
4069 - "name": net client
name (json
-string
)
4070 - "promiscuous": promiscuous mode is
enabled (json
-bool
)
4071 - "multicast": multicast receive
state (one of
'normal', 'none', 'all')
4072 - "unicast": unicast receive
state (one of
'normal', 'none', 'all')
4073 - "vlan": vlan receive
state (one of
'normal', 'none', 'all') (Since
2.0)
4074 - "broadcast-allowed": allow to receive
broadcast (json
-bool
)
4075 - "multicast-overflow": multicast table is
overflowed (json
-bool
)
4076 - "unicast-overflow": unicast table is
overflowed (json
-bool
)
4077 - "main-mac": main macaddr
string (json
-string
)
4078 - "vlan-table": a json
-array of active vlan id
4079 - "unicast-table": a json
-array of unicast macaddr string
4080 - "multicast-table": a json
-array of multicast macaddr string
4084 -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
4087 "promiscuous": true,
4089 "main-mac": "52:54:00:12:34:56",
4090 "unicast": "normal",
4098 "multicast": "normal",
4099 "multicast-overflow": false,
4100 "unicast-overflow": false,
4101 "multicast-table": [
4102 "01:00:5e:00:00:01",
4103 "33:33:00:00:00:01",
4106 "broadcast-allowed": false
4114 .name
= "blockdev-add",
4115 .args_type
= "options:q",
4116 .mhandler
.cmd_new
= qmp_marshal_blockdev_add
,
4125 This command is still a work
in progress
. It doesn
't support all
4126 block drivers among other things. Stay away from it unless you want
4127 to help with its development.
4131 - "options": block driver options
4135 -> { "execute": "blockdev-add",
4136 "arguments": { "options" : { "driver": "qcow2",
4137 "file": { "driver": "file",
4138 "filename": "test.qcow2" } } } }
4143 -> { "execute": "blockdev-add",
4155 "filename": "/tmp/test.qcow2"
4161 "filename": "/dev/fdset/4"
4173 .name = "x-blockdev-del",
4174 .args_type = "id:s?,node-name:s?",
4175 .mhandler.cmd_new = qmp_marshal_x_blockdev_del,
4183 Deletes a block device thas has been added using blockdev-add.
4184 The selected device can be either a block backend or a graph node.
4186 In the former case the backend will be destroyed, along with its
4187 inserted medium if there's any
. The command will fail
if the backend
4188 or its medium are
in use
.
4190 In the latter
case the node will be destroyed
. The command will fail
4191 if the node is attached to a block backend or is otherwise being
4194 One of
"id" or
"node-name" must be specified
, but not both
.
4196 This command is still a work
in progress and is considered
4197 experimental
. Stay away from it unless you want to help with its
4202 - "id": Name of the block backend device to
delete (json
-string
, optional
)
4203 - "node-name": Name of the graph node to
delete (json
-string
, optional
)
4207 -> { "execute": "blockdev-add",
4214 "filename": "test.qcow2"
4222 -> { "execute": "x-blockdev-del",
4223 "arguments": { "id": "drive0" }
4230 .name
= "blockdev-open-tray",
4231 .args_type
= "device:s,force:b?",
4232 .mhandler
.cmd_new
= qmp_marshal_blockdev_open_tray
,
4239 Opens a block device
's tray. If there is a block driver state tree inserted as a
4240 medium, it will become inaccessible to the guest (but it will remain associated
4241 to the block device, so closing the tray will make it accessible again).
4243 If the tray was already open before, this will be a no-op.
4245 Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
4246 which no such event will be generated, these include:
4247 - if the guest has locked the tray, @force is false and the guest does not
4248 respond to the eject request
4249 - if the BlockBackend denoted by @device does not have a guest device attached
4251 - if the guest device does not have an actual tray and is empty, for instance
4252 for floppy disk drives
4256 - "device": block device name (json-string)
4257 - "force": if false (the default), an eject request will be sent to the guest if
4258 it has locked the tray (and the tray will not be opened immediately);
4259 if true, the tray will be opened regardless of whether it is locked
4260 (json-bool, optional)
4264 -> { "execute": "blockdev-open-tray",
4265 "arguments": { "device": "ide1-cd0" } }
4267 <- { "timestamp": { "seconds": 1418751016,
4268 "microseconds": 716996 },
4269 "event": "DEVICE_TRAY_MOVED",
4270 "data": { "device": "ide1-cd0",
4271 "tray-open": true } }
4278 .name = "blockdev-close-tray",
4279 .args_type = "device:s",
4280 .mhandler.cmd_new = qmp_marshal_blockdev_close_tray,
4287 Closes a block device's tray
. If there is a block driver state tree associated
4288 with the block
device (which is currently ejected
), that tree will be loaded as
4291 If the tray was already closed before
, this will be a no
-op
.
4295 - "device": block device
name (json
-string
)
4299 -> { "execute": "blockdev-close-tray",
4300 "arguments": { "device": "ide1-cd0" } }
4302 <- { "timestamp": { "seconds": 1418751345,
4303 "microseconds": 272147 },
4304 "event": "DEVICE_TRAY_MOVED",
4305 "data": { "device": "ide1-cd0",
4306 "tray-open": false } }
4313 .name
= "x-blockdev-remove-medium",
4314 .args_type
= "device:s",
4315 .mhandler
.cmd_new
= qmp_marshal_x_blockdev_remove_medium
,
4319 x
-blockdev
-remove
-medium
4320 ------------------------
4322 Removes a
medium (a block driver state tree
) from a block device
. That block
4323 device
's tray must currently be open (unless there is no attached guest device).
4325 If the tray is open and there is no medium inserted, this will be a no-op.
4327 This command is still a work in progress and is considered experimental.
4328 Stay away from it unless you want to help with its development.
4332 - "device": block device name (json-string)
4336 -> { "execute": "x-blockdev-remove-medium",
4337 "arguments": { "device": "ide1-cd0" } }
4339 <- { "error": { "class": "GenericError",
4340 "desc": "Tray of device 'ide1
-cd0
' is not open" } }
4342 -> { "execute": "blockdev-open-tray",
4343 "arguments": { "device": "ide1-cd0" } }
4345 <- { "timestamp": { "seconds": 1418751627,
4346 "microseconds": 549958 },
4347 "event": "DEVICE_TRAY_MOVED",
4348 "data": { "device": "ide1-cd0",
4349 "tray-open": true } }
4353 -> { "execute": "x-blockdev-remove-medium",
4354 "arguments": { "device": "ide1-cd0" } }
4361 .name = "x-blockdev-insert-medium",
4362 .args_type = "device:s,node-name:s",
4363 .mhandler.cmd_new = qmp_marshal_x_blockdev_insert_medium,
4367 x-blockdev-insert-medium
4368 ------------------------
4370 Inserts a medium (a block driver state tree) into a block device. That block
4371 device's tray must currently be
open (unless there is no attached guest device
)
4372 and there must be no medium inserted already
.
4374 This command is still a work
in progress and is considered experimental
.
4375 Stay away from it unless you want to help with its development
.
4379 - "device": block device
name (json
-string
)
4380 - "node-name": root node of the BDS tree to insert into the block device
4384 -> { "execute": "blockdev-add",
4385 "arguments": { "options": { "node-name": "node0",
4387 "file": { "driver": "file",
4388 "filename": "fedora.iso" } } } }
4392 -> { "execute": "x-blockdev-insert-medium",
4393 "arguments": { "device": "ide1-cd0",
4394 "node-name": "node0" } }
4401 .name
= "query-named-block-nodes",
4403 .mhandler
.cmd_new
= qmp_marshal_query_named_block_nodes
,
4407 @query
-named
-block
-nodes
4408 ------------------------
4410 Return a list of BlockDeviceInfo
for all the named block driver nodes
4414 -> { "execute": "query-named-block-nodes" }
4415 <- { "return": [ { "ro":false,
4418 "file":"disks/test.qcow2",
4419 "node-name": "my-node",
4420 "backing_file_depth":1,
4434 "write_threshold": 0,
4436 "filename":"disks/test.qcow2",
4438 "virtual-size":2048000,
4439 "backing_file":"base.qcow2",
4440 "full-backing-filename":"disks/base.qcow2",
4441 "backing-filename-format":"qcow2",
4445 "name": "snapshot1",
4447 "date-sec": 10000200,
4449 "vm-clock-sec": 206,
4454 "filename":"disks/base.qcow2",
4456 "virtual-size":2048000
4463 .name
= "blockdev-change-medium",
4464 .args_type
= "device:B,filename:F,format:s?,read-only-mode:s?",
4465 .mhandler
.cmd_new
= qmp_marshal_blockdev_change_medium
,
4469 blockdev
-change
-medium
4470 ----------------------
4472 Changes the medium inserted into a block device by ejecting the current medium
4473 and loading a
new image file which is inserted as the
new medium
.
4477 - "device": device
name (json
-string
)
4478 - "filename": filename of the
new image (json
-string
)
4479 - "format": format of the
new image (json
-string
, optional
)
4480 - "read-only-mode": new read
-only
mode (json
-string
, optional
)
4481 - Possible values
: "retain" (default), "read-only", "read-write"
4485 1. Change a removable medium
4487 -> { "execute": "blockdev-change-medium",
4488 "arguments": { "device": "ide1-cd0",
4489 "filename": "/srv/images/Fedora-12-x86_64-DVD.iso",
4493 2. Load a read
-only medium into a writable drive
4495 -> { "execute": "blockdev-change-medium",
4496 "arguments": { "device": "isa-fd0",
4497 "filename": "/srv/images/ro.img",
4499 "read-only-mode": "retain" } }
4502 { "class": "GenericError",
4503 "desc": "Could not open '/srv/images/ro.img': Permission denied" } }
4505 -> { "execute": "blockdev-change-medium",
4506 "arguments": { "device": "isa-fd0",
4507 "filename": "/srv/images/ro.img",
4509 "read-only-mode": "read-only" } }
4516 .name
= "query-memdev",
4518 .mhandler
.cmd_new
= qmp_marshal_query_memdev
,
4525 Show memory devices information
.
4530 -> { "execute": "query-memdev" }
4537 "host-nodes": [0, 1],
4545 "host-nodes": [2, 3],
4546 "policy": "preferred"
4554 .name
= "query-memory-devices",
4556 .mhandler
.cmd_new
= qmp_marshal_query_memory_devices
,
4560 @query
-memory
-devices
4561 --------------------
4563 Return a list of memory devices
.
4566 -> { "execute": "query-memory-devices" }
4567 <- { "return": [ { "data":
4568 { "addr": 5368709120,
4569 "hotpluggable": true,
4572 "memdev": "/objects/memX",
4581 .name
= "query-acpi-ospm-status",
4583 .mhandler
.cmd_new
= qmp_marshal_query_acpi_ospm_status
,
4587 @query
-acpi
-ospm
-status
4588 --------------------
4590 Return list of ACPIOSTInfo
for devices that support status reporting
4591 via ACPI _OST method
.
4594 -> { "execute": "query-acpi-ospm-status" }
4595 <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
4596 { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
4597 { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
4598 { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
4602 #
if defined TARGET_I386
4604 .name
= "rtc-reset-reinjection",
4606 .mhandler
.cmd_new
= qmp_marshal_rtc_reset_reinjection
,
4611 rtc
-reset
-reinjection
4612 ---------------------
4614 Reset the RTC interrupt reinjection backlog
.
4620 -> { "execute": "rtc-reset-reinjection" }
4625 .name
= "trace-event-get-state",
4626 .args_type
= "name:s",
4627 .mhandler
.cmd_new
= qmp_marshal_trace_event_get_state
,
4631 trace-event
-get
-state
4632 ---------------------
4634 Query the state of events
.
4638 -> { "execute": "trace-event-get-state", "arguments": { "name": "qemu_memalign" } }
4639 <- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
4643 .name
= "trace-event-set-state",
4644 .args_type
= "name:s,enable:b,ignore-unavailable:b?",
4645 .mhandler
.cmd_new
= qmp_marshal_trace_event_set_state
,
4649 trace-event
-set
-state
4650 ---------------------
4652 Set the state of events
.
4656 -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } }
4661 .name
= "x-input-send-event",
4662 .args_type
= "console:i?,events:q",
4663 .mhandler
.cmd_new
= qmp_marshal_x_input_send_event
,
4670 Send input event to guest
.
4674 - "device": display
device (json
-string
, optional
)
4675 - "head": display
head (json
-int
, optional
)
4676 - "events": list of input events
4678 The consoles are visible
in the qom tree
, under
4679 /backend
/console
[$index
]. They have a device link and head property
, so
4680 it is possible to map which console belongs to which device and display
.
4682 Note
: this command is experimental
, and not a stable API
.
4686 Press left mouse button
.
4688 -> { "execute": "x-input-send-event",
4689 "arguments": { "device": "video0",
4690 "events": [ { "type": "btn",
4691 "data" : { "down": true, "button": "Left" } } ] } }
4694 -> { "execute": "x-input-send-event",
4695 "arguments": { "device": "video0",
4696 "events": [ { "type": "btn",
4697 "data" : { "down": false, "button": "Left" } } ] } }
4704 -> { "execute": "x-input-send-event",
4705 "arguments": { "events": [
4706 { "type": "key", "data" : { "down": true,
4707 "key": {"type": "qcode", "data": "ctrl" } } },
4708 { "type": "key", "data" : { "down": true,
4709 "key": {"type": "qcode", "data": "alt" } } },
4710 { "type": "key", "data" : { "down": true,
4711 "key": {"type": "qcode", "data": "delete" } } } ] } }
4716 Move mouse pointer to absolute
coordinates (20000, 400).
4718 -> { "execute": "x-input-send-event" ,
4719 "arguments": { "events": [
4720 { "type": "abs", "data" : { "axis": "X", "value" : 20000 } },
4721 { "type": "abs", "data" : { "axis": "Y", "value" : 400 } } ] } }
4727 .name
= "block-set-write-threshold",
4728 .args_type
= "node-name:s,write-threshold:l",
4729 .mhandler
.cmd_new
= qmp_marshal_block_set_write_threshold
,
4733 block
-set
-write
-threshold
4736 Change the write threshold
for a block drive
. The threshold is an offset
,
4737 thus must be non
-negative
. Default is no write threshold
.
4738 Setting the threshold to zero disables it
.
4742 - "node-name": the node name
in the block driver state
graph (json
-string
)
4743 - "write-threshold": the write threshold
in bytes (json
-int
)
4747 -> { "execute": "block-set-write-threshold",
4748 "arguments": { "node-name": "mydev",
4749 "write-threshold": 17179869184 } }
4755 .name
= "query-rocker",
4756 .args_type
= "name:s",
4757 .mhandler
.cmd_new
= qmp_marshal_query_rocker
,
4766 - "name": switch name
4770 -> { "execute": "query-rocker", "arguments": { "name": "sw1" } }
4771 <- { "return": {"name": "sw1", "ports": 2, "id": 1327446905938}}
4776 .name
= "query-rocker-ports",
4777 .args_type
= "name:s",
4778 .mhandler
.cmd_new
= qmp_marshal_query_rocker_ports
,
4782 Show rocker
switch ports
4783 ------------------------
4787 - "name": switch name
4791 -> { "execute": "query-rocker-ports", "arguments": { "name": "sw1" } }
4792 <- { "return": [ {"duplex": "full", "enabled": true, "name": "sw1.1",
4793 "autoneg": "off", "link-up": true, "speed": 10000},
4794 {"duplex": "full", "enabled": true, "name": "sw1.2",
4795 "autoneg": "off", "link-up": true, "speed": 10000}
4801 .name
= "query-rocker-of-dpa-flows",
4802 .args_type
= "name:s,tbl-id:i?",
4803 .mhandler
.cmd_new
= qmp_marshal_query_rocker_of_dpa_flows
,
4807 Show rocker
switch OF
-DPA flow tables
4808 -------------------------------------
4812 - "name": switch name
4813 - "tbl-id": (optional
) flow table ID
4817 -> { "execute": "query-rocker-of-dpa-flows", "arguments": { "name": "sw1" } }
4818 <- { "return": [ {"key": {"in-pport": 0, "priority": 1, "tbl-id": 0},
4821 "action": {"goto-tbl": 10},
4822 "mask": {"in-pport": 4294901760}
4830 .name
= "query-rocker-of-dpa-groups",
4831 .args_type
= "name:s,type:i?",
4832 .mhandler
.cmd_new
= qmp_marshal_query_rocker_of_dpa_groups
,
4836 Show rocker OF
-DPA group tables
4837 -------------------------------
4841 - "name": switch name
4842 - "type": (optional
) group type
4846 -> { "execute": "query-rocker-of-dpa-groups", "arguments": { "name": "sw1" } }
4847 <- { "return": [ {"type": 0, "out-pport": 2, "pport": 2, "vlan-id": 3841,
4848 "pop-vlan": 1, "id": 251723778},
4849 {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3841,
4850 "pop-vlan": 1, "id": 251723776},
4851 {"type": 0, "out-pport": 1, "pport": 1, "vlan-id": 3840,
4852 "pop-vlan": 1, "id": 251658241},
4853 {"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3840,
4854 "pop-vlan": 1, "id": 251658240}