control.json (9b112b1b79f0e93242a9ce9bffd1113458e93e03) control.json (a937b6aa739f65f2cae2ad9a7eb65a309ad2a359)
1# -*- Mode: Python -*-
2# vim: filetype=python
3#
4
5##
6# = QMP monitor control
7##
8
9##
10# @qmp_capabilities:
11#
12# Enable QMP capabilities.
13#
14# Arguments:
15#
16# @enable: An optional list of QMPCapability values to enable. The
1# -*- Mode: Python -*-
2# vim: filetype=python
3#
4
5##
6# = QMP monitor control
7##
8
9##
10# @qmp_capabilities:
11#
12# Enable QMP capabilities.
13#
14# Arguments:
15#
16# @enable: An optional list of QMPCapability values to enable. The
17# client must not enable any capability that is not
18# mentioned in the QMP greeting message. If the field is not
19# provided, it means no QMP capabilities will be enabled.
20# (since 2.12)
17# client must not enable any capability that is not mentioned in
18# the QMP greeting message. If the field is not provided, it
19# means no QMP capabilities will be enabled. (since 2.12)
21#
22# Example:
23#
24# -> { "execute": "qmp_capabilities",
25# "arguments": { "enable": [ "oob" ] } }
26# <- { "return": {} }
27#
20#
21# Example:
22#
23# -> { "execute": "qmp_capabilities",
24# "arguments": { "enable": [ "oob" ] } }
25# <- { "return": {} }
26#
28# Notes: This command is valid exactly when first connecting: it must be
29# issued before any other command will be accepted, and will fail once the
30# monitor is accepting other commands. (see qemu docs/interop/qmp-spec.txt)
27# Notes: This command is valid exactly when first connecting: it must
28# be issued before any other command will be accepted, and will
29# fail once the monitor is accepting other commands. (see qemu
30# docs/interop/qmp-spec.txt)
31#
31#
32# The QMP client needs to explicitly enable QMP capabilities, otherwise
33# all the QMP capabilities will be turned off by default.
32# The QMP client needs to explicitly enable QMP capabilities,
33# otherwise all the QMP capabilities will be turned off by
34# default.
34#
35# Since: 0.13
36##
37{ 'command': 'qmp_capabilities',
38 'data': { '*enable': [ 'QMPCapability' ] },
39 'allow-preconfig': true }
40
41##
42# @QMPCapability:
43#
44# Enumeration of capabilities to be advertised during initial client
45# connection, used for agreeing on particular QMP extension behaviors.
46#
35#
36# Since: 0.13
37##
38{ 'command': 'qmp_capabilities',
39 'data': { '*enable': [ 'QMPCapability' ] },
40 'allow-preconfig': true }
41
42##
43# @QMPCapability:
44#
45# Enumeration of capabilities to be advertised during initial client
46# connection, used for agreeing on particular QMP extension behaviors.
47#
47# @oob: QMP ability to support out-of-band requests.
48# (Please refer to qmp-spec.txt for more information on OOB)
48# @oob: QMP ability to support out-of-band requests. (Please refer to
49# qmp-spec.txt for more information on OOB)
49#
50# Since: 2.12
51##
52{ 'enum': 'QMPCapability',
53 'data': [ 'oob' ] }
54
55##
56# @VersionTriple:

--- 11 unchanged lines hidden (view full) ---

68{ 'struct': 'VersionTriple',
69 'data': {'major': 'int', 'minor': 'int', 'micro': 'int'} }
70
71##
72# @VersionInfo:
73#
74# A description of QEMU's version.
75#
50#
51# Since: 2.12
52##
53{ 'enum': 'QMPCapability',
54 'data': [ 'oob' ] }
55
56##
57# @VersionTriple:

--- 11 unchanged lines hidden (view full) ---

