OpenE2K/qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity
b953601be0
qemu-e2k/docs/qmp-commands.txt
Marc-André Lureau b953601be0 qmp-commands: move 'query-migrate-cache-size' doc to schema 
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2017-01-16 09:15:28 +01:00

2480 lines
78 KiB
Plaintext
Raw Blame History

QMP Supported Commands
----------------------
This document describes all commands currently supported by QMP.
Most of the time their usage is exactly the same as in the user Monitor, this
means that any other document which also describe commands (the manpage,
QEMU's manual, etc) can and should be consulted.
QMP has two types of commands: regular and query commands. Regular commands
usually change the Virtual Machine's state someway, while query commands just
return information. The sections below are divided accordingly.
It's important to observe that all communication examples are formatted in
a reader-friendly way, so that they're easier to understand. However, in real
protocol usage, they're emitted as a single line.
Also, the following notation is used to denote data flow:
-> data issued by the Client
<- Server data response
Please, refer to the QMP specification (docs/qmp-spec.txt) for detailed
information on the Server command and response formats.
NOTE: This document is temporary and will be replaced soon.
1. Stability Considerations
===========================
The current QMP command set (described in this file) may be useful for a
number of use cases, however it's limited and several commands have bad
defined semantics, specially with regard to command completion.
These problems are going to be solved incrementally in the next QEMU releases
and we're going to establish a deprecation policy for badly defined commands.
If you're planning to adopt QMP, please observe the following:
1. The deprecation policy will take effect and be documented soon, please
check the documentation of each used command as soon as a new release of
QEMU is available
2. DO NOT rely on anything which is not explicit documented
3. Errors, in special, are not documented. Applications should NOT check
for specific errors classes or data (it's strongly recommended to only
check for the "error" key)
2. Regular Commands
===================
Server's responses in the examples below are always a success response, please
refer to the QMP specification for more details on error responses.
eject
-----
Eject a removable medium.
Arguments:
- "force": force ejection (json-bool, optional)
- "device": block device name (deprecated, use @id instead)
(json-string, optional)
- "id": the name or QOM path of the guest device (json-string, optional)
Example:
-> { "execute": "eject", "arguments": { "id": "ide0-1-0" } }
<- { "return": {} }
Note: The "force" argument defaults to false.
change
------
Change a removable medium or VNC configuration.
Arguments:
- "device": device name (json-string)
- "target": filename or item (json-string)
- "arg": additional argument (json-string, optional)
Examples:
1. Change a removable medium
-> { "execute": "change",
"arguments": { "device": "ide1-cd0",
"target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
<- { "return": {} }
2. Change VNC password
-> { "execute": "change",
"arguments": { "device": "vnc", "target": "password",
"arg": "foobar1" } }
<- { "return": {} }
screendump
----------
Save screen into PPM image.
Arguments:
- "filename": file path (json-string)
Example:
-> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
<- { "return": {} }
device_add
----------
Add a device.
Arguments:
- "driver": the name of the new device's driver (json-string)
- "bus": the device's parent bus (device tree path, json-string, optional)
- "id": the device's ID, must be unique (json-string)
- device properties
Example:
-> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
<- { "return": {} }
Notes:
(1) For detailed information about this command, please refer to the
'docs/qdev-device-use.txt' file.
(2) It's possible to list device properties by running QEMU with the
"-device DEVICE,\?" command-line argument, where DEVICE is the device's name
device_del
----------
Remove a device.
Arguments:
- "id": the device's ID or QOM path (json-string)
Example:
-> { "execute": "device_del", "arguments": { "id": "net1" } }
<- { "return": {} }
Example:
-> { "execute": "device_del", "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
<- { "return": {} }
send-key
----------
Send keys to VM.
Arguments:
keys array:
- "key": key sequence (a json-array of key union values,
union can be number or qcode enum)
- hold-time: time to delay key up events, milliseconds. Defaults to 100
(json-int, optional)
Example:
-> { "execute": "send-key",
"arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
{ "type": "qcode", "data": "alt" },
{ "type": "qcode", "data": "delete" } ] } }
<- { "return": {} }
cpu
---
Set the default CPU.
Arguments:
- "index": the CPU's index (json-int)
Example:
-> { "execute": "cpu", "arguments": { "index": 0 } }
<- { "return": {} }
Note: CPUs' indexes are obtained with the 'query-cpus' command.
xen-save-devices-state
-------
Save the state of all devices to file. The RAM and the block devices
of the VM are not saved by this command.
Arguments:
- "filename": the file to save the state of the devices to as binary
data. See xen-save-devices-state.txt for a description of the binary
format.
Example:
-> { "execute": "xen-save-devices-state",
"arguments": { "filename": "/tmp/save" } }
<- { "return": {} }
xen-load-devices-state
----------------------
Load the state of all devices from file. The RAM and the block devices
of the VM are not loaded by this command.
Arguments:
- "filename": the file to load the state of the devices from as binary
data. See xen-save-devices-state.txt for a description of the binary
format.
Example:
-> { "execute": "xen-load-devices-state",
"arguments": { "filename": "/tmp/resume" } }
<- { "return": {} }
xen-set-global-dirty-log
-------
Enable or disable the global dirty log mode.
Arguments:
- "enable": Enable it or disable it.
Example:
-> { "execute": "xen-set-global-dirty-log",
"arguments": { "enable": true } }
<- { "return": {} }
migrate
-------
Migrate to URI.
Arguments:
- "blk": block migration, full disk copy (json-bool, optional)
- "inc": incremental disk copy (json-bool, optional)
- "uri": Destination URI (json-string)
Example:
-> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
<- { "return": {} }
Notes:
(1) The 'query-migrate' command should be used to check migration's progress
and final result (this information is provided by the 'status' member)
(2) All boolean arguments default to false
(3) The user Monitor's "detach" argument is invalid in QMP and should not
be used
migrate-incoming
----------------
Continue an incoming migration
Arguments:
- "uri": Source/listening URI (json-string)
Example:
-> { "execute": "migrate-incoming", "arguments": { "uri": "tcp::4446" } }
<- { "return": {} }
Notes:
(1) QEMU must be started with -incoming defer to allow migrate-incoming to
be used
(2) The uri format is the same as for -incoming
migrate-set-cache-size
----------------------
Set cache size to be used by XBZRLE migration, the cache size will be rounded
down to the nearest power of 2
Arguments:
- "value": cache size in bytes (json-int)
Example:
-> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
<- { "return": {} }
x-colo-lost-heartbeat
--------------------
Tell COLO that heartbeat is lost, a failover or takeover is needed.
Example:
-> { "execute": "x-colo-lost-heartbeat" }
<- { "return": {} }
dump
Dump guest memory to file. The file can be processed with crash or gdb.
Arguments:
- "paging": do paging to get guest's memory mapping (json-bool)
- "protocol": destination file(started with "file:") or destination file
descriptor (started with "fd:") (json-string)
- "detach": if specified, command will return immediately, without waiting
for the dump to finish. The user can track progress using
"query-dump". (json-bool)
- "begin": the starting physical address. It's optional, and should be specified
with length together (json-int)
- "length": the memory size, in bytes. It's optional, and should be specified
with begin together (json-int)
- "format": the format of guest memory dump. It's optional, and can be
elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
conflict with paging and filter, ie. begin and length (json-string)
Example:
-> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
<- { "return": {} }
Notes:
(1) All boolean arguments default to false
query-dump-guest-memory-capability
----------
Show available formats for 'dump-guest-memory'
Example:
-> { "execute": "query-dump-guest-memory-capability" }
<- { "return": { "formats":
["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
query-dump
----------
Query background dump status.
Arguments: None.
Example:
-> { "execute": "query-dump" }
<- { "return": { "status": "active", "completed": 1024000,
"total": 2048000 } }
dump-skeys
----------
Save guest storage keys to file.
Arguments:
- "filename": file path (json-string)
Example:
-> { "execute": "dump-skeys", "arguments": { "filename": "/tmp/skeys" } }
<- { "return": {} }
netdev_add
----------
Add host network device.
Arguments:
- "type": the device type, "tap", "user", ... (json-string)
- "id": the device's ID, must be unique (json-string)
- device options
Example:
-> { "execute": "netdev_add",
"arguments": { "type": "user", "id": "netdev1",
"dnssearch": "example.org" } }
<- { "return": {} }
Note: The supported device options are the same ones supported by the '-netdev'
command-line argument, which are listed in the '-help' output or QEMU's
manual
netdev_del
----------
Remove host network device.
Arguments:
- "id": the device's ID, must be unique (json-string)
Example:
-> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
<- { "return": {} }
object-add
----------
Create QOM object.
Arguments:
- "qom-type": the object's QOM type, i.e. the class name (json-string)
- "id": the object's ID, must be unique (json-string)
- "props": a dictionary of object property values (optional, json-dict)
Example:
-> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
"props": { "filename": "/dev/hwrng" } } }
<- { "return": {} }
object-del
----------
Remove QOM object.
Arguments:
- "id": the object's ID (json-string)
Example:
-> { "execute": "object-del", "arguments": { "id": "rng1" } }
<- { "return": {} }
block_resize
------------
Resize a block image while a guest is running.
Arguments:
- "device": the device's ID, must be unique (json-string)
- "node-name": the node name in the block driver state graph (json-string)
- "size": new size
Example:
-> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
<- { "return": {} }
block-stream
------------
Copy data from a backing file into a block device.
Arguments:
- "job-id": Identifier for the newly-created block job. If omitted,
the device name will be used. (json-string, optional)
- "device": The device name or node-name of a root node (json-string)
- "base": The file name of the backing image above which copying starts.
It cannot be set if 'base-node' is also set (json-string, optional)
- "base-node": the node name of the backing image above which copying starts.
It cannot be set if 'base' is also set.
(json-string, optional) (Since 2.8)
- "backing-file": The backing file string to write into the active layer. This
filename is not validated.
If a pathname string is such that it cannot be resolved by
QEMU, that means that subsequent QMP or HMP commands must use
node-names for the image in question, as filename lookup
methods will fail.
If not specified, QEMU will automatically determine the
backing file string to use, or error out if there is no
obvious choice. Care should be taken when specifying the
string, to specify a valid filename or protocol.
(json-string, optional) (Since 2.1)
- "speed": the maximum speed, in bytes per second (json-int, optional)
- "on-error": the action to take on an error (default 'report'). 'stop' and
'enospc' can only be used if the block device supports io-status.
(json-string, optional) (Since 2.1)
Example:
-> { "execute": "block-stream", "arguments": { "device": "virtio0",
"base": "/tmp/master.qcow2" } }
<- { "return": {} }
block-commit
------------
Live commit of data from overlay image nodes into backing nodes - i.e., writes
data between 'top' and 'base' into 'base'.
Arguments:
- "job-id": Identifier for the newly-created block job. If omitted,
the device name will be used. (json-string, optional)
- "device": The device name or node-name of a root node (json-string)
- "base": The file name of the backing image to write data into.
If not specified, this is the deepest backing image
(json-string, optional)
- "top": The file name of the backing image within the image chain,
which contains the topmost data to be committed down. If
not specified, this is the active layer. (json-string, optional)
- backing-file: The backing file string to write into the overlay
image of 'top'. If 'top' is the active layer,
specifying a backing file string is an error. This
filename is not validated.
If a pathname string is such that it cannot be
resolved by QEMU, that means that subsequent QMP or
HMP commands must use node-names for the image in
question, as filename lookup methods will fail.
If not specified, QEMU will automatically determine
the backing file string to use, or error out if
there is no obvious choice. Care should be taken
when specifying the string, to specify a valid
filename or protocol.
(json-string, optional) (Since 2.1)
If top == base, that is an error.
If top == active, the job will not be completed by itself,
user needs to complete the job with the block-job-complete
command after getting the ready event. (Since 2.0)
If the base image is smaller than top, then the base image
will be resized to be the same size as top. If top is
smaller than the base image, the base will not be
truncated. If you want the base image size to match the
size of the smaller top, you can safely truncate it
yourself once the commit operation successfully completes.
(json-string)
- "speed": the maximum speed, in bytes per second (json-int, optional)
Example:
-> { "execute": "block-commit", "arguments": { "device": "virtio0",
"top": "/tmp/snap1.qcow2" } }
<- { "return": {} }
drive-backup
------------
Start a point-in-time copy of a block device to a new destination. The
status of ongoing drive-backup operations can be checked with
query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
The operation can be stopped before it has completed using the
block-job-cancel command.
Arguments:
- "job-id": Identifier for the newly-created block job. If omitted,
the device name will be used. (json-string, optional)
- "device": the device name or node-name of a root node which should be copied.
(json-string)
- "target": the target of the new image. If the file exists, or if it is a
device, the existing file/device will be used as the new
destination. If it does not exist, a new file will be created.
(json-string)
- "format": the format of the new destination, default is to probe if 'mode' is
'existing', else the format of the source
(json-string, optional)
- "sync": what parts of the disk image should be copied to the destination;
possibilities include "full" for all the disk, "top" for only the sectors
allocated in the topmost image, "incremental" for only the dirty sectors in
the bitmap, or "none" to only replicate new I/O (MirrorSyncMode).
- "bitmap": dirty bitmap name for sync==incremental. Must be present if sync
is "incremental", must NOT be present otherwise.
- "mode": whether and how QEMU should create a new image
(NewImageMode, optional, default 'absolute-paths')
- "speed": the maximum speed, in bytes per second (json-int, optional)
- "compress": true to compress data, if the target format supports it.
(json-bool, optional, default false)
- "on-source-error": the action to take on an error on the source, default
'report'. 'stop' and 'enospc' can only be used
if the block device supports io-status.
(BlockdevOnError, optional)
- "on-target-error": the action to take on an error on the target, default
'report' (no limitations, since this applies to
a different block device than device).
(BlockdevOnError, optional)
Example:
-> { "execute": "drive-backup", "arguments": { "device": "drive0",
"sync": "full",
"target": "backup.img" } }
<- { "return": {} }
blockdev-backup
---------------
The device version of drive-backup: this command takes an existing named device
as backup target.
Arguments:
- "job-id": Identifier for the newly-created block job. If omitted,
the device name will be used. (json-string, optional)
- "device": the device name or node-name of a root node which should be copied.
(json-string)
- "target": the name of the backup target device. (json-string)
- "sync": what parts of the disk image should be copied to the destination;
possibilities include "full" for all the disk, "top" for only the
sectors allocated in the topmost image, or "none" to only replicate
new I/O (MirrorSyncMode).
- "speed": the maximum speed, in bytes per second (json-int, optional)
- "compress": true to compress data, if the target format supports it.
(json-bool, optional, default false)
- "on-source-error": the action to take on an error on the source, default
'report'. 'stop' and 'enospc' can only be used
if the block device supports io-status.
(BlockdevOnError, optional)
- "on-target-error": the action to take on an error on the target, default
'report' (no limitations, since this applies to
a different block device than device).
(BlockdevOnError, optional)
Example:
-> { "execute": "blockdev-backup", "arguments": { "device": "src-id",
"sync": "full",
"target": "tgt-id" } }
<- { "return": {} }
block-dirty-bitmap-add
----------------------
Since 2.4
Create a dirty bitmap with a name on the device, and start tracking the writes.
Arguments:
- "node": device/node on which to create dirty bitmap (json-string)
- "name": name of the new dirty bitmap (json-string)
- "granularity": granularity to track writes with (int, optional)
Example:
-> { "execute": "block-dirty-bitmap-add", "arguments": { "node": "drive0",
"name": "bitmap0" } }
<- { "return": {} }
block-dirty-bitmap-remove
-------------------------
Since 2.4
Stop write tracking and remove the dirty bitmap that was created with
block-dirty-bitmap-add.
Arguments:
- "node": device/node on which to remove dirty bitmap (json-string)
- "name": name of the dirty bitmap to remove (json-string)
Example:
-> { "execute": "block-dirty-bitmap-remove", "arguments": { "node": "drive0",
"name": "bitmap0" } }
<- { "return": {} }
block-dirty-bitmap-clear
------------------------
Since 2.4
Reset the dirty bitmap associated with a node so that an incremental backup
from this point in time forward will only backup clusters modified after this
clear operation.
Arguments:
- "node": device/node on which to remove dirty bitmap (json-string)
- "name": name of the dirty bitmap to remove (json-string)
Example:
-> { "execute": "block-dirty-bitmap-clear", "arguments": { "node": "drive0",
"name": "bitmap0" } }
<- { "return": {} }
blockdev-snapshot-sync
----------------------
Synchronous snapshot of a block device. snapshot-file specifies the
target of the new image. If the file exists, or if it is a device, the
snapshot will be created in the existing file/device. If does not
exist, a new file will be created. format specifies the format of the
snapshot image, default is qcow2.
Arguments:
- "device": device name to snapshot (json-string)
- "node-name": graph node name to snapshot (json-string)
- "snapshot-file": name of new image file (json-string)
- "snapshot-node-name": graph node name of the new snapshot (json-string)
- "mode": whether and how QEMU should create the snapshot file
(NewImageMode, optional, default "absolute-paths")
- "format": format of new image (json-string, optional)
Example:
-> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
"snapshot-file":
"/some/place/my-image",
"format": "qcow2" } }
<- { "return": {} }
blockdev-snapshot
-----------------
Since 2.5
Create a snapshot, by installing 'node' as the backing image of
'overlay'. Additionally, if 'node' is associated with a block
device, the block device changes to using 'overlay' as its new active
image.
Arguments:
- "node": device that will have a snapshot created (json-string)
- "overlay": device that will have 'node' as its backing image (json-string)
Example:
-> { "execute": "blockdev-add",
"arguments": { "driver": "qcow2",
"node-name": "node1534",
"file": { "driver": "file",
"filename": "hd1.qcow2" },
"backing": "" } }
<- { "return": {} }
-> { "execute": "blockdev-snapshot", "arguments": { "node": "ide-hd0",
"overlay": "node1534" } }
<- { "return": {} }
blockdev-snapshot-internal-sync
-------------------------------
Synchronously take an internal snapshot of a block device when the format of
image used supports it. If the name is an empty string, or a snapshot with
name already exists, the operation will fail.
Arguments:
- "device": the device name or node-name of a root node to snapshot
(json-string)
- "name": name of the new snapshot (json-string)
Example:
-> { "execute": "blockdev-snapshot-internal-sync",
"arguments": { "device": "ide-hd0",
"name": "snapshot0" }
}
<- { "return": {} }
blockdev-snapshot-delete-internal-sync
--------------------------------------
Synchronously delete an internal snapshot of a block device when the format of
image used supports it. The snapshot is identified by name or id or both. One
of name or id is required. If the snapshot is not found, the operation will
fail.
Arguments:
- "device": the device name or node-name of a root node (json-string)
- "id": ID of the snapshot (json-string, optional)
- "name": name of the snapshot (json-string, optional)
Example:
-> { "execute": "blockdev-snapshot-delete-internal-sync",
"arguments": { "device": "ide-hd0",
"name": "snapshot0" }
}
<- { "return": {
"id": "1",
"name": "snapshot0",
"vm-state-size": 0,
"date-sec": 1000012,
"date-nsec": 10,
"vm-clock-sec": 100,
"vm-clock-nsec": 20
}
}
drive-mirror
------------
Start mirroring a block device's writes to a new destination. target
specifies the target of the new image. If the file exists, or if it is
a device, it will be used as the new destination for writes. If it does not
exist, a new file will be created. format specifies the format of the
mirror image, default is to probe if mode='existing', else the format
of the source.
Arguments:
- "job-id": Identifier for the newly-created block job. If omitted,
the device name will be used. (json-string, optional)
- "device": the device name or node-name of a root node whose writes should be
mirrored. (json-string)
- "target": name of new image file (json-string)
- "format": format of new image (json-string, optional)
- "node-name": the name of the new block driver state in the node graph
(json-string, optional)
- "replaces": the block driver node name to replace when finished
(json-string, optional)
- "mode": how an image file should be created into the target
file/device (NewImageMode, optional, default 'absolute-paths')
- "speed": maximum speed of the streaming job, in bytes per second
(json-int)
- "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
- "buf-size": maximum amount of data in flight from source to target, in bytes
(json-int, default 10M)
- "sync": what parts of the disk image should be copied to the destination;
possibilities include "full" for all the disk, "top" for only the sectors
allocated in the topmost image, or "none" to only replicate new I/O
(MirrorSyncMode).
- "on-source-error": the action to take on an error on the source
(BlockdevOnError, default 'report')
- "on-target-error": the action to take on an error on the target
(BlockdevOnError, default 'report')
- "unmap": whether the target sectors should be discarded where source has only
zeroes. (json-bool, optional, default true)
The default value of the granularity is the image cluster size clamped
between 4096 and 65536, if the image format defines one. If the format
does not define a cluster size, the default value of the granularity
is 65536.
Example:
-> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
"target": "/some/place/my-image",
"sync": "full",
"format": "qcow2" } }
<- { "return": {} }
blockdev-mirror
------------
Start mirroring a block device's writes to another block device. target
specifies the target of mirror operation.
Arguments:
- "job-id": Identifier for the newly-created block job. If omitted,
the device name will be used. (json-string, optional)
- "device": The device name or node-name of a root node whose writes should be
mirrored (json-string)
- "target": device name to mirror to (json-string)
- "replaces": the block driver node name to replace when finished
(json-string, optional)
- "speed": maximum speed of the streaming job, in bytes per second
(json-int)
- "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
- "buf_size": maximum amount of data in flight from source to target, in bytes
(json-int, default 10M)
- "sync": what parts of the disk image should be copied to the destination;
possibilities include "full" for all the disk, "top" for only the sectors
allocated in the topmost image, or "none" to only replicate new I/O
(MirrorSyncMode).
- "on-source-error": the action to take on an error on the source
(BlockdevOnError, default 'report')
- "on-target-error": the action to take on an error on the target
(BlockdevOnError, default 'report')
The default value of the granularity is the image cluster size clamped
between 4096 and 65536, if the image format defines one. If the format
does not define a cluster size, the default value of the granularity
is 65536.
Example:
-> { "execute": "blockdev-mirror", "arguments": { "device": "ide-hd0",
"target": "target0",
"sync": "full" } }
<- { "return": {} }
change-backing-file
-------------------
Since: 2.1
Change the backing file in the image file metadata. This does not cause
QEMU to reopen the image file to reparse the backing filename (it may,
however, perform a reopen to change permissions from r/o -> r/w -> r/o,
if needed). The new backing file string is written into the image file
metadata, and the QEMU internal strings are updated.
Arguments:
- "image-node-name": The name of the block driver state node of the
image to modify. The "device" is argument is used to
verify "image-node-name" is in the chain described by
"device".
(json-string, optional)
- "device": The device name or node-name of the root node that owns
image-node-name.
(json-string)
- "backing-file": The string to write as the backing file. This string is
not validated, so care should be taken when specifying
the string or the image chain may not be able to be
reopened again.
(json-string)
Returns: Nothing on success
If "device" does not exist or cannot be determined, DeviceNotFound
getfd
-----
Receive a file descriptor via SCM rights and assign it a name.
Arguments:
- "fdname": file descriptor name (json-string)
Example:
-> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
<- { "return": {} }
Notes:
(1) If the name specified by the "fdname" argument already exists,
the file descriptor assigned to it will be closed and replaced
by the received file descriptor.
(2) The 'closefd' command can be used to explicitly close the file
descriptor when it is no longer needed.
closefd
-------
Close a file descriptor previously passed via SCM rights.
Arguments:
- "fdname": file descriptor name (json-string)
Example:
-> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
<- { "return": {} }
add-fd
-------
Add a file descriptor, that was passed via SCM rights, to an fd set.
Arguments:
- "fdset-id": The ID of the fd set to add the file descriptor to.
(json-int, optional)
- "opaque": A free-form string that can be used to describe the fd.
(json-string, optional)
Return a json-object with the following information:
- "fdset-id": The ID of the fd set that the fd was added to. (json-int)
- "fd": The file descriptor that was received via SCM rights and added to the
fd set. (json-int)
Example:
-> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
<- { "return": { "fdset-id": 1, "fd": 3 } }
Notes:
(1) The list of fd sets is shared by all monitor connections.
(2) If "fdset-id" is not specified, a new fd set will be created.
remove-fd
---------
Remove a file descriptor from an fd set.
Arguments:
- "fdset-id": The ID of the fd set that the file descriptor belongs to.
(json-int)
- "fd": The file descriptor that is to be removed. (json-int, optional)
Example:
-> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
<- { "return": {} }
Notes:
(1) The list of fd sets is shared by all monitor connections.
(2) If "fd" is not specified, all file descriptors in "fdset-id" will be
removed.
query-fdsets
-------------
Return information describing all fd sets.
Arguments: None
Example:
-> { "execute": "query-fdsets" }
<- { "return": [
{
"fds": [
{
"fd": 30,
"opaque": "rdonly:/path/to/file"
},
{
"fd": 24,
"opaque": "rdwr:/path/to/file"
}
],
"fdset-id": 1
},
{
"fds": [
{
"fd": 28
},
{
"fd": 29
}
],
"fdset-id": 0
}
]
}
Note: The list of fd sets is shared by all monitor connections.
block_passwd
------------
Set the password of encrypted block devices.
Arguments:
- "device": device name (json-string)
- "node-name": name in the block driver state graph (json-string)
- "password": password (json-string)
Example:
-> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
"password": "12345" } }
<- { "return": {} }
block_set_io_throttle
------------
Change I/O throttle limits for a block drive.
Arguments:
- "device": block device name (deprecated, use @id instead)
(json-string, optional)
- "id": the name or QOM path of the guest device (json-string, optional)
- "bps": total throughput limit in bytes per second (json-int)
- "bps_rd": read throughput limit in bytes per second (json-int)
- "bps_wr": write throughput limit in bytes per second (json-int)
- "iops": total I/O operations per second (json-int)
- "iops_rd": read I/O operations per second (json-int)
- "iops_wr": write I/O operations per second (json-int)
- "bps_max": total throughput limit during bursts, in bytes (json-int, optional)
- "bps_rd_max": read throughput limit during bursts, in bytes (json-int, optional)
- "bps_wr_max": write throughput limit during bursts, in bytes (json-int, optional)
- "iops_max": total I/O operations per second during bursts (json-int, optional)
- "iops_rd_max": read I/O operations per second during bursts (json-int, optional)
- "iops_wr_max": write I/O operations per second during bursts (json-int, optional)
- "bps_max_length": maximum length of the @bps_max burst period, in seconds (json-int, optional)
- "bps_rd_max_length": maximum length of the @bps_rd_max burst period, in seconds (json-int, optional)
- "bps_wr_max_length": maximum length of the @bps_wr_max burst period, in seconds (json-int, optional)
- "iops_max_length": maximum length of the @iops_max burst period, in seconds (json-int, optional)
- "iops_rd_max_length": maximum length of the @iops_rd_max burst period, in seconds (json-int, optional)
- "iops_wr_max_length": maximum length of the @iops_wr_max burst period, in seconds (json-int, optional)
- "iops_size": I/O size in bytes when limiting (json-int, optional)
- "group": throttle group name (json-string, optional)
Example:
-> { "execute": "block_set_io_throttle", "arguments": { "id": "ide0-1-0",
"bps": 1000000,
"bps_rd": 0,
"bps_wr": 0,
"iops": 0,
"iops_rd": 0,
"iops_wr": 0,
"bps_max": 8000000,
"bps_rd_max": 0,
"bps_wr_max": 0,
"iops_max": 0,
"iops_rd_max": 0,
"iops_wr_max": 0,
"bps_max_length": 60,
"iops_size": 0 } }
<- { "return": {} }
set_password
------------
Set the password for vnc/spice protocols.
Arguments:
- "protocol": protocol name (json-string)
- "password": password (json-string)
- "connected": [ keep | disconnect | fail ] (json-string, optional)
Example:
-> { "execute": "set_password", "arguments": { "protocol": "vnc",
"password": "secret" } }
<- { "return": {} }
expire_password
---------------
Set the password expire time for vnc/spice protocols.
Arguments:
- "protocol": protocol name (json-string)
- "time": [ now | never | +secs | secs ] (json-string)
Example:
-> { "execute": "expire_password", "arguments": { "protocol": "vnc",
"time": "+60" } }
<- { "return": {} }
qmp_capabilities
----------------
Enable QMP capabilities.
Arguments: None.
Example:
-> { "execute": "qmp_capabilities" }
<- { "return": {} }
Note: This command must be issued before issuing any other command.
3. Query Commands
=================
query-version
-------------
Show QEMU version.
Return a json-object with the following information:
- "qemu": A json-object containing three integer values:
- "major": QEMU's major version (json-int)
- "minor": QEMU's minor version (json-int)
- "micro": QEMU's micro version (json-int)
- "package": package's version (json-string)
Example:
-> { "execute": "query-version" }
<- {
"return":{
"qemu":{
"major":0,
"minor":11,
"micro":5
},
"package":""
}
}
query-commands
--------------
List QMP available commands.
Each command is represented by a json-object, the returned value is a json-array
of all commands.
Each json-object contain:
- "name": command's name (json-string)
Example:
-> { "execute": "query-commands" }
<- {
"return":[
{
"name":"query-balloon"
},
{
"name":"system_powerdown"
}
]
}
Note: This example has been shortened as the real response is too long.
query-qmp-schema
----------------
Return the QMP wire schema. The returned value is a json-array of
named schema entities. Entities are commands, events and various
types. See docs/qapi-code-gen.txt for information on their structure
and intended use.
query-block
-----------
Show the block devices.
Each block device information is stored in a json-object and the returned value
is a json-array of all devices.
Each json-object contain the following:
- "device": device name (json-string)
- "type": device type (json-string)
- deprecated, retained for backward compatibility
- Possible values: "unknown"
- "removable": true if the device is removable, false otherwise (json-bool)
- "locked": true if the device is locked, false otherwise (json-bool)
- "tray_open": only present if removable, true if the device has a tray,
and it is open (json-bool)
- "inserted": only present if the device is inserted, it is a json-object
containing the following:
- "file": device file name (json-string)
- "ro": true if read-only, false otherwise (json-bool)
- "drv": driver format name (json-string)
- Possible values: "blkdebug", "bochs", "cloop", "dmg",
"file", "file", "ftp", "ftps", "host_cdrom",
"host_device", "http", "https",
"nbd", "parallels", "qcow", "qcow2", "raw",
"vdi", "vmdk", "vpc", "vvfat"
- "backing_file": backing file name (json-string, optional)
- "backing_file_depth": number of files in the backing file chain (json-int)
- "encrypted": true if encrypted, false otherwise (json-bool)
- "bps": limit total bytes per second (json-int)
- "bps_rd": limit read bytes per second (json-int)
- "bps_wr": limit write bytes per second (json-int)
- "iops": limit total I/O operations per second (json-int)
- "iops_rd": limit read operations per second (json-int)
- "iops_wr": limit write operations per second (json-int)
- "bps_max": total max in bytes (json-int)
- "bps_rd_max": read max in bytes (json-int)
- "bps_wr_max": write max in bytes (json-int)
- "iops_max": total I/O operations max (json-int)
- "iops_rd_max": read I/O operations max (json-int)
- "iops_wr_max": write I/O operations max (json-int)
- "iops_size": I/O size when limiting by iops (json-int)
- "detect_zeroes": detect and optimize zero writing (json-string)
- Possible values: "off", "on", "unmap"
- "write_threshold": write offset threshold in bytes, a event will be
emitted if crossed. Zero if disabled (json-int)
- "image": the detail of the image, it is a json-object containing
the following:
- "filename": image file name (json-string)
- "format": image format (json-string)
- "virtual-size": image capacity in bytes (json-int)
- "dirty-flag": true if image is not cleanly closed, not present
means clean (json-bool, optional)
- "actual-size": actual size on disk in bytes of the image, not
present when image does not support thin
provision (json-int, optional)
- "cluster-size": size of a cluster in bytes, not present if image
format does not support it (json-int, optional)
- "encrypted": true if the image is encrypted, not present means
false or the image format does not support
encryption (json-bool, optional)
- "backing_file": backing file name, not present means no backing
file is used or the image format does not
support backing file chain
(json-string, optional)
- "full-backing-filename": full path of the backing file, not
present if it equals backing_file or no
backing file is used
(json-string, optional)
- "backing-filename-format": the format of the backing file, not
present means unknown or no backing
file (json-string, optional)
- "snapshots": the internal snapshot info, it is an optional list
of json-object containing the following:
- "id": unique snapshot id (json-string)
- "name": snapshot name (json-string)
- "vm-state-size": size of the VM state in bytes (json-int)
- "date-sec": UTC date of the snapshot in seconds (json-int)
- "date-nsec": fractional part in nanoseconds to be used with
date-sec (json-int)
- "vm-clock-sec": VM clock relative to boot in seconds
(json-int)
- "vm-clock-nsec": fractional part in nanoseconds to be used
with vm-clock-sec (json-int)
- "backing-image": the detail of the backing image, it is an
optional json-object only present when a
backing image present for this image
- "io-status": I/O operation status, only present if the device supports it
and the VM is configured to stop on errors. It's always reset
to "ok" when the "cont" command is issued (json_string, optional)
- Possible values: "ok", "failed", "nospace"
Example:
-> { "execute": "query-block" }
<- {
"return":[
{
"io-status": "ok",
"device":"ide0-hd0",
"locked":false,
"removable":false,
"inserted":{
"ro":false,
"drv":"qcow2",
"encrypted":false,
"file":"disks/test.qcow2",
"backing_file_depth":1,
"bps":1000000,
"bps_rd":0,
"bps_wr":0,
"iops":1000000,
"iops_rd":0,
"iops_wr":0,
"bps_max": 8000000,
"bps_rd_max": 0,
"bps_wr_max": 0,
"iops_max": 0,
"iops_rd_max": 0,
"iops_wr_max": 0,
"iops_size": 0,
"detect_zeroes": "on",
"write_threshold": 0,
"image":{
"filename":"disks/test.qcow2",
"format":"qcow2",
"virtual-size":2048000,
"backing_file":"base.qcow2",
"full-backing-filename":"disks/base.qcow2",
"backing-filename-format":"qcow2",
"snapshots":[
{
"id": "1",
"name": "snapshot1",
"vm-state-size": 0,
"date-sec": 10000200,
"date-nsec": 12,
"vm-clock-sec": 206,
"vm-clock-nsec": 30
}
],
"backing-image":{
"filename":"disks/base.qcow2",
"format":"qcow2",
"virtual-size":2048000
}
}
},
"type":"unknown"
},
{
"io-status": "ok",
"device":"ide1-cd0",
"locked":false,
"removable":true,
"type":"unknown"
},
{
"device":"floppy0",
"locked":false,
"removable":true,
"type":"unknown"
},
{
"device":"sd0",
"locked":false,
"removable":true,
"type":"unknown"
}
]
}
query-blockstats
----------------
Show block device statistics.
Each device statistic information is stored in a json-object and the returned
value is a json-array of all devices.
Each json-object contain the following:
- "device": device name (json-string)
- "stats": A json-object with the statistics information, it contains:
- "rd_bytes": bytes read (json-int)
- "wr_bytes": bytes written (json-int)
- "rd_operations": read operations (json-int)
- "wr_operations": write operations (json-int)
- "flush_operations": cache flush operations (json-int)
- "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
- "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
- "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
- "wr_highest_offset": The offset after the greatest byte written to the
BlockDriverState since it has been opened (json-int)
- "rd_merged": number of read requests that have been merged into
another request (json-int)
- "wr_merged": number of write requests that have been merged into
another request (json-int)
- "idle_time_ns": time since the last I/O operation, in
nanoseconds. If the field is absent it means
that there haven't been any operations yet
(json-int, optional)
- "failed_rd_operations": number of failed read operations
(json-int)
- "failed_wr_operations": number of failed write operations
(json-int)
- "failed_flush_operations": number of failed flush operations
(json-int)
- "invalid_rd_operations": number of invalid read operations
(json-int)
- "invalid_wr_operations": number of invalid write operations
(json-int)
- "invalid_flush_operations": number of invalid flush operations
(json-int)
- "account_invalid": whether invalid operations are included in
the last access statistics (json-bool)
- "account_failed": whether failed operations are included in the
latency and last access statistics
(json-bool)
- "timed_stats": A json-array containing statistics collected in
specific intervals, with the following members:
- "interval_length": interval used for calculating the
statistics, in seconds (json-int)
- "min_rd_latency_ns": minimum latency of read operations in
the defined interval, in nanoseconds
(json-int)
- "min_wr_latency_ns": minimum latency of write operations in
the defined interval, in nanoseconds
(json-int)
- "min_flush_latency_ns": minimum latency of flush operations
in the defined interval, in
nanoseconds (json-int)
- "max_rd_latency_ns": maximum latency of read operations in
the defined interval, in nanoseconds
(json-int)
- "max_wr_latency_ns": maximum latency of write operations in
the defined interval, in nanoseconds
(json-int)
- "max_flush_latency_ns": maximum latency of flush operations
in the defined interval, in
nanoseconds (json-int)
- "avg_rd_latency_ns": average latency of read operations in
the defined interval, in nanoseconds
(json-int)
- "avg_wr_latency_ns": average latency of write operations in
the defined interval, in nanoseconds
(json-int)
- "avg_flush_latency_ns": average latency of flush operations
in the defined interval, in
nanoseconds (json-int)
- "avg_rd_queue_depth": average number of pending read
operations in the defined interval
(json-number)
- "avg_wr_queue_depth": average number of pending write
operations in the defined interval
(json-number).
- "parent": Contains recursively the statistics of the underlying
protocol (e.g. the host file for a qcow2 image). If there is
no underlying protocol, this field is omitted
(json-object, optional)
Example:
-> { "execute": "query-blockstats" }
<- {
"return":[
{
"device":"ide0-hd0",
"parent":{
"stats":{
"wr_highest_offset":3686448128,
"wr_bytes":9786368,
"wr_operations":751,
"rd_bytes":122567168,
"rd_operations":36772
"wr_total_times_ns":313253456
"rd_total_times_ns":3465673657
"flush_total_times_ns":49653
"flush_operations":61,
"rd_merged":0,
"wr_merged":0,
"idle_time_ns":2953431879,
"account_invalid":true,
"account_failed":false
}
},
"stats":{
"wr_highest_offset":2821110784,
"wr_bytes":9786368,
"wr_operations":692,
"rd_bytes":122739200,
"rd_operations":36604
"flush_operations":51,
"wr_total_times_ns":313253456
"rd_total_times_ns":3465673657
"flush_total_times_ns":49653,
"rd_merged":0,
"wr_merged":0,
"idle_time_ns":2953431879,
"account_invalid":true,
"account_failed":false
}
},
{
"device":"ide1-cd0",
"stats":{
"wr_highest_offset":0,
"wr_bytes":0,
"wr_operations":0,
"rd_bytes":0,
"rd_operations":0
"flush_operations":0,
"wr_total_times_ns":0
"rd_total_times_ns":0
"flush_total_times_ns":0,
"rd_merged":0,
"wr_merged":0,
"account_invalid":false,
"account_failed":false
}
},
{
"device":"floppy0",
"stats":{
"wr_highest_offset":0,
"wr_bytes":0,
"wr_operations":0,
"rd_bytes":0,
"rd_operations":0
"flush_operations":0,
"wr_total_times_ns":0
"rd_total_times_ns":0
"flush_total_times_ns":0,
"rd_merged":0,
"wr_merged":0,
"account_invalid":false,
"account_failed":false
}
},
{
"device":"sd0",
"stats":{
"wr_highest_offset":0,
"wr_bytes":0,
"wr_operations":0,
"rd_bytes":0,
"rd_operations":0
"flush_operations":0,
"wr_total_times_ns":0
"rd_total_times_ns":0
"flush_total_times_ns":0,
"rd_merged":0,
"wr_merged":0,
"account_invalid":false,
"account_failed":false
}
}
]
}
query-command-line-options
--------------------------
Show command line option schema.
Return a json-array of command line option schema for all options (or for
the given option), returning an error if the given option doesn't exist.
Each array entry contains the following:
- "option": option name (json-string)
- "parameters": a json-array describes all parameters of the option:
- "name": parameter name (json-string)
- "type": parameter type (one of 'string', 'boolean', 'number',
or 'size')
- "help": human readable description of the parameter
(json-string, optional)
- "default": default value string for the parameter
(json-string, optional)
Example:
-> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
<- { "return": [
{
"parameters": [
{
"name": "romfile",
"type": "string"
},
{
"name": "bootindex",
"type": "number"
}
],
"option": "option-rom"
}
]
}
query-tpm
---------
Return information about the TPM device.
Arguments: None
Example:
-> { "execute": "query-tpm" }
<- { "return":
[
{ "model": "tpm-tis",
"options":
{ "type": "passthrough",
"data":
{ "cancel-path": "/sys/class/misc/tpm0/device/cancel",
"path": "/dev/tpm0"
}
},
"id": "tpm0"
}
]
}
query-tpm-models
----------------
Return a list of supported TPM models.
Arguments: None
Example:
-> { "execute": "query-tpm-models" }
<- { "return": [ "tpm-tis" ] }
query-tpm-types
---------------
Return a list of supported TPM types.
Arguments: None
Example:
-> { "execute": "query-tpm-types" }
<- { "return": [ "passthrough" ] }
chardev-add
----------------
Add a chardev.
Arguments:
- "id": the chardev's ID, must be unique (json-string)
- "backend": chardev backend type + parameters
Examples:
-> { "execute" : "chardev-add",
"arguments" : { "id" : "foo",
"backend" : { "type" : "null", "data" : {} } } }
<- { "return": {} }
-> { "execute" : "chardev-add",
"arguments" : { "id" : "bar",
"backend" : { "type" : "file",
"data" : { "out" : "/tmp/bar.log" } } } }
<- { "return": {} }
-> { "execute" : "chardev-add",
"arguments" : { "id" : "baz",
"backend" : { "type" : "pty", "data" : {} } } }
<- { "return": { "pty" : "/dev/pty/42" } }
chardev-remove
--------------
Remove a chardev.
Arguments:
- "id": the chardev's ID, must exist and not be in use (json-string)
Example:
-> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
<- { "return": {} }
query-rx-filter
---------------
Show rx-filter information.
Returns a json-array of rx-filter information for all NICs (or for the
given NIC), returning an error if the given NIC doesn't exist, or
given NIC doesn't support rx-filter querying, or given net client
isn't a NIC.
The query will clear the event notification flag of each NIC, then qemu
will start to emit event to QMP monitor.
Each array entry contains the following:
- "name": net client name (json-string)
- "promiscuous": promiscuous mode is enabled (json-bool)
- "multicast": multicast receive state (one of 'normal', 'none', 'all')
- "unicast": unicast receive state (one of 'normal', 'none', 'all')
- "vlan": vlan receive state (one of 'normal', 'none', 'all') (Since 2.0)
- "broadcast-allowed": allow to receive broadcast (json-bool)
- "multicast-overflow": multicast table is overflowed (json-bool)
- "unicast-overflow": unicast table is overflowed (json-bool)
- "main-mac": main macaddr string (json-string)
- "vlan-table": a json-array of active vlan id
- "unicast-table": a json-array of unicast macaddr string
- "multicast-table": a json-array of multicast macaddr string
Example:
-> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
<- { "return": [
{
"promiscuous": true,
"name": "vnet0",
"main-mac": "52:54:00:12:34:56",
"unicast": "normal",
"vlan": "normal",
"vlan-table": [
4,
0
],
"unicast-table": [
],
"multicast": "normal",
"multicast-overflow": false,
"unicast-overflow": false,
"multicast-table": [
"01:00:5e:00:00:01",
"33:33:00:00:00:01",
"33:33:ff:12:34:56"
],
"broadcast-allowed": false
}
]
}
blockdev-add
------------
Add a block device.
This command is still a work in progress. It doesn't support all
block drivers among other things. Stay away from it unless you want
to help with its development.
For the arguments, see the QAPI schema documentation of BlockdevOptions.
Example (1):
-> { "execute": "blockdev-add",
"arguments": { "driver": "qcow2",
"file": { "driver": "file",
"filename": "test.qcow2" } } }
<- { "return": {} }
Example (2):
-> { "execute": "blockdev-add",
"arguments": {
"driver": "qcow2",
"node-name": "my_disk",
"discard": "unmap",
"cache": {
"direct": true,
"writeback": true
},
"file": {
"driver": "file",
"filename": "/tmp/test.qcow2"
},
"backing": {
"driver": "raw",
"file": {
"driver": "file",
"filename": "/dev/fdset/4"
}
}
}
}
<- { "return": {} }
x-blockdev-del
------------
Since 2.5
Deletes a block device that has been added using blockdev-add.
The command will fail if the node is attached to a device or is
otherwise being used.
This command is still a work in progress and is considered
experimental. Stay away from it unless you want to help with its
development.
Arguments:
- "node-name": Name of the graph node to delete (json-string)
Example:
-> { "execute": "blockdev-add",
"arguments": {
"driver": "qcow2",
"node-name": "node0",
"file": {
"driver": "file",
"filename": "test.qcow2"
}
}
}
<- { "return": {} }
-> { "execute": "x-blockdev-del",
"arguments": { "node-name": "node0" }
}
<- { "return": {} }
blockdev-open-tray
------------------
Opens a block device's tray. If there is a block driver state tree inserted as a
medium, it will become inaccessible to the guest (but it will remain associated
to the block device, so closing the tray will make it accessible again).
If the tray was already open before, this will be a no-op.
Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
which no such event will be generated, these include:
- if the guest has locked the tray, @force is false and the guest does not
respond to the eject request
- if the BlockBackend denoted by @device does not have a guest device attached
to it
- if the guest device does not have an actual tray and is empty, for instance
for floppy disk drives
Arguments:
- "device": block device name (deprecated, use @id instead)
(json-string, optional)
- "id": the name or QOM path of the guest device (json-string, optional)
- "force": if false (the default), an eject request will be sent to the guest if
it has locked the tray (and the tray will not be opened immediately);
if true, the tray will be opened regardless of whether it is locked
(json-bool, optional)
Example:
-> { "execute": "blockdev-open-tray",
"arguments": { "id": "ide0-1-0" } }
<- { "timestamp": { "seconds": 1418751016,
"microseconds": 716996 },
"event": "DEVICE_TRAY_MOVED",
"data": { "device": "ide1-cd0",
"id": "ide0-1-0",
"tray-open": true } }
<- { "return": {} }
blockdev-close-tray
-------------------
Closes a block device's tray. If there is a block driver state tree associated
with the block device (which is currently ejected), that tree will be loaded as
the medium.
If the tray was already closed before, this will be a no-op.
Arguments:
- "device": block device name (deprecated, use @id instead)
(json-string, optional)
- "id": the name or QOM path of the guest device (json-string, optional)
Example:
-> { "execute": "blockdev-close-tray",
"arguments": { "id": "ide0-1-0" } }
<- { "timestamp": { "seconds": 1418751345,
"microseconds": 272147 },
"event": "DEVICE_TRAY_MOVED",
"data": { "device": "ide1-cd0",
"id": "ide0-1-0",
"tray-open": false } }
<- { "return": {} }
x-blockdev-remove-medium
------------------------
Removes a medium (a block driver state tree) from a block device. That block
device's tray must currently be open (unless there is no attached guest device).
If the tray is open and there is no medium inserted, this will be a no-op.
This command is still a work in progress and is considered experimental.
Stay away from it unless you want to help with its development.
Arguments:
- "device": block device name (deprecated, use @id instead)
(json-string, optional)
- "id": the name or QOM path of the guest device (json-string, optional)
Example:
-> { "execute": "x-blockdev-remove-medium",
"arguments": { "id": "ide0-1-0" } }
<- { "error": { "class": "GenericError",
"desc": "Tray of device 'ide0-1-0' is not open" } }
-> { "execute": "blockdev-open-tray",
"arguments": { "id": "ide0-1-0" } }
<- { "timestamp": { "seconds": 1418751627,
"microseconds": 549958 },
"event": "DEVICE_TRAY_MOVED",
"data": { "device": "ide1-cd0",
"id": "ide0-1-0",
"tray-open": true } }
<- { "return": {} }
-> { "execute": "x-blockdev-remove-medium",
"arguments": { "device": "ide0-1-0" } }
<- { "return": {} }
x-blockdev-insert-medium
------------------------
Inserts a medium (a block driver state tree) into a block device. That block
device's tray must currently be open (unless there is no attached guest device)
and there must be no medium inserted already.
This command is still a work in progress and is considered experimental.
Stay away from it unless you want to help with its development.
Arguments:
- "device": block device name (deprecated, use @id instead)
(json-string, optional)
- "id": the name or QOM path of the guest device (json-string, optional)
- "node-name": root node of the BDS tree to insert into the block device
Example:
-> { "execute": "blockdev-add",
"arguments": { { "node-name": "node0",
"driver": "raw",
"file": { "driver": "file",
"filename": "fedora.iso" } } }
<- { "return": {} }
-> { "execute": "x-blockdev-insert-medium",
"arguments": { "id": "ide0-1-0",
"node-name": "node0" } }
<- { "return": {} }
x-blockdev-change
-----------------
Dynamically reconfigure the block driver state graph. It can be used
to add, remove, insert or replace a graph node. Currently only the
Quorum driver implements this feature to add or remove its child. This
is useful to fix a broken quorum child.
If @node is specified, it will be inserted under @parent. @child
may not be specified in this case. If both @parent and @child are
specified but @node is not, @child will be detached from @parent.
Arguments:
- "parent": the id or name of the parent node (json-string)
- "child": the name of a child under the given parent node (json-string, optional)
- "node": the name of the node that will be added (json-string, optional)
Note: this command is experimental, and not a stable API. It doesn't
support all kinds of operations, all kinds of children, nor all block
drivers.
Warning: The data in a new quorum child MUST be consistent with that of
the rest of the array.
Example:
Add a new node to a quorum
-> { "execute": "blockdev-add",
"arguments": { "driver": "raw",
"node-name": "new_node",
"file": { "driver": "file",
"filename": "test.raw" } } }
<- { "return": {} }
-> { "execute": "x-blockdev-change",
"arguments": { "parent": "disk1",
"node": "new_node" } }
<- { "return": {} }
Delete a quorum's node
-> { "execute": "x-blockdev-change",
"arguments": { "parent": "disk1",
"child": "children.1" } }
<- { "return": {} }
query-named-block-nodes
-----------------------
Return a list of BlockDeviceInfo for all the named block driver nodes
Example:
-> { "execute": "query-named-block-nodes" }
<- { "return": [ { "ro":false,
"drv":"qcow2",
"encrypted":false,
"file":"disks/test.qcow2",
"node-name": "my-node",
"backing_file_depth":1,
"bps":1000000,
"bps_rd":0,
"bps_wr":0,
"iops":1000000,
"iops_rd":0,
"iops_wr":0,
"bps_max": 8000000,
"bps_rd_max": 0,
"bps_wr_max": 0,
"iops_max": 0,
"iops_rd_max": 0,
"iops_wr_max": 0,
"iops_size": 0,
"write_threshold": 0,
"image":{
"filename":"disks/test.qcow2",
"format":"qcow2",
"virtual-size":2048000,
"backing_file":"base.qcow2",
"full-backing-filename":"disks/base.qcow2",
"backing-filename-format":"qcow2",
"snapshots":[
{
"id": "1",
"name": "snapshot1",
"vm-state-size": 0,
"date-sec": 10000200,
"date-nsec": 12,
"vm-clock-sec": 206,
"vm-clock-nsec": 30
}
],
"backing-image":{
"filename":"disks/base.qcow2",
"format":"qcow2",
"virtual-size":2048000
}
} } ] }
blockdev-change-medium
----------------------
Changes the medium inserted into a block device by ejecting the current medium
and loading a new image file which is inserted as the new medium.
Arguments:
- "device": block device name (deprecated, use @id instead)
(json-string, optional)
- "id": the name or QOM path of the guest device (json-string, optional)
- "filename": filename of the new image (json-string)
- "format": format of the new image (json-string, optional)
- "read-only-mode": new read-only mode (json-string, optional)
- Possible values: "retain" (default), "read-only", "read-write"
Examples:
1. Change a removable medium
-> { "execute": "blockdev-change-medium",
"arguments": { "id": "ide0-1-0",
"filename": "/srv/images/Fedora-12-x86_64-DVD.iso",
"format": "raw" } }
<- { "return": {} }
2. Load a read-only medium into a writable drive
-> { "execute": "blockdev-change-medium",
"arguments": { "id": "floppyA",
"filename": "/srv/images/ro.img",
"format": "raw",
"read-only-mode": "retain" } }
<- { "error":
{ "class": "GenericError",
"desc": "Could not open '/srv/images/ro.img': Permission denied" } }
-> { "execute": "blockdev-change-medium",
"arguments": { "id": "floppyA",
"filename": "/srv/images/ro.img",
"format": "raw",
"read-only-mode": "read-only" } }
<- { "return": {} }
query-memdev
------------
Show memory devices information.
Example (1):
-> { "execute": "query-memdev" }
<- { "return": [
{
"size": 536870912,
"merge": false,
"dump": true,
"prealloc": false,
"host-nodes": [0, 1],
"policy": "bind"
},
{
"id": "mem1",
"size": 536870912,
"merge": false,
"dump": true,
"prealloc": true,
"host-nodes": [2, 3],
"policy": "preferred"
}
]
}
query-memory-devices
--------------------
Return a list of memory devices.
Example:
-> { "execute": "query-memory-devices" }
<- { "return": [ { "data":
{ "addr": 5368709120,
"hotpluggable": true,
"hotplugged": true,
"id": "d1",
"memdev": "/objects/memX",
"node": 0,
"size": 1073741824,
"slot": 0},
"type": "dimm"
} ] }
query-acpi-ospm-status
----------------------
Return list of ACPIOSTInfo for devices that support status reporting
via ACPI _OST method.
Example:
-> { "execute": "query-acpi-ospm-status" }
<- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
{ "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
{ "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
{ "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
]}
rtc-reset-reinjection
---------------------
Reset the RTC interrupt reinjection backlog.
Arguments: None.
Example:
-> { "execute": "rtc-reset-reinjection" }
<- { "return": {} }
trace-event-get-state
---------------------
Query the state of events.
Arguments:
- "name": Event name pattern (json-string).
- "vcpu": The vCPU to query, any vCPU by default (json-int, optional).
An event is returned if:
- its name matches the "name" pattern, and
- if "vcpu" is given, the event has the "vcpu" property.
Therefore, if "vcpu" is given, the operation will only match per-vCPU events,
returning their state on the specified vCPU. Special case: if "name" is an exact
match, "vcpu" is given and the event does not have the "vcpu" property, an error
is returned.
Example:
-> { "execute": "trace-event-get-state", "arguments": { "name": "qemu_memalign" } }
<- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
trace-event-set-state
---------------------
Set the state of events.
Arguments:
- "name": Event name pattern (json-string).
- "enable": Whether to enable or disable the event (json-bool).
- "ignore-unavailable": Whether to ignore errors for events that cannot be
changed (json-bool, optional).
- "vcpu": The vCPU to act upon, all vCPUs by default (json-int, optional).
An event's state is modified if:
- its name matches the "name" pattern, and
- if "vcpu" is given, the event has the "vcpu" property.
Therefore, if "vcpu" is given, the operation will only match per-vCPU events,
setting their state on the specified vCPU. Special case: if "name" is an exact
match, "vcpu" is given and the event does not have the "vcpu" property, an error
is returned.
Example:
-> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } }
<- { "return": {} }
input-send-event
----------------
Send input event to guest.
Arguments:
- "device": display device (json-string, optional)
- "head": display head (json-int, optional)
- "events": list of input events
The consoles are visible in the qom tree, under
/backend/console[$index]. They have a device link and head property, so
it is possible to map which console belongs to which device and display.
Example (1):
Press left mouse button.
-> { "execute": "input-send-event",
"arguments": { "device": "video0",
"events": [ { "type": "btn",
"data" : { "down": true, "button": "left" } } ] } }
<- { "return": {} }
-> { "execute": "input-send-event",
"arguments": { "device": "video0",
"events": [ { "type": "btn",
"data" : { "down": false, "button": "left" } } ] } }
<- { "return": {} }
Example (2):
Press ctrl-alt-del.
-> { "execute": "input-send-event",
"arguments": { "events": [
{ "type": "key", "data" : { "down": true,
"key": {"type": "qcode", "data": "ctrl" } } },
{ "type": "key", "data" : { "down": true,
"key": {"type": "qcode", "data": "alt" } } },
{ "type": "key", "data" : { "down": true,
"key": {"type": "qcode", "data": "delete" } } } ] } }
<- { "return": {} }
Example (3):
Move mouse pointer to absolute coordinates (20000, 400).
-> { "execute": "input-send-event" ,
"arguments": { "events": [
{ "type": "abs", "data" : { "axis": "x", "value" : 20000 } },
{ "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
<- { "return": {} }
block-set-write-threshold
------------
Change the write threshold for a block drive. The threshold is an offset,
thus must be non-negative. Default is no write threshold.
Setting the threshold to zero disables it.
Arguments:
- "node-name": the node name in the block driver state graph (json-string)
- "write-threshold": the write threshold in bytes (json-int)
Example:
-> { "execute": "block-set-write-threshold",
"arguments": { "node-name": "mydev",
"write-threshold": 17179869184 } }
<- { "return": {} }
Show rocker switch
------------------
Arguments:
- "name": switch name
Example:
-> { "execute": "query-rocker", "arguments": { "name": "sw1" } }
<- { "return": {"name": "sw1", "ports": 2, "id": 1327446905938}}
Show rocker switch ports
------------------------
Arguments:
- "name": switch name
Example:
-> { "execute": "query-rocker-ports", "arguments": { "name": "sw1" } }
<- { "return": [ {"duplex": "full", "enabled": true, "name": "sw1.1",
"autoneg": "off", "link-up": true, "speed": 10000},
{"duplex": "full", "enabled": true, "name": "sw1.2",
"autoneg": "off", "link-up": true, "speed": 10000}
]}
Show rocker switch OF-DPA flow tables
-------------------------------------
Arguments:
- "name": switch name
- "tbl-id": (optional) flow table ID
Example:
-> { "execute": "query-rocker-of-dpa-flows", "arguments": { "name": "sw1" } }
<- { "return": [ {"key": {"in-pport": 0, "priority": 1, "tbl-id": 0},
"hits": 138,
"cookie": 0,
"action": {"goto-tbl": 10},
"mask": {"in-pport": 4294901760}
},
{...more...},
]}
Show rocker OF-DPA group tables
-------------------------------
Arguments:
- "name": switch name
- "type": (optional) group type
Example:
-> { "execute": "query-rocker-of-dpa-groups", "arguments": { "name": "sw1" } }
<- { "return": [ {"type": 0, "out-pport": 2, "pport": 2, "vlan-id": 3841,
"pop-vlan": 1, "id": 251723778},
{"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3841,
"pop-vlan": 1, "id": 251723776},
{"type": 0, "out-pport": 1, "pport": 1, "vlan-id": 3840,
"pop-vlan": 1, "id": 251658241},
{"type": 0, "out-pport": 0, "pport": 0, "vlan-id": 3840,
"pop-vlan": 1, "id": 251658240}
]}
query-gic-capabilities
---------------
Return a list of GICCapability objects, describing supported GIC
(Generic Interrupt Controller) versions.
Arguments: None
Example:
-> { "execute": "query-gic-capabilities" }
<- { "return": [{ "version": 2, "emulated": true, "kernel": false },
{ "version": 3, "emulated": false, "kernel": true } ] }
Show existing/possible CPUs
---------------------------
Arguments: None.
Example for pseries machine type started with
-smp 2,cores=2,maxcpus=4 -cpu POWER8:
-> { "execute": "query-hotpluggable-cpus" }
<- {"return": [
{ "props": { "core-id": 8 }, "type": "POWER8-spapr-cpu-core",
"vcpus-count": 1 },
{ "props": { "core-id": 0 }, "type": "POWER8-spapr-cpu-core",
"vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"}
]}'
Example for pc machine type started with
-smp 1,maxcpus=2:
-> { "execute": "query-hotpluggable-cpus" }
<- {"return": [
{
"type": "qemu64-x86_64-cpu", "vcpus-count": 1,
"props": {"core-id": 0, "socket-id": 1, "thread-id": 0}
},
{
"qom-path": "/machine/unattached/device[0]",
"type": "qemu64-x86_64-cpu", "vcpus-count": 1,
"props": {"core-id": 0, "socket-id": 0, "thread-id": 0}
}
]}
Reference in New Issue View Git Blame Copy Permalink