xref: /qemu/storage-daemon/qapi/qapi-schema.json (revision cd9e18641b4f2bf96c0b5add83ae1ebad87f9c3d)
12af282ecSKevin Wolf# -*- Mode: Python -*-
2f7160f32SAndrea Bolognani# vim: filetype=python
32af282ecSKevin Wolf
42af282ecSKevin Wolf# Note that modules are shared with the QEMU main schema under the assumption
52af282ecSKevin Wolf# that the storage daemon schema is a subset of the main schema. For the shared
62af282ecSKevin Wolf# modules, no code is generated here, but we reuse the code files generated
72af282ecSKevin Wolf# from the main schema.
82af282ecSKevin Wolf#
92af282ecSKevin Wolf# If you wish to extend the storage daemon schema to contain things that are
102af282ecSKevin Wolf# not in the main schema, be aware that array types of types defined in shared
112af282ecSKevin Wolf# modules are only generated if an array of the respective type is already used
122af282ecSKevin Wolf# in the main schema. Therefore, if you use such arrays, you may need to define
132af282ecSKevin Wolf# the array type in the main schema, even if it is unused outside of the
142af282ecSKevin Wolf# storage daemon.
152af282ecSKevin Wolf
16a6af5443SJohn Snow##
17*5e03548bSMarkus Armbruster# = Introduction
18a6af5443SJohn Snow#
19*5e03548bSMarkus Armbruster# This manual describes the commands and events supported by the QEMU
20*5e03548bSMarkus Armbruster# storage daemon QMP.
21*5e03548bSMarkus Armbruster#
22*5e03548bSMarkus Armbruster# For locating a particular item, please see the `qapi-qsd-index`.
23*5e03548bSMarkus Armbruster#
24*5e03548bSMarkus Armbruster# The following notation is used in examples:
25*5e03548bSMarkus Armbruster#
26*5e03548bSMarkus Armbruster# .. qmp-example::
27*5e03548bSMarkus Armbruster#
28*5e03548bSMarkus Armbruster#   -> ... text sent by client (commands) ...
29*5e03548bSMarkus Armbruster#   <- ... text sent by server (command responses and events) ...
30*5e03548bSMarkus Armbruster#
31*5e03548bSMarkus Armbruster# Example text is formatted for readability.  However, in real
32*5e03548bSMarkus Armbruster# protocol usage, its commonly emitted as a single line.
33*5e03548bSMarkus Armbruster#
34*5e03548bSMarkus Armbruster# Please refer to the
35*5e03548bSMarkus Armbruster# :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`
36*5e03548bSMarkus Armbruster# for the general format of commands, responses, and events.
37a6af5443SJohn Snow##
38a6af5443SJohn Snow
39a6af5443SJohn Snow
402af282ecSKevin Wolf{ 'include': '../../qapi/pragma.json' }
412af282ecSKevin Wolf
424622c706SMarkus Armbruster# Documentation generated with qapi-gen.py is in source order, with
434622c706SMarkus Armbruster# included sub-schemas inserted at the first include directive
444622c706SMarkus Armbruster# (subsequent include directives have no effect).  To get a sane and
454622c706SMarkus Armbruster# stable order, it's best to include each sub-schema just once, or
464622c706SMarkus Armbruster# include it first right here.
474622c706SMarkus Armbruster
484622c706SMarkus Armbruster{ 'include': '../../qapi/common.json' }
494622c706SMarkus Armbruster{ 'include': '../../qapi/sockets.json' }
504622c706SMarkus Armbruster{ 'include': '../../qapi/crypto.json' }
514622c706SMarkus Armbruster{ 'include': '../../qapi/job.json' }
524622c706SMarkus Armbruster
5323c02aceSStefan Hajnoczi##
5423c02aceSStefan Hajnoczi# = Block devices
5523c02aceSStefan Hajnoczi##
562af282ecSKevin Wolf{ 'include': '../../qapi/block-core.json' }
575daa6bfdSKevin Wolf{ 'include': '../../qapi/block-export.json' }
584622c706SMarkus Armbruster
592af282ecSKevin Wolf{ 'include': '../../qapi/char.json' }
608825587bSKevin Wolf{ 'include': '../../qapi/authz.json' }
612af282ecSKevin Wolf{ 'include': '../../qapi/transaction.json' }
624622c706SMarkus Armbruster{ 'include': '../../qapi/control.json' }
634622c706SMarkus Armbruster{ 'include': '../../qapi/introspect.json' }
644622c706SMarkus Armbruster{ 'include': '../../qapi/qom.json' }
65