69{ 'struct': 'VersionTriple',
70 'data': {'major': 'int', 'minor': 'int', 'micro': 'int'} }
71
72##
73# @VersionInfo:
74#
75# A description of QEMU's version.
76#
76# @qemu: The version of QEMU. By current convention, a micro
77# version of 50 signifies a development branch. A micro version
78# greater than or equal to 90 signifies a release candidate for
79# the next minor version. A micro version of less than 50
80# signifies a stable release.
77# @qemu: The version of QEMU. By current convention, a micro version
78# of 50 signifies a development branch. A micro version greater
79# than or equal to 90 signifies a release candidate for the next
80# minor version. A micro version of less than 50 signifies a
81# stable release.
81#
82#
82# @package: QEMU will always set this field to an empty string. Downstream
83# versions of QEMU should set this to a non-empty string. The
84# exact format depends on the downstream however it highly
85# recommended that a unique name is used.
83# @package: QEMU will always set this field to an empty string.
84# Downstream versions of QEMU should set this to a non-empty
85# string. The exact format depends on the downstream however it
86# highly recommended that a unique name is used.
86#
87# Since: 0.14
88##
89{ 'struct': 'VersionInfo',
90 'data': {'qemu': 'VersionTriple', 'package': 'str'} }
91
92##
93# @query-version:
94#
95# Returns the current version of QEMU.
96#
87#
88# Since: 0.14
89##
90{ 'struct': 'VersionInfo',
91 'data': {'qemu': 'VersionTriple', 'package': 'str'} }
92
93##
94# @query-version:
95#
96# Returns the current version of QEMU.
97#
97# Returns: A @VersionInfo object describing the current version of QEMU.
98# Returns: A @VersionInfo object describing the current version of
99# QEMU.
98#
99# Since: 0.14
100#
101# Example:
102#
103# -> { "execute": "query-version" }
104# <- {
105# "return":{
106# "qemu":{
107# "major":0,
108# "minor":11,
109# "micro":5
110# },
111# "package":""
112# }
113# }
100#
101# Since: 0.14
102#
103# Example:
104#
105# -> { "execute": "query-version" }
106# <- {
107# "return":{
108# "qemu":{
109# "major":0,
110# "minor":11,
111# "micro":5
112# },
113# "package":""
114# }
115# }
114#
115##
116{ 'command': 'query-version', 'returns': 'VersionInfo',
117 'allow-preconfig': true }
118
119##
120# @CommandInfo:
121#
122# Information about a QMP command

--- 22 unchanged lines hidden (view full) ---

145# "name":"query-balloon"
146# },
147# {
148# "name":"system_powerdown"
149# }
150# ]
151# }
152#
116##
117{ 'command': 'query-version', 'returns': 'VersionInfo',
118 'allow-preconfig': true }
119
120##
121# @CommandInfo:
122#
123# Information about a QMP command

--- 22 unchanged lines hidden (view full) ---

146# "name":"query-balloon"
147# },
148# {
149# "name":"system_powerdown"
150# }
151# ]
152# }
153#
153# Note: This example has been shortened as the real response is too long.
154#
154# Note: This example has been shortened as the real response is too
155# long.
155##
156{ 'command': 'query-commands', 'returns': ['CommandInfo'],
157 'allow-preconfig': true }
158
159##
160# @quit:
161#
156##
157{ 'command': 'query-commands', 'returns': ['CommandInfo'],
158 'allow-preconfig': true }
159
160##
161# @quit:
162#
162# This command will cause the QEMU process to exit gracefully. While every
163# attempt is made to send the QMP response before terminating, this is not
164# guaranteed. When using this interface, a premature EOF would not be
165# unexpected.
163# This command will cause the QEMU process to exit gracefully. While
164# every attempt is made to send the QMP response before terminating,
165# this is not guaranteed. When using this interface, a premature EOF
166# would not be unexpected.
166#
167# Since: 0.14
168#
169# Example:
170#
171# -> { "execute": "quit" }
172# <- { "return": {} }
173##

--- 16 unchanged lines hidden (view full) ---

190##
191# @MonitorOptions:
192#
193# Options to be used for adding a new monitor.
194#
195# @id: Name of the monitor
196#
197# @mode: Selects the monitor mode (default: readline in the system
167#
168# Since: 0.14
169#
170# Example:
171#
172# -> { "execute": "quit" }
173# <- { "return": {} }
174##

--- 16 unchanged lines hidden (view full) ---

191##
192# @MonitorOptions:
193#
194# Options to be used for adding a new monitor.
195#
196# @id: Name of the monitor
197#
198# @mode: Selects the monitor mode (default: readline in the system
198# emulator, control in qemu-storage-daemon)
199# emulator, control in qemu-storage-daemon)
199#
200# @pretty: Enables pretty printing (QMP only)
201#
202# @chardev: Name of a character device to expose the monitor on
203#
204# Since: 5.0
205##
206{ 'struct': 'MonitorOptions',
207 'data': {
208 '*id': 'str',
209 '*mode': 'MonitorMode',
210 '*pretty': 'bool',
211 'chardev': 'str'
212 } }
200#
201# @pretty: Enables pretty printing (QMP only)
202#
203# @chardev: Name of a character device to expose the monitor on
204#
205# Since: 5.0
206##
207{ 'struct': 'MonitorOptions',
208 'data': {
209 '*id': 'str',
210 '*mode': 'MonitorMode',
211 '*pretty': 'bool',
212 'chardev': 'str'
213 } }