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