diff options
author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2016-06-23 14:56:09 +0200 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2017-01-16 09:19:46 +0100 |
commit | 1133b1d674469d8dd5e2e02e5cf8f288ca8bf500 (patch) | |
tree | 5ae3502103126eddaa68973d793273302d19311a | |
parent | 915a213f7a0fe5c7551df8ce54714baf3dd60929 (diff) |
qmp-commands: move 'blockdev-open-tray' doc to schema
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
-rw-r--r-- | docs/qmp-commands.txt | 42 | ||||
-rw-r--r-- | qapi/block-core.json | 15 |
2 files changed, 15 insertions, 42 deletions
diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 95b648deec..433454c3e9 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -343,48 +343,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. -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 ------------------- diff --git a/qapi/block-core.json b/qapi/block-core.json index 72fa6e0839..64b5ce7e66 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -2939,6 +2939,21 @@ # it is locked # # Since: 2.5 +# +# 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": {} } +# ## { 'command': 'blockdev-open-tray', 'data': { '*device': 'str', |