qmp-commands: move 'query-block' doc to schema
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
Marc-André Lureau
Markus Armbruster
parent
5c32b4ccd6
commit
978cceab03
|
|
@ -800,181 +800,6 @@ 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
|
||||
----------------
|
||||
|
||||
|
|
|
|||
|
|
@ -469,6 +469,87 @@
|
|||
# Returns: a list of @BlockInfo describing each virtual block device
|
||||
#
|
||||
# Since: 0.14.0
|
||||
#
|
||||
# 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"
|
||||
# }
|
||||
# ]
|
||||
# }
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-block', 'returns': ['BlockInfo'] }
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue