From 91d00e57a181e1d831833c6e460d981500d0e7ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Fri, 13 Jan 2017 15:41:24 +0100 Subject: docs: add master qapi texi files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The qapi2texi script generates a file to be included in a texi file. Add "QEMU QMP Reference Manual" and "QEMU Guest Agent Protocol Reference" master texi files. Signed-off-by: Marc-André Lureau Reviewed-by: Markus Armbruster Message-Id: <20170113144135.5150-11-marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster --- docs/qemu-ga-ref.texi | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++ docs/qemu-qmp-ref.texi | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 148 insertions(+) create mode 100644 docs/qemu-ga-ref.texi create mode 100644 docs/qemu-qmp-ref.texi (limited to 'docs') diff --git a/docs/qemu-ga-ref.texi b/docs/qemu-ga-ref.texi new file mode 100644 index 0000000..b889802 --- /dev/null +++ b/docs/qemu-ga-ref.texi @@ -0,0 +1,74 @@ +\input texinfo +@setfilename qemu-ga-ref.info + +@exampleindent 0 +@paragraphindent 0 + +@settitle QEMU Guest Agent Protocol Reference + +@copying +This is the QEMU Guest Agent Protocol reference manual. + +Copyright @copyright{} 2016 The QEMU Project developers + +@quotation +This manual is free documentation: you can redistribute it and/or +modify it under the terms of the GNU General Public License as +published by the Free Software Foundation, either version 2 of the +License, or (at your option) any later version. + +This manual is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this manual. If not, see http://www.gnu.org/licenses/. +@end quotation +@end copying + +@dircategory QEMU +@direntry +* QEMU-GA-Ref: (qemu-ga-ref). QEMU Guest Agent Protocol Reference +@end direntry + +@titlepage +@title Guest Agent Protocol Reference Manual +@subtitle QEMU version @value{VERSION} +@page +@vskip 0pt plus 1filll +@insertcopying +@end titlepage + +@contents + +@ifnottex +@node Top +@top QEMU Guest Agent protocol reference +@end ifnottex + +@menu +* API Reference:: +* Commands and Events Index:: +* Data Types Index:: +@end menu + +@node API Reference +@chapter API Reference + +@c for texi2pod: +@c man begin DESCRIPTION + +@include qemu-ga-qapi.texi + +@c man end + +@node Commands and Events Index +@unnumbered Commands and Events Index +@printindex fn + +@node Data Types Index +@unnumbered Data Types Index +@printindex tp + +@bye diff --git a/docs/qemu-qmp-ref.texi b/docs/qemu-qmp-ref.texi new file mode 100644 index 0000000..efb3370 --- /dev/null +++ b/docs/qemu-qmp-ref.texi @@ -0,0 +1,74 @@ +\input texinfo +@setfilename qemu-qmp-ref.info + +@exampleindent 0 +@paragraphindent 0 + +@settitle QEMU QMP Reference Manual + +@copying +This is the QEMU QMP reference manual. + +Copyright @copyright{} 2016 The QEMU Project developers + +@quotation +This manual is free documentation: you can redistribute it and/or +modify it under the terms of the GNU General Public License as +published by the Free Software Foundation, either version 2 of the +License, or (at your option) any later version. + +This manual is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this manual. If not, see http://www.gnu.org/licenses/. +@end quotation +@end copying + +@dircategory QEMU +@direntry +* QEMU-QMP-Ref: (qemu-qmp-ref). QEMU QMP Reference Manual +@end direntry + +@titlepage +@title QMP Reference Manual +@subtitle QEMU version @value{VERSION} +@page +@vskip 0pt plus 1filll +@insertcopying +@end titlepage + +@contents + +@ifnottex +@node Top +@top QEMU QMP reference +@end ifnottex + +@menu +* API Reference:: +* Commands and Events Index:: +* Data Types Index:: +@end menu + +@node API Reference +@chapter API Reference + +@c for texi2pod: +@c man begin DESCRIPTION + +@include qemu-qapi.texi + +@c man end + +@node Commands and Events Index +@unnumbered Commands and Events Index +@printindex fn + +@node Data Types Index +@unnumbered Data Types Index +@printindex tp + +@bye -- cgit v1.1 From 65ce54f5e2abe58b6447457e1453a517ba8c91f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:06:34 +0200 Subject: qmp-commands: move 'add_client' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 18 ------------------ 1 file changed, 18 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 18db4cd..a259428 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1548,24 +1548,6 @@ Example: "time": "+60" } } <- { "return": {} } -add_client ----------- - -Add a graphics client - -Arguments: - -- "protocol": protocol name (json-string) -- "fdname": file descriptor name (json-string) -- "skipauth": whether to skip authentication (json-bool, optional) -- "tls": whether to perform TLS (json-bool, optional) - -Example: - --> { "execute": "add_client", "arguments": { "protocol": "vnc", - "fdname": "myclient" } } -<- { "return": {} } - qmp_capabilities ---------------- -- cgit v1.1 From 3aa4c6cd3932f5606f2faa59e5d7a45fe12417bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:07:26 +0200 Subject: qmp-commands: move 'query-name' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index a259428..ceee41f 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2607,20 +2607,6 @@ Example: } } -query-name ----------- - -Show VM name. - -Return a json-object with the following information: - -- "name": VM's name (json-string, optional) - -Example: - --> { "execute": "query-name" } -<- { "return": { "name": "qemu-name" } } - query-uuid ---------- -- cgit v1.1 From b4f65cd27a049632e77e258bb7503d49a9c54a70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:07:57 +0200 Subject: qmp-commands: move 'query-kvm' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 15 --------------- 1 file changed, 15 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index ceee41f..33fa51e 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2405,21 +2405,6 @@ Example: Note: This example has been shortened as the real response is too long. -query-kvm ---------- - -Show KVM information. - -Return a json-object with the following information: - -- "enabled": true if KVM support is enabled, false otherwise (json-bool) -- "present": true if QEMU has KVM support, false otherwise (json-bool) - -Example: - --> { "execute": "query-kvm" } -<- { "return": { "enabled": true, "present": true } } - query-status ------------ -- cgit v1.1 From 477bc1e4f18acccdd76bed12cbb0b980603fe5ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:10:12 +0200 Subject: qmp-commands: move 'query-status' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 31 ------------------------------- 1 file changed, 31 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 33fa51e..47ae840 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2405,37 +2405,6 @@ Example: Note: This example has been shortened as the real response is too long. -query-status ------------- - -Return a json-object with the following information: - -- "running": true if the VM is running, or false if it is paused (json-bool) -- "singlestep": true if the VM is in single step mode, - false otherwise (json-bool) -- "status": one of the following values (json-string) - "debug" - QEMU is running on a debugger - "inmigrate" - guest is paused waiting for an incoming migration - "internal-error" - An internal error that prevents further guest - execution has occurred - "io-error" - the last IOP has failed and the device is configured - to pause on I/O errors - "paused" - guest has been paused via the 'stop' command - "postmigrate" - guest is paused following a successful 'migrate' - "prelaunch" - QEMU was started with -S and guest has not started - "finish-migrate" - guest is paused to finish the migration process - "restore-vm" - guest is paused to restore VM state - "running" - guest is actively running - "save-vm" - guest is paused to save the VM state - "shutdown" - guest is shut down (and -no-shutdown is in use) - "watchdog" - the watchdog action is configured to pause and - has been triggered - -Example: - --> { "execute": "query-status" } -<- { "return": { "running": true, "singlestep": false, "status": "running" } } - query-mice ---------- -- cgit v1.1 From 0ed90f77e833037c126f5e5e76956d256a655e5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:10:54 +0200 Subject: qmp-commands: move 'query-uuid' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 47ae840..ab0e38c 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2561,20 +2561,6 @@ Example: } } -query-uuid ----------- - -Show VM UUID. - -Return a json-object with the following information: - -- "UUID": Universally Unique Identifier (json-string) - -Example: - --> { "execute": "query-uuid" } -<- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } } - query-command-line-options -------------------------- -- cgit v1.1 From 4055aa8d409262188bc0fc139e8d5be38cfd4f3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:12:15 +0200 Subject: qmp-commands: move 'query-chardev' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 36 ------------------------------------ 1 file changed, 36 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index ab0e38c..ef7366e 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1690,42 +1690,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-chardev -------------- - -Each device is represented by a json-object. The returned value is a json-array -of all devices. - -Each json-object contain the following: - -- "label": device's label (json-string) -- "filename": device's file (json-string) -- "frontend-open": open/closed state of the frontend device attached to this - backend (json-bool) - -Example: - --> { "execute": "query-chardev" } -<- { - "return": [ - { - "label": "charchannel0", - "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server", - "frontend-open": false - }, - { - "label": "charmonitor", - "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.monitor,server", - "frontend-open": true - }, - { - "label": "charserial0", - "filename": "pty:/dev/pts/2", - "frontend-open": true - } - ] - } - query-chardev-backends ------------- -- cgit v1.1 From 90e365c054f64c970697b735d947834f6b65e90e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:13:09 +0200 Subject: qmp-commands: move 'query-chardev-backends' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 32 -------------------------------- 1 file changed, 32 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index ef7366e..46d6abe 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1690,38 +1690,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-chardev-backends -------------- - -List available character device backends. - -Each backend is represented by a json-object, the returned value is a json-array -of all backends. - -Each json-object contains: - -- "name": backend name (json-string) - -Example: - --> { "execute": "query-chardev-backends" } -<- { - "return":[ - { - "name":"udp" - }, - { - "name":"tcp" - }, - { - "name":"unix" - }, - { - "name":"spiceport" - } - ] - } - query-block ----------- -- cgit v1.1 From a4143a845a6d4b078b34aa3c750566cfdea6192a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:15:20 +0200 Subject: qmp-commands: move 'ringbuf-write' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 20 -------------------- 1 file changed, 20 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 46d6abe..c22c6f1 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -334,26 +334,6 @@ Example: Note: inject-nmi fails when the guest doesn't support injecting. -ringbuf-write -------------- - -Write to a ring buffer character device. - -Arguments: - -- "device": ring buffer character device name (json-string) -- "data": data to write (json-string) -- "format": data format (json-string, optional) - - Possible values: "utf8" (default), "base64" - -Example: - --> { "execute": "ringbuf-write", - "arguments": { "device": "foo", - "data": "abcdefgh", - "format": "utf8" } } -<- { "return": {} } - ringbuf-read ------------- -- cgit v1.1 From 4f19a01b3e066b56bf22d83ff12d840c9a213dff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:15:59 +0200 Subject: qmp-commands: move 'ringbuf-read' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 27 --------------------------- 1 file changed, 27 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index c22c6f1..817cc5a 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -334,33 +334,6 @@ Example: Note: inject-nmi fails when the guest doesn't support injecting. -ringbuf-read -------------- - -Read from a ring buffer character device. - -Arguments: - -- "device": ring buffer character device name (json-string) -- "size": how many bytes to read at most (json-int) - - Number of data bytes, not number of characters in encoded data -- "format": data format (json-string, optional) - - Possible values: "utf8" (default), "base64" - - Naturally, format "utf8" works only when the ring buffer - contains valid UTF-8 text. Invalid UTF-8 sequences get - replaced. Bug: replacement doesn't work. Bug: can screw - up on encountering NUL characters, after the ring buffer - lost data, and when reading stops because the size limit - is reached. - -Example: - --> { "execute": "ringbuf-read", - "arguments": { "device": "foo", - "size": 1000, - "format": "utf8" } } -<- {"return": "abcdefgh"} - xen-save-devices-state ------- -- cgit v1.1 From 66c2f5a56ce1a1b85b133ad39ee7cc1a599126cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:18:23 +0200 Subject: qmp-commands: move 'query-events' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 28 ---------------------------- 1 file changed, 28 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 817cc5a..f51ffbf 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1607,34 +1607,6 @@ Example: Note: This example has been shortened as the real response is too long. -query-events --------------- - -List QMP available events. - -Each event is represented by a json-object, the returned value is a json-array -of all events. - -Each json-object contains: - -- "name": event's name (json-string) - -Example: - --> { "execute": "query-events" } -<- { - "return":[ - { - "name":"SHUTDOWN" - }, - { - "name":"RESET" - } - ] - } - -Note: This example has been shortened as the real response is too long. - query-qmp-schema ---------------- -- cgit v1.1 From 104b1caf0544292ab27c9281bb48b0d9bd098658 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:24:07 +0200 Subject: qmp-commands: move 'query-migrate' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 169 -------------------------------------------------- 1 file changed, 169 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index f51ffbf..094e314 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2458,175 +2458,6 @@ Example: ] } -query-migrate -------------- - -Migration status. - -Return a json-object. If migration is active there will be another json-object -with RAM migration status and if block migration is active another one with -block migration status. - -The main json-object contains the following: - -- "status": migration status (json-string) - - Possible values: "setup", "active", "completed", "failed", "cancelled" -- "total-time": total amount of ms since migration started. If - migration has ended, it returns the total migration - time (json-int) -- "setup-time" amount of setup time in milliseconds _before_ the - iterations begin but _after_ the QMP command is issued. - This is designed to provide an accounting of any activities - (such as RDMA pinning) which may be expensive, but do not - actually occur during the iterative migration rounds - themselves. (json-int) -- "downtime": only present when migration has finished correctly - total amount in ms for downtime that happened (json-int) -- "expected-downtime": only present while migration is active - total amount in ms for downtime that was calculated on - the last bitmap round (json-int) -- "ram": only present if "status" is "active", it is a json-object with the - following RAM information: - - "transferred": amount transferred in bytes (json-int) - - "remaining": amount remaining to transfer in bytes (json-int) - - "total": total amount of memory in bytes (json-int) - - "duplicate": number of pages filled entirely with the same - byte (json-int) - These are sent over the wire much more efficiently. - - "skipped": number of skipped zero pages (json-int) - - "normal" : number of whole pages transferred. I.e. they - were not sent as duplicate or xbzrle pages (json-int) - - "normal-bytes" : number of bytes transferred in whole - pages. This is just normal pages times size of one page, - but this way upper levels don't need to care about page - size (json-int) - - "dirty-sync-count": times that dirty ram was synchronized (json-int) -- "disk": only present if "status" is "active" and it is a block migration, - it is a json-object with the following disk information: - - "transferred": amount transferred in bytes (json-int) - - "remaining": amount remaining to transfer in bytes json-int) - - "total": total disk size in bytes (json-int) -- "xbzrle-cache": only present if XBZRLE is active. - It is a json-object with the following XBZRLE information: - - "cache-size": XBZRLE cache size in bytes - - "bytes": number of bytes transferred for XBZRLE compressed pages - - "pages": number of XBZRLE compressed pages - - "cache-miss": number of XBRZRLE page cache misses - - "cache-miss-rate": rate of XBRZRLE page cache misses - - "overflow": number of times XBZRLE overflows. This means - that the XBZRLE encoding was bigger than just sent the - whole page, and then we sent the whole page instead (as as - normal page). - -Examples: - -1. Before the first migration - --> { "execute": "query-migrate" } -<- { "return": {} } - -2. Migration is done and has succeeded - --> { "execute": "query-migrate" } -<- { "return": { - "status": "completed", - "ram":{ - "transferred":123, - "remaining":123, - "total":246, - "total-time":12345, - "setup-time":12345, - "downtime":12345, - "duplicate":123, - "normal":123, - "normal-bytes":123456, - "dirty-sync-count":15 - } - } - } - -3. Migration is done and has failed - --> { "execute": "query-migrate" } -<- { "return": { "status": "failed" } } - -4. Migration is being performed and is not a block migration: - --> { "execute": "query-migrate" } -<- { - "return":{ - "status":"active", - "ram":{ - "transferred":123, - "remaining":123, - "total":246, - "total-time":12345, - "setup-time":12345, - "expected-downtime":12345, - "duplicate":123, - "normal":123, - "normal-bytes":123456, - "dirty-sync-count":15 - } - } - } - -5. Migration is being performed and is a block migration: - --> { "execute": "query-migrate" } -<- { - "return":{ - "status":"active", - "ram":{ - "total":1057024, - "remaining":1053304, - "transferred":3720, - "total-time":12345, - "setup-time":12345, - "expected-downtime":12345, - "duplicate":123, - "normal":123, - "normal-bytes":123456, - "dirty-sync-count":15 - }, - "disk":{ - "total":20971520, - "remaining":20880384, - "transferred":91136 - } - } - } - -6. Migration is being performed and XBZRLE is active: - --> { "execute": "query-migrate" } -<- { - "return":{ - "status":"active", - "capabilities" : [ { "capability": "xbzrle", "state" : true } ], - "ram":{ - "total":1057024, - "remaining":1053304, - "transferred":3720, - "total-time":12345, - "setup-time":12345, - "expected-downtime":12345, - "duplicate":10, - "normal":3333, - "normal-bytes":3412992, - "dirty-sync-count":15 - }, - "xbzrle-cache":{ - "cache-size":67108864, - "bytes":20971520, - "pages":2444343, - "cache-miss":2244, - "cache-miss-rate":0.123, - "overflow":34434 - } - } - } - migrate-set-capabilities ------------------------ -- cgit v1.1 From 0a0bb9644212cce5f906280d543dd73c88f866db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:25:56 +0200 Subject: qmp-commands: move 'migrate-set-capabilities' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 21 --------------------- 1 file changed, 21 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 094e314..da7e88b 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2458,27 +2458,6 @@ Example: ] } -migrate-set-capabilities ------------------------- - -Enable/Disable migration capabilities - -- "xbzrle": XBZRLE support -- "rdma-pin-all": pin all pages when using RDMA during migration -- "auto-converge": throttle down guest to help convergence of migration -- "zero-blocks": compress zero blocks during block migration -- "compress": use multiple compression threads to accelerate live migration -- "events": generate events for each migration state change -- "postcopy-ram": postcopy mode for live migration -- "x-colo": COarse-Grain LOck Stepping (COLO) for Non-stop Service - -Arguments: - -Example: - --> { "execute": "migrate-set-capabilities" , "arguments": - { "capabilities": [ { "capability": "xbzrle", "state": true } ] } } - query-migrate-capabilities -------------------------- -- cgit v1.1 From 135b238e5d622b32ad90b94f25d86a180beb884c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:27:13 +0200 Subject: qmp-commands: move 'query-migrate-capabilities' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 31 ------------------------------- 1 file changed, 31 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index da7e88b..5fbe938 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2458,37 +2458,6 @@ Example: ] } -query-migrate-capabilities --------------------------- - -Query current migration capabilities - -- "capabilities": migration capabilities state - - "xbzrle" : XBZRLE state (json-bool) - - "rdma-pin-all" : RDMA Pin Page state (json-bool) - - "auto-converge" : Auto Converge state (json-bool) - - "zero-blocks" : Zero Blocks state (json-bool) - - "compress": Multiple compression threads state (json-bool) - - "events": Migration state change event state (json-bool) - - "postcopy-ram": postcopy ram state (json-bool) - - "x-colo": COarse-Grain LOck Stepping for Non-stop Service (json-bool) - -Arguments: - -Example: - --> { "execute": "query-migrate-capabilities" } -<- {"return": [ - {"state": false, "capability": "xbzrle"}, - {"state": false, "capability": "rdma-pin-all"}, - {"state": false, "capability": "auto-converge"}, - {"state": false, "capability": "zero-blocks"}, - {"state": false, "capability": "compress"}, - {"state": true, "capability": "events"}, - {"state": false, "capability": "postcopy-ram"}, - {"state": false, "capability": "x-colo"} - ]} - migrate-set-parameters ---------------------- -- cgit v1.1 From 35db41e5dcf8b9bad6751be41d1cc87aa2272a55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:28:47 +0200 Subject: qmp-commands: move 'migrate-set-parameters' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 24 ------------------------ 1 file changed, 24 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 5fbe938..387cb32 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2458,30 +2458,6 @@ Example: ] } -migrate-set-parameters ----------------------- - -Set migration parameters - -- "compress-level": set compression level during migration (json-int) -- "compress-threads": set compression thread count for migration (json-int) -- "decompress-threads": set decompression thread count for migration (json-int) -- "cpu-throttle-initial": set initial percentage of time guest cpus are - throttled for auto-converge (json-int) -- "cpu-throttle-increment": set throttle increasing percentage for - auto-converge (json-int) -- "max-bandwidth": set maximum speed for migrations (in bytes/sec) (json-int) -- "downtime-limit": set maximum tolerated downtime (in milliseconds) for - migrations (json-int) -- "x-checkpoint-delay": set the delay time for periodic checkpoint (json-int) - -Arguments: - -Example: - --> { "execute": "migrate-set-parameters" , "arguments": - { "compress-level": 1 } } - query-migrate-parameters ------------------------ -- cgit v1.1 From cf56cfad3ca963fef0f2856217d19f2e13ed1c90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:30:37 +0200 Subject: qmp-commands: move 'query-migrate-parameters' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 34 ---------------------------------- 1 file changed, 34 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 387cb32..f5cf7da 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2458,40 +2458,6 @@ Example: ] } -query-migrate-parameters ------------------------- - -Query current migration parameters - -- "parameters": migration parameters value - - "compress-level" : compression level value (json-int) - - "compress-threads" : compression thread count value (json-int) - - "decompress-threads" : decompression thread count value (json-int) - - "cpu-throttle-initial" : initial percentage of time guest cpus are - throttled (json-int) - - "cpu-throttle-increment" : throttle increasing percentage for - auto-converge (json-int) - - "max-bandwidth" : maximium migration speed in bytes per second - (json-int) - - "downtime-limit" : maximum tolerated downtime of migration in - milliseconds (json-int) -Arguments: - -Example: - --> { "execute": "query-migrate-parameters" } -<- { - "return": { - "decompress-threads": 2, - "cpu-throttle-increment": 10, - "compress-threads": 8, - "compress-level": 1, - "cpu-throttle-initial": 20, - "max-bandwidth": 33554432, - "downtime-limit": 300 - } - } - query-balloon ------------- -- cgit v1.1 From d0d3fc7ff9f50dde85f020b9aa8ef8e076f647cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:32:33 +0200 Subject: qmp-commands: move 'client_migrate_info' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 23 ----------------------- 1 file changed, 23 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index f5cf7da..f963066 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -517,29 +517,6 @@ Example: -> { "execute": "x-colo-lost-heartbeat" } <- { "return": {} } -client_migrate_info -------------------- - -Set migration information for remote display. This makes the server -ask the client to automatically reconnect using the new parameters -once migration finished successfully. Only implemented for SPICE. - -Arguments: - -- "protocol": must be "spice" (json-string) -- "hostname": migration target hostname (json-string) -- "port": spice tcp port for plaintext channels (json-int, optional) -- "tls-port": spice tcp port for tls-secured channels (json-int, optional) -- "cert-subject": server certificate subject (json-string, optional) - -Example: - --> { "execute": "client_migrate_info", - "arguments": { "protocol": "spice", - "hostname": "virt42.lab.kraxel.org", - "port": 1234 } } -<- { "return": {} } - dump -- cgit v1.1 From 3c3ea00a8c65f73d41ad921333bbee7931414a4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:34:00 +0200 Subject: qmp-commands: move 'migrate-start-postcopy' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 10 ---------- 1 file changed, 10 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index f963066..536bddf 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -456,16 +456,6 @@ Example: -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } } <- { "return": {} } -migrate-start-postcopy ----------------------- - -Switch an in-progress migration to postcopy mode. Ignored after the end of -migration (or once already in postcopy). - -Example: --> { "execute": "migrate-start-postcopy" } -<- { "return": {} } - query-migrate-cache-size ------------------------ -- cgit v1.1 From 60639df5c2368aea848bc9963e57603adf21e1c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:34:48 +0200 Subject: qmp-commands: move 'query-mice' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 35 ----------------------------------- 1 file changed, 35 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 536bddf..693ede6 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2229,41 +2229,6 @@ Example: Note: This example has been shortened as the real response is too long. -query-mice ----------- - -Show VM mice information. - -Each mouse is represented by a json-object, the returned value is a json-array -of all mice. - -The mouse json-object contains the following: - -- "name": mouse's name (json-string) -- "index": mouse's index (json-int) -- "current": true if this mouse is receiving events, false otherwise (json-bool) -- "absolute": true if the mouse generates absolute input events (json-bool) - -Example: - --> { "execute": "query-mice" } -<- { - "return":[ - { - "name":"QEMU Microsoft Mouse", - "index":0, - "current":false, - "absolute":false - }, - { - "name":"QEMU PS/2 Mouse", - "index":1, - "current":true, - "absolute":true - } - ] - } - query-vnc --------- -- cgit v1.1 From 5c5bee64187269d9ae6deb122626920a963b0f2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:56:56 +0200 Subject: qmp-commands: move 'query-cpus' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 46 ---------------------------------------------- 1 file changed, 46 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 693ede6..e0d827a 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1945,52 +1945,6 @@ Example: ] } -query-cpus ----------- - -Show CPU information. - -Return a json-array. Each CPU is represented by a json-object, which contains: - -- "CPU": CPU index (json-int) -- "current": true if this is the current CPU, false otherwise (json-bool) -- "halted": true if the cpu is halted, false otherwise (json-bool) -- "qom_path": path to the CPU object in the QOM tree (json-str) -- "arch": architecture of the cpu, which determines what additional - keys will be present (json-str) -- Current program counter. The key's name depends on the architecture: - "pc": i386/x86_64 (json-int) - "nip": PPC (json-int) - "pc" and "npc": sparc (json-int) - "PC": mips (json-int) -- "thread_id": ID of the underlying host thread (json-int) - -Example: - --> { "execute": "query-cpus" } -<- { - "return":[ - { - "CPU":0, - "current":true, - "halted":false, - "qom_path":"/machine/unattached/device[0]", - "arch":"x86", - "pc":3227107138, - "thread_id":3134 - }, - { - "CPU":1, - "current":false, - "halted":true, - "qom_path":"/machine/unattached/device[2]", - "arch":"x86", - "pc":7108165, - "thread_id":3135 - } - ] - } - query-iothreads --------------- -- cgit v1.1 From fdf4d34f8398099431888d3f7522a7b71df0ba58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 10:57:59 +0200 Subject: qmp-commands: move 'query-iothreads' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 30 ------------------------------ 1 file changed, 30 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index e0d827a..e7d47d3 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1945,36 +1945,6 @@ Example: ] } -query-iothreads ---------------- - -Returns a list of information about each iothread. - -Note this list excludes the QEMU main loop thread, which is not declared -using the -object iothread command-line option. It is always the main thread -of the process. - -Return a json-array. Each iothread is represented by a json-object, which contains: - -- "id": name of iothread (json-str) -- "thread-id": ID of the underlying host thread (json-int) - -Example: - --> { "execute": "query-iothreads" } -<- { - "return":[ - { - "id":"iothread0", - "thread-id":3134 - }, - { - "id":"iothread1", - "thread-id":3135 - } - ] - } - query-pci --------- -- cgit v1.1 From 85f96549100a7239ceae15c9a5b0ba8cdd95bdaa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 11:36:11 +0200 Subject: qmp-commands: move 'query-vnc' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 54 --------------------------------------------------- 1 file changed, 54 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index e7d47d3..c56d0ef 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2153,60 +2153,6 @@ Example: Note: This example has been shortened as the real response is too long. -query-vnc ---------- - -Show VNC server information. - -Return a json-object with server information. Connected clients are returned -as a json-array of json-objects. - -The main json-object contains the following: - -- "enabled": true or false (json-bool) -- "host": server's IP address (json-string) -- "family": address family (json-string) - - Possible values: "ipv4", "ipv6", "unix", "unknown" -- "service": server's port number (json-string) -- "auth": authentication method (json-string) - - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight", - "tls", "ultra", "unknown", "vencrypt", "vencrypt", - "vencrypt+plain", "vencrypt+tls+none", - "vencrypt+tls+plain", "vencrypt+tls+sasl", - "vencrypt+tls+vnc", "vencrypt+x509+none", - "vencrypt+x509+plain", "vencrypt+x509+sasl", - "vencrypt+x509+vnc", "vnc" -- "clients": a json-array of all connected clients - -Clients are described by a json-object, each one contain the following: - -- "host": client's IP address (json-string) -- "family": address family (json-string) - - Possible values: "ipv4", "ipv6", "unix", "unknown" -- "service": client's port number (json-string) -- "x509_dname": TLS dname (json-string, optional) -- "sasl_username": SASL username (json-string, optional) - -Example: - --> { "execute": "query-vnc" } -<- { - "return":{ - "enabled":true, - "host":"0.0.0.0", - "service":"50402", - "auth":"vnc", - "family":"ipv4", - "clients":[ - { - "host":"127.0.0.1", - "service":"50401", - "family":"ipv4" - } - ] - } - } - query-spice ----------- -- cgit v1.1 From bc7e260271f98d44006d4e14bcb05647b8f2606e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 11:37:09 +0200 Subject: qmp-commands: move 'query-spice' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 67 --------------------------------------------------- 1 file changed, 67 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index c56d0ef..d018480 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2153,73 +2153,6 @@ Example: Note: This example has been shortened as the real response is too long. -query-spice ------------ - -Show SPICE server information. - -Return a json-object with server information. Connected clients are returned -as a json-array of json-objects. - -The main json-object contains the following: - -- "enabled": true or false (json-bool) -- "host": server's IP address (json-string) -- "port": server's port number (json-int, optional) -- "tls-port": server's port number (json-int, optional) -- "auth": authentication method (json-string) - - Possible values: "none", "spice" -- "channels": a json-array of all active channels clients - -Channels are described by a json-object, each one contain the following: - -- "host": client's IP address (json-string) -- "family": address family (json-string) - - Possible values: "ipv4", "ipv6", "unix", "unknown" -- "port": client's port number (json-string) -- "connection-id": spice connection id. All channels with the same id - belong to the same spice session (json-int) -- "channel-type": channel type. "1" is the main control channel, filter for - this one if you want track spice sessions only (json-int) -- "channel-id": channel id. Usually "0", might be different needed when - multiple channels of the same type exist, such as multiple - display channels in a multihead setup (json-int) -- "tls": whether the channel is encrypted (json-bool) - -Example: - --> { "execute": "query-spice" } -<- { - "return": { - "enabled": true, - "auth": "spice", - "port": 5920, - "tls-port": 5921, - "host": "0.0.0.0", - "channels": [ - { - "port": "54924", - "family": "ipv4", - "channel-type": 1, - "connection-id": 1804289383, - "host": "127.0.0.1", - "channel-id": 0, - "tls": true - }, - { - "port": "36710", - "family": "ipv4", - "channel-type": 4, - "connection-id": 1804289383, - "host": "127.0.0.1", - "channel-id": 0, - "tls": false - }, - [ ... more channels follow ... ] - ] - } - } - query-command-line-options -------------------------- -- cgit v1.1 From f504e3dc21bb76ef7766cc99390defb200faa893 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 11:40:02 +0200 Subject: qmp-commands: move 'query-balloon' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 19 ------------------- 1 file changed, 19 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index d018480..9445bd1 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2193,25 +2193,6 @@ Example: ] } -query-balloon -------------- - -Show balloon information. - -Make an asynchronous request for balloon info. When the request completes a -json-object will be returned containing the following data: - -- "actual": current balloon value in bytes (json-int) - -Example: - --> { "execute": "query-balloon" } -<- { - "return":{ - "actual":1073741824, - } - } - query-tpm --------- -- cgit v1.1 From 3fc3aa6de974dc7e302ec29ec89fdc3bfc2a2bcf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 11:44:21 +0200 Subject: qmp-commands: move 'query-pci' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 208 -------------------------------------------------- 1 file changed, 208 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 9445bd1..ffc7cb9 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1945,214 +1945,6 @@ Example: ] } -query-pci ---------- - -PCI buses and devices information. - -The returned value is a json-array of all buses. Each bus is represented by -a json-object, which has a key with a json-array of all PCI devices attached -to it. Each device is represented by a json-object. - -The bus json-object contains the following: - -- "bus": bus number (json-int) -- "devices": a json-array of json-objects, each json-object represents a - PCI device - -The PCI device json-object contains the following: - -- "bus": identical to the parent's bus number (json-int) -- "slot": slot number (json-int) -- "function": function number (json-int) -- "class_info": a json-object containing: - - "desc": device class description (json-string, optional) - - "class": device class number (json-int) -- "id": a json-object containing: - - "device": device ID (json-int) - - "vendor": vendor ID (json-int) -- "irq": device's IRQ if assigned (json-int, optional) -- "qdev_id": qdev id string (json-string) -- "pci_bridge": It's a json-object, only present if this device is a - PCI bridge, contains: - - "bus": bus number (json-int) - - "secondary": secondary bus number (json-int) - - "subordinate": subordinate bus number (json-int) - - "io_range": I/O memory range information, a json-object with the - following members: - - "base": base address, in bytes (json-int) - - "limit": limit address, in bytes (json-int) - - "memory_range": memory range information, a json-object with the - following members: - - "base": base address, in bytes (json-int) - - "limit": limit address, in bytes (json-int) - - "prefetchable_range": Prefetchable memory range information, a - json-object with the following members: - - "base": base address, in bytes (json-int) - - "limit": limit address, in bytes (json-int) - - "devices": a json-array of PCI devices if there's any attached, each - each element is represented by a json-object, which contains - the same members of the 'PCI device json-object' described - above (optional) -- "regions": a json-array of json-objects, each json-object represents a - memory region of this device - -The memory range json-object contains the following: - -- "base": base memory address (json-int) -- "limit": limit value (json-int) - -The region json-object can be an I/O region or a memory region, an I/O region -json-object contains the following: - -- "type": "io" (json-string, fixed) -- "bar": BAR number (json-int) -- "address": memory address (json-int) -- "size": memory size (json-int) - -A memory region json-object contains the following: - -- "type": "memory" (json-string, fixed) -- "bar": BAR number (json-int) -- "address": memory address (json-int) -- "size": memory size (json-int) -- "mem_type_64": true or false (json-bool) -- "prefetch": true or false (json-bool) - -Example: - --> { "execute": "query-pci" } -<- { - "return":[ - { - "bus":0, - "devices":[ - { - "bus":0, - "qdev_id":"", - "slot":0, - "class_info":{ - "class":1536, - "desc":"Host bridge" - }, - "id":{ - "device":32902, - "vendor":4663 - }, - "function":0, - "regions":[ - - ] - }, - { - "bus":0, - "qdev_id":"", - "slot":1, - "class_info":{ - "class":1537, - "desc":"ISA bridge" - }, - "id":{ - "device":32902, - "vendor":28672 - }, - "function":0, - "regions":[ - - ] - }, - { - "bus":0, - "qdev_id":"", - "slot":1, - "class_info":{ - "class":257, - "desc":"IDE controller" - }, - "id":{ - "device":32902, - "vendor":28688 - }, - "function":1, - "regions":[ - { - "bar":4, - "size":16, - "address":49152, - "type":"io" - } - ] - }, - { - "bus":0, - "qdev_id":"", - "slot":2, - "class_info":{ - "class":768, - "desc":"VGA controller" - }, - "id":{ - "device":4115, - "vendor":184 - }, - "function":0, - "regions":[ - { - "prefetch":true, - "mem_type_64":false, - "bar":0, - "size":33554432, - "address":4026531840, - "type":"memory" - }, - { - "prefetch":false, - "mem_type_64":false, - "bar":1, - "size":4096, - "address":4060086272, - "type":"memory" - }, - { - "prefetch":false, - "mem_type_64":false, - "bar":6, - "size":65536, - "address":-1, - "type":"memory" - } - ] - }, - { - "bus":0, - "qdev_id":"", - "irq":11, - "slot":4, - "class_info":{ - "class":1280, - "desc":"RAM controller" - }, - "id":{ - "device":6900, - "vendor":4098 - }, - "function":0, - "regions":[ - { - "bar":0, - "size":32, - "address":49280, - "type":"io" - } - ] - } - ] - } - ] - } - -Note: This example has been shortened as the real response is too long. - query-command-line-options -------------------------- -- cgit v1.1 From 8046bf53ba447a6b8932c046cc84845e9cecc804 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:01:27 +0200 Subject: qmp-commands: move 'quit' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index ffc7cb9..4df1d47 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -53,18 +53,6 @@ If you're planning to adopt QMP, please observe the following: Server's responses in the examples below are always a success response, please refer to the QMP specification for more details on error responses. -quit ----- - -Quit the emulator. - -Arguments: None. - -Example: - --> { "execute": "quit" } -<- { "return": {} } - eject ----- -- cgit v1.1 From 9787339ebb6af5360c3b4759831ff4a54464b64d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:02:39 +0200 Subject: qmp-commands: move 'stop' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 4df1d47..d0d324d 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -113,18 +113,6 @@ Example: -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } } <- { "return": {} } -stop ----- - -Stop the emulator. - -Arguments: None. - -Example: - --> { "execute": "stop" } -<- { "return": {} } - cont ---- -- cgit v1.1 From cd98e00be03c04faa82dd1149974a85dcb94aad8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:03:06 +0200 Subject: qmp-commands: move 'system_reset' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index d0d324d..647cc3a 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -137,18 +137,6 @@ Example: -> { "execute": "system_wakeup" } <- { "return": {} } -system_reset ------------- - -Reset the system. - -Arguments: None. - -Example: - --> { "execute": "system_reset" } -<- { "return": {} } - system_powerdown ---------------- -- cgit v1.1 From 04fcbabc45d793b0ec0b38b56e1fa4a9257892e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:03:30 +0200 Subject: qmp-commands: move 'system_powerdown' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 647cc3a..2de1a48 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -137,18 +137,6 @@ Example: -> { "execute": "system_wakeup" } <- { "return": {} } -system_powerdown ----------------- - -Send system power down event. - -Arguments: None. - -Example: - --> { "execute": "system_powerdown" } -<- { "return": {} } - device_add ---------- -- cgit v1.1 From a7b83754aaff4e9dd012730e3060bfd2de9eee86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:04:10 +0200 Subject: qmp-commands: move 'cpu-add' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 2de1a48..215239f 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -219,20 +219,6 @@ Example: Note: CPUs' indexes are obtained with the 'query-cpus' command. -cpu-add -------- - -Adds virtual cpu - -Arguments: - -- "id": cpu id (json-int) - -Example: - --> { "execute": "cpu-add", "arguments": { "id": 2 } } -<- { "return": {} } - memsave ------- -- cgit v1.1 From 30831b63dac44e2cac6779a7d2db34daa560b142 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:05:26 +0200 Subject: qmp-commands: move 'memsave' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Notice that "cpu" argument is actually "cpu-index" in the json. Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 20 -------------------- 1 file changed, 20 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 215239f..df988ab 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -219,26 +219,6 @@ Example: Note: CPUs' indexes are obtained with the 'query-cpus' command. -memsave -------- - -Save to disk virtual memory dump starting at 'val' of size 'size'. - -Arguments: - -- "val": the starting address (json-int) -- "size": the memory size, in bytes (json-int) -- "filename": file path (json-string) -- "cpu": virtual CPU index (json-int, optional) - -Example: - --> { "execute": "memsave", - "arguments": { "val": 10, - "size": 100, - "filename": "/tmp/virtual-mem-dump" } } -<- { "return": {} } - pmemsave -------- -- cgit v1.1 From 978d4d97dac8ab98e28011fd696e2594a999af26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:06:17 +0200 Subject: qmp-commands: move 'pmemsave' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 19 ------------------- 1 file changed, 19 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index df988ab..bc7cec1 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -219,25 +219,6 @@ Example: Note: CPUs' indexes are obtained with the 'query-cpus' command. -pmemsave --------- - -Save to disk physical memory dump starting at 'val' of size 'size'. - -Arguments: - -- "val": the starting address (json-int) -- "size": the memory size, in bytes (json-int) -- "filename": file path (json-string) - -Example: - --> { "execute": "pmemsave", - "arguments": { "val": 10, - "size": 100, - "filename": "/tmp/physical-mem-dump" } } -<- { "return": {} } - inject-nmi ---------- -- cgit v1.1 From 3815d0de51124db3da50abaebbb4ec5f1d531f53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:07:08 +0200 Subject: qmp-commands: move 'cont' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index bc7cec1..083273d7 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -113,18 +113,6 @@ Example: -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } } <- { "return": {} } -cont ----- - -Resume emulation. - -Arguments: None. - -Example: - --> { "execute": "cont" } -<- { "return": {} } - system_wakeup ------------- -- cgit v1.1 From 253cdee14864806d1aaa397ece3fddbcbdcc1734 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:07:39 +0200 Subject: qmp-commands: move 'system_wakeup' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 083273d7..2361e84 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -113,18 +113,6 @@ Example: -> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } } <- { "return": {} } -system_wakeup -------------- - -Wakeup guest from suspend. - -Arguments: None. - -Example: - --> { "execute": "system_wakeup" } -<- { "return": {} } - device_add ---------- -- cgit v1.1 From 149ea099cdee4857f9af7125682f7dadf23c8ac8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:08:44 +0200 Subject: qmp-commands: move 'inject-nmi' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 2361e84..ba4fd1c 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -195,20 +195,6 @@ Example: Note: CPUs' indexes are obtained with the 'query-cpus' command. -inject-nmi ----------- - -Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64). - -Arguments: None. - -Example: - --> { "execute": "inject-nmi" } -<- { "return": {} } - -Note: inject-nmi fails when the guest doesn't support injecting. - xen-save-devices-state ------- -- cgit v1.1 From f9cfb8f729dc11e387daa575ae193c0ad56c8a92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:09:45 +0200 Subject: qmp-commands: move 'set_link' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 15 --------------- 1 file changed, 15 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index ba4fd1c..6038f5c 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1088,21 +1088,6 @@ Example: -> { "execute": "balloon", "arguments": { "value": 536870912 } } <- { "return": {} } -set_link --------- - -Change the link status of a network adapter. - -Arguments: - -- "name": network device name (json-string) -- "up": status is up (json-bool) - -Example: - --> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } } -<- { "return": {} } - getfd ----- -- cgit v1.1 From 7b338db7ef58619db0a43d464d3cfe07e6ea0e3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:10:30 +0200 Subject: qmp-commands: move 'balloon' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 6038f5c..a6d3946 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1074,20 +1074,6 @@ Arguments: Returns: Nothing on success If "device" does not exist or cannot be determined, DeviceNotFound -balloon -------- - -Request VM to change its memory allocation (in bytes). - -Arguments: - -- "value": New memory allocation (json-int) - -Example: - --> { "execute": "balloon", "arguments": { "value": 536870912 } } -<- { "return": {} } - getfd ----- -- cgit v1.1 From 5c82b0f1982932b494ccb1c35a96b7db1db444f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:13:09 +0200 Subject: qmp-commands: move 'transaction' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 86 --------------------------------------------------- 1 file changed, 86 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index a6d3946..eee7f25 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -699,92 +699,6 @@ Example: "target": "tgt-id" } } <- { "return": {} } -transaction ------------ - -Atomically operate on one or more block devices. Operations that are -currently supported: - - - drive-backup - - blockdev-backup - - blockdev-snapshot-sync - - blockdev-snapshot-internal-sync - - abort - - block-dirty-bitmap-add - - block-dirty-bitmap-clear - -Refer to the qemu/qapi-schema.json file for minimum required QEMU -versions for these operations. A list of dictionaries is accepted, -that contains the actions to be performed. If there is any failure -performing any of the operations, all operations for the group are -abandoned. - -For external snapshots, the dictionary contains the device, the file to use for -the new snapshot, and the format. The default format, if not specified, is -qcow2. - -Each new snapshot defaults to being created by QEMU (wiping any -contents if the file already exists), but it is also possible to reuse -an externally-created file. In the latter case, you should ensure that -the new image file has the same contents as the current one; QEMU cannot -perform any meaningful check. Typically this is achieved by using the -current image file as the backing file for the new image. - -On failure, the original disks pre-snapshot attempt will be used. - -For internal snapshots, the dictionary contains the device and the snapshot's -name. If an internal snapshot matching name already exists, the request will -be rejected. Only some image formats support it, for example, qcow2, rbd, -and sheepdog. - -On failure, qemu will try delete the newly created internal snapshot in the -transaction. When an I/O error occurs during deletion, the user needs to fix -it later with qemu-img or other command. - -Arguments: - -actions array: - - "type": the operation to perform (json-string). Possible - values: "drive-backup", "blockdev-backup", - "blockdev-snapshot-sync", - "blockdev-snapshot-internal-sync", - "abort", "block-dirty-bitmap-add", - "block-dirty-bitmap-clear" - - "data": a dictionary. The contents depend on the value - of "type". When "type" is "blockdev-snapshot-sync": - - "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) - - "format": format of new image (json-string, optional) - - "mode": whether and how QEMU should create the snapshot file - (NewImageMode, optional, default "absolute-paths") - When "type" is "blockdev-snapshot-internal-sync": - - "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": "transaction", - "arguments": { "actions": [ - { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0", - "snapshot-file": "/some/place/my-image", - "format": "qcow2" } }, - { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile", - "snapshot-file": "/some/place/my-image2", - "snapshot-node-name": "node3432", - "mode": "existing", - "format": "qcow2" } }, - { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1", - "snapshot-file": "/some/place/my-image2", - "mode": "existing", - "format": "qcow2" } }, - { "type": "blockdev-snapshot-internal-sync", "data" : { - "device": "ide-hd2", - "name": "snapshot0" } } ] } } -<- { "return": {} } - block-dirty-bitmap-add ---------------------- Since 2.4 -- cgit v1.1 From e9ac76acd7aed4d96d05a6abf1460dd63afec20f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:15:03 +0200 Subject: qmp-commands: move 'human-monitor-command' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 33 --------------------------------- 1 file changed, 33 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index eee7f25..3faba0c 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1228,39 +1228,6 @@ Example: Note: This command must be issued before issuing any other command. -human-monitor-command ---------------------- - -Execute a Human Monitor command. - -Arguments: - -- command-line: the command name and its arguments, just like the - Human Monitor's shell (json-string) -- cpu-index: select the CPU number to be used by commands which access CPU - data, like 'info registers'. The Monitor selects CPU 0 if this - argument is not provided (json-int, optional) - -Example: - --> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } } -<- { "return": "kvm support: enabled\r\n" } - -Notes: - -(1) The Human Monitor is NOT an stable interface, this means that command - names, arguments and responses can change or be removed at ANY time. - Applications that rely on long term stability guarantees should NOT - use this command - -(2) Limitations: - - o This command is stateless, this means that commands that depend - on state information (such as getfd) might not work - - o Commands that prompt the user for data (eg. 'cont' when the block - device is encrypted) don't currently work - 3. Query Commands ================= -- cgit v1.1 From 92dcfb434ce2c4b0f27a1a243d1e770a8e666d00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:16:09 +0200 Subject: qmp-commands: move 'migrate_cancel' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 3faba0c..a2f2a1b 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -270,18 +270,6 @@ Notes: (3) The user Monitor's "detach" argument is invalid in QMP and should not be used -migrate_cancel --------------- - -Cancel the current migration. - -Arguments: None. - -Example: - --> { "execute": "migrate_cancel" } -<- { "return": {} } - migrate-incoming ---------------- -- cgit v1.1 From de0b45ea6bd463c3a51de9425ce0a49df2e14484 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:16:59 +0200 Subject: qmp-commands: move 'migrate_set_downtime' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index a2f2a1b..ed4389f 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -332,20 +332,6 @@ Example: -> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } } <- { "return": {} } -migrate_set_downtime --------------------- - -Set maximum tolerated downtime (in seconds) for migrations. - -Arguments: - -- "value": maximum downtime (json-number) - -Example: - --> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } } -<- { "return": {} } - x-colo-lost-heartbeat -------------------- -- cgit v1.1 From ab9895337c4613ddee1b56f4a1ce3025155483c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:18:01 +0200 Subject: qmp-commands: move 'migrate_set_speed' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index ed4389f..889955e 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -318,20 +318,6 @@ Example: -> { "execute": "query-migrate-cache-size" } <- { "return": 67108864 } -migrate_set_speed ------------------ - -Set maximum speed for migrations. - -Arguments: - -- "value": maximum speed, in bytes per second (json-int) - -Example: - --> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } } -<- { "return": {} } - x-colo-lost-heartbeat -------------------- -- cgit v1.1 From b953601be00e020bd960d7bd4f1276b743cd35fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:19:25 +0200 Subject: qmp-commands: move 'query-migrate-cache-size' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 13 ------------- 1 file changed, 13 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 889955e..88bb012 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -305,19 +305,6 @@ Example: -> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } } <- { "return": {} } -query-migrate-cache-size ------------------------- - -Show cache size to be used by XBZRLE migration - -returns a json-object with the following information: -- "size" : json-int - -Example: - --> { "execute": "query-migrate-cache-size" } -<- { "return": 67108864 } - x-colo-lost-heartbeat -------------------- -- cgit v1.1 From 4d8a374e3e62ab581be74a66915fd38b1c98816f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:20:39 +0200 Subject: qmp-commands: move 'set_password' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 17 ----------------- 1 file changed, 17 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 88bb012..1faa47f 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1128,23 +1128,6 @@ Example: "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 --------------- -- cgit v1.1 From 342816b975ec263b7663f7d2e025ed5b7fc1dc13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:21:41 +0200 Subject: qmp-commands: move 'expire_password' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 16 ---------------- 1 file changed, 16 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 1faa47f..65cab07 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1128,22 +1128,6 @@ Example: "iops_size": 0 } } <- { "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 ---------------- -- cgit v1.1 From 01387ae5604d9ef26f25134b3bf266c341b9e973 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:22:37 +0200 Subject: qmp-commands: move 'change' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 27 --------------------------- 1 file changed, 27 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 65cab07..f4645f5 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -72,33 +72,6 @@ Example: 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 ---------- -- cgit v1.1 From b3ac5a0de9b88454e42d0ee2755cc1083ccc25bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:23:44 +0200 Subject: qmp-commands: move 'migrate' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 24 ------------------------ 1 file changed, 24 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index f4645f5..7194ab1 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -219,30 +219,6 @@ Example: "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 ---------------- -- cgit v1.1 From dbdbddb96e55da26a503cfa107689b77f7d65dd9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:24:40 +0200 Subject: qmp-commands: move 'migrate-incoming' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 20 -------------------- 1 file changed, 20 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 7194ab1..116d2f7 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -219,26 +219,6 @@ Example: "arguments": { "enable": true } } <- { "return": {} } -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 ---------------------- -- cgit v1.1 From 2ea72beb9f9f561c66b9bacfee61d0fb96d4f15b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:25:28 +0200 Subject: qmp-commands: move 'xen-save-devices-state' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 18 ------------------ 1 file changed, 18 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 116d2f7..73fef65 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -168,24 +168,6 @@ Example: 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 ---------------------- -- cgit v1.1 From a4df6eff46e366e8c6ac69d93ea59f95ebd802fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:26:12 +0200 Subject: qmp-commands: move 'xen-set-global-dirty-log' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 15 --------------- 1 file changed, 15 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 73fef65..d7104e8 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -186,21 +186,6 @@ Example: "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-set-cache-size ---------------------- -- cgit v1.1 From e389c0049afae90de2b958afa439dd9f47b12c1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:27:06 +0200 Subject: qmp-commands: move 'device_del' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 19 ------------------- 1 file changed, 19 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index d7104e8..8adc106 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -111,25 +111,6 @@ Notes: (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 ---------- -- cgit v1.1 From 58e4300a7f5864950a3486ce81b144472161b870 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:29:50 +0200 Subject: qmp-commands: move 'dump-guest-memory' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 30 ------------------------------ 1 file changed, 30 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 8adc106..162467e 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -192,36 +192,6 @@ 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 ---------- -- cgit v1.1 From 2ccb98033353512a1cdf171fdc88047d5977c97d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:31:04 +0200 Subject: qmp-commands: move 'query-dump-guest-memory-capability' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 11 ----------- 1 file changed, 11 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 162467e..e4c8457 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -192,17 +192,6 @@ Example: -> { "execute": "x-colo-lost-heartbeat" } <- { "return": {} } -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 ---------- -- cgit v1.1 From ee332b5125e416600d0b47689d8050f479b38479 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:31:48 +0200 Subject: qmp-commands: move 'dump-skeys' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index e4c8457..b19c36d 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -205,20 +205,6 @@ Example: <- { "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 ---------- -- cgit v1.1 From aa72941bccda04854f888ba50c4970a86db74b33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:33:15 +0200 Subject: qmp-commands: move 'netdev_add' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 22 ---------------------- 1 file changed, 22 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index b19c36d..9d1a92a 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -205,28 +205,6 @@ Example: <- { "return": { "status": "active", "completed": 1024000, "total": 2048000 } } -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 ---------- -- cgit v1.1 From d071f6be51932ac30d0d585f74e38f9c8f6be769 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:33:57 +0200 Subject: qmp-commands: move 'netdev_del' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 15 --------------- 1 file changed, 15 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 9d1a92a..9e26cfe 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -205,21 +205,6 @@ Example: <- { "return": { "status": "active", "completed": 1024000, "total": 2048000 } } -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 ---------- -- cgit v1.1 From 6517192b160363f9f24c7f05a0f7f88c5a1be114 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:34:37 +0200 Subject: qmp-commands: move 'object-add' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 17 ----------------- 1 file changed, 17 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 9e26cfe..397b3d6 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -205,23 +205,6 @@ Example: <- { "return": { "status": "active", "completed": 1024000, "total": 2048000 } } -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 ---------- -- cgit v1.1 From de0ba66226ebdf1747759c53ac9ab0de7b9ebf58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:35:05 +0200 Subject: qmp-commands: move 'object-del' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 15 --------------- 1 file changed, 15 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 397b3d6..2555eef 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -205,21 +205,6 @@ Example: <- { "return": { "status": "active", "completed": 1024000, "total": 2048000 } } -object-del ----------- - -Remove QOM object. - -Arguments: - -- "id": the object's ID (json-string) - -Example: - --> { "execute": "object-del", "arguments": { "id": "rng1" } } -<- { "return": {} } - - block_resize ------------ -- cgit v1.1 From 179bf59a3aeccf2350e054e24a232a1b69e9a27b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:35:51 +0200 Subject: qmp-commands: move 'getfd' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 22 ---------------------- 1 file changed, 22 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 2555eef..483769c 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -688,28 +688,6 @@ Arguments: 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 ------- -- cgit v1.1 From f5ad8e87c737996abe5e61124dc07adb2b610dac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:37:08 +0200 Subject: qmp-commands: move 'closefd' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 483769c..d727f36 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -688,20 +688,6 @@ Arguments: Returns: Nothing on success If "device" does not exist or cannot be determined, DeviceNotFound -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 ------- -- cgit v1.1 From 43fef34a2938c2feda5b668bba01a7fb01a19308 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:39:05 +0200 Subject: qmp-commands: move 'add-fd' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 28 ---------------------------- 1 file changed, 28 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index d727f36..21f3ddf 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -688,34 +688,6 @@ Arguments: Returns: Nothing on success If "device" does not exist or cannot be determined, DeviceNotFound -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 --------- -- cgit v1.1 From 4503e4b3b90b8095e267b7791c8ce5194d6396e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:39:42 +0200 Subject: qmp-commands: move 'remove-fd' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 22 ---------------------- 1 file changed, 22 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 21f3ddf..b034265 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -688,28 +688,6 @@ Arguments: Returns: Nothing on success If "device" does not exist or cannot be determined, DeviceNotFound -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 ------------- -- cgit v1.1 From d71ca35dfc3da867fc25d2db4beb923b81669e35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:40:29 +0200 Subject: qmp-commands: move 'query-fdsets' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 40 ---------------------------------------- 1 file changed, 40 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index b034265..1fe4f40 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -688,46 +688,6 @@ Arguments: Returns: Nothing on success If "device" does not exist or cannot be determined, DeviceNotFound -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 ------------ -- cgit v1.1 From f45fd52cefaf84fab166dd9d25d12b87813f4882 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:41:20 +0200 Subject: qmp-commands: move 'send-key' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 22 ---------------------- 1 file changed, 22 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 1fe4f40..38ccf84 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -111,28 +111,6 @@ Notes: (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 -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 --- -- cgit v1.1 From 77b6681ec224af6047a4ba76d7558c150a205718 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:41:46 +0200 Subject: qmp-commands: move 'screendump' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 38ccf84..4201b50 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -72,20 +72,6 @@ Example: Note: The "force" argument defaults to false. -screendump ----------- - -Save screen into PPM image. - -Arguments: - -- "filename": file path (json-string) - -Example: - --> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } } -<- { "return": {} } - device_add ---------- -- cgit v1.1 From 2212092e11db4c92416f989db9000737daaf9d37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:42:29 +0200 Subject: qmp-commands: move 'chardev-add' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 28 ---------------------------- 1 file changed, 28 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 4201b50..393e228 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1252,34 +1252,6 @@ 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 -------------- -- cgit v1.1 From 7cfee8d94367deee91776897c1b33ad99bd54fbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:42:58 +0200 Subject: qmp-commands: move 'chardev-remove' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 393e228..e5ac6a1 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1252,20 +1252,6 @@ Example: -> { "execute": "query-tpm-types" } <- { "return": [ "passthrough" ] } -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 --------------- -- cgit v1.1 From b7c7941b04bbc65425bcad710fa29fb88bd5ab9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:43:58 +0200 Subject: qmp-commands: move 'query-tpm-models' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index e5ac6a1..f3ec744 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1228,18 +1228,6 @@ Example: ] } -query-tpm-models ----------------- - -Return a list of supported TPM models. - -Arguments: None - -Example: - --> { "execute": "query-tpm-models" } -<- { "return": [ "tpm-tis" ] } - query-tpm-types --------------- -- cgit v1.1 From 5a4c031616f4f41edebe608732a7f784c4cff484 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:44:16 +0200 Subject: qmp-commands: move 'query-tpm-types' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index f3ec744..c613ab4 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1228,18 +1228,6 @@ Example: ] } -query-tpm-types ---------------- - -Return a list of supported TPM types. - -Arguments: None - -Example: - --> { "execute": "query-tpm-types" } -<- { "return": [ "passthrough" ] } - query-rx-filter --------------- -- cgit v1.1 From 4e022d01ee17cbc5653db51108832fe938a9c6da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:45:12 +0200 Subject: qmp-commands: move 'query-tpm' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 25 ------------------------- 1 file changed, 25 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index c613ab4..3afb438 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1203,31 +1203,6 @@ Example: ] } -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-rx-filter --------------- -- cgit v1.1 From e26a0d0070630baf8fc03f66fdc01682b7bad35e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:46:31 +0200 Subject: qmp-commands: move 'query-command-line-options' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 40 ---------------------------------------- 1 file changed, 40 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 3afb438..1a3e4e5 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1163,46 +1163,6 @@ Example: ] } -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-rx-filter --------------- -- cgit v1.1 From 043ea3123d39e1c9cfcc2118c0837864a5a8ec76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:47:48 +0200 Subject: qmp-commands: move 'query-rx-filter' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 57 --------------------------------------------------- 1 file changed, 57 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 1a3e4e5..0e868ce 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1163,63 +1163,6 @@ Example: ] } -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 ------------ -- cgit v1.1 From 70d5b0c2539543e9ace53984902122fccae7a7de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:54:00 +0200 Subject: qmp-commands: move 'input-send-event' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 55 --------------------------------------------------- 1 file changed, 55 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 0e868ce..5131a3b 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1660,61 +1660,6 @@ 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 ------------ -- cgit v1.1 From cfc84c8b458bf3a64a1478173e132cf29698df22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:54:38 +0200 Subject: qmp-commands: move 'query-memdev' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau [Straightforward conflict with commit e1ff3c6 resolved] Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 30 ------------------------------ 1 file changed, 30 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 5131a3b..06b4cba 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1534,36 +1534,6 @@ Examples: <- { "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 -------------------- -- cgit v1.1 From 22f9a094f854d8bfc19b47d2eef68328e7b89b5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:55:05 +0200 Subject: qmp-commands: move 'query-memory-devices' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 19 ------------------- 1 file changed, 19 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 06b4cba..1e34523 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1534,25 +1534,6 @@ Examples: <- { "return": {} } -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 ---------------------- -- cgit v1.1 From 18b43003d4738f6ea3466ba1a70b0f25c23b0b02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:56:06 +0200 Subject: qmp-commands: move 'query-acpi-ospm-status' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 1e34523..c7e566c 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1534,20 +1534,6 @@ Examples: <- { "return": {} } -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 --------------------- -- cgit v1.1 From 5c32b4ccd61442abba7059352fe9e62b6759e607 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:57:29 +0200 Subject: qmp-commands: move 'rtc-reset-reinjection' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index c7e566c..4e14bef 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -1534,18 +1534,6 @@ Examples: <- { "return": {} } -rtc-reset-reinjection ---------------------- - -Reset the RTC interrupt reinjection backlog. - -Arguments: None. - -Example: - --> { "execute": "rtc-reset-reinjection" } -<- { "return": {} } - trace-event-get-state --------------------- -- cgit v1.1 From 978cceab03f86e5bce3d88c373209f0adcbc8afe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 13:58:48 +0200 Subject: qmp-commands: move 'query-block' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 175 -------------------------------------------------- 1 file changed, 175 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 4e14bef..4b72f08 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -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 ---------------- -- cgit v1.1 From f2eaea1884c1e2abc226f8eae1d3cfc760de70f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:00:14 +0200 Subject: qmp-commands: move 'query-blockstats' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 188 -------------------------------------------------- 1 file changed, 188 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 4b72f08..41797c8 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -800,194 +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-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 - } - } - ] - } - blockdev-add ------------ -- cgit v1.1 From 91f96b643c43cf8253d383f505f10737e3149ca2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:01:09 +0200 Subject: qmp-commands: move 'block_passwd' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 17 ----------------- 1 file changed, 17 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 41797c8..8bf810b 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -652,23 +652,6 @@ Arguments: Returns: Nothing on success If "device" does not exist or cannot be determined, DeviceNotFound -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 ------------ -- cgit v1.1 From 0dc869cf709368265bb5b7a5fe35b7e3b53a776e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:01:52 +0200 Subject: qmp-commands: move 'block_resize' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 16 ---------------- 1 file changed, 16 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 8bf810b..5302c80 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -169,22 +169,6 @@ Example: <- { "return": { "status": "active", "completed": 1024000, "total": 2048000 } } -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 ------------ -- cgit v1.1 From b4039d8d23a6729c0206b3b3b14a9cd0bd618b69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:04:28 +0200 Subject: qmp-commands: move 'blockdev-snapshot-sync' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 27 --------------------------- 1 file changed, 27 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 5302c80..c857d39 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -402,33 +402,6 @@ Example: "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 -- cgit v1.1 From 3282eca4aee00d17727b6ff520287afe559aa823 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:08:19 +0200 Subject: qmp-commands: move 'blockdev-snapshot' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 29 ----------------------------- 1 file changed, 29 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index c857d39..41b070d 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -402,35 +402,6 @@ Example: "name": "bitmap0" } } <- { "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 ------------------------------- -- cgit v1.1 From 280c4b3cf2a6db32c1dffe9a9f9680ae72ddb924 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:09:20 +0200 Subject: qmp-commands: move 'change-backing-file' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 31 ------------------------------- 1 file changed, 31 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 41b070d..87fda01 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -549,37 +549,6 @@ Example: "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 - block_set_io_throttle ------------ -- cgit v1.1 From f44fb58f354724d7fca84ff829fbebfb53468b96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:10:29 +0200 Subject: qmp-commands: move 'block-commit' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 56 --------------------------------------------------- 1 file changed, 56 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 87fda01..09c9aaa 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -208,62 +208,6 @@ Example: "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 ------------ -- cgit v1.1 From b03364126c63d1565197850531f9ff8bfbb1cc1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:11:47 +0200 Subject: qmp-commands: move 'drive-backup' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 48 ------------------------------------------------ 1 file changed, 48 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 09c9aaa..be2acb0 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -208,54 +208,6 @@ Example: "base": "/tmp/master.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 --------------- -- cgit v1.1 From 1cf75113f8955e8d2b3aa07fc11fb3a193bafd51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:13:07 +0200 Subject: qmp-commands: move 'blockdev-backup' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 35 ----------------------------------- 1 file changed, 35 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index be2acb0..513c2c7 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -208,41 +208,6 @@ Example: "base": "/tmp/master.qcow2" } } <- { "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 -- cgit v1.1 From e1f34cb209109039cbc1d5b11dce85e5289db872 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:13:48 +0200 Subject: qmp-commands: move 'query-named-block-nodes' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 53 --------------------------------------------------- 1 file changed, 53 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 513c2c7..798753b 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -813,59 +813,6 @@ Delete a quorum's node "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 ---------------------- -- cgit v1.1 From 12a21b73cbe607abdd1c5dabb2c4fbdbf77ba7dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:17:31 +0200 Subject: qmp-commands: move 'drive-mirror' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 54 --------------------------------------------------- 1 file changed, 54 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 798753b..6b210d0 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -315,60 +315,6 @@ Example: } } -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 ------------ -- cgit v1.1 From 2258a5dbbebc0b846856673c1d9c001c6cd91d48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:19:37 +0200 Subject: qmp-commands: move 'block-dirty-bitmap-add' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 18 ------------------ 1 file changed, 18 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 6b210d0..56e47a1 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -208,24 +208,6 @@ Example: "base": "/tmp/master.qcow2" } } <- { "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 -- cgit v1.1 From 4bbca422a5d9e1019e2be90212c56c530ebb553b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:23:39 +0200 Subject: qmp-commands: move 'block-dirty-bitmap-remove' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 18 ------------------ 1 file changed, 18 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 56e47a1..3a6a4f5 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -208,24 +208,6 @@ Example: "base": "/tmp/master.qcow2" } } <- { "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 -- cgit v1.1 From 73dffdc89f00f759b8ce670e78a74b8f322b1cd9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:25:54 +0200 Subject: qmp-commands: move 'block-dirty-bitmap-clear' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 19 ------------------- 1 file changed, 19 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 3a6a4f5..cb97f47 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -208,25 +208,6 @@ Example: "base": "/tmp/master.qcow2" } } <- { "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-internal-sync ------------------------------- -- cgit v1.1 From b4a0ac14e8944ca36a7e77033086b3fe5b751659 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:48:23 +0200 Subject: qmp-commands: move 'block_set_io_throttle' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 50 -------------------------------------------------- 1 file changed, 50 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index cb97f47..e23ac6b 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -301,56 +301,6 @@ Example: "sync": "full" } } <- { "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": {} } - qmp_capabilities ---------------- -- cgit v1.1 From 49b37c23c70ddfed6c39a105ee59d8f140dee8e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:52:13 +0200 Subject: qmp-commands: move 'block-stream' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 39 --------------------------------------- 1 file changed, 39 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index e23ac6b..7cd7bc0 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -169,45 +169,6 @@ Example: <- { "return": { "status": "active", "completed": 1024000, "total": 2048000 } } -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": {} } - blockdev-snapshot-internal-sync ------------------------------- -- cgit v1.1 From b4749948c1227bfdea340226beead0c8d0907eb7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:54:05 +0200 Subject: qmp-commands: move 'blockdev-add' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 46 ---------------------------------------------- 1 file changed, 46 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 7cd7bc0..25f4535 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -343,52 +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-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 -- cgit v1.1 From 915a213f7a0fe5c7551df8ce54714baf3dd60929 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:55:00 +0200 Subject: qmp-commands: move 'x-blockdev-del' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 36 ------------------------------------ 1 file changed, 36 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 25f4535..95b648d 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -343,42 +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. -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 ------------------ -- cgit v1.1 From 1133b1d674469d8dd5e2e02e5cf8f288ca8bf500 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:56:09 +0200 Subject: qmp-commands: move 'blockdev-open-tray' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 42 ------------------------------------------ 1 file changed, 42 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 95b648d..433454c 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 ------------------- -- cgit v1.1 From 7f3c6f22daf758ce98d6f727cf4195770504454f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:56:51 +0200 Subject: qmp-commands: move 'blockdev-close-tray' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 29 ----------------------------- 1 file changed, 29 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 433454c..da8198b 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -343,35 +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-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 ------------------------ -- cgit v1.1 From 8e1c14295c88c33647baddeb49168c98158480dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:58:23 +0200 Subject: qmp-commands: move 'x-blockdev-remove-medium' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 42 ------------------------------------------ 1 file changed, 42 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index da8198b..7e3a6ce 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. -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 ------------------------ -- cgit v1.1 From b480abf3b8e77ff43179ea3e980da4254aa89c57 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 14:59:33 +0200 Subject: qmp-commands: move 'x-blockdev-insert-medium' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 33 --------------------------------- 1 file changed, 33 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 7e3a6ce..3f34512 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -343,39 +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. -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 ----------------- -- cgit v1.1 From be3e83cb8a81cf1cc863708b4caead7b9252f6fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:03:06 +0200 Subject: qmp-commands: move 'blockdev-change-medium' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 46 ---------------------------------------------- 1 file changed, 46 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 3f34512..70de4a6 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -387,52 +387,6 @@ Delete a quorum's node "child": "children.1" } } <- { "return": {} } -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": {} } - trace-event-get-state --------------------- -- cgit v1.1 From e817862b1790a7f56adb44bc80d861df6bad18ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:04:41 +0200 Subject: qmp-commands: move 'block-set-write-threshold' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 19 ------------------- 1 file changed, 19 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 70de4a6..af903bf 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -438,25 +438,6 @@ Example: -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } } <- { "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 ------------------ -- cgit v1.1 From bfeafc9c532cb2f94a5ad10d3070fcd3805dadc8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:06:14 +0200 Subject: qmp-commands: move 'blockdev-snapshot-internal-sync' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 21 --------------------- 1 file changed, 21 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index af903bf..87b1fe41 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -169,27 +169,6 @@ Example: <- { "return": { "status": "active", "completed": 1024000, "total": 2048000 } } -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 -------------------------------------- -- cgit v1.1 From b31177b028c7f2f5e84f267b40802118476a7645 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:07:40 +0200 Subject: qmp-commands: move 'blockdev-snapshot-delete-internal-sync' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 31 ------------------------------- 1 file changed, 31 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 87b1fe41..795f33f 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -169,37 +169,6 @@ Example: <- { "return": { "status": "active", "completed": 1024000, "total": 2048000 } } -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 - } - } - blockdev-mirror ------------ -- cgit v1.1 From 5fba0a72ec1968debca8bb80732cc75aa7cd8a21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:08:55 +0200 Subject: qmp-commands: move 'eject' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 19 ------------------- 1 file changed, 19 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 795f33f..d586059 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -53,25 +53,6 @@ If you're planning to adopt QMP, please observe the following: 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. - device_add ---------- -- cgit v1.1 From dd746afbb43989064cb98d2448d066da2e156aa8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:09:51 +0200 Subject: qmp-commands: move 'query-version' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 27 --------------------------- 1 file changed, 27 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index d586059..cb41253 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -209,33 +209,6 @@ Note: This command must be issued before issuing any other command. ================= -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 -------------- -- cgit v1.1 From 8b0ffce442b9dbfaac65aa4eccdc4cdf5dc0203b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:10:40 +0200 Subject: qmp-commands: move 'query-commands' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 28 ---------------------------- 1 file changed, 28 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index cb41253..0e0416e 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -209,34 +209,6 @@ Note: This command must be issued before issuing any other command. ================= -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 ---------------- -- cgit v1.1 From a35c33f0b090d9504004cdcce9f295acc2c9b4d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:11:47 +0200 Subject: qmp-commands: move 'query-rocker' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 0e0416e..903b065 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -312,18 +312,6 @@ Example: -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } } <- { "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 ------------------------ -- cgit v1.1 From 7e20b16919e0a8c5040a280416b14ba8c3078fe1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:12:36 +0200 Subject: qmp-commands: move 'query-rocker-ports' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 16 ---------------- 1 file changed, 16 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 903b065..f4a5dbf 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -312,22 +312,6 @@ Example: -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } } <- { "return": {} } -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 ------------------------------------- -- cgit v1.1 From 435fcb29067590a38773e00c4caadc7ff6e3eb51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:14:30 +0200 Subject: qmp-commands: move 'query-rocker-of-dpa-flows' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 20 -------------------- 1 file changed, 20 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index f4a5dbf..93c8fc2 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -312,26 +312,6 @@ Example: -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } } <- { "return": {} } -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 ------------------------------- -- cgit v1.1 From 9389a4e3ba3bf9115bdec3ca118b42faed311b24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:17:32 +0200 Subject: qmp-commands: move 'query-rocker-of-dpa-groups' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 21 --------------------- 1 file changed, 21 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 93c8fc2..0c7cf02 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -312,27 +312,6 @@ Example: -> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } } <- { "return": {} } -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 --------------- -- cgit v1.1 From a93b9ba76fdce637bfc3305e4b38dcc0ac0e478b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:20:58 +0200 Subject: qmp-commands: move 'trace-event-get-state' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 24 ------------------------ 1 file changed, 24 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 0c7cf02..e309c7a 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -261,30 +261,6 @@ Delete a quorum's node "child": "children.1" } } <- { "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 --------------------- -- cgit v1.1 From 8a9b273e5770f9f0586791c6364a04d2647467ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:21:49 +0200 Subject: qmp-commands: move 'trace-event-set-state' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 27 --------------------------- 1 file changed, 27 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index e309c7a..335acc7 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -261,33 +261,6 @@ Delete a quorum's node "child": "children.1" } } <- { "return": {} } -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": {} } - query-gic-capabilities --------------- -- cgit v1.1 From 7e31d1ae454aeb5b53997b8a3134edeac4d9b19f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:24:35 +0200 Subject: qmp-commands: move 'query-hotpluggable-cpus' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 31 ------------------------------- 1 file changed, 31 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 335acc7..321f07d 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -274,34 +274,3 @@ 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} - } - ]} -- cgit v1.1 From 1965e98d51ebe4b1effbe11fa71c4cd483ae6383 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:26:12 +0200 Subject: qmp-commands: move 'query-gic-capabilities' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 321f07d..be17705 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -260,17 +260,3 @@ Delete a quorum's node "arguments": { "parent": "disk1", "child": "children.1" } } <- { "return": {} } - -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 } ] } -- cgit v1.1 From bd77ea2e5ace7282ce2f1c523c60e5c4c6b44177 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:28:23 +0200 Subject: qmp-commands: move 'x-blockdev-change' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 44 -------------------------------------------- 1 file changed, 44 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index be17705..7870756 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -216,47 +216,3 @@ 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. - -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": {} } -- cgit v1.1 From f6235a256f92da7be62af66e5ec49381a731a421 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:32:39 +0200 Subject: qmp-commands: move 'blockdev-mirror' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 41 ----------------------------------------- 1 file changed, 41 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 7870756..7dce470 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -150,47 +150,6 @@ Example: <- { "return": { "status": "active", "completed": 1024000, "total": 2048000 } } -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": {} } - qmp_capabilities ---------------- -- cgit v1.1 From 926dce5cb97f542af6286c10abfd959673595737 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:33:42 +0200 Subject: qmp-commands: move 'query-dump' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 13 ------------- 1 file changed, 13 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 7dce470..40d68e6 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -137,19 +137,6 @@ Example: -> { "execute": "x-colo-lost-heartbeat" } <- { "return": {} } -query-dump ----------- - -Query background dump status. - -Arguments: None. - -Example: - --> { "execute": "query-dump" } -<- { "return": { "status": "active", "completed": 1024000, - "total": 2048000 } } - qmp_capabilities ---------------- -- cgit v1.1 From 8f457b67066e58e7a1c6d2bd2280634e1f59c137 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:38:59 +0200 Subject: qmp-commands: move 'migrate-set-cache-size' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 15 --------------- 1 file changed, 15 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 40d68e6..0de1b04 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -112,21 +112,6 @@ Example: "arguments": { "filename": "/tmp/resume" } } <- { "return": {} } -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 -------------------- -- cgit v1.1 From 7d1182d989f61ffbd6745112bd487611e2f40bc4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:39:50 +0200 Subject: qmp-commands: move 'xen-load-devices-state' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 18 ------------------ 1 file changed, 18 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 0de1b04..93b3742 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -94,24 +94,6 @@ Example: Note: CPUs' indexes are obtained with the 'query-cpus' command. -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": {} } - x-colo-lost-heartbeat -------------------- -- cgit v1.1 From c08d64434aea7b798c4a25d40db4021ca17a8588 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Tue, 1 Nov 2016 11:18:01 +0300 Subject: qmp-commands: move 'x-colo-lost-heartbeat' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 10 ---------- 1 file changed, 10 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 93b3742..715b923 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -94,16 +94,6 @@ Example: Note: CPUs' indexes are obtained with the 'query-cpus' command. -x-colo-lost-heartbeat --------------------- - -Tell COLO that heartbeat is lost, a failover or takeover is needed. - -Example: - --> { "execute": "x-colo-lost-heartbeat" } -<- { "return": {} } - qmp_capabilities ---------------- -- cgit v1.1 From add1d100650db3a73b59c3021095a51778d8edd3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Sun, 25 Sep 2016 13:07:38 +0400 Subject: qmp-commands: remove query-qmp-schema from txt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It's better described in the schema already. Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 715b923..3613cbf 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -107,15 +107,3 @@ Example: <- { "return": {} } Note: This command must be issued before issuing any other command. - -3. Query Commands -================= - - -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. -- cgit v1.1 From bf4914731f6e717a9a4027ead1fac93a74087051 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Sun, 25 Sep 2016 13:08:07 +0400 Subject: qmp-commands: remove qmp_capabilities from txt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It's better described in the schema already. Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 3613cbf..b51d5b3 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -93,17 +93,3 @@ Example: <- { "return": {} } Note: CPUs' indexes are obtained with the 'query-cpus' command. - -qmp_capabilities ----------------- - -Enable QMP capabilities. - -Arguments: None. - -Example: - --> { "execute": "qmp_capabilities" } -<- { "return": {} } - -Note: This command must be issued before issuing any other command. -- cgit v1.1 From adcbc0d99780af87ad3ffe99b92e0e64fb4cb73c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Sun, 25 Sep 2016 13:10:27 +0400 Subject: qmp-commands: remove cpu from txt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The cpu command is deprecated since commit 755f196898. Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 16 ---------------- 1 file changed, 16 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index b51d5b3..89170aa 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -77,19 +77,3 @@ Notes: (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 - -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. -- cgit v1.1 From 0ea87df5064a3f02de564fca06234e0b240368ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Sun, 25 Sep 2016 13:13:21 +0400 Subject: qmp-commands: remove device_add from txt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It's already fully described in the schema. Fix the schema to document the command and not the argument (place doc before first arg). Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 26 -------------------------- 1 file changed, 26 deletions(-) (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 89170aa..07138cd 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -46,34 +46,8 @@ If you're planning to adopt QMP, please observe the following: 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. - -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 -- cgit v1.1 From 4d8bb958fa0bf8695c5b38b9f153073c62a989b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Mon, 6 Jul 2015 22:13:50 +0200 Subject: qmp-commands: move documentation bits to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Moving the remaining bits of documentation to the json file (text improvements is not the objective of this patch) Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-commands.txt | 53 --------------------------------------------------- 1 file changed, 53 deletions(-) delete mode 100644 docs/qmp-commands.txt (limited to 'docs') diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt deleted file mode 100644 index 07138cd..0000000 --- a/docs/qmp-commands.txt +++ /dev/null @@ -1,53 +0,0 @@ - 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. -- cgit v1.1 From 370d4eba7de41e23d84ed617371b45f2db92d68d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:51:26 +0200 Subject: qmp-events: move 'BLOCK_IMAGE_CORRUPTED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 28 ---------------------------- 1 file changed, 28 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index e0a2365..f3ea933 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -30,34 +30,6 @@ Example: Note: this event is rate-limited. -BLOCK_IMAGE_CORRUPTED ---------------------- - -Emitted when a disk image is being marked corrupt. The image can be -identified by its device or node name. The 'device' field is always -present for compatibility reasons, but it can be empty ("") if the -image does not have a device name associated. - -Data: - -- "device": Device name (json-string) -- "node-name": Node name (json-string, optional) -- "msg": Informative message (e.g., reason for the corruption) - (json-string) -- "offset": If the corruption resulted from an image access, this - is the host's access offset into the image - (json-int, optional) -- "size": If the corruption resulted from an image access, this - is the access size (json-int, optional) - -Example: - -{ "event": "BLOCK_IMAGE_CORRUPTED", - "data": { "device": "ide0-hd0", "node-name": "node0", - "msg": "Prevented active L1 table overwrite", "offset": 196608, - "size": 65536 }, - "timestamp": { "seconds": 1378126126, "microseconds": 966463 } } - BLOCK_IO_ERROR -------------- -- cgit v1.1 From 07c9f583d50ba68bd19dc2a66236d43c638f1f03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:52:10 +0200 Subject: qmp-events: move 'BLOCK_IO_ERROR' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 31 ------------------------------- 1 file changed, 31 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index f3ea933..dc5bce1 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -30,37 +30,6 @@ Example: Note: this event is rate-limited. -BLOCK_IO_ERROR --------------- - -Emitted when a disk I/O error occurs. - -Data: - -- "device": device name. This is always present for compatibility - reasons, but it can be empty ("") if the image does not - have a device name associated. (json-string) -- "node-name": node name. Note that errors may be reported for the root node - that is directly attached to a guest device rather than for the - node where the error occurred. (json-string) -- "operation": I/O operation (json-string, "read" or "write") -- "action": action that has been taken, it's one of the following (json-string): - "ignore": error has been ignored - "report": error has been reported to the device - "stop": the VM is going to stop because of the error - -Example: - -{ "event": "BLOCK_IO_ERROR", - "data": { "device": "ide0-hd1", - "node-name": "#block212", - "operation": "write", - "action": "stop" }, - "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } - -Note: If action is "stop", a STOP event will eventually follow the -BLOCK_IO_ERROR event. - BLOCK_JOB_CANCELLED ------------------- -- cgit v1.1 From e21e65b212612083439a68f18b44e373aa38de00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:52:56 +0200 Subject: qmp-events: move 'BLOCK_JOB_COMPLETED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 30 ------------------------------ 1 file changed, 30 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index dc5bce1..9b42f40 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -55,36 +55,6 @@ Example: "speed": 0 }, "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } -BLOCK_JOB_COMPLETED -------------------- - -Emitted when a block job has completed. - -Data: - -- "type": Job type (json-string; "stream" for image streaming - "commit" for block commit) -- "device": Job identifier. Originally the device name but other - values are allowed since QEMU 2.7 (json-string) -- "len": Maximum progress value (json-int) -- "offset": Current progress value (json-int) - On success this is equal to len. - On failure this is less than len. -- "speed": Rate limit, bytes per second (json-int) -- "error": Error message (json-string, optional) - Only present on failure. This field contains a human-readable - error message. There are no semantics other than that streaming - has failed and clients should not try to interpret the error - string. - -Example: - -{ "event": "BLOCK_JOB_COMPLETED", - "data": { "type": "stream", "device": "virtio-disk0", - "len": 10737418240, "offset": 10737418240, - "speed": 0 }, - "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } - BLOCK_JOB_ERROR --------------- -- cgit v1.1 From e161df3939fd725b67d660e793e1538860c156fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:53:50 +0200 Subject: qmp-events: move 'BLOCK_JOB_CANCELLED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 25 ------------------------- 1 file changed, 25 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 9b42f40..e001571 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -30,31 +30,6 @@ Example: Note: this event is rate-limited. -BLOCK_JOB_CANCELLED -------------------- - -Emitted when a block job has been cancelled. - -Data: - -- "type": Job type (json-string; "stream" for image streaming - "commit" for block commit) -- "device": Job identifier. Originally the device name but other - values are allowed since QEMU 2.7 (json-string) -- "len": Maximum progress value (json-int) -- "offset": Current progress value (json-int) - On success this is equal to len. - On failure this is less than len. -- "speed": Rate limit, bytes per second (json-int) - -Example: - -{ "event": "BLOCK_JOB_CANCELLED", - "data": { "type": "stream", "device": "virtio-disk0", - "len": 10737418240, "offset": 134217728, - "speed": 0 }, - "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } - BLOCK_JOB_ERROR --------------- -- cgit v1.1 From af0e09106c57e732234eaf9bea5973437b3711d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:54:20 +0200 Subject: qmp-events: move 'BLOCK_JOB_ERROR' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 23 ----------------------- 1 file changed, 23 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index e001571..bc831bf 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -30,29 +30,6 @@ Example: Note: this event is rate-limited. -BLOCK_JOB_ERROR ---------------- - -Emitted when a block job encounters an error. - -Data: - -- "device": Job identifier. Originally the device name but other - values are allowed since QEMU 2.7 (json-string) -- "operation": I/O operation (json-string, "read" or "write") -- "action": action that has been taken, it's one of the following (json-string): - "ignore": error has been ignored, the job may fail later - "report": error will be reported and the job canceled - "stop": error caused job to be paused - -Example: - -{ "event": "BLOCK_JOB_ERROR", - "data": { "device": "ide0-hd1", - "operation": "write", - "action": "stop" }, - "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } - BLOCK_JOB_READY --------------- -- cgit v1.1 From 11a3dee1b965ac38baf319e8b00db79a889a0200 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:54:49 +0200 Subject: qmp-events: move 'BLOCK_JOB_READY' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 27 --------------------------- 1 file changed, 27 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index bc831bf..71882a6 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -30,33 +30,6 @@ Example: Note: this event is rate-limited. -BLOCK_JOB_READY ---------------- - -Emitted when a block job is ready to complete. - -Data: - -- "type": Job type (json-string; "stream" for image streaming - "commit" for block commit) -- "device": Job identifier. Originally the device name but other - values are allowed since QEMU 2.7 (json-string) -- "len": Maximum progress value (json-int) -- "offset": Current progress value (json-int) - On success this is equal to len. - On failure this is less than len. -- "speed": Rate limit, bytes per second (json-int) - -Example: - -{ "event": "BLOCK_JOB_READY", - "data": { "device": "drive0", "type": "mirror", "speed": 0, - "len": 2097152, "offset": 2097152 } - "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } - -Note: The "ready to complete" status is always reset by a BLOCK_JOB_ERROR -event. - DEVICE_DELETED -------------- -- cgit v1.1 From 01b7d4be5c5408365487851f3b8b1e6f10dfaa4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 15:57:27 +0200 Subject: qmp-events: move 'DEVICE_TRAY_MOVED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 22 ---------------------- 1 file changed, 22 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 71882a6..7cae0aa 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -48,28 +48,6 @@ Data: "path": "/machine/peripheral/virtio-net-pci-0" }, "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } -DEVICE_TRAY_MOVED ------------------ - -It's emitted whenever the tray of a removable device is moved by the guest -or by HMP/QMP commands. - -Data: - -- "device": Block device name. This is always present for compatibility - reasons, but it can be empty ("") if the image does not have a - device name associated. (json-string) -- "id": The name or QOM path of the guest device (json-string) -- "tray-open": true if the tray has been opened or false if it has been closed - (json-bool) - -{ "event": "DEVICE_TRAY_MOVED", - "data": { "device": "ide1-cd0", - "id": "/machine/unattached/device[22]", - "tray-open": true - }, - "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } - DUMP_COMPLETED -------------- -- cgit v1.1 From 12defe50f8c2339fda4c6f9d2c45710e9d31ecda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:11:21 +0200 Subject: qmp-events: move 'SHUTDOWN' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 16 ---------------- 1 file changed, 16 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 7cae0aa..ab0f58e 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -221,22 +221,6 @@ Example: Note: this event is rate-limited. -SHUTDOWN --------- - -Emitted when the Virtual Machine has shut down, indicating that qemu -is about to exit. - -Data: None. - -Example: - -{ "event": "SHUTDOWN", - "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } - -Note: If the command-line option "-no-shutdown" has been specified, a STOP -event will eventually follow the SHUTDOWN event. - SPICE_CONNECTED --------------- -- cgit v1.1 From 189d43bed6c08855b6a12b889264f09f5af012a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:17:22 +0200 Subject: qmp-events: move 'POWERDOWN' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 13 ------------- 1 file changed, 13 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index ab0f58e..44840ce 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -114,19 +114,6 @@ Data: "timestamp": { "seconds": 1368697518, "microseconds": 326866 } } } -POWERDOWN ---------- - -Emitted when the Virtual Machine is powered down through the power -control system, such as via ACPI. - -Data: None. - -Example: - -{ "event": "POWERDOWN", - "timestamp": { "seconds": 1267040730, "microseconds": 682951 } } - QUORUM_FAILURE -------------- -- cgit v1.1 From 7a2aae7a364db27924702bd4b284398bdd01240a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:18:09 +0200 Subject: qmp-events: move 'RESET' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 44840ce..c5a165a 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -166,18 +166,6 @@ Flush operation: Note: this event is rate-limited. -RESET ------ - -Emitted when the Virtual Machine is reset. - -Data: None. - -Example: - -{ "event": "RESET", - "timestamp": { "seconds": 1267041653, "microseconds": 9518 } } - RESUME ------ -- cgit v1.1 From 138c454c0f2cdb5145cdd4762d5f6e8b8093da0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:18:36 +0200 Subject: qmp-events: move 'STOP' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index c5a165a..b826641 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -324,18 +324,6 @@ Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} -STOP ----- - -Emitted when the Virtual Machine is stopped. - -Data: None. - -Example: - -{ "event": "STOP", - "timestamp": { "seconds": 1267041730, "microseconds": 281295 } } - SUSPEND ------- -- cgit v1.1 From a2235a0499c799552a4ea330350acc0d71217f9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:22:10 +0200 Subject: qmp-events: move 'RESUME' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index b826641..27f9e59 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -166,18 +166,6 @@ Flush operation: Note: this event is rate-limited. -RESUME ------- - -Emitted when the Virtual Machine resumes execution. - -Data: None. - -Example: - -{ "event": "RESUME", - "timestamp": { "seconds": 1271770767, "microseconds": 582542 } } - RTC_CHANGE ---------- -- cgit v1.1 From 6f3cc5406b4c3383d017cb3540160eb49e659abb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:22:38 +0200 Subject: qmp-events: move 'SUSPEND' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 27f9e59..2e3a22a 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -312,18 +312,6 @@ Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} -SUSPEND -------- - -Emitted when guest enters S3 state. - -Data: None. - -Example: - -{ "event": "SUSPEND", - "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } - SUSPEND_DISK ------------ -- cgit v1.1 From 4de62c38a530af909171452d121a2eee9102bf65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:23:22 +0200 Subject: qmp-events: move 'SUSPEND_DISK' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 2e3a22a..83f0355 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -312,20 +312,6 @@ Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} -SUSPEND_DISK ------------- - -Emitted when the guest makes a request to enter S4 state. - -Data: None. - -Example: - -{ "event": "SUSPEND_DISK", - "timestamp": { "seconds": 1344456160, "microseconds": 309119 } } - -Note: QEMU shuts down when entering S4 state. - VNC_CONNECTED ------------- -- cgit v1.1 From aa496f9812a7fb880f8782c8c3956183e759fbf0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:24:25 +0200 Subject: qmp-events: move 'WAKEUP' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 83f0355..8e709ea 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -420,18 +420,6 @@ Example: Note: this event is rate-limited separately for each "id". -WAKEUP ------- - -Emitted when the guest has woken up from S3 and is running. - -Data: None. - -Example: - -{ "event": "WAKEUP", - "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } - WATCHDOG -------- -- cgit v1.1 From 73c41bfd314fe3319e35325162a7e9ded310fc4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:25:25 +0200 Subject: qmp-events: move 'RTC_CHANGE' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 18 ------------------ 1 file changed, 18 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 8e709ea..3576064 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -166,24 +166,6 @@ Flush operation: Note: this event is rate-limited. -RTC_CHANGE ----------- - -Emitted when the guest changes the RTC time. - -Data: - -- "offset": Offset between base RTC clock (as specified by -rtc base), and -new RTC clock value (json-number) - -Example: - -{ "event": "RTC_CHANGE", - "data": { "offset": 78 }, - "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } - -Note: this event is rate-limited. - SPICE_CONNECTED --------------- -- cgit v1.1 From 9ba5cec9dd68ac1b38fbb7ab45f389e5e05b89f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:26:36 +0200 Subject: qmp-events: move 'WATCHDOG' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 21 --------------------- 1 file changed, 21 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 3576064..fbcf4f8 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -401,24 +401,3 @@ Example: "timestamp": { "seconds": 1401385907, "microseconds": 422329 } } Note: this event is rate-limited separately for each "id". - -WATCHDOG --------- - -Emitted when the watchdog device's timer is expired. - -Data: - -- "action": Action that has been taken, it's one of the following (json-string): - "reset", "shutdown", "poweroff", "pause", "debug", or "none" - -Example: - -{ "event": "WATCHDOG", - "data": { "action": "reset" }, - "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } - -Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is -followed respectively by the RESET, SHUTDOWN, or STOP events. - -Note: this event is rate-limited. -- cgit v1.1 From cdc94a1b3e7e2616363ee837dea1724062370669 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:27:18 +0200 Subject: qmp-events: move 'DEVICE_DELETED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 18 ------------------ 1 file changed, 18 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index fbcf4f8..c19177d 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -30,24 +30,6 @@ Example: Note: this event is rate-limited. -DEVICE_DELETED --------------- - -Emitted whenever the device removal completion is acknowledged -by the guest. -At this point, it's safe to reuse the specified device ID. -Device removal can be initiated by the guest or by HMP/QMP commands. - -Data: - -- "device": device name (json-string, optional) -- "path": device path (json-string) - -{ "event": "DEVICE_DELETED", - "data": { "device": "virtio-net-pci-0", - "path": "/machine/peripheral/virtio-net-pci-0" }, - "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } - DUMP_COMPLETED -------------- -- cgit v1.1 From 5dbdcf43243497f5350b311aff98dcf583bfdbc2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:28:39 +0200 Subject: qmp-events: move 'NIC_RX_FILTER_CHANGED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 17 ----------------- 1 file changed, 17 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index c19177d..a4323f9 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -79,23 +79,6 @@ Example: }, "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } -NIC_RX_FILTER_CHANGED ---------------------- - -The event is emitted once until the query command is executed, -the first event will always be emitted. - -Data: - -- "name": net client name (json-string) -- "path": device path (json-string) - -{ "event": "NIC_RX_FILTER_CHANGED", - "data": { "name": "vnet0", - "path": "/machine/peripheral/vnet0/virtio-backend" }, - "timestamp": { "seconds": 1368697518, "microseconds": 326866 } } -} - QUORUM_FAILURE -------------- -- cgit v1.1 From f46052fd139d8990c0d6395b563972ca1f2cf2fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:29:24 +0200 Subject: qmp-events: move 'VNC_CONNECTED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 31 ------------------------------- 1 file changed, 31 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index a4323f9..f0eb626 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -259,37 +259,6 @@ Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} -VNC_CONNECTED -------------- - -Emitted when a VNC client establishes a connection. - -Data: - -- "server": Server information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "auth": authentication method (json-string, optional) -- "client": Client information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - -Example: - -{ "event": "VNC_CONNECTED", - "data": { - "server": { "auth": "sasl", "family": "ipv4", - "service": "5901", "host": "0.0.0.0" }, - "client": { "family": "ipv4", "service": "58425", - "host": "127.0.0.1" } }, - "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } - - -Note: This event is emitted before any authentication takes place, thus -the authentication ID is not provided. - VNC_DISCONNECTED ---------------- -- cgit v1.1 From 99ab2471a438ec3f9041c80cbdd412f19949cc18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:29:59 +0200 Subject: qmp-events: move 'VNC_INITIALIZED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 30 ------------------------------ 1 file changed, 30 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index f0eb626..1bc7672 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -288,36 +288,6 @@ Example: "host": "127.0.0.1", "sasl_username": "luiz" } }, "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } -VNC_INITIALIZED ---------------- - -Emitted after authentication takes place (if any) and the VNC session is -made active. - -Data: - -- "server": Server information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "auth": authentication method (json-string, optional) -- "client": Client information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "x509_dname": TLS dname (json-string, optional) - - "sasl_username": SASL username (json-string, optional) - -Example: - -{ "event": "VNC_INITIALIZED", - "data": { - "server": { "auth": "sasl", "family": "ipv4", - "service": "5901", "host": "0.0.0.0"}, - "client": { "family": "ipv4", "service": "46089", - "host": "127.0.0.1", "sasl_username": "luiz" } }, - "timestamp": { "seconds": 1263475302, "microseconds": 150772 } } - VSERPORT_CHANGE --------------- -- cgit v1.1 From 659789ba365bfc99210adf5347a28dc3f977e727 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:30:33 +0200 Subject: qmp-events: move 'VNC_DISCONNECTED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 29 ----------------------------- 1 file changed, 29 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 1bc7672..c9d44f3 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -259,35 +259,6 @@ Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} -VNC_DISCONNECTED ----------------- - -Emitted when the connection is closed. - -Data: - -- "server": Server information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "auth": authentication method (json-string, optional) -- "client": Client information (json-object) - - "host": IP address (json-string) - - "service": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "x509_dname": TLS dname (json-string, optional) - - "sasl_username": SASL username (json-string, optional) - -Example: - -{ "event": "VNC_DISCONNECTED", - "data": { - "server": { "auth": "sasl", "family": "ipv4", - "service": "5901", "host": "0.0.0.0" }, - "client": { "family": "ipv4", "service": "58425", - "host": "127.0.0.1", "sasl_username": "luiz" } }, - "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } - VSERPORT_CHANGE --------------- -- cgit v1.1 From 5db6670347d3e599ee1e82f6400bbf387e129b98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:31:17 +0200 Subject: qmp-events: move 'SPICE_CONNECTED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 25 ------------------------- 1 file changed, 25 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index c9d44f3..5c121c5 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -131,31 +131,6 @@ Flush operation: Note: this event is rate-limited. -SPICE_CONNECTED ---------------- - -Emitted when a SPICE client connects. - -Data: - -- "server": Server information (json-object) - - "host": IP address (json-string) - - "port": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") -- "client": Client information (json-object) - - "host": IP address (json-string) - - "port": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - -Example: - -{ "timestamp": {"seconds": 1290688046, "microseconds": 388707}, - "event": "SPICE_CONNECTED", - "data": { - "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"}, - "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} -}} - SPICE_DISCONNECTED ------------------ -- cgit v1.1 From da08e2a5a2a6ba5956bee1158f9ac2fc2ce364b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:31:52 +0200 Subject: qmp-events: move 'SPICE_INITIALIZED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 37 ------------------------------------- 1 file changed, 37 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 5c121c5..bca0f54 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -156,43 +156,6 @@ Example: "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} }} -SPICE_INITIALIZED ------------------ - -Emitted after initial handshake and authentication takes place (if any) -and the SPICE channel is up and running - -Data: - -- "server": Server information (json-object) - - "host": IP address (json-string) - - "port": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "auth": authentication method (json-string, optional) -- "client": Client information (json-object) - - "host": IP address (json-string) - - "port": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - - "connection-id": spice connection id. All channels with the same id - belong to the same spice session (json-int) - - "channel-type": channel type. "1" is the main control channel, filter for - this one if you want track spice sessions only (json-int) - - "channel-id": channel id. Usually "0", might be different needed when - multiple channels of the same type exist, such as multiple - display channels in a multihead setup (json-int) - - "tls": whevener the channel is encrypted (json-bool) - -Example: - -{ "timestamp": {"seconds": 1290688046, "microseconds": 417172}, - "event": "SPICE_INITIALIZED", - "data": {"server": {"auth": "spice", "port": "5921", - "family": "ipv4", "host": "127.0.0.1"}, - "client": {"port": "49004", "family": "ipv4", "channel-type": 3, - "connection-id": 1804289383, "host": "127.0.0.1", - "channel-id": 0, "tls": true} -}} - SPICE_MIGRATE_COMPLETED ----------------------- -- cgit v1.1 From 93ab0fc3c3d4884c475fa452a41e9c4bd1d693d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:32:29 +0200 Subject: qmp-events: move 'SPICE_DISCONNECTED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 25 ------------------------- 1 file changed, 25 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index bca0f54..8fa3c23 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -131,31 +131,6 @@ Flush operation: Note: this event is rate-limited. -SPICE_DISCONNECTED ------------------- - -Emitted when a SPICE client disconnects. - -Data: - -- "server": Server information (json-object) - - "host": IP address (json-string) - - "port": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") -- "client": Client information (json-object) - - "host": IP address (json-string) - - "port": port number (json-string) - - "family": address family (json-string, "ipv4" or "ipv6") - -Example: - -{ "timestamp": {"seconds": 1290688046, "microseconds": 388707}, - "event": "SPICE_DISCONNECTED", - "data": { - "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"}, - "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} -}} - SPICE_MIGRATE_COMPLETED ----------------------- -- cgit v1.1 From e6bcb080f965d0a71acd859c8a35e0652b5c366e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:32:56 +0200 Subject: qmp-events: move 'SPICE_MIGRATE_COMPLETED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 12 ------------ 1 file changed, 12 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 8fa3c23..0574a21 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -131,18 +131,6 @@ Flush operation: Note: this event is rate-limited. -SPICE_MIGRATE_COMPLETED ------------------------ - -Emitted when SPICE migration has completed - -Data: None. - -Example: - -{ "timestamp": {"seconds": 1290688046, "microseconds": 417172}, - "event": "SPICE_MIGRATE_COMPLETED" } - MIGRATION --------- -- cgit v1.1 From bce911ce263e78d13fad5415881a5310ead6c73f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:33:23 +0200 Subject: qmp-events: move 'MIGRATION' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 15 --------------- 1 file changed, 15 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 0574a21..d61ab1d 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -131,21 +131,6 @@ Flush operation: Note: this event is rate-limited. -MIGRATION ---------- - -Emitted when a migration event happens - -Data: None. - - - "status": migration status - See MigrationStatus in ~/qapi-schema.json for possible values - -Example: - -{"timestamp": {"seconds": 1432121972, "microseconds": 744001}, - "event": "MIGRATION", "data": {"status": "completed"}} - MIGRATION_PASS -------------- -- cgit v1.1 From 622b3a6a51ee6ecfd14f78a2b013c17b0e7c05fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:34:01 +0200 Subject: qmp-events: move 'ACPI_DEVICE_OST' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 10 ---------- 1 file changed, 10 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index d61ab1d..2c7eccf 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -1,16 +1,6 @@ QEMU Machine Protocol Events ============================ -ACPI_DEVICE_OST ---------------- - -Emitted when guest executes ACPI _OST method. - - - data: ACPIOSTInfo type as described in qapi-schema.json - -{ "event": "ACPI_DEVICE_OST", - "data": { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0 } } - BALLOON_CHANGE -------------- -- cgit v1.1 From a030dc00295438c56498032e93af42b19cbc94fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:34:34 +0200 Subject: qmp-events: move 'BALLOON_CHANGE' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 19 ------------------- 1 file changed, 19 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 2c7eccf..9f6415d 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -1,25 +1,6 @@ QEMU Machine Protocol Events ============================ -BALLOON_CHANGE --------------- - -Emitted when the guest changes the actual BALLOON level. This -value is equivalent to the 'actual' field return by the -'query-balloon' command - -Data: - -- "actual": actual level of the guest memory balloon in bytes (json-number) - -Example: - -{ "event": "BALLOON_CHANGE", - "data": { "actual": 944766976 }, - "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } - -Note: this event is rate-limited. - DUMP_COMPLETED -------------- -- cgit v1.1 From 449dbec15a39da4f8c2d7e9178a997c5b486f397 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:35:19 +0200 Subject: qmp-events: move 'GUEST_PANICKED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 14 -------------- 1 file changed, 14 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 9f6415d..f8e777c 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -19,20 +19,6 @@ Example: "data": {"result": {"total": 1090650112, "status": "completed", "completed": 1090650112} } } -GUEST_PANICKED --------------- - -Emitted when guest OS panic is detected. - -Data: - -- "action": Action that has been taken (json-string, currently always "pause"). - -Example: - -{ "event": "GUEST_PANICKED", - "data": { "action": "pause" } } - MEM_UNPLUG_ERROR -------------------- Emitted when memory hot unplug error occurs. -- cgit v1.1 From 9dcbe9a7e8e3bd40315c00682ff3f42b832dd435 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:36:17 +0200 Subject: qmp-events: move 'QUORUM_FAILURE' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 19 ------------------- 1 file changed, 19 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index f8e777c..c0a3bb8 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -36,25 +36,6 @@ Example: }, "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } -QUORUM_FAILURE --------------- - -Emitted by the Quorum block driver if it fails to establish a quorum. - -Data: - -- "reference": device name if defined else node name. -- "sector-num": Number of the first sector of the failed read operation. -- "sectors-count": Failed read operation sector count. - -Example: - -{ "event": "QUORUM_FAILURE", - "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 }, - "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } - -Note: this event is rate-limited. - QUORUM_REPORT_BAD ----------------- -- cgit v1.1 From 2ee7fea7ce0306e39fa4bfed122c3fa0acf0bb02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:38:12 +0200 Subject: qmp-events: move 'QUORUM_REPORT_BAD' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 33 --------------------------------- 1 file changed, 33 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index c0a3bb8..6f42640 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -36,39 +36,6 @@ Example: }, "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } -QUORUM_REPORT_BAD ------------------ - -Emitted to report a corruption of a Quorum file. - -Data: - -- "type": Quorum operation type -- "error": Error message (json-string, optional) - Only present on failure. This field contains a human-readable - error message. There are no semantics other than that the - block layer reported an error and clients should not try to - interpret the error string. -- "node-name": The graph node name of the block driver state. -- "sector-num": Number of the first sector of the failed read operation. -- "sectors-count": Failed read operation sector count. - -Example: - -Read operation: -{ "event": "QUORUM_REPORT_BAD", - "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5, - "type": "read" }, - "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } - -Flush operation: -{ "event": "QUORUM_REPORT_BAD", - "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120, - "type": "flush", "error": "Broken pipe" }, - "timestamp": { "seconds": 1456406829, "microseconds": 291763 } } - -Note: this event is rate-limited. - MIGRATION_PASS -------------- -- cgit v1.1 From 14df1ea1683a52decbe4664fba6a8aa139536f27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:39:06 +0200 Subject: qmp-events: move 'VSERPORT_CHANGE' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 18 ------------------ 1 file changed, 18 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 6f42640..59743b5 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -49,21 +49,3 @@ Data: None. Example: {"timestamp": {"seconds": 1449669631, "microseconds": 239225}, "event": "MIGRATION_PASS", "data": {"pass": 2}} - -VSERPORT_CHANGE ---------------- - -Emitted when the guest opens or closes a virtio-serial port. - -Data: - -- "id": device identifier of the virtio-serial port (json-string) -- "open": true if the guest has opened the virtio-serial port (json-bool) - -Example: - -{ "event": "VSERPORT_CHANGE", - "data": { "id": "channel0", "open": true }, - "timestamp": { "seconds": 1401385907, "microseconds": 422329 } } - -Note: this event is rate-limited separately for each "id". -- cgit v1.1 From e602f0b4e7fc497c50a63732feeb9be7650cdaef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:39:52 +0200 Subject: qmp-events: move 'MEM_UNPLUG_ERROR' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 17 ----------------- 1 file changed, 17 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 59743b5..66a287e 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -19,23 +19,6 @@ Example: "data": {"result": {"total": 1090650112, "status": "completed", "completed": 1090650112} } } -MEM_UNPLUG_ERROR --------------------- -Emitted when memory hot unplug error occurs. - -Data: - -- "device": device name (json-string) -- "msg": Informative message (e.g., reason for the error) (json-string) - -Example: - -{ "event": "MEM_UNPLUG_ERROR" - "data": { "device": "dimm1", - "msg": "acpi: device unplug for unsupported device" - }, - "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } - MIGRATION_PASS -------------- -- cgit v1.1 From a102a4acad6c1bc94942efbec18cf7f20bdac40e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:45:03 +0200 Subject: qmp-events: move 'DUMP_COMPLETED' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 18 ------------------ 1 file changed, 18 deletions(-) (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt index 66a287e..d84be5f 100644 --- a/docs/qmp-events.txt +++ b/docs/qmp-events.txt @@ -1,24 +1,6 @@ QEMU Machine Protocol Events ============================ -DUMP_COMPLETED --------------- - -Emitted when the guest has finished one memory dump. - -Data: - -- "result": DumpQueryResult type described in qapi-schema.json -- "error": Error message when dump failed. This is only a - human-readable string provided when dump failed. It should not be - parsed in any way (json-string, optional) - -Example: - -{ "event": "DUMP_COMPLETED", - "data": {"result": {"total": 1090650112, "status": "completed", - "completed": 1090650112} } } - MIGRATION_PASS -------------- -- cgit v1.1 From 231aaf3a8217443b518221719d1073c08f367225 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 23 Jun 2016 16:45:54 +0200 Subject: qmp-events: move 'MIGRATION_PASS' doc to schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau Signed-off-by: Markus Armbruster --- docs/qmp-events.txt | 16 ---------------- 1 file changed, 16 deletions(-) delete mode 100644 docs/qmp-events.txt (limited to 'docs') diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt deleted file mode 100644 index d84be5f..0000000 --- a/docs/qmp-events.txt +++ /dev/null @@ -1,16 +0,0 @@ - QEMU Machine Protocol Events - ============================ - -MIGRATION_PASS --------------- - -Emitted from the source side of a migration at the start of each pass -(when it syncs the dirty bitmap) - -Data: None. - - - "pass": An incrementing count (starting at 1 on the first pass) - -Example: -{"timestamp": {"seconds": 1449669631, "microseconds": 239225}, - "event": "MIGRATION_PASS", "data": {"pass": 2}} -- cgit v1.1 From 3313b6124b524893683311e01437a82b40784e8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Fri, 13 Jan 2017 15:41:29 +0100 Subject: qapi: add qapi2texi script MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit As the name suggests, the qapi2texi script converts JSON QAPI description into a texi file suitable for different target formats (info/man/txt/pdf/html...). It parses the following kind of blocks: Free-form: ## # = Section # == Subsection # # Some text foo with *emphasis* # 1. with a list # 2. like that # # And some code: # | $ echo foo # | -> do this # | <- get that # ## Symbol description: ## # @symbol: # # Symbol body ditto ergo sum. Foo bar # baz ding. # # @param1: the frob to frobnicate # @param2: #optional how hard to frobnicate # # Returns: the frobnicated frob. # If frob isn't frobnicatable, GenericError. # # Since: version # Notes: notes, comments can have # - itemized list # - like this # # Example: # # -> { "execute": "quit" } # <- { "return": {} } # ## That's roughly following the following EBNF grammar: api_comment = "##\n" comment "##\n" comment = freeform_comment | symbol_comment freeform_comment = { "# " text "\n" | "#\n" } symbol_comment = "# @" name ":\n" { member | tag_section | freeform_comment } member = "# @" name ':' [ text ] "\n" freeform_comment tag_section = "# " ( "Returns:", "Since:", "Note:", "Notes:", "Example:", "Examples:" ) [ text ] "\n" freeform_comment text = free text with markup Note that the grammar is ambiguous: a line "# @foo:\n" can be parsed both as freeform_comment and as symbol_comment. The actual parser recognizes symbol_comment. See docs/qapi-code-gen.txt for more details. Deficiencies and limitations: - the generated QMP documentation includes internal types - union type support is lacking - type information is lacking in generated documentation - doc comment error message positions are imprecise, they point to the beginning of the comment. - a few minor issues, all marked TODO/FIXME in the code Signed-off-by: Marc-André Lureau Message-Id: <20170113144135.5150-16-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster [test-qapi.py tweaked to avoid trailing empty lines in .out] Signed-off-by: Markus Armbruster --- docs/qapi-code-gen.txt | 180 ++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 147 insertions(+), 33 deletions(-) (limited to 'docs') diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt index 2841c51..7eb7be1 100644 --- a/docs/qapi-code-gen.txt +++ b/docs/qapi-code-gen.txt @@ -44,40 +44,154 @@ Input must be ASCII (although QMP supports full Unicode strings, the QAPI parser does not). At present, there is no place where a QAPI schema requires the use of JSON numbers or null. + +=== Comments === + Comments are allowed; anything between an unquoted # and the following -newline is ignored. Although there is not yet a documentation -generator, a form of stylized comments has developed for consistently -documenting details about an expression and when it was added to the -schema. The documentation is delimited between two lines of ##, then -the first line names the expression, an optional overview is provided, -then individual documentation about each member of 'data' is provided, -and finally, a 'Since: x.y.z' tag lists the release that introduced -the expression. Optional members are tagged with the phrase -'#optional', often with their default value; and extensions added -after the expression was first released are also given a '(since -x.y.z)' comment. For example: - - ## - # @BlockStats: - # - # Statistics of a virtual block device or a block backing device. - # - # @device: #optional If the stats are for a virtual block device, the name - # corresponding to the virtual block device. - # - # @stats: A @BlockDeviceStats for the device. - # - # @parent: #optional This describes the file block device if it has one. - # - # @backing: #optional This describes the backing block device if it has one. - # (Since 2.0) - # - # Since: 0.14.0 - ## - { 'struct': 'BlockStats', - 'data': {'*device': 'str', 'stats': 'BlockDeviceStats', - '*parent': 'BlockStats', - '*backing': 'BlockStats'} } +newline is ignored. + +A multi-line comment that starts and ends with a '##' line is a +documentation comment. These are parsed by the documentation +generator, which recognizes certain markup detailed below. + + +==== Documentation markup ==== + +Comment text starting with '=' is a section title: + + # = Section title + +Double the '=' for a subsection title: + + # == Subection title + +'|' denotes examples: + + # | Text of the example, may span + # | multiple lines + +'*' starts an itemized list: + + # * First item, may span + # multiple lines + # * Second item + +You can also use '-' instead of '*'. + +A decimal number followed by '.' starts a numbered list: + + # 1. First item, may span + # multiple lines + # 2. Second item + +The actual number doesn't matter. You could even use '*' instead of +'2.' for the second item. + +Lists can't be nested. Blank lines are currently not supported within +lists. + +Additional whitespace between the initial '#' and the comment text is +permitted. + +*foo* and _foo_ are for strong and emphasis styles respectively (they +do not work over multiple lines). @foo is used to reference a name in +the schema. + +Example: + +## +# = Section +# == Subsection +# +# Some text foo with *strong* and _emphasis_ +# 1. with a list +# 2. like that +# +# And some code: +# | $ echo foo +# | -> do this +# | <- get that +# +## + + +==== Expression documentation ==== + +Each expression that isn't an include directive must be preceded by a +documentation block. Such blocks are called expression documentation +blocks. + +The documentation block consists of a first line naming the +expression, an optional overview, a description of each argument (for +commands and events) or member (for structs, unions and alternates), +and optional tagged sections. + +FIXME: the parser accepts these things in almost any order. + +Optional arguments / members are tagged with the phrase '#optional', +often with their default value; and extensions added after the +expression was first released are also given a '(since x.y.z)' +comment. + +A tagged section starts with one of the following words: +"Note:"/"Notes:", "Since:", "Example"/"Examples", "Returns:", "TODO:". +The section ends with the start of a new section. + +A 'Since: x.y.z' tagged section lists the release that introduced the +expression. + +For example: + +## +# @BlockStats: +# +# Statistics of a virtual block device or a block backing device. +# +# @device: #optional If the stats are for a virtual block device, the name +# corresponding to the virtual block device. +# +# @node-name: #optional The node name of the device. (since 2.3) +# +# ... more members ... +# +# Since: 0.14.0 +## +{ 'struct': 'BlockStats', + 'data': {'*device': 'str', '*node-name': 'str', + ... more members ... } } + +## +# @query-blockstats: +# +# Query the @BlockStats for all virtual block devices. +# +# @query-nodes: #optional If true, the command will query all the +# block nodes ... explain, explain ... (since 2.3) +# +# Returns: A list of @BlockStats for each virtual block devices. +# +# Since: 0.14.0 +# +# Example: +# +# -> { "execute": "query-blockstats" } +# <- { +# ... lots of output ... +# } +# +## +{ 'command': 'query-blockstats', + 'data': { '*query-nodes': 'bool' }, + 'returns': ['BlockStats'] } + +==== Free-form documentation ==== + +A documentation block that isn't an expression documentation block is +a free-form documentation block. These may be used to provide +additional text and structuring content. + + +=== Schema overview === The schema sets up a series of types, as well as commands and events that will use those types. Forward references are allowed: the parser -- cgit v1.1 From c051a4c2020f31fba134f54e03fc48aac3be4706 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Fri, 13 Jan 2017 15:41:30 +0100 Subject: docs: add qemu logo to pdf MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a logo to texi2pdf output. Other formats (info/html) are left as future improvements. The PDF (needed by texi2pdf for vectorized images) was generated from pc-bios/qemu_logo.svg like this: inkscape --export-pdf=docs/qemu_logo.pdf pc-bios/qemu_logo.svg Signed-off-by: Marc-André Lureau Reviewed-by: Markus Armbruster Message-Id: <20170113144135.5150-17-marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster --- docs/qemu-ga-ref.texi | 4 ++++ docs/qemu-qmp-ref.texi | 4 ++++ docs/qemu_logo.pdf | Bin 0 -> 9117 bytes 3 files changed, 8 insertions(+) create mode 100644 docs/qemu_logo.pdf (limited to 'docs') diff --git a/docs/qemu-ga-ref.texi b/docs/qemu-ga-ref.texi index b889802..87cc8d0 100644 --- a/docs/qemu-ga-ref.texi +++ b/docs/qemu-ga-ref.texi @@ -6,6 +6,10 @@ @settitle QEMU Guest Agent Protocol Reference +@iftex +@center @image{docs/qemu_logo} +@end iftex + @copying This is the QEMU Guest Agent Protocol reference manual. diff --git a/docs/qemu-qmp-ref.texi b/docs/qemu-qmp-ref.texi index efb3370..818e525 100644 --- a/docs/qemu-qmp-ref.texi +++ b/docs/qemu-qmp-ref.texi @@ -6,6 +6,10 @@ @settitle QEMU QMP Reference Manual +@iftex +@center @image{docs/qemu_logo} +@end iftex + @copying This is the QEMU QMP reference manual. diff --git a/docs/qemu_logo.pdf b/docs/qemu_logo.pdf new file mode 100644 index 0000000..294cb7d Binary files /dev/null and b/docs/qemu_logo.pdf differ -- cgit v1.1 From 56e8bdd46a8a42d89b0afea9da83ae7679cc0439 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Fri, 13 Jan 2017 15:41:35 +0100 Subject: build-sys: add qapi doc generation targets MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Generate and install the man, txt and html versions of QAPI documentation (generate and install qemu-doc.txt too). Add it also to optional pdf/info targets. Signed-off-by: Marc-André Lureau Message-Id: <20170113144135.5150-22-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster Signed-off-by: Markus Armbruster --- docs/qmp-intro.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/qmp-intro.txt b/docs/qmp-intro.txt index f6a3a03..60deafb 100644 --- a/docs/qmp-intro.txt +++ b/docs/qmp-intro.txt @@ -16,8 +16,7 @@ QMP is JSON[1] based and features the following: For detailed information on QMP's usage, please, refer to the following files: o qmp-spec.txt QEMU Machine Protocol current specification -o qmp-commands.txt QMP supported commands (auto-generated at build-time) -o qmp-events.txt List of available asynchronous events +o qemu-qmp-ref.html QEMU QMP commands and events (auto-generated at build-time) [1] http://www.json.org -- cgit v1.1