]>
Commit | Line | Data |
---|---|---|
608cfed6 | 1 | # -*- Mode: Python -*- |
f7160f32 | 2 | # vim: filetype=python |
608cfed6 MA |
3 | # |
4 | ||
5 | ## | |
6 | # = Remote desktop | |
7 | ## | |
8 | ||
30e863e5 | 9 | { 'include': 'common.json' } |
608cfed6 MA |
10 | { 'include': 'sockets.json' } |
11 | ||
7277db91 SR |
12 | ## |
13 | # @DisplayProtocol: | |
14 | # | |
15 | # Display protocols which support changing password options. | |
16 | # | |
17 | # Since: 7.0 | |
7277db91 SR |
18 | ## |
19 | { 'enum': 'DisplayProtocol', | |
20 | 'data': [ 'vnc', 'spice' ] } | |
21 | ||
22 | ## | |
23 | # @SetPasswordAction: | |
24 | # | |
25 | # An action to take on changing a password on a connection with active clients. | |
26 | # | |
27 | # @keep: maintain existing clients | |
28 | # | |
29 | # @fail: fail the command if clients are connected | |
30 | # | |
31 | # @disconnect: disconnect existing clients | |
32 | # | |
33 | # Since: 7.0 | |
7277db91 SR |
34 | ## |
35 | { 'enum': 'SetPasswordAction', | |
36 | 'data': [ 'keep', 'fail', 'disconnect' ] } | |
37 | ||
608cfed6 | 38 | ## |
675fd3c9 | 39 | # @SetPasswordOptions: |
608cfed6 | 40 | # |
675fd3c9 | 41 | # Options for set_password. |
608cfed6 | 42 | # |
e050e426 PM |
43 | # @protocol: - 'vnc' to modify the VNC server password |
44 | # - 'spice' to modify the Spice server password | |
608cfed6 MA |
45 | # |
46 | # @password: the new password | |
47 | # | |
675fd3c9 SR |
48 | # @connected: How to handle existing clients when changing the |
49 | # password. If nothing is specified, defaults to 'keep'. | |
50 | # For VNC, only 'keep' is currently implemented. | |
51 | # | |
52 | # Since: 7.0 | |
675fd3c9 SR |
53 | ## |
54 | { 'union': 'SetPasswordOptions', | |
55 | 'base': { 'protocol': 'DisplayProtocol', | |
56 | 'password': 'str', | |
57 | '*connected': 'SetPasswordAction' }, | |
58 | 'discriminator': 'protocol', | |
59 | 'data': { 'vnc': 'SetPasswordOptionsVnc' } } | |
60 | ||
61 | ## | |
62 | # @SetPasswordOptionsVnc: | |
63 | # | |
64 | # Options for set_password specific to the VNC procotol. | |
65 | # | |
66 | # @display: The id of the display where the password should be changed. | |
67 | # Defaults to the first. | |
68 | # | |
69 | # Since: 7.0 | |
675fd3c9 SR |
70 | ## |
71 | { 'struct': 'SetPasswordOptionsVnc', | |
72 | 'data': { '*display': 'str' } } | |
73 | ||
74 | ## | |
75 | # @set_password: | |
76 | # | |
77 | # Set the password of a remote display server. | |
608cfed6 | 78 | # |
e050e426 PM |
79 | # Returns: - Nothing on success |
80 | # - If Spice is not enabled, DeviceNotFound | |
608cfed6 | 81 | # |
9bc6e893 | 82 | # Since: 0.14 |
608cfed6 MA |
83 | # |
84 | # Example: | |
85 | # | |
86 | # -> { "execute": "set_password", "arguments": { "protocol": "vnc", | |
87 | # "password": "secret" } } | |
88 | # <- { "return": {} } | |
89 | # | |
90 | ## | |
675fd3c9 | 91 | { 'command': 'set_password', 'boxed': true, 'data': 'SetPasswordOptions' } |
608cfed6 MA |
92 | |
93 | ## | |
675fd3c9 | 94 | # @ExpirePasswordOptions: |
608cfed6 | 95 | # |
675fd3c9 | 96 | # General options for expire_password. |
608cfed6 | 97 | # |
675fd3c9 SR |
98 | # @protocol: - 'vnc' to modify the VNC server expiration |
99 | # - 'spice' to modify the Spice server expiration | |
608cfed6 MA |
100 | # |
101 | # @time: when to expire the password. | |
608cfed6 | 102 | # |
e050e426 PM |
103 | # - 'now' to expire the password immediately |
104 | # - 'never' to cancel password expiration | |
105 | # - '+INT' where INT is the number of seconds from now (integer) | |
106 | # - 'INT' where INT is the absolute time in seconds | |
107 | # | |
608cfed6 MA |
108 | # Notes: Time is relative to the server and currently there is no way to |
109 | # coordinate server time with client time. It is not recommended to | |
110 | # use the absolute time version of the @time parameter unless you're | |
111 | # sure you are on the same machine as the QEMU instance. | |
112 | # | |
675fd3c9 | 113 | # Since: 7.0 |
675fd3c9 SR |
114 | ## |
115 | { 'union': 'ExpirePasswordOptions', | |
116 | 'base': { 'protocol': 'DisplayProtocol', | |
117 | 'time': 'str' }, | |
118 | 'discriminator': 'protocol', | |
119 | 'data': { 'vnc': 'ExpirePasswordOptionsVnc' } } | |
120 | ||
121 | ## | |
122 | # @ExpirePasswordOptionsVnc: | |
123 | # | |
124 | # Options for expire_password specific to the VNC procotol. | |
125 | # | |
126 | # @display: The id of the display where the expiration should be changed. | |
127 | # Defaults to the first. | |
128 | # | |
129 | # Since: 7.0 | |
675fd3c9 | 130 | ## |
675fd3c9 SR |
131 | { 'struct': 'ExpirePasswordOptionsVnc', |
132 | 'data': { '*display': 'str' } } | |
133 | ||
134 | ## | |
135 | # @expire_password: | |
136 | # | |
137 | # Expire the password of a remote display server. | |
138 | # | |
139 | # Returns: - Nothing on success | |
140 | # - If @protocol is 'spice' and Spice is not active, DeviceNotFound | |
141 | # | |
142 | # Since: 0.14 | |
143 | # | |
608cfed6 MA |
144 | # Example: |
145 | # | |
146 | # -> { "execute": "expire_password", "arguments": { "protocol": "vnc", | |
147 | # "time": "+60" } } | |
148 | # <- { "return": {} } | |
149 | # | |
150 | ## | |
675fd3c9 | 151 | { 'command': 'expire_password', 'boxed': true, 'data': 'ExpirePasswordOptions' } |
608cfed6 | 152 | |
9a0a119a KS |
153 | ## |
154 | # @ImageFormat: | |
155 | # | |
156 | # Supported image format types. | |
157 | # | |
158 | # @png: PNG format | |
159 | # | |
160 | # @ppm: PPM format | |
161 | # | |
162 | # Since: 7.1 | |
9a0a119a KS |
163 | ## |
164 | { 'enum': 'ImageFormat', | |
165 | 'data': ['ppm', 'png'] } | |
166 | ||
608cfed6 MA |
167 | ## |
168 | # @screendump: | |
169 | # | |
9a0a119a | 170 | # Capture the contents of a screen and write it to a file. |
608cfed6 | 171 | # |
9a0a119a | 172 | # @filename: the path of a new file to store the image |
608cfed6 | 173 | # |
f771c544 TH |
174 | # @device: ID of the display device that should be dumped. If this parameter |
175 | # is missing, the primary display will be used. (Since 2.12) | |
176 | # | |
177 | # @head: head to use in case the device supports multiple heads. If this | |
178 | # parameter is missing, head #0 will be used. Also note that the head | |
179 | # can only be specified in conjunction with the device ID. (Since 2.12) | |
180 | # | |
9a0a119a KS |
181 | # @format: image format for screendump. (default: ppm) (Since 7.1) |
182 | # | |
608cfed6 MA |
183 | # Returns: Nothing on success |
184 | # | |
9bc6e893 | 185 | # Since: 0.14 |
608cfed6 MA |
186 | # |
187 | # Example: | |
188 | # | |
189 | # -> { "execute": "screendump", | |
190 | # "arguments": { "filename": "/tmp/image" } } | |
191 | # <- { "return": {} } | |
192 | # | |
193 | ## | |
f771c544 | 194 | { 'command': 'screendump', |
9a0a119a KS |
195 | 'data': {'filename': 'str', '*device': 'str', '*head': 'int', |
196 | '*format': 'ImageFormat'}, | |
0d9b90ce | 197 | 'coroutine': true } |
608cfed6 MA |
198 | |
199 | ## | |
200 | # == Spice | |
201 | ## | |
202 | ||
203 | ## | |
204 | # @SpiceBasicInfo: | |
205 | # | |
206 | # The basic information for SPICE network connection | |
207 | # | |
208 | # @host: IP address | |
209 | # | |
210 | # @port: port number | |
211 | # | |
212 | # @family: address family | |
213 | # | |
214 | # Since: 2.1 | |
215 | ## | |
216 | { 'struct': 'SpiceBasicInfo', | |
217 | 'data': { 'host': 'str', | |
218 | 'port': 'str', | |
514337c1 | 219 | 'family': 'NetworkAddressFamily' }, |
8a9f1e1d | 220 | 'if': 'CONFIG_SPICE' } |
608cfed6 MA |
221 | |
222 | ## | |
223 | # @SpiceServerInfo: | |
224 | # | |
225 | # Information about a SPICE server | |
226 | # | |
227 | # @auth: authentication method | |
228 | # | |
229 | # Since: 2.1 | |
230 | ## | |
231 | { 'struct': 'SpiceServerInfo', | |
232 | 'base': 'SpiceBasicInfo', | |
514337c1 | 233 | 'data': { '*auth': 'str' }, |
8a9f1e1d | 234 | 'if': 'CONFIG_SPICE' } |
608cfed6 MA |
235 | |
236 | ## | |
237 | # @SpiceChannel: | |
238 | # | |
239 | # Information about a SPICE client channel. | |
240 | # | |
241 | # @connection-id: SPICE connection id number. All channels with the same id | |
242 | # belong to the same SPICE session. | |
243 | # | |
244 | # @channel-type: SPICE channel type number. "1" is the main control | |
245 | # channel, filter for this one if you want to track spice | |
246 | # sessions only | |
247 | # | |
248 | # @channel-id: SPICE channel ID number. Usually "0", might be different when | |
249 | # multiple channels of the same type exist, such as multiple | |
250 | # display channels in a multihead setup | |
251 | # | |
252 | # @tls: true if the channel is encrypted, false otherwise. | |
253 | # | |
9bc6e893 | 254 | # Since: 0.14 |
608cfed6 MA |
255 | ## |
256 | { 'struct': 'SpiceChannel', | |
257 | 'base': 'SpiceBasicInfo', | |
258 | 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int', | |
514337c1 | 259 | 'tls': 'bool'}, |
8a9f1e1d | 260 | 'if': 'CONFIG_SPICE' } |
608cfed6 MA |
261 | |
262 | ## | |
263 | # @SpiceQueryMouseMode: | |
264 | # | |
265 | # An enumeration of Spice mouse states. | |
266 | # | |
267 | # @client: Mouse cursor position is determined by the client. | |
268 | # | |
269 | # @server: Mouse cursor position is determined by the server. | |
270 | # | |
271 | # @unknown: No information is available about mouse mode used by | |
272 | # the spice server. | |
273 | # | |
274 | # Note: spice/enums.h has a SpiceMouseMode already, hence the name. | |
275 | # | |
276 | # Since: 1.1 | |
277 | ## | |
278 | { 'enum': 'SpiceQueryMouseMode', | |
514337c1 | 279 | 'data': [ 'client', 'server', 'unknown' ], |
8a9f1e1d | 280 | 'if': 'CONFIG_SPICE' } |
608cfed6 MA |
281 | |
282 | ## | |
283 | # @SpiceInfo: | |
284 | # | |
285 | # Information about the SPICE session. | |
286 | # | |
287 | # @enabled: true if the SPICE server is enabled, false otherwise | |
288 | # | |
289 | # @migrated: true if the last guest migration completed and spice | |
290 | # migration had completed as well. false otherwise. (since 1.4) | |
291 | # | |
292 | # @host: The hostname the SPICE server is bound to. This depends on | |
293 | # the name resolution on the host and may be an IP address. | |
294 | # | |
295 | # @port: The SPICE server's port number. | |
296 | # | |
297 | # @compiled-version: SPICE server version. | |
298 | # | |
299 | # @tls-port: The SPICE server's TLS port number. | |
300 | # | |
301 | # @auth: the current authentication type used by the server | |
e050e426 PM |
302 | # |
303 | # - 'none' if no authentication is being used | |
304 | # - 'spice' uses SASL or direct TLS authentication, depending on command | |
305 | # line options | |
608cfed6 MA |
306 | # |
307 | # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can | |
308 | # be determined by the client or the server, or unknown if spice | |
309 | # server doesn't provide this information. (since: 1.1) | |
310 | # | |
311 | # @channels: a list of @SpiceChannel for each active spice channel | |
312 | # | |
9bc6e893 | 313 | # Since: 0.14 |
608cfed6 MA |
314 | ## |
315 | { 'struct': 'SpiceInfo', | |
316 | 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int', | |
317 | '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str', | |
514337c1 | 318 | 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']}, |
8a9f1e1d | 319 | 'if': 'CONFIG_SPICE' } |
608cfed6 MA |
320 | |
321 | ## | |
322 | # @query-spice: | |
323 | # | |
324 | # Returns information about the current SPICE server | |
325 | # | |
326 | # Returns: @SpiceInfo | |
327 | # | |
9bc6e893 | 328 | # Since: 0.14 |
608cfed6 MA |
329 | # |
330 | # Example: | |
331 | # | |
332 | # -> { "execute": "query-spice" } | |
333 | # <- { "return": { | |
334 | # "enabled": true, | |
335 | # "auth": "spice", | |
336 | # "port": 5920, | |
74dd52e5 | 337 | # "migrated":false, |
608cfed6 MA |
338 | # "tls-port": 5921, |
339 | # "host": "0.0.0.0", | |
74dd52e5 | 340 | # "mouse-mode":"client", |
608cfed6 MA |
341 | # "channels": [ |
342 | # { | |
343 | # "port": "54924", | |
344 | # "family": "ipv4", | |
345 | # "channel-type": 1, | |
346 | # "connection-id": 1804289383, | |
347 | # "host": "127.0.0.1", | |
348 | # "channel-id": 0, | |
349 | # "tls": true | |
350 | # }, | |
351 | # { | |
352 | # "port": "36710", | |
353 | # "family": "ipv4", | |
354 | # "channel-type": 4, | |
355 | # "connection-id": 1804289383, | |
356 | # "host": "127.0.0.1", | |
357 | # "channel-id": 0, | |
358 | # "tls": false | |
359 | # }, | |
360 | # [ ... more channels follow ... ] | |
361 | # ] | |
362 | # } | |
363 | # } | |
364 | # | |
365 | ## | |
514337c1 | 366 | { 'command': 'query-spice', 'returns': 'SpiceInfo', |
8a9f1e1d | 367 | 'if': 'CONFIG_SPICE' } |
608cfed6 MA |
368 | |
369 | ## | |
370 | # @SPICE_CONNECTED: | |
371 | # | |
372 | # Emitted when a SPICE client establishes a connection | |
373 | # | |
374 | # @server: server information | |
375 | # | |
376 | # @client: client information | |
377 | # | |
9bc6e893 | 378 | # Since: 0.14 |
608cfed6 MA |
379 | # |
380 | # Example: | |
381 | # | |
382 | # <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707}, | |
383 | # "event": "SPICE_CONNECTED", | |
384 | # "data": { | |
385 | # "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"}, | |
386 | # "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} | |
387 | # }} | |
388 | # | |
389 | ## | |
390 | { 'event': 'SPICE_CONNECTED', | |
391 | 'data': { 'server': 'SpiceBasicInfo', | |
514337c1 | 392 | 'client': 'SpiceBasicInfo' }, |
8a9f1e1d | 393 | 'if': 'CONFIG_SPICE' } |
608cfed6 MA |
394 | |
395 | ## | |
396 | # @SPICE_INITIALIZED: | |
397 | # | |
398 | # Emitted after initial handshake and authentication takes place (if any) | |
399 | # and the SPICE channel is up and running | |
400 | # | |
401 | # @server: server information | |
402 | # | |
403 | # @client: client information | |
404 | # | |
9bc6e893 | 405 | # Since: 0.14 |
608cfed6 MA |
406 | # |
407 | # Example: | |
408 | # | |
409 | # <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172}, | |
410 | # "event": "SPICE_INITIALIZED", | |
411 | # "data": {"server": {"auth": "spice", "port": "5921", | |
412 | # "family": "ipv4", "host": "127.0.0.1"}, | |
413 | # "client": {"port": "49004", "family": "ipv4", "channel-type": 3, | |
414 | # "connection-id": 1804289383, "host": "127.0.0.1", | |
415 | # "channel-id": 0, "tls": true} | |
416 | # }} | |
417 | # | |
418 | ## | |
419 | { 'event': 'SPICE_INITIALIZED', | |
420 | 'data': { 'server': 'SpiceServerInfo', | |
514337c1 | 421 | 'client': 'SpiceChannel' }, |
8a9f1e1d | 422 | 'if': 'CONFIG_SPICE' } |
608cfed6 MA |
423 | |
424 | ## | |
425 | # @SPICE_DISCONNECTED: | |
426 | # | |
427 | # Emitted when the SPICE connection is closed | |
428 | # | |
429 | # @server: server information | |
430 | # | |
431 | # @client: client information | |
432 | # | |
9bc6e893 | 433 | # Since: 0.14 |
608cfed6 MA |
434 | # |
435 | # Example: | |
436 | # | |
437 | # <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707}, | |
438 | # "event": "SPICE_DISCONNECTED", | |
439 | # "data": { | |
440 | # "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"}, | |
441 | # "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} | |
442 | # }} | |
443 | # | |
444 | ## | |
445 | { 'event': 'SPICE_DISCONNECTED', | |
446 | 'data': { 'server': 'SpiceBasicInfo', | |
514337c1 | 447 | 'client': 'SpiceBasicInfo' }, |
8a9f1e1d | 448 | 'if': 'CONFIG_SPICE' } |
608cfed6 MA |
449 | |
450 | ## | |
451 | # @SPICE_MIGRATE_COMPLETED: | |
452 | # | |
453 | # Emitted when SPICE migration has completed | |
454 | # | |
455 | # Since: 1.3 | |
456 | # | |
457 | # Example: | |
458 | # | |
459 | # <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172}, | |
460 | # "event": "SPICE_MIGRATE_COMPLETED" } | |
461 | # | |
462 | ## | |
514337c1 | 463 | { 'event': 'SPICE_MIGRATE_COMPLETED', |
8a9f1e1d | 464 | 'if': 'CONFIG_SPICE' } |
608cfed6 MA |
465 | |
466 | ## | |
467 | # == VNC | |
468 | ## | |
469 | ||
470 | ## | |
471 | # @VncBasicInfo: | |
472 | # | |
473 | # The basic information for vnc network connection | |
474 | # | |
475 | # @host: IP address | |
476 | # | |
477 | # @service: The service name of the vnc port. This may depend on the host | |
478 | # system's service database so symbolic names should not be relied | |
479 | # on. | |
480 | # | |
481 | # @family: address family | |
482 | # | |
483 | # @websocket: true in case the socket is a websocket (since 2.3). | |
484 | # | |
485 | # Since: 2.1 | |
486 | ## | |
487 | { 'struct': 'VncBasicInfo', | |
488 | 'data': { 'host': 'str', | |
489 | 'service': 'str', | |
490 | 'family': 'NetworkAddressFamily', | |
05eb4a25 | 491 | 'websocket': 'bool' }, |
8a9f1e1d | 492 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
493 | |
494 | ## | |
495 | # @VncServerInfo: | |
496 | # | |
497 | # The network connection information for server | |
498 | # | |
499 | # @auth: authentication method used for | |
500 | # the plain (non-websocket) VNC server | |
501 | # | |
502 | # Since: 2.1 | |
503 | ## | |
504 | { 'struct': 'VncServerInfo', | |
505 | 'base': 'VncBasicInfo', | |
05eb4a25 | 506 | 'data': { '*auth': 'str' }, |
8a9f1e1d | 507 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
508 | |
509 | ## | |
510 | # @VncClientInfo: | |
511 | # | |
512 | # Information about a connected VNC client. | |
513 | # | |
514 | # @x509_dname: If x509 authentication is in use, the Distinguished | |
515 | # Name of the client. | |
516 | # | |
517 | # @sasl_username: If SASL authentication is in use, the SASL username | |
518 | # used for authentication. | |
519 | # | |
9bc6e893 | 520 | # Since: 0.14 |
608cfed6 MA |
521 | ## |
522 | { 'struct': 'VncClientInfo', | |
523 | 'base': 'VncBasicInfo', | |
05eb4a25 | 524 | 'data': { '*x509_dname': 'str', '*sasl_username': 'str' }, |
8a9f1e1d | 525 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
526 | |
527 | ## | |
528 | # @VncInfo: | |
529 | # | |
530 | # Information about the VNC session. | |
531 | # | |
532 | # @enabled: true if the VNC server is enabled, false otherwise | |
533 | # | |
534 | # @host: The hostname the VNC server is bound to. This depends on | |
535 | # the name resolution on the host and may be an IP address. | |
536 | # | |
e050e426 PM |
537 | # @family: - 'ipv6' if the host is listening for IPv6 connections |
538 | # - 'ipv4' if the host is listening for IPv4 connections | |
539 | # - 'unix' if the host is listening on a unix domain socket | |
540 | # - 'unknown' otherwise | |
608cfed6 MA |
541 | # |
542 | # @service: The service name of the server's port. This may depends | |
543 | # on the host system's service database so symbolic names should not | |
544 | # be relied on. | |
545 | # | |
546 | # @auth: the current authentication type used by the server | |
e050e426 PM |
547 | # |
548 | # - 'none' if no authentication is being used | |
549 | # - 'vnc' if VNC authentication is being used | |
550 | # - 'vencrypt+plain' if VEncrypt is used with plain text authentication | |
551 | # - 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication | |
552 | # - 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication | |
553 | # - 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth | |
554 | # - 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth | |
555 | # - 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth | |
556 | # - 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth | |
557 | # - 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth | |
558 | # - 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth | |
608cfed6 MA |
559 | # |
560 | # @clients: a list of @VncClientInfo of all currently connected clients | |
561 | # | |
9bc6e893 | 562 | # Since: 0.14 |
608cfed6 MA |
563 | ## |
564 | { 'struct': 'VncInfo', | |
565 | 'data': {'enabled': 'bool', '*host': 'str', | |
566 | '*family': 'NetworkAddressFamily', | |
05eb4a25 | 567 | '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']}, |
8a9f1e1d | 568 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
569 | |
570 | ## | |
571 | # @VncPrimaryAuth: | |
572 | # | |
573 | # vnc primary authentication method. | |
574 | # | |
575 | # Since: 2.3 | |
576 | ## | |
577 | { 'enum': 'VncPrimaryAuth', | |
578 | 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra', | |
05eb4a25 | 579 | 'tls', 'vencrypt', 'sasl' ], |
8a9f1e1d | 580 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
581 | |
582 | ## | |
583 | # @VncVencryptSubAuth: | |
584 | # | |
585 | # vnc sub authentication method with vencrypt. | |
586 | # | |
587 | # Since: 2.3 | |
588 | ## | |
589 | { 'enum': 'VncVencryptSubAuth', | |
590 | 'data': [ 'plain', | |
591 | 'tls-none', 'x509-none', | |
592 | 'tls-vnc', 'x509-vnc', | |
593 | 'tls-plain', 'x509-plain', | |
05eb4a25 | 594 | 'tls-sasl', 'x509-sasl' ], |
8a9f1e1d | 595 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
596 | |
597 | ## | |
598 | # @VncServerInfo2: | |
599 | # | |
600 | # The network connection information for server | |
601 | # | |
602 | # @auth: The current authentication type used by the servers | |
603 | # | |
604 | # @vencrypt: The vencrypt sub authentication type used by the | |
605 | # servers, only specified in case auth == vencrypt. | |
606 | # | |
607 | # Since: 2.9 | |
608 | ## | |
609 | { 'struct': 'VncServerInfo2', | |
610 | 'base': 'VncBasicInfo', | |
611 | 'data': { 'auth' : 'VncPrimaryAuth', | |
05eb4a25 | 612 | '*vencrypt' : 'VncVencryptSubAuth' }, |
8a9f1e1d | 613 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
614 | |
615 | ## | |
616 | # @VncInfo2: | |
617 | # | |
618 | # Information about a vnc server | |
619 | # | |
620 | # @id: vnc server name. | |
621 | # | |
622 | # @server: A list of @VncBasincInfo describing all listening sockets. | |
623 | # The list can be empty (in case the vnc server is disabled). | |
624 | # It also may have multiple entries: normal + websocket, | |
625 | # possibly also ipv4 + ipv6 in the future. | |
626 | # | |
627 | # @clients: A list of @VncClientInfo of all currently connected clients. | |
628 | # The list can be empty, for obvious reasons. | |
629 | # | |
630 | # @auth: The current authentication type used by the non-websockets servers | |
631 | # | |
632 | # @vencrypt: The vencrypt authentication type used by the servers, | |
633 | # only specified in case auth == vencrypt. | |
634 | # | |
635 | # @display: The display device the vnc server is linked to. | |
636 | # | |
637 | # Since: 2.3 | |
638 | ## | |
639 | { 'struct': 'VncInfo2', | |
640 | 'data': { 'id' : 'str', | |
641 | 'server' : ['VncServerInfo2'], | |
642 | 'clients' : ['VncClientInfo'], | |
643 | 'auth' : 'VncPrimaryAuth', | |
644 | '*vencrypt' : 'VncVencryptSubAuth', | |
05eb4a25 | 645 | '*display' : 'str' }, |
8a9f1e1d | 646 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
647 | |
648 | ## | |
649 | # @query-vnc: | |
650 | # | |
651 | # Returns information about the current VNC server | |
652 | # | |
653 | # Returns: @VncInfo | |
654 | # | |
9bc6e893 | 655 | # Since: 0.14 |
608cfed6 MA |
656 | # |
657 | # Example: | |
658 | # | |
659 | # -> { "execute": "query-vnc" } | |
660 | # <- { "return": { | |
661 | # "enabled":true, | |
662 | # "host":"0.0.0.0", | |
663 | # "service":"50402", | |
664 | # "auth":"vnc", | |
665 | # "family":"ipv4", | |
666 | # "clients":[ | |
667 | # { | |
668 | # "host":"127.0.0.1", | |
669 | # "service":"50401", | |
670 | # "family":"ipv4" | |
c7f4a0fc | 671 | # "websocket":false, |
608cfed6 MA |
672 | # } |
673 | # ] | |
674 | # } | |
675 | # } | |
676 | # | |
677 | ## | |
05eb4a25 | 678 | { 'command': 'query-vnc', 'returns': 'VncInfo', |
8a9f1e1d | 679 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
680 | ## |
681 | # @query-vnc-servers: | |
682 | # | |
683 | # Returns a list of vnc servers. The list can be empty. | |
684 | # | |
685 | # Returns: a list of @VncInfo2 | |
686 | # | |
687 | # Since: 2.3 | |
688 | ## | |
05eb4a25 | 689 | { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'], |
8a9f1e1d | 690 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
691 | |
692 | ## | |
693 | # @change-vnc-password: | |
694 | # | |
695 | # Change the VNC server password. | |
696 | # | |
26ec4e53 | 697 | # @password: the new password to use with VNC authentication |
608cfed6 MA |
698 | # |
699 | # Since: 1.1 | |
700 | # | |
26ec4e53 PM |
701 | # Notes: An empty password in this command will set the password to the empty |
702 | # string. Existing clients are unaffected by executing this command. | |
608cfed6 | 703 | ## |
b0ddeba2 MAL |
704 | { 'command': 'change-vnc-password', |
705 | 'data': { 'password': 'str' }, | |
8a9f1e1d | 706 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
707 | |
708 | ## | |
709 | # @VNC_CONNECTED: | |
710 | # | |
711 | # Emitted when a VNC client establishes a connection | |
712 | # | |
713 | # @server: server information | |
714 | # | |
715 | # @client: client information | |
716 | # | |
717 | # Note: This event is emitted before any authentication takes place, thus | |
26ec4e53 | 718 | # the authentication ID is not provided |
608cfed6 | 719 | # |
9bc6e893 | 720 | # Since: 0.13 |
608cfed6 MA |
721 | # |
722 | # Example: | |
723 | # | |
724 | # <- { "event": "VNC_CONNECTED", | |
725 | # "data": { | |
aecba617 | 726 | # "server": { "auth": "sasl", "family": "ipv4", "websocket": false, |
608cfed6 MA |
727 | # "service": "5901", "host": "0.0.0.0" }, |
728 | # "client": { "family": "ipv4", "service": "58425", | |
aecba617 | 729 | # "host": "127.0.0.1", "websocket": false } }, |
608cfed6 MA |
730 | # "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } |
731 | # | |
732 | ## | |
733 | { 'event': 'VNC_CONNECTED', | |
734 | 'data': { 'server': 'VncServerInfo', | |
05eb4a25 | 735 | 'client': 'VncBasicInfo' }, |
8a9f1e1d | 736 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
737 | |
738 | ## | |
739 | # @VNC_INITIALIZED: | |
740 | # | |
741 | # Emitted after authentication takes place (if any) and the VNC session is | |
742 | # made active | |
743 | # | |
744 | # @server: server information | |
745 | # | |
746 | # @client: client information | |
747 | # | |
9bc6e893 | 748 | # Since: 0.13 |
608cfed6 MA |
749 | # |
750 | # Example: | |
751 | # | |
752 | # <- { "event": "VNC_INITIALIZED", | |
753 | # "data": { | |
aecba617 | 754 | # "server": { "auth": "sasl", "family": "ipv4", "websocket": false, |
608cfed6 | 755 | # "service": "5901", "host": "0.0.0.0"}, |
aecba617 | 756 | # "client": { "family": "ipv4", "service": "46089", "websocket": false, |
608cfed6 MA |
757 | # "host": "127.0.0.1", "sasl_username": "luiz" } }, |
758 | # "timestamp": { "seconds": 1263475302, "microseconds": 150772 } } | |
759 | # | |
760 | ## | |
761 | { 'event': 'VNC_INITIALIZED', | |
762 | 'data': { 'server': 'VncServerInfo', | |
05eb4a25 | 763 | 'client': 'VncClientInfo' }, |
8a9f1e1d | 764 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
765 | |
766 | ## | |
767 | # @VNC_DISCONNECTED: | |
768 | # | |
769 | # Emitted when the connection is closed | |
770 | # | |
771 | # @server: server information | |
772 | # | |
773 | # @client: client information | |
774 | # | |
9bc6e893 | 775 | # Since: 0.13 |
608cfed6 MA |
776 | # |
777 | # Example: | |
778 | # | |
779 | # <- { "event": "VNC_DISCONNECTED", | |
780 | # "data": { | |
aecba617 | 781 | # "server": { "auth": "sasl", "family": "ipv4", "websocket": false, |
608cfed6 | 782 | # "service": "5901", "host": "0.0.0.0" }, |
aecba617 | 783 | # "client": { "family": "ipv4", "service": "58425", "websocket": false, |
608cfed6 MA |
784 | # "host": "127.0.0.1", "sasl_username": "luiz" } }, |
785 | # "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } | |
786 | # | |
787 | ## | |
788 | { 'event': 'VNC_DISCONNECTED', | |
789 | 'data': { 'server': 'VncServerInfo', | |
05eb4a25 | 790 | 'client': 'VncClientInfo' }, |
8a9f1e1d | 791 | 'if': 'CONFIG_VNC' } |
608cfed6 MA |
792 | |
793 | ## | |
794 | # = Input | |
795 | ## | |
796 | ||
797 | ## | |
798 | # @MouseInfo: | |
799 | # | |
800 | # Information about a mouse device. | |
801 | # | |
802 | # @name: the name of the mouse device | |
803 | # | |
804 | # @index: the index of the mouse device | |
805 | # | |
806 | # @current: true if this device is currently receiving mouse events | |
807 | # | |
808 | # @absolute: true if this device supports absolute coordinates as input | |
809 | # | |
9bc6e893 | 810 | # Since: 0.14 |
608cfed6 MA |
811 | ## |
812 | { 'struct': 'MouseInfo', | |
813 | 'data': {'name': 'str', 'index': 'int', 'current': 'bool', | |
814 | 'absolute': 'bool'} } | |
815 | ||
816 | ## | |
817 | # @query-mice: | |
818 | # | |
819 | # Returns information about each active mouse device | |
820 | # | |
821 | # Returns: a list of @MouseInfo for each device | |
822 | # | |
9bc6e893 | 823 | # Since: 0.14 |
608cfed6 MA |
824 | # |
825 | # Example: | |
826 | # | |
827 | # -> { "execute": "query-mice" } | |
828 | # <- { "return": [ | |
829 | # { | |
830 | # "name":"QEMU Microsoft Mouse", | |
831 | # "index":0, | |
832 | # "current":false, | |
833 | # "absolute":false | |
834 | # }, | |
835 | # { | |
836 | # "name":"QEMU PS/2 Mouse", | |
837 | # "index":1, | |
838 | # "current":true, | |
839 | # "absolute":true | |
840 | # } | |
841 | # ] | |
842 | # } | |
843 | # | |
844 | ## | |
845 | { 'command': 'query-mice', 'returns': ['MouseInfo'] } | |
846 | ||
847 | ## | |
848 | # @QKeyCode: | |
849 | # | |
850 | # An enumeration of key name. | |
851 | # | |
852 | # This is used by the @send-key command. | |
853 | # | |
854 | # @unmapped: since 2.0 | |
855 | # @pause: since 2.0 | |
856 | # @ro: since 2.4 | |
857 | # @kp_comma: since 2.4 | |
858 | # @kp_equals: since 2.6 | |
859 | # @power: since 2.6 | |
860 | # @hiragana: since 2.9 | |
861 | # @henkan: since 2.9 | |
862 | # @yen: since 2.9 | |
863 | # | |
864 | # @sleep: since 2.10 | |
865 | # @wake: since 2.10 | |
866 | # @audionext: since 2.10 | |
867 | # @audioprev: since 2.10 | |
868 | # @audiostop: since 2.10 | |
869 | # @audioplay: since 2.10 | |
870 | # @audiomute: since 2.10 | |
871 | # @volumeup: since 2.10 | |
872 | # @volumedown: since 2.10 | |
873 | # @mediaselect: since 2.10 | |
874 | # @mail: since 2.10 | |
875 | # @calculator: since 2.10 | |
876 | # @computer: since 2.10 | |
877 | # @ac_home: since 2.10 | |
878 | # @ac_back: since 2.10 | |
879 | # @ac_forward: since 2.10 | |
880 | # @ac_refresh: since 2.10 | |
881 | # @ac_bookmarks: since 2.10 | |
608cfed6 | 882 | # |
280b8da3 M |
883 | # @muhenkan: since 2.12 |
884 | # @katakanahiragana: since 2.12 | |
885 | # | |
d7696ff8 AO |
886 | # @lang1: since 6.1 |
887 | # @lang2: since 6.1 | |
888 | # | |
80b857f0 DB |
889 | # 'sysrq' was mistakenly added to hack around the fact that |
890 | # the ps2 driver was not generating correct scancodes sequences | |
891 | # when 'alt+print' was pressed. This flaw is now fixed and the | |
892 | # 'sysrq' key serves no further purpose. Any further use of | |
893 | # 'sysrq' will be transparently changed to 'print', so they | |
894 | # are effectively synonyms. | |
895 | # | |
9bc6e893 | 896 | # Since: 1.3 |
608cfed6 MA |
897 | ## |
898 | { 'enum': 'QKeyCode', | |
899 | 'data': [ 'unmapped', | |
900 | 'shift', 'shift_r', 'alt', 'alt_r', 'ctrl', | |
901 | 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8', | |
902 | '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e', | |
903 | 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right', | |
904 | 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon', | |
905 | 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b', | |
906 | 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock', | |
907 | 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10', | |
908 | 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply', | |
909 | 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0', | |
910 | 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8', | |
911 | 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end', | |
912 | 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again', | |
913 | 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut', | |
914 | 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', | |
280b8da3 | 915 | 'ro', 'hiragana', 'henkan', 'yen', 'muhenkan', 'katakanahiragana', |
608cfed6 MA |
916 | 'kp_comma', 'kp_equals', 'power', 'sleep', 'wake', |
917 | 'audionext', 'audioprev', 'audiostop', 'audioplay', 'audiomute', | |
918 | 'volumeup', 'volumedown', 'mediaselect', | |
919 | 'mail', 'calculator', 'computer', | |
d7696ff8 AO |
920 | 'ac_home', 'ac_back', 'ac_forward', 'ac_refresh', 'ac_bookmarks', |
921 | 'lang1', 'lang2' ] } | |
608cfed6 | 922 | |
3cda299d MA |
923 | ## |
924 | # @KeyValueKind: | |
925 | # | |
926 | # Since: 1.3 | |
927 | ## | |
928 | { 'enum': 'KeyValueKind', | |
929 | 'data': [ 'number', 'qcode' ] } | |
930 | ||
931 | ## | |
932 | # @IntWrapper: | |
933 | # | |
934 | # Since: 1.3 | |
935 | ## | |
936 | { 'struct': 'IntWrapper', | |
937 | 'data': { 'data': 'int' } } | |
938 | ||
939 | ## | |
940 | # @QKeyCodeWrapper: | |
941 | # | |
942 | # Since: 1.3 | |
943 | ## | |
944 | { 'struct': 'QKeyCodeWrapper', | |
945 | 'data': { 'data': 'QKeyCode' } } | |
946 | ||
608cfed6 MA |
947 | ## |
948 | # @KeyValue: | |
949 | # | |
950 | # Represents a keyboard key. | |
951 | # | |
9bc6e893 | 952 | # Since: 1.3 |
608cfed6 MA |
953 | ## |
954 | { 'union': 'KeyValue', | |
3cda299d MA |
955 | 'base': { 'type': 'KeyValueKind' }, |
956 | 'discriminator': 'type', | |
608cfed6 | 957 | 'data': { |
3cda299d MA |
958 | 'number': 'IntWrapper', |
959 | 'qcode': 'QKeyCodeWrapper' } } | |
608cfed6 MA |
960 | |
961 | ## | |
962 | # @send-key: | |
963 | # | |
964 | # Send keys to guest. | |
965 | # | |
966 | # @keys: An array of @KeyValue elements. All @KeyValues in this array are | |
967 | # simultaneously sent to the guest. A @KeyValue.number value is sent | |
968 | # directly to the guest, while @KeyValue.qcode must be a valid | |
969 | # @QKeyCode value | |
970 | # | |
971 | # @hold-time: time to delay key up events, milliseconds. Defaults | |
972 | # to 100 | |
973 | # | |
e050e426 PM |
974 | # Returns: - Nothing on success |
975 | # - If key is unknown or redundant, InvalidParameter | |
608cfed6 | 976 | # |
9bc6e893 | 977 | # Since: 1.3 |
608cfed6 MA |
978 | # |
979 | # Example: | |
980 | # | |
981 | # -> { "execute": "send-key", | |
982 | # "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" }, | |
983 | # { "type": "qcode", "data": "alt" }, | |
984 | # { "type": "qcode", "data": "delete" } ] } } | |
985 | # <- { "return": {} } | |
986 | # | |
987 | ## | |
988 | { 'command': 'send-key', | |
989 | 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } } | |
990 | ||
991 | ## | |
992 | # @InputButton: | |
993 | # | |
994 | # Button of a pointer input device (mouse, tablet). | |
995 | # | |
996 | # @side: front side button of a 5-button mouse (since 2.9) | |
997 | # | |
998 | # @extra: rear side button of a 5-button mouse (since 2.9) | |
999 | # | |
1000 | # Since: 2.0 | |
1001 | ## | |
1002 | { 'enum' : 'InputButton', | |
1003 | 'data' : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down', 'side', | |
64ebbb7d | 1004 | 'extra', 'wheel-left', 'wheel-right' ] } |
608cfed6 MA |
1005 | |
1006 | ## | |
1007 | # @InputAxis: | |
1008 | # | |
1009 | # Position axis of a pointer input device (mouse, tablet). | |
1010 | # | |
1011 | # Since: 2.0 | |
1012 | ## | |
1013 | { 'enum' : 'InputAxis', | |
1014 | 'data' : [ 'x', 'y' ] } | |
1015 | ||
1016 | ## | |
1017 | # @InputKeyEvent: | |
1018 | # | |
1019 | # Keyboard input event. | |
1020 | # | |
c0ac533b AB |
1021 | # @key: Which key this event is for. |
1022 | # @down: True for key-down and false for key-up events. | |
608cfed6 MA |
1023 | # |
1024 | # Since: 2.0 | |
1025 | ## | |
1026 | { 'struct' : 'InputKeyEvent', | |
1027 | 'data' : { 'key' : 'KeyValue', | |
1028 | 'down' : 'bool' } } | |
1029 | ||
1030 | ## | |
1031 | # @InputBtnEvent: | |
1032 | # | |
1033 | # Pointer button input event. | |
1034 | # | |
1035 | # @button: Which button this event is for. | |
c0ac533b | 1036 | # @down: True for key-down and false for key-up events. |
608cfed6 MA |
1037 | # |
1038 | # Since: 2.0 | |
1039 | ## | |
1040 | { 'struct' : 'InputBtnEvent', | |
1041 | 'data' : { 'button' : 'InputButton', | |
1042 | 'down' : 'bool' } } | |
1043 | ||
1044 | ## | |
1045 | # @InputMoveEvent: | |
1046 | # | |
1047 | # Pointer motion input event. | |
1048 | # | |
26ec4e53 PM |
1049 | # @axis: Which axis is referenced by @value. |
1050 | # @value: Pointer position. For absolute coordinates the | |
1051 | # valid range is 0 -> 0x7ffff | |
608cfed6 MA |
1052 | # |
1053 | # Since: 2.0 | |
1054 | ## | |
1055 | { 'struct' : 'InputMoveEvent', | |
1056 | 'data' : { 'axis' : 'InputAxis', | |
1057 | 'value' : 'int' } } | |
1058 | ||
b6fd5434 MA |
1059 | ## |
1060 | # @InputEventKind: | |
1061 | # | |
1062 | # Since: 2.0 | |
1063 | ## | |
1064 | { 'enum': 'InputEventKind', | |
1065 | 'data': [ 'key', 'btn', 'rel', 'abs' ] } | |
1066 | ||
1067 | ## | |
1068 | # @InputKeyEventWrapper: | |
1069 | # | |
1070 | # Since: 2.0 | |
1071 | ## | |
1072 | { 'struct': 'InputKeyEventWrapper', | |
1073 | 'data': { 'data': 'InputKeyEvent' } } | |
1074 | ||
1075 | ## | |
1076 | # @InputBtnEventWrapper: | |
1077 | # | |
1078 | # Since: 2.0 | |
1079 | ## | |
1080 | { 'struct': 'InputBtnEventWrapper', | |
1081 | 'data': { 'data': 'InputBtnEvent' } } | |
1082 | ||
1083 | ## | |
1084 | # @InputMoveEventWrapper: | |
1085 | # | |
1086 | # Since: 2.0 | |
1087 | ## | |
1088 | { 'struct': 'InputMoveEventWrapper', | |
1089 | 'data': { 'data': 'InputMoveEvent' } } | |
1090 | ||
608cfed6 MA |
1091 | ## |
1092 | # @InputEvent: | |
1093 | # | |
1094 | # Input event union. | |
1095 | # | |
1096 | # @type: the input type, one of: | |
100cc4fe | 1097 | # |
26ec4e53 PM |
1098 | # - 'key': Input event of Keyboard |
1099 | # - 'btn': Input event of pointer buttons | |
1100 | # - 'rel': Input event of relative pointer motion | |
1101 | # - 'abs': Input event of absolute pointer motion | |
608cfed6 MA |
1102 | # |
1103 | # Since: 2.0 | |
1104 | ## | |
1105 | { 'union' : 'InputEvent', | |
b6fd5434 MA |
1106 | 'base': { 'type': 'InputEventKind' }, |
1107 | 'discriminator': 'type', | |
1108 | 'data' : { 'key' : 'InputKeyEventWrapper', | |
1109 | 'btn' : 'InputBtnEventWrapper', | |
1110 | 'rel' : 'InputMoveEventWrapper', | |
1111 | 'abs' : 'InputMoveEventWrapper' } } | |
608cfed6 MA |
1112 | |
1113 | ## | |
1114 | # @input-send-event: | |
1115 | # | |
1116 | # Send input event(s) to guest. | |
1117 | # | |
608cfed6 MA |
1118 | # The @device and @head parameters can be used to send the input event |
1119 | # to specific input devices in case (a) multiple input devices of the | |
1120 | # same kind are added to the virtual machine and (b) you have | |
1121 | # configured input routing (see docs/multiseat.txt) for those input | |
1122 | # devices. The parameters work exactly like the device and head | |
1123 | # properties of input devices. If @device is missing, only devices | |
1124 | # that have no input routing config are admissible. If @device is | |
1125 | # specified, both input devices with and without input routing config | |
1126 | # are admissible, but devices with input routing config take | |
1127 | # precedence. | |
1128 | # | |
43d7c2d0 PM |
1129 | # @device: display device to send event(s) to. |
1130 | # @head: head to send event(s) to, in case the | |
1131 | # display device supports multiple scanouts. | |
1132 | # @events: List of InputEvent union. | |
1133 | # | |
1134 | # Returns: Nothing on success. | |
1135 | # | |
608cfed6 MA |
1136 | # Since: 2.6 |
1137 | # | |
1138 | # Note: The consoles are visible in the qom tree, under | |
26ec4e53 PM |
1139 | # /backend/console[$index]. They have a device link and head property, |
1140 | # so it is possible to map which console belongs to which device and | |
1141 | # display. | |
608cfed6 MA |
1142 | # |
1143 | # Example: | |
1144 | # | |
1145 | # 1. Press left mouse button. | |
1146 | # | |
1147 | # -> { "execute": "input-send-event", | |
1148 | # "arguments": { "device": "video0", | |
1149 | # "events": [ { "type": "btn", | |
1150 | # "data" : { "down": true, "button": "left" } } ] } } | |
1151 | # <- { "return": {} } | |
1152 | # | |
1153 | # -> { "execute": "input-send-event", | |
1154 | # "arguments": { "device": "video0", | |
1155 | # "events": [ { "type": "btn", | |
1156 | # "data" : { "down": false, "button": "left" } } ] } } | |
1157 | # <- { "return": {} } | |
1158 | # | |
1159 | # 2. Press ctrl-alt-del. | |
1160 | # | |
1161 | # -> { "execute": "input-send-event", | |
1162 | # "arguments": { "events": [ | |
1163 | # { "type": "key", "data" : { "down": true, | |
1164 | # "key": {"type": "qcode", "data": "ctrl" } } }, | |
1165 | # { "type": "key", "data" : { "down": true, | |
1166 | # "key": {"type": "qcode", "data": "alt" } } }, | |
1167 | # { "type": "key", "data" : { "down": true, | |
1168 | # "key": {"type": "qcode", "data": "delete" } } } ] } } | |
1169 | # <- { "return": {} } | |
1170 | # | |
1171 | # 3. Move mouse pointer to absolute coordinates (20000, 400). | |
1172 | # | |
1173 | # -> { "execute": "input-send-event" , | |
1174 | # "arguments": { "events": [ | |
1175 | # { "type": "abs", "data" : { "axis": "x", "value" : 20000 } }, | |
1176 | # { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } } | |
1177 | # <- { "return": {} } | |
1178 | # | |
1179 | ## | |
1180 | { 'command': 'input-send-event', | |
1181 | 'data': { '*device': 'str', | |
1182 | '*head' : 'int', | |
1183 | 'events' : [ 'InputEvent' ] } } | |
0c8d7065 | 1184 | |
0c8d7065 GH |
1185 | ## |
1186 | # @DisplayGTK: | |
1187 | # | |
1188 | # GTK display options. | |
1189 | # | |
1190 | # @grab-on-hover: Grab keyboard input on mouse hover. | |
e8b1386e GH |
1191 | # @zoom-to-fit: Zoom guest display to fit into the host window. When |
1192 | # turned off the host window will be resized instead. | |
1193 | # In case the display device can notify the guest on | |
1194 | # window resizes (virtio-gpu) this will default to "on", | |
1195 | # assuming the guest will resize the display to match | |
1196 | # the window size then. Otherwise it defaults to "off". | |
1197 | # Since 3.1 | |
0c8d7065 GH |
1198 | # |
1199 | # Since: 2.12 | |
0c8d7065 GH |
1200 | ## |
1201 | { 'struct' : 'DisplayGTK', | |
e8b1386e GH |
1202 | 'data' : { '*grab-on-hover' : 'bool', |
1203 | '*zoom-to-fit' : 'bool' } } | |
0c8d7065 | 1204 | |
d4dc4ab1 ES |
1205 | ## |
1206 | # @DisplayEGLHeadless: | |
1207 | # | |
1208 | # EGL headless display options. | |
1209 | # | |
1210 | # @rendernode: Which DRM render node should be used. Default is the first | |
1211 | # available node on the host. | |
1212 | # | |
1213 | # Since: 3.1 | |
d4dc4ab1 ES |
1214 | ## |
1215 | { 'struct' : 'DisplayEGLHeadless', | |
1216 | 'data' : { '*rendernode' : 'str' } } | |
1217 | ||
142ca628 MAL |
1218 | ## |
1219 | # @DisplayDBus: | |
1220 | # | |
1221 | # DBus display options. | |
1222 | # | |
1223 | # @addr: The D-Bus bus address (default to the session bus). | |
1224 | # | |
1225 | # @rendernode: Which DRM render node should be used. Default is the first | |
1226 | # available node on the host. | |
1227 | # | |
99997823 MAL |
1228 | # @p2p: Whether to use peer-to-peer connections (accepted through |
1229 | # ``add_client``). | |
1230 | # | |
739362d4 MAL |
1231 | # @audiodev: Use the specified DBus audiodev to export audio. |
1232 | # | |
142ca628 | 1233 | # Since: 7.0 |
142ca628 MAL |
1234 | ## |
1235 | { 'struct' : 'DisplayDBus', | |
1236 | 'data' : { '*rendernode' : 'str', | |
99997823 | 1237 | '*addr': 'str', |
739362d4 MAL |
1238 | '*p2p': 'bool', |
1239 | '*audiodev': 'str' } } | |
142ca628 | 1240 | |
406dfba6 AB |
1241 | ## |
1242 | # @DisplayGLMode: | |
1243 | # | |
1244 | # Display OpenGL mode. | |
1245 | # | |
1246 | # @off: Disable OpenGL (default). | |
1247 | # @on: Use OpenGL, pick context type automatically. | |
1248 | # Would better be named 'auto' but is called 'on' for backward | |
1249 | # compatibility with bool type. | |
1250 | # @core: Use OpenGL with Core (desktop) Context. | |
1251 | # @es: Use OpenGL with ES (embedded systems) Context. | |
1252 | # | |
1253 | # Since: 3.0 | |
406dfba6 | 1254 | ## |
fbeed197 MA |
1255 | { 'enum' : 'DisplayGLMode', |
1256 | 'data' : [ 'off', 'on', 'core', 'es' ] } | |
62f27922 | 1257 | |
2f8b7cd5 ST |
1258 | ## |
1259 | # @DisplayCurses: | |
1260 | # | |
1261 | # Curses display options. | |
1262 | # | |
23e46452 | 1263 | # @charset: Font charset used by guest (default: CP437). |
2f8b7cd5 ST |
1264 | # |
1265 | # Since: 4.0 | |
2f8b7cd5 ST |
1266 | ## |
1267 | { 'struct' : 'DisplayCurses', | |
1268 | 'data' : { '*charset' : 'str' } } | |
1269 | ||
48941a52 CE |
1270 | ## |
1271 | # @DisplayCocoa: | |
1272 | # | |
1273 | # Cocoa display options. | |
1274 | # | |
1275 | # @left-command-key: Enable/disable forwarding of left command key to | |
1276 | # guest. Allows command-tab window switching on the | |
1277 | # host without sending this key to the guest when | |
1278 | # "off". Defaults to "on" | |
1279 | # | |
f844cdb9 GNS |
1280 | # @full-grab: Capture all key presses, including system combos. This |
1281 | # requires accessibility permissions, since it performs | |
1282 | # a global grab on key events. (default: off) | |
1283 | # See https://support.apple.com/en-in/guide/mac-help/mh32356/mac | |
1284 | # | |
4797adce GNS |
1285 | # @swap-opt-cmd: Swap the Option and Command keys so that their key codes match |
1286 | # their position on non-Mac keyboards and you can use Meta/Super | |
1287 | # and Alt where you expect them. (default: off) | |
1288 | # | |
48941a52 CE |
1289 | # Since: 7.0 |
1290 | ## | |
1291 | { 'struct': 'DisplayCocoa', | |
1292 | 'data': { | |
f844cdb9 | 1293 | '*left-command-key': 'bool', |
4797adce GNS |
1294 | '*full-grab': 'bool', |
1295 | '*swap-opt-cmd': 'bool' | |
48941a52 CE |
1296 | } } |
1297 | ||
0c8d7065 GH |
1298 | ## |
1299 | # @DisplayType: | |
1300 | # | |
1301 | # Display (user interface) type. | |
1302 | # | |
42176d77 MAL |
1303 | # @default: The default user interface, selecting from the first available |
1304 | # of gtk, sdl, cocoa, and vnc. | |
1305 | # | |
1306 | # @none: No user interface or video output display. The guest will | |
1307 | # still see an emulated graphics card, but its output will not | |
1308 | # be displayed to the QEMU user. | |
1309 | # | |
1310 | # @gtk: The GTK user interface. | |
1311 | # | |
1312 | # @sdl: The SDL user interface. | |
1313 | # | |
1314 | # @egl-headless: No user interface, offload GL operations to a local | |
1315 | # DRI device. Graphical display need to be paired with | |
1316 | # VNC or Spice. (Since 3.1) | |
1317 | # | |
1318 | # @curses: Display video output via curses. For graphics device | |
1319 | # models which support a text mode, QEMU can display this | |
1320 | # output using a curses/ncurses interface. Nothing is | |
1321 | # displayed when the graphics device is in graphical mode or | |
1322 | # if the graphics device does not support a text | |
1323 | # mode. Generally only the VGA device models support text | |
1324 | # mode. | |
1325 | # | |
1326 | # @cocoa: The Cocoa user interface. | |
1327 | # | |
d8aec9d9 MAL |
1328 | # @spice-app: Set up a Spice server and run the default associated |
1329 | # application to connect to it. The server will redirect | |
1330 | # the serial console and QEMU monitors. (Since 4.0) | |
1331 | # | |
142ca628 MAL |
1332 | # @dbus: Start a D-Bus service for the display. (Since 7.0) |
1333 | # | |
0c8d7065 | 1334 | # Since: 2.12 |
0c8d7065 GH |
1335 | ## |
1336 | { 'enum' : 'DisplayType', | |
66c2207f TH |
1337 | 'data' : [ |
1338 | { 'name': 'default' }, | |
1339 | { 'name': 'none' }, | |
8a9f1e1d MAL |
1340 | { 'name': 'gtk', 'if': 'CONFIG_GTK' }, |
1341 | { 'name': 'sdl', 'if': 'CONFIG_SDL' }, | |
66c2207f | 1342 | { 'name': 'egl-headless', |
8a9f1e1d MAL |
1343 | 'if': { 'all': ['CONFIG_OPENGL', 'CONFIG_GBM'] } }, |
1344 | { 'name': 'curses', 'if': 'CONFIG_CURSES' }, | |
1345 | { 'name': 'cocoa', 'if': 'CONFIG_COCOA' }, | |
142ca628 MAL |
1346 | { 'name': 'spice-app', 'if': 'CONFIG_SPICE' }, |
1347 | { 'name': 'dbus', 'if': 'CONFIG_DBUS_DISPLAY' } | |
1348 | ] | |
1349 | } | |
0c8d7065 GH |
1350 | |
1351 | ## | |
1352 | # @DisplayOptions: | |
1353 | # | |
1354 | # Display (user interface) options. | |
1355 | # | |
c0ac533b AB |
1356 | # @type: Which DisplayType qemu should use. |
1357 | # @full-screen: Start user interface in fullscreen mode (default: off). | |
1358 | # @window-close: Allow to quit qemu with window close button (default: on). | |
1359 | # @show-cursor: Force showing the mouse cursor (default: off). (since: 5.0) | |
1360 | # @gl: Enable OpenGL support (default: off). | |
0c8d7065 GH |
1361 | # |
1362 | # Since: 2.12 | |
0c8d7065 GH |
1363 | ## |
1364 | { 'union' : 'DisplayOptions', | |
1365 | 'base' : { 'type' : 'DisplayType', | |
1366 | '*full-screen' : 'bool', | |
1367 | '*window-close' : 'bool', | |
7027bdd7 | 1368 | '*show-cursor' : 'bool', |
62f27922 | 1369 | '*gl' : 'DisplayGLMode' }, |
0c8d7065 | 1370 | 'discriminator' : 'type', |
66c2207f | 1371 | 'data' : { |
8a9f1e1d | 1372 | 'gtk': { 'type': 'DisplayGTK', 'if': 'CONFIG_GTK' }, |
48941a52 | 1373 | 'cocoa': { 'type': 'DisplayCocoa', 'if': 'CONFIG_COCOA' }, |
8a9f1e1d | 1374 | 'curses': { 'type': 'DisplayCurses', 'if': 'CONFIG_CURSES' }, |
66c2207f | 1375 | 'egl-headless': { 'type': 'DisplayEGLHeadless', |
142ca628 MAL |
1376 | 'if': { 'all': ['CONFIG_OPENGL', 'CONFIG_GBM'] } }, |
1377 | 'dbus': { 'type': 'DisplayDBus', 'if': 'CONFIG_DBUS_DISPLAY' } | |
66c2207f TH |
1378 | } |
1379 | } | |
e1ca8f7e GH |
1380 | |
1381 | ## | |
1382 | # @query-display-options: | |
1383 | # | |
1384 | # Returns information about display configuration | |
1385 | # | |
1386 | # Returns: @DisplayOptions | |
1387 | # | |
1388 | # Since: 3.1 | |
e1ca8f7e GH |
1389 | ## |
1390 | { 'command': 'query-display-options', | |
1391 | 'returns': 'DisplayOptions' } | |
9cc07651 ZC |
1392 | |
1393 | ## | |
1394 | # @DisplayReloadType: | |
1395 | # | |
1396 | # Available DisplayReload types. | |
1397 | # | |
1398 | # @vnc: VNC display | |
1399 | # | |
1400 | # Since: 6.0 | |
9cc07651 ZC |
1401 | ## |
1402 | { 'enum': 'DisplayReloadType', | |
1403 | 'data': ['vnc'] } | |
1404 | ||
1405 | ## | |
1406 | # @DisplayReloadOptionsVNC: | |
1407 | # | |
1408 | # Specify the VNC reload options. | |
1409 | # | |
1410 | # @tls-certs: reload tls certs or not. | |
1411 | # | |
1412 | # Since: 6.0 | |
9cc07651 ZC |
1413 | ## |
1414 | { 'struct': 'DisplayReloadOptionsVNC', | |
1415 | 'data': { '*tls-certs': 'bool' } } | |
1416 | ||
1417 | ## | |
1418 | # @DisplayReloadOptions: | |
1419 | # | |
1420 | # Options of the display configuration reload. | |
1421 | # | |
1422 | # @type: Specify the display type. | |
1423 | # | |
1424 | # Since: 6.0 | |
9cc07651 ZC |
1425 | ## |
1426 | { 'union': 'DisplayReloadOptions', | |
1427 | 'base': {'type': 'DisplayReloadType'}, | |
1428 | 'discriminator': 'type', | |
1429 | 'data': { 'vnc': 'DisplayReloadOptionsVNC' } } | |
1430 | ||
1431 | ## | |
1432 | # @display-reload: | |
1433 | # | |
1434 | # Reload display configuration. | |
1435 | # | |
1436 | # Returns: Nothing on success. | |
1437 | # | |
1438 | # Since: 6.0 | |
1439 | # | |
1440 | # Example: | |
1441 | # | |
1442 | # -> { "execute": "display-reload", | |
1443 | # "arguments": { "type": "vnc", "tls-certs": true } } | |
1444 | # <- { "return": {} } | |
1445 | # | |
1446 | ## | |
1447 | { 'command': 'display-reload', | |
1448 | 'data': 'DisplayReloadOptions', | |
1449 | 'boxed' : true } | |
abea1946 VSO |
1450 | |
1451 | ## | |
1452 | # @DisplayUpdateType: | |
1453 | # | |
1454 | # Available DisplayUpdate types. | |
1455 | # | |
1456 | # @vnc: VNC display | |
1457 | # | |
1458 | # Since: 7.1 | |
abea1946 VSO |
1459 | ## |
1460 | { 'enum': 'DisplayUpdateType', | |
1461 | 'data': ['vnc'] } | |
1462 | ||
1463 | ## | |
1464 | # @DisplayUpdateOptionsVNC: | |
1465 | # | |
1466 | # Specify the VNC reload options. | |
1467 | # | |
1468 | # @addresses: If specified, change set of addresses | |
1469 | # to listen for connections. Addresses configured | |
1470 | # for websockets are not touched. | |
1471 | # | |
1472 | # Since: 7.1 | |
abea1946 VSO |
1473 | ## |
1474 | { 'struct': 'DisplayUpdateOptionsVNC', | |
1475 | 'data': { '*addresses': ['SocketAddress'] } } | |
1476 | ||
1477 | ## | |
1478 | # @DisplayUpdateOptions: | |
1479 | # | |
1480 | # Options of the display configuration reload. | |
1481 | # | |
1482 | # @type: Specify the display type. | |
1483 | # | |
1484 | # Since: 7.1 | |
abea1946 VSO |
1485 | ## |
1486 | { 'union': 'DisplayUpdateOptions', | |
1487 | 'base': {'type': 'DisplayUpdateType'}, | |
1488 | 'discriminator': 'type', | |
1489 | 'data': { 'vnc': 'DisplayUpdateOptionsVNC' } } | |
1490 | ||
1491 | ## | |
1492 | # @display-update: | |
1493 | # | |
1494 | # Update display configuration. | |
1495 | # | |
1496 | # Returns: Nothing on success. | |
1497 | # | |
1498 | # Since: 7.1 | |
1499 | # | |
1500 | # Example: | |
1501 | # | |
1502 | # -> { "execute": "display-update", | |
1503 | # "arguments": { "type": "vnc", "addresses": | |
1504 | # [ { "type": "inet", "host": "0.0.0.0", | |
1505 | # "port": "5901" } ] } } | |
1506 | # <- { "return": {} } | |
1507 | # | |
1508 | ## | |
1509 | { 'command': 'display-update', | |
1510 | 'data': 'DisplayUpdateOptions', | |
1511 | 'boxed' : true } |