qemu-nbd: always compile in --aio=MODE option
[qemu.git] / qapi / common.json
blobbad56bf68821fab4a30d709db06609fea18b498e
1 # -*- Mode: Python -*-
3 # QAPI common definitions
5 ##
6 # @ErrorClass
8 # QEMU error classes
10 # @GenericError: this is used for errors that don't require a specific error
11 #                class. This should be the default case for most errors
13 # @CommandNotFound: the requested command has not been found
15 # @DeviceEncrypted: the requested operation can't be fulfilled because the
16 #                   selected device is encrypted
18 # @DeviceNotActive: a device has failed to be become active
20 # @DeviceNotFound: the requested device has not been found
22 # @KVMMissingCap: the requested operation can't be fulfilled because a
23 #                 required KVM capability is missing
25 # Since: 1.2
27 { 'enum': 'ErrorClass',
28   'data': [ 'GenericError', 'CommandNotFound', 'DeviceEncrypted',
29             'DeviceNotActive', 'DeviceNotFound', 'KVMMissingCap' ] }
32 # @VersionTriple
34 # A three-part version number.
36 # @qemu.major:  The major version number.
38 # @qemu.minor:  The minor version number.
40 # @qemu.micro:  The micro version number.
42 # Since: 2.4
44 { 'struct': 'VersionTriple',
45   'data': {'major': 'int', 'minor': 'int', 'micro': 'int'} }
49 # @VersionInfo:
51 # A description of QEMU's version.
53 # @qemu:        The version of QEMU.  By current convention, a micro
54 #               version of 50 signifies a development branch.  A micro version
55 #               greater than or equal to 90 signifies a release candidate for
56 #               the next minor version.  A micro version of less than 50
57 #               signifies a stable release.
59 # @package:     QEMU will always set this field to an empty string.  Downstream
60 #               versions of QEMU should set this to a non-empty string.  The
61 #               exact format depends on the downstream however it highly
62 #               recommended that a unique name is used.
64 # Since: 0.14.0
66 { 'struct': 'VersionInfo',
67   'data': {'qemu': 'VersionTriple', 'package': 'str'} }
70 # @query-version:
72 # Returns the current version of QEMU.
74 # Returns:  A @VersionInfo object describing the current version of QEMU.
76 # Since: 0.14.0
78 { 'command': 'query-version', 'returns': 'VersionInfo' }
81 # @CommandInfo:
83 # Information about a QMP command
85 # @name: The command name
87 # Since: 0.14.0
89 { 'struct': 'CommandInfo', 'data': {'name': 'str'} }
92 # @query-commands:
94 # Return a list of supported QMP commands by this server
96 # Returns: A list of @CommandInfo for all supported commands
98 # Since: 0.14.0
100 { 'command': 'query-commands', 'returns': ['CommandInfo'] }
103 # @OnOffAuto
105 # An enumeration of three options: on, off, and auto
107 # @auto: QEMU selects the value between on and off
109 # @on: Enabled
111 # @off: Disabled
113 # Since: 2.2
115 { 'enum': 'OnOffAuto',
116   'data': [ 'auto', 'on', 'off' ] }