5 # = QMP monitor control
11 # Enable QMP capabilities.
15 # @enable: An optional list of QMPCapability values to enable. The
16 # client must not enable any capability that is not
17 # mentioned in the QMP greeting message. If the field is not
18 # provided, it means no QMP capabilities will be enabled.
23 # -> { "execute": "qmp_capabilities",
24 # "arguments": { "enable": [ "oob" ] } }
27 # Notes: This command is valid exactly when first connecting: it must be
28 # issued before any other command will be accepted, and will fail once the
29 # monitor is accepting other commands. (see qemu docs/interop/qmp-spec.txt)
31 # The QMP client needs to explicitly enable QMP capabilities, otherwise
32 # all the QMP capabilities will be turned off by default.
37 { 'command': 'qmp_capabilities',
38 'data': { '*enable': [ 'QMPCapability' ] },
39 'allow-preconfig': true }
44 # Enumeration of capabilities to be advertised during initial client
45 # connection, used for agreeing on particular QMP extension behaviors.
47 # @oob: QMP ability to support out-of-band requests.
48 # (Please refer to qmp-spec.txt for more information on OOB)
53 { 'enum': 'QMPCapability',
59 # A three-part version number.
61 # @major: The major version number.
63 # @minor: The minor version number.
65 # @micro: The micro version number.
69 { 'struct': 'VersionTriple',
70 'data': {'major': 'int', 'minor': 'int', 'micro': 'int'} }
76 # A description of QEMU's version.
78 # @qemu: The version of QEMU. By current convention, a micro
79 # version of 50 signifies a development branch. A micro version
80 # greater than or equal to 90 signifies a release candidate for
81 # the next minor version. A micro version of less than 50
82 # signifies a stable release.
84 # @package: QEMU will always set this field to an empty string. Downstream
85 # versions of QEMU should set this to a non-empty string. The
86 # exact format depends on the downstream however it highly
87 # recommended that a unique name is used.
91 { 'struct': 'VersionInfo',
92 'data': {'qemu': 'VersionTriple', 'package': 'str'} }
97 # Returns the current version of QEMU.
99 # Returns: A @VersionInfo object describing the current version of QEMU.
105 # -> { "execute": "query-version" }
118 { 'command': 'query-version', 'returns': 'VersionInfo',
119 'allow-preconfig': true }
124 # Information about a QMP command
126 # @name: The command name
130 { 'struct': 'CommandInfo', 'data': {'name': 'str'} }
135 # Return a list of supported QMP commands by this server
137 # Returns: A list of @CommandInfo for all supported commands
143 # -> { "execute": "query-commands" }
147 # "name":"query-balloon"
150 # "name":"system_powerdown"
155 # Note: This example has been shortened as the real response is too long.
158 { 'command': 'query-commands', 'returns': ['CommandInfo'],
159 'allow-preconfig': true }
164 # Information about a QMP event
166 # @name: The event name
170 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
175 # Return information on QMP events.
178 # @deprecated: This command is deprecated, because its output doesn't
179 # reflect compile-time configuration. Use 'query-qmp-schema'
182 # Returns: A list of @EventInfo.
188 # -> { "execute": "query-events" }
200 # Note: This example has been shortened as the real response is too long.
203 { 'command': 'query-events', 'returns': ['EventInfo'],
204 'features': [ 'deprecated' ] }
209 # This command will cause the QEMU process to exit gracefully. While every
210 # attempt is made to send the QMP response before terminating, this is not
211 # guaranteed. When using this interface, a premature EOF would not be
218 # -> { "execute": "quit" }
219 # <- { "return": {} }
221 { 'command': 'quit' }
226 # An enumeration of monitor modes.
228 # @readline: HMP monitor (human-oriented command line interface)
230 # @control: QMP monitor (JSON-based machine interface)
234 { 'enum': 'MonitorMode', 'data': [ 'readline', 'control' ] }
239 # Options to be used for adding a new monitor.
241 # @id: Name of the monitor
243 # @mode: Selects the monitor mode (default: readline in the system
244 # emulator, control in qemu-storage-daemon)
246 # @pretty: Enables pretty printing (QMP only)
248 # @chardev: Name of a character device to expose the monitor on
252 { 'struct': 'MonitorOptions',
255 '*mode': 'MonitorMode',