4 This document describes all commands currently supported by QMP.
6 Most of the time their usage is exactly the same as in the user Monitor, this
7 means that any other document which also describe commands (the manpage,
8 QEMU's manual, etc) can and should be consulted.
10 QMP has two types of commands: regular and query commands. Regular commands
11 usually change the Virtual Machine's state someway, while query commands just
12 return information. The sections below are divided accordingly.
14 It's important to observe that all communication examples are formatted in
15 a reader-friendly way, so that they're easier to understand. However, in real
16 protocol usage, they're emitted as a single line.
18 Also, the following notation is used to denote data flow:
20 -> data issued by the Client
21 <- Server data response
23 Please, refer to the QMP specification (docs/qmp-spec.txt) for detailed
24 information on the Server command and response formats.
26 NOTE: This document is temporary and will be replaced soon.
28 1. Stability Considerations
29 ===========================
31 The current QMP command set (described in this file) may be useful for a
32 number of use cases, however it's limited and several commands have bad
33 defined semantics, specially with regard to command completion.
35 These problems are going to be solved incrementally in the next QEMU releases
36 and we're going to establish a deprecation policy for badly defined commands.
38 If you're planning to adopt QMP, please observe the following:
40 1. The deprecation policy will take effect and be documented soon, please
41 check the documentation of each used command as soon as a new release of
44 2. DO NOT rely on anything which is not explicit documented
46 3. Errors, in special, are not documented. Applications should NOT check
47 for specific errors classes or data (it's strongly recommended to only
48 check for the "error" key)
53 Server's responses in the examples below are always a success response, please
54 refer to the QMP specification for more details on error responses.
63 - "driver": the name of the new device's driver (json-string)
64 - "bus": the device's parent bus (device tree path, json-string, optional)
65 - "id": the device's ID, must be unique (json-string)
70 -> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
75 (1) For detailed information about this command, please refer to the
76 'docs/qdev-device-use.txt' file.
78 (2) It's possible to list device properties by running QEMU with the
79 "-device DEVICE,\?" command-line argument, where DEVICE is the device's name
88 - "index": the CPU's index (json-int)
92 -> { "execute": "cpu", "arguments": { "index": 0 } }
95 Note: CPUs' indexes are obtained with the 'query-cpus' command.
97 xen-load-devices-state
98 ----------------------
100 Load the state of all devices from file. The RAM and the block devices
101 of the VM are not loaded by this command.
105 - "filename": the file to load the state of the devices from as binary
106 data. See xen-save-devices-state.txt for a description of the binary
111 -> { "execute": "xen-load-devices-state",
112 "arguments": { "filename": "/tmp/resume" } }
115 migrate-set-cache-size
116 ----------------------
118 Set cache size to be used by XBZRLE migration, the cache size will be rounded
119 down to the nearest power of 2
123 - "value": cache size in bytes (json-int)
127 -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
130 x-colo-lost-heartbeat
133 Tell COLO that heartbeat is lost, a failover or takeover is needed.
137 -> { "execute": "x-colo-lost-heartbeat" }
143 Query background dump status.
149 -> { "execute": "query-dump" }
150 <- { "return": { "status": "active", "completed": 1024000,
156 Start mirroring a block device's writes to another block device. target
157 specifies the target of mirror operation.
161 - "job-id": Identifier for the newly-created block job. If omitted,
162 the device name will be used. (json-string, optional)
163 - "device": The device name or node-name of a root node whose writes should be
164 mirrored (json-string)
165 - "target": device name to mirror to (json-string)
166 - "replaces": the block driver node name to replace when finished
167 (json-string, optional)
168 - "speed": maximum speed of the streaming job, in bytes per second
170 - "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
171 - "buf_size": maximum amount of data in flight from source to target, in bytes
172 (json-int, default 10M)
173 - "sync": what parts of the disk image should be copied to the destination;
174 possibilities include "full" for all the disk, "top" for only the sectors
175 allocated in the topmost image, or "none" to only replicate new I/O
177 - "on-source-error": the action to take on an error on the source
178 (BlockdevOnError, default 'report')
179 - "on-target-error": the action to take on an error on the target
180 (BlockdevOnError, default 'report')
182 The default value of the granularity is the image cluster size clamped
183 between 4096 and 65536, if the image format defines one. If the format
184 does not define a cluster size, the default value of the granularity
189 -> { "execute": "blockdev-mirror", "arguments": { "device": "ide-hd0",
197 Enable QMP capabilities.
203 -> { "execute": "qmp_capabilities" }
206 Note: This command must be issued before issuing any other command.
215 Return the QMP wire schema. The returned value is a json-array of
216 named schema entities. Entities are commands, events and various
217 types. See docs/qapi-code-gen.txt for information on their structure
223 Dynamically reconfigure the block driver state graph. It can be used
224 to add, remove, insert or replace a graph node. Currently only the
225 Quorum driver implements this feature to add or remove its child. This
226 is useful to fix a broken quorum child.
228 If @node is specified, it will be inserted under @parent. @child
229 may not be specified in this case. If both @parent and @child are
230 specified but @node is not, @child will be detached from @parent.
233 - "parent": the id or name of the parent node (json-string)
234 - "child": the name of a child under the given parent node (json-string, optional)
235 - "node": the name of the node that will be added (json-string, optional)
237 Note: this command is experimental, and not a stable API. It doesn't
238 support all kinds of operations, all kinds of children, nor all block
241 Warning: The data in a new quorum child MUST be consistent with that of
242 the rest of the array.
246 Add a new node to a quorum
247 -> { "execute": "blockdev-add",
248 "arguments": { "driver": "raw",
249 "node-name": "new_node",
250 "file": { "driver": "file",
251 "filename": "test.raw" } } }
253 -> { "execute": "x-blockdev-change",
254 "arguments": { "parent": "disk1",
255 "node": "new_node" } }
258 Delete a quorum's node
259 -> { "execute": "x-blockdev-change",
260 "arguments": { "parent": "disk1",
261 "child": "children.1" } }
264 query-gic-capabilities
267 Return a list of GICCapability objects, describing supported GIC
268 (Generic Interrupt Controller) versions.
274 -> { "execute": "query-gic-capabilities" }
275 <- { "return": [{ "version": 2, "emulated": true, "kernel": false },
276 { "version": 3, "emulated": false, "kernel": true } ] }