]> git.proxmox.com Git - mirror_qemu.git/blame - qapi/qapi-schema.json
qapi: Extract ACPI commands to 'acpi.json'
[mirror_qemu.git] / qapi / qapi-schema.json
CommitLineData
e3193601 1# -*- Mode: Python -*-
f7160f32 2# vim: filetype=python
4d8bb958
MAL
3##
4# = Introduction
5#
6# This document describes all commands currently supported by QMP.
7#
8# Most of the time their usage is exactly the same as in the user Monitor, this
9# means that any other document which also describe commands (the manpage,
10# QEMU's manual, etc) can and should be consulted.
11#
12# QMP has two types of commands: regular and query commands. Regular commands
13# usually change the Virtual Machine's state someway, while query commands just
14# return information. The sections below are divided accordingly.
15#
16# It's important to observe that all communication examples are formatted in
17# a reader-friendly way, so that they're easier to understand. However, in real
18# protocol usage, they're emitted as a single line.
19#
20# Also, the following notation is used to denote data flow:
21#
22# Example:
23#
24# | -> data issued by the Client
25# | <- Server data response
e3193601 26#
cfb41b88 27# Please, refer to the QMP specification (docs/interop/qmp-spec.txt) for
4d8bb958
MAL
28# detailed information on the Server command and response formats.
29#
30# = Stability Considerations
31#
32# The current QMP command set (described in this file) may be useful for a
33# number of use cases, however it's limited and several commands have bad
34# defined semantics, specially with regard to command completion.
35#
36# These problems are going to be solved incrementally in the next QEMU releases
37# and we're going to establish a deprecation policy for badly defined commands.
38#
39# If you're planning to adopt QMP, please observe the following:
40#
41# 1. The deprecation policy will take effect and be documented soon, please
42# check the documentation of each used command as soon as a new release of
43# QEMU is available
44#
45# 2. DO NOT rely on anything which is not explicit documented
46#
47# 3. Errors, in special, are not documented. Applications should NOT check
48# for specific errors classes or data (it's strongly recommended to only
49# check for the "error" key)
50#
51##
48a32bed 52
9a9f9099 53{ 'include': 'pragma.json' }
1554a8fa 54
fb0bc835 55# Documentation generated with qapi-gen.py is in source order, with
211e5063
MA
56# included sub-schemas inserted at the first include directive
57# (subsequent include directives have no effect). To get a sane and
58# stable order, it's best to include each sub-schema just once, or
eb815e24 59# include it first right here.
104059da 60
abb3d37d 61{ 'include': 'error.json' }
eb815e24
MA
62{ 'include': 'common.json' }
63{ 'include': 'sockets.json' }
64{ 'include': 'run-state.json' }
65{ 'include': 'crypto.json' }
66{ 'include': 'block.json' }
67{ 'include': 'char.json' }
d06b747b 68{ 'include': 'dump.json' }
bf42508f 69{ 'include': 'job.json' }
eb815e24 70{ 'include': 'net.json' }
4a5c9903 71{ 'include': 'rdma.json' }
eb815e24
MA
72{ 'include': 'rocker.json' }
73{ 'include': 'tpm.json' }
74{ 'include': 'ui.json' }
c8c99887 75{ 'include': 'authz.json' }
eb815e24
MA
76{ 'include': 'migration.json' }
77{ 'include': 'transaction.json' }
78{ 'include': 'trace.json' }
fa4dcf57 79{ 'include': 'control.json' }
eb815e24 80{ 'include': 'introspect.json' }
c577ff62
MA
81{ 'include': 'qom.json' }
82{ 'include': 'qdev.json' }
8ac25c84 83{ 'include': 'machine.json' }
7f7b4e7a 84{ 'include': 'machine-target.json' }
eb815e24 85{ 'include': 'misc.json' }
b0227cdb 86{ 'include': 'misc-target.json' }
8c3a7d00 87{ 'include': 'audio.json' }
27c9188f 88{ 'include': 'acpi.json' }