9 { 'include': 'common.json' }
10 { 'include': 'sockets.json' }
15 # Display protocols which support changing password options.
19 { 'enum': 'DisplayProtocol',
20 'data': [ 'vnc', 'spice' ] }
25 # An action to take on changing a password on a connection with active
28 # @keep: maintain existing clients
30 # @fail: fail the command if clients are connected
32 # @disconnect: disconnect existing clients
36 { 'enum': 'SetPasswordAction',
37 'data': [ 'keep', 'fail', 'disconnect' ] }
40 # @SetPasswordOptions:
42 # Options for set_password.
45 # - 'vnc' to modify the VNC server password
46 # - 'spice' to modify the Spice server password
48 # @password: the new password
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.
56 { 'union': 'SetPasswordOptions',
57 'base': { 'protocol': 'DisplayProtocol',
59 '*connected': 'SetPasswordAction' },
60 'discriminator': 'protocol',
61 'data': { 'vnc': 'SetPasswordOptionsVnc' } }
64 # @SetPasswordOptionsVnc:
66 # Options for set_password specific to the VNC protocol.
68 # @display: The id of the display where the password should be
69 # changed. Defaults to the first.
73 { 'struct': 'SetPasswordOptionsVnc',
74 'data': { '*display': 'str' } }
79 # Set the password of a remote display server.
82 # - If Spice is not enabled, DeviceNotFound
88 # -> { "execute": "set_password", "arguments": { "protocol": "vnc",
89 # "password": "secret" } }
92 { 'command': 'set_password', 'boxed': true, 'data': 'SetPasswordOptions' }
95 # @ExpirePasswordOptions:
97 # General options for expire_password.
100 # - 'vnc' to modify the VNC server expiration
101 # - 'spice' to modify the Spice server expiration
103 # @time: when to expire the password.
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
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.
117 { 'union': 'ExpirePasswordOptions',
118 'base': { 'protocol': 'DisplayProtocol',
120 'discriminator': 'protocol',
121 'data': { 'vnc': 'ExpirePasswordOptionsVnc' } }
124 # @ExpirePasswordOptionsVnc:
126 # Options for expire_password specific to the VNC protocol.
128 # @display: The id of the display where the expiration should be
129 # changed. Defaults to the first.
133 { 'struct': 'ExpirePasswordOptionsVnc',
134 'data': { '*display': 'str' } }
139 # Expire the password of a remote display server.
142 # - If @protocol is 'spice' and Spice is not active,
149 # -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
151 # <- { "return": {} }
153 { 'command': 'expire_password', 'boxed': true, 'data': 'ExpirePasswordOptions' }
158 # Supported image format types.
166 { 'enum': 'ImageFormat',
167 'data': ['ppm', 'png'] }
172 # Capture the contents of a screen and write it to a file.
174 # @filename: the path of a new file to store the image
176 # @device: ID of the display device that should be dumped. If this
177 # parameter is missing, the primary display will be used. (Since
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
185 # @format: image format for screendump. (default: ppm) (Since 7.1)
191 # -> { "execute": "screendump",
192 # "arguments": { "filename": "/tmp/image" } }
193 # <- { "return": {} }
195 { 'command': 'screendump',
196 'data': {'filename': 'str', '*device': 'str', '*head': 'int',
197 '*format': 'ImageFormat'},
199 'if': 'CONFIG_PIXMAN' }
208 # The basic information for SPICE network connection
214 # @family: address family
218 { 'struct': 'SpiceBasicInfo',
219 'data': { 'host': 'str',
221 'family': 'NetworkAddressFamily' },
222 'if': 'CONFIG_SPICE' }
227 # Information about a SPICE server
229 # @auth: authentication method
233 { 'struct': 'SpiceServerInfo',
234 'base': 'SpiceBasicInfo',
235 'data': { '*auth': 'str' },
236 'if': 'CONFIG_SPICE' }
241 # Information about a SPICE client channel.
243 # @connection-id: SPICE connection id number. All channels with the
244 # same id belong to the same SPICE session.
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
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
254 # @tls: true if the channel is encrypted, false otherwise.
258 { 'struct': 'SpiceChannel',
259 'base': 'SpiceBasicInfo',
260 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
262 'if': 'CONFIG_SPICE' }
265 # @SpiceQueryMouseMode:
267 # An enumeration of Spice mouse states.
269 # @client: Mouse cursor position is determined by the client.
271 # @server: Mouse cursor position is determined by the server.
273 # @unknown: No information is available about mouse mode used by the
276 # .. note:: spice/enums.h has a SpiceMouseMode already, hence the name.
280 { 'enum': 'SpiceQueryMouseMode',
281 'data': [ 'client', 'server', 'unknown' ],
282 'if': 'CONFIG_SPICE' }
287 # Information about the SPICE session.
289 # @enabled: true if the SPICE server is enabled, false otherwise
291 # @migrated: true if the last guest migration completed and spice
292 # migration had completed as well, false otherwise (since 1.4)
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.
297 # @port: The SPICE server's port number.
299 # @compiled-version: SPICE server version.
301 # @tls-port: The SPICE server's TLS port number.
303 # @auth: the current authentication type used by the server
305 # - 'none' if no authentication is being used
306 # - 'spice' uses SASL or direct TLS authentication, depending on
307 # command line options
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.
314 # @channels: a list of @SpiceChannel for each active spice channel
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' }
327 # Returns information about the current SPICE server
329 # Returns: @SpiceInfo
335 # -> { "execute": "query-spice" }
343 # "mouse-mode":"client",
349 # "connection-id": 1804289383,
350 # "host": "127.0.0.1",
358 # "connection-id": 1804289383,
359 # "host": "127.0.0.1",
368 { 'command': 'query-spice', 'returns': 'SpiceInfo',
369 'if': 'CONFIG_SPICE' }
374 # Emitted when a SPICE client establishes a connection
376 # @server: server information
378 # @client: client information
384 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
385 # "event": "SPICE_CONNECTED",
387 # "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
388 # "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
391 { 'event': 'SPICE_CONNECTED',
392 'data': { 'server': 'SpiceBasicInfo',
393 'client': 'SpiceBasicInfo' },
394 'if': 'CONFIG_SPICE' }
397 # @SPICE_INITIALIZED:
399 # Emitted after initial handshake and authentication takes place (if
400 # any) and the SPICE channel is up and running
402 # @server: server information
404 # @client: client information
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}
419 { 'event': 'SPICE_INITIALIZED',
420 'data': { 'server': 'SpiceServerInfo',
421 'client': 'SpiceChannel' },
422 'if': 'CONFIG_SPICE' }
425 # @SPICE_DISCONNECTED:
427 # Emitted when the SPICE connection is closed
429 # @server: server information
431 # @client: client information
437 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
438 # "event": "SPICE_DISCONNECTED",
440 # "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
441 # "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
444 { 'event': 'SPICE_DISCONNECTED',
445 'data': { 'server': 'SpiceBasicInfo',
446 'client': 'SpiceBasicInfo' },
447 'if': 'CONFIG_SPICE' }
450 # @SPICE_MIGRATE_COMPLETED:
452 # Emitted when SPICE migration has completed
458 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
459 # "event": "SPICE_MIGRATE_COMPLETED" }
461 { 'event': 'SPICE_MIGRATE_COMPLETED',
462 'if': 'CONFIG_SPICE' }
471 # The basic information for vnc network connection
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
479 # @family: address family
481 # @websocket: true in case the socket is a websocket (since 2.3).
485 { 'struct': 'VncBasicInfo',
486 'data': { 'host': 'str',
488 'family': 'NetworkAddressFamily',
489 'websocket': 'bool' },
495 # The network connection information for server
497 # @auth: authentication method used for the plain (non-websocket) VNC
502 { 'struct': 'VncServerInfo',
503 'base': 'VncBasicInfo',
504 'data': { '*auth': 'str' },
510 # Information about a connected VNC client.
512 # @x509_dname: If x509 authentication is in use, the Distinguished
513 # Name of the client.
515 # @sasl_username: If SASL authentication is in use, the SASL username
516 # used for authentication.
520 { 'struct': 'VncClientInfo',
521 'base': 'VncBasicInfo',
522 'data': { '*x509_dname': 'str', '*sasl_username': 'str' },
528 # Information about the VNC session.
530 # @enabled: true if the VNC server is enabled, false otherwise
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.
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
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
545 # @auth: the current authentication type used by the server
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
551 # - 'vencrypt+tls+none' if VEncrypt is used with TLS and no
553 # - 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC
555 # - 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain
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
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
565 # @clients: a list of @VncClientInfo of all currently connected
570 { 'struct': 'VncInfo',
571 'data': {'enabled': 'bool', '*host': 'str',
572 '*family': 'NetworkAddressFamily',
573 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']},
579 # vnc primary authentication method.
583 { 'enum': 'VncPrimaryAuth',
584 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
585 'tls', 'vencrypt', 'sasl' ],
589 # @VncVencryptSubAuth:
591 # vnc sub authentication method with vencrypt.
595 { 'enum': 'VncVencryptSubAuth',
597 'tls-none', 'x509-none',
598 'tls-vnc', 'x509-vnc',
599 'tls-plain', 'x509-plain',
600 'tls-sasl', 'x509-sasl' ],
606 # The network connection information for server
608 # @auth: The current authentication type used by the servers
610 # @vencrypt: The vencrypt sub authentication type used by the servers,
611 # only specified in case auth == vencrypt.
615 { 'struct': 'VncServerInfo2',
616 'base': 'VncBasicInfo',
617 'data': { 'auth' : 'VncPrimaryAuth',
618 '*vencrypt' : 'VncVencryptSubAuth' },
624 # Information about a vnc server
626 # @id: vnc server name.
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.
633 # @clients: A list of @VncClientInfo of all currently connected
634 # clients. The list can be empty, for obvious reasons.
636 # @auth: The current authentication type used by the non-websockets
639 # @vencrypt: The vencrypt authentication type used by the servers,
640 # only specified in case auth == vencrypt.
642 # @display: The display device the vnc server is linked to.
646 { 'struct': 'VncInfo2',
647 'data': { 'id' : 'str',
648 'server' : ['VncServerInfo2'],
649 'clients' : ['VncClientInfo'],
650 'auth' : 'VncPrimaryAuth',
651 '*vencrypt' : 'VncVencryptSubAuth',
652 '*display' : 'str' },
658 # Returns information about the current VNC server
666 # -> { "execute": "query-vnc" }
675 # "host":"127.0.0.1",
684 { 'command': 'query-vnc', 'returns': 'VncInfo',
687 # @query-vnc-servers:
689 # Returns a list of vnc servers. The list can be empty.
691 # Returns: a list of @VncInfo2
695 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'],
699 # @change-vnc-password:
701 # Change the VNC server password.
703 # @password: the new password to use with VNC authentication
707 # .. note:: An empty password in this command will set the password to
708 # the empty string. Existing clients are unaffected by executing
711 { 'command': 'change-vnc-password',
712 'data': { 'password': 'str' },
718 # Emitted when a VNC client establishes a connection
720 # @server: server information
722 # @client: client information
724 # .. note:: This event is emitted before any authentication takes place,
725 # thus the authentication ID is not provided.
731 # <- { "event": "VNC_CONNECTED",
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 } }
739 { 'event': 'VNC_CONNECTED',
740 'data': { 'server': 'VncServerInfo',
741 'client': 'VncBasicInfo' },
747 # Emitted after authentication takes place (if any) and the VNC
748 # session is made active
750 # @server: server information
752 # @client: client information
758 # <- { "event": "VNC_INITIALIZED",
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 } }
766 { 'event': 'VNC_INITIALIZED',
767 'data': { 'server': 'VncServerInfo',
768 'client': 'VncClientInfo' },
774 # Emitted when the connection is closed
776 # @server: server information
778 # @client: client information
784 # <- { "event": "VNC_DISCONNECTED",
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 } }
792 { 'event': 'VNC_DISCONNECTED',
793 'data': { 'server': 'VncServerInfo',
794 'client': 'VncClientInfo' },
804 # Information about a mouse device.
806 # @name: the name of the mouse device
808 # @index: the index of the mouse device
810 # @current: true if this device is currently receiving mouse events
812 # @absolute: true if this device supports absolute coordinates as
817 { 'struct': 'MouseInfo',
818 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
819 'absolute': 'bool'} }
824 # Returns information about each active mouse device
826 # Returns: a list of @MouseInfo for each device
832 # -> { "execute": "query-mice" }
835 # "name":"QEMU Microsoft Mouse",
841 # "name":"QEMU PS/2 Mouse",
849 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
854 # An enumeration of key name.
856 # This is used by the @send-key command.
858 # @unmapped: since 2.0
864 # @kp_comma: since 2.4
866 # @kp_equals: since 2.6
870 # @hiragana: since 2.9
880 # @audionext: since 2.10
882 # @audioprev: since 2.10
884 # @audiostop: since 2.10
886 # @audioplay: since 2.10
888 # @audiomute: since 2.10
890 # @volumeup: since 2.10
892 # @volumedown: since 2.10
894 # @mediaselect: since 2.10
898 # @calculator: since 2.10
900 # @computer: since 2.10
902 # @ac_home: since 2.10
904 # @ac_back: since 2.10
906 # @ac_forward: since 2.10
908 # @ac_refresh: since 2.10
910 # @ac_bookmarks: since 2.10
912 # @muhenkan: since 2.12
914 # @katakanahiragana: since 2.12
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.
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' ] }
982 { 'enum': 'KeyValueKind',
983 'data': [ 'number', 'qcode' ] }
988 # @data: a numeric key code
992 { 'struct': 'IntWrapper',
993 'data': { 'data': 'int' } }
998 # @data: An enumeration of key name
1002 { 'struct': 'QKeyCodeWrapper',
1003 'data': { 'data': 'QKeyCode' } }
1008 # Represents a keyboard key.
1010 # @type: key encoding
1014 { 'union': 'KeyValue',
1015 'base': { 'type': 'KeyValueKind' },
1016 'discriminator': 'type',
1018 'number': 'IntWrapper',
1019 'qcode': 'QKeyCodeWrapper' } }
1024 # Send keys to guest.
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
1031 # @hold-time: time to delay key up events, milliseconds. Defaults to
1035 # - If key is unknown or redundant, GenericError
1041 # -> { "execute": "send-key",
1042 # "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
1043 # { "type": "qcode", "data": "alt" },
1044 # { "type": "qcode", "data": "delete" } ] } }
1045 # <- { "return": {} }
1047 { 'command': 'send-key',
1048 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
1053 # Button of a pointer input device (mouse, tablet).
1055 # @side: front side button of a 5-button mouse (since 2.9)
1057 # @extra: rear side button of a 5-button mouse (since 2.9)
1059 # @touch: screen contact on a multi-touch device (since 8.1)
1063 { 'enum' : 'InputButton',
1064 'data' : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down', 'side',
1065 'extra', 'wheel-left', 'wheel-right', 'touch' ] }
1070 # Position axis of a pointer input device (mouse, tablet).
1074 { 'enum' : 'InputAxis',
1075 'data' : [ 'x', 'y' ] }
1078 # @InputMultiTouchType:
1080 # Type of a multi-touch event.
1082 # @begin: A new touch event sequence has just started.
1084 # @update: A touch event sequence has been updated.
1086 # @end: A touch event sequence has finished.
1088 # @cancel: A touch event sequence has been canceled.
1090 # @data: Absolute position data.
1094 { 'enum' : 'InputMultiTouchType',
1095 'data' : [ 'begin', 'update', 'end', 'cancel', 'data' ] }
1101 # Keyboard input event.
1103 # @key: Which key this event is for.
1105 # @down: True for key-down and false for key-up events.
1109 { 'struct' : 'InputKeyEvent',
1110 'data' : { 'key' : 'KeyValue',
1116 # Pointer button input event.
1118 # @button: Which button this event is for.
1120 # @down: True for key-down and false for key-up events.
1124 { 'struct' : 'InputBtnEvent',
1125 'data' : { 'button' : 'InputButton',
1131 # Pointer motion input event.
1133 # @axis: Which axis is referenced by @value.
1135 # @value: Pointer position. For absolute coordinates the valid range
1140 { 'struct' : 'InputMoveEvent',
1141 'data' : { 'axis' : 'InputAxis',
1145 # @InputMultiTouchEvent:
1147 # MultiTouch input event.
1149 # @type: The type of multi-touch event.
1151 # @slot: Which slot has generated the event.
1153 # @tracking-id: ID to correlate this event with previously generated
1156 # @axis: Which axis is referenced by @value.
1158 # @value: Contact position.
1162 { 'struct' : 'InputMultiTouchEvent',
1163 'data' : { 'type' : 'InputMultiTouchType',
1165 'tracking-id': 'int',
1166 'axis' : 'InputAxis',
1172 # @key: a keyboard input event
1174 # @btn: a pointer button input event
1176 # @rel: a relative pointer motion input event
1178 # @abs: an absolute pointer motion input event
1180 # @mtt: a multi-touch input event
1184 { 'enum': 'InputEventKind',
1185 'data': [ 'key', 'btn', 'rel', 'abs', 'mtt' ] }
1188 # @InputKeyEventWrapper:
1190 # @data: Keyboard input event
1194 { 'struct': 'InputKeyEventWrapper',
1195 'data': { 'data': 'InputKeyEvent' } }
1198 # @InputBtnEventWrapper:
1200 # @data: Pointer button input event
1204 { 'struct': 'InputBtnEventWrapper',
1205 'data': { 'data': 'InputBtnEvent' } }
1208 # @InputMoveEventWrapper:
1210 # @data: Pointer motion input event
1214 { 'struct': 'InputMoveEventWrapper',
1215 'data': { 'data': 'InputMoveEvent' } }
1218 # @InputMultiTouchEventWrapper:
1220 # @data: MultiTouch input event
1224 { 'struct': 'InputMultiTouchEventWrapper',
1225 'data': { 'data': 'InputMultiTouchEvent' } }
1230 # Input event union.
1232 # @type: the type of input event
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' } }
1246 # @input-send-event:
1248 # Send input event(s) to guest.
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
1261 # @device: display device to send event(s) to.
1263 # @head: head to send event(s) to, in case the display device supports
1264 # multiple scanouts.
1266 # @events: List of InputEvent union.
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.
1277 # 1. Press left mouse button.
1279 # -> { "execute": "input-send-event",
1280 # "arguments": { "device": "video0",
1281 # "events": [ { "type": "btn",
1282 # "data" : { "down": true, "button": "left" } } ] } }
1283 # <- { "return": {} }
1285 # -> { "execute": "input-send-event",
1286 # "arguments": { "device": "video0",
1287 # "events": [ { "type": "btn",
1288 # "data" : { "down": false, "button": "left" } } ] } }
1289 # <- { "return": {} }
1291 # 2. Press ctrl-alt-del.
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": {} }
1303 # 3. Move mouse pointer to absolute coordinates (20000, 400).
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": {} }
1311 { 'command': 'input-send-event',
1312 'data': { '*device': 'str',
1314 'events' : [ 'InputEvent' ] } }
1319 # GTK display options.
1321 # @grab-on-hover: Grab keyboard input on mouse hover.
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)
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)
1334 # @show-menubar: Display the main window menubar. Defaults to "on".
1339 { 'struct' : 'DisplayGTK',
1340 'data' : { '*grab-on-hover' : 'bool',
1341 '*zoom-to-fit' : 'bool',
1342 '*show-tabs' : 'bool',
1343 '*show-menubar' : 'bool' } }
1346 # @DisplayEGLHeadless:
1348 # EGL headless display options.
1350 # @rendernode: Which DRM render node should be used. Default is the
1351 # first available node on the host.
1355 { 'struct' : 'DisplayEGLHeadless',
1356 'data' : { '*rendernode' : 'str' } }
1361 # DBus display options.
1363 # @addr: The D-Bus bus address (default to the session bus).
1365 # @rendernode: Which DRM render node should be used. Default is the
1366 # first available node on the host.
1368 # @p2p: Whether to use peer-to-peer connections (accepted through
1371 # @audiodev: Use the specified DBus audiodev to export audio.
1375 { 'struct' : 'DisplayDBus',
1376 'data' : { '*rendernode' : 'str',
1379 '*audiodev': 'str' } }
1384 # Display OpenGL mode.
1386 # @off: Disable OpenGL (default).
1388 # @on: Use OpenGL, pick context type automatically. Would better be
1389 # named 'auto' but is called 'on' for backward compatibility with
1392 # @core: Use OpenGL with Core (desktop) Context.
1394 # @es: Use OpenGL with ES (embedded systems) Context.
1398 { 'enum' : 'DisplayGLMode',
1399 'data' : [ 'off', 'on', 'core', 'es' ] }
1404 # Curses display options.
1406 # @charset: Font charset used by guest (default: CP437).
1410 { 'struct' : 'DisplayCurses',
1411 'data' : { '*charset' : 'str' } }
1416 # Cocoa display options.
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"
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
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)
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)
1435 # @zoom-interpolation: Apply interpolation to smooth output when
1436 # zoom-to-fit is enabled. Defaults to "off". (Since 9.0)
1440 { 'struct': 'DisplayCocoa',
1442 '*left-command-key': 'bool',
1443 '*full-grab': 'bool',
1444 '*swap-opt-cmd': 'bool',
1445 '*zoom-to-fit': 'bool',
1446 '*zoom-interpolation': 'bool'
1452 # Set of modifier keys that need to be held for shortcut key actions.
1456 { 'enum' : 'HotKeyMod',
1457 'data' : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] }
1462 # SDL2 display options.
1464 # @grab-mod: Modifier keys that should be pressed together with the
1465 # "G" key to release the mouse grab.
1469 { 'struct' : 'DisplaySDL',
1470 'data' : { '*grab-mod' : 'HotKeyMod' } }
1475 # Display (user interface) type.
1477 # @default: The default user interface, selecting from the first
1478 # available of gtk, sdl, cocoa, and vnc.
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.
1484 # @gtk: The GTK user interface.
1486 # @sdl: The SDL user interface.
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)
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.
1499 # @cocoa: The Cocoa user interface.
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)
1505 # @dbus: Start a D-Bus service for the display. (Since 7.0)
1509 { 'enum' : 'DisplayType',
1511 { 'name': 'default' },
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' }
1526 # Display (user interface) options.
1528 # @type: Which DisplayType qemu should use.
1530 # @full-screen: Start user interface in fullscreen mode
1533 # @window-close: Allow to quit qemu with window close button
1536 # @show-cursor: Force showing the mouse cursor (default: off).
1539 # @gl: Enable OpenGL support (default: off).
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',
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' }
1562 # @query-display-options:
1564 # Returns information about display configuration
1566 # Returns: @DisplayOptions
1570 { 'command': 'query-display-options',
1571 'returns': 'DisplayOptions' }
1574 # @DisplayReloadType:
1576 # Available DisplayReload types.
1582 { 'enum': 'DisplayReloadType',
1586 # @DisplayReloadOptionsVNC:
1588 # Specify the VNC reload options.
1590 # @tls-certs: reload tls certs or not.
1594 { 'struct': 'DisplayReloadOptionsVNC',
1595 'data': { '*tls-certs': 'bool' } }
1598 # @DisplayReloadOptions:
1600 # Options of the display configuration reload.
1602 # @type: Specify the display type.
1606 { 'union': 'DisplayReloadOptions',
1607 'base': {'type': 'DisplayReloadType'},
1608 'discriminator': 'type',
1609 'data': { 'vnc': 'DisplayReloadOptionsVNC' } }
1614 # Reload display configuration.
1620 # -> { "execute": "display-reload",
1621 # "arguments": { "type": "vnc", "tls-certs": true } }
1622 # <- { "return": {} }
1624 { 'command': 'display-reload',
1625 'data': 'DisplayReloadOptions',
1629 # @DisplayUpdateType:
1631 # Available DisplayUpdate types.
1637 { 'enum': 'DisplayUpdateType',
1641 # @DisplayUpdateOptionsVNC:
1643 # Specify the VNC reload options.
1645 # @addresses: If specified, change set of addresses to listen for
1646 # connections. Addresses configured for websockets are not
1651 { 'struct': 'DisplayUpdateOptionsVNC',
1652 'data': { '*addresses': ['SocketAddress'] } }
1655 # @DisplayUpdateOptions:
1657 # Options of the display configuration reload.
1659 # @type: Specify the display type.
1663 { 'union': 'DisplayUpdateOptions',
1664 'base': {'type': 'DisplayUpdateType'},
1665 'discriminator': 'type',
1666 'data': { 'vnc': 'DisplayUpdateOptionsVNC' } }
1671 # Update display configuration.
1677 # -> { "execute": "display-update",
1678 # "arguments": { "type": "vnc", "addresses":
1679 # [ { "type": "inet", "host": "0.0.0.0",
1680 # "port": "5901" } ] } }
1681 # <- { "return": {} }
1683 { 'command': 'display-update',
1684 'data': 'DisplayUpdateOptions',
1688 # @client_migrate_info:
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.
1694 # @protocol: must be "spice"
1696 # @hostname: migration target hostname
1698 # @port: spice tcp port for plaintext channels
1700 # @tls-port: spice tcp port for tls-secured channels
1702 # @cert-subject: server certificate subject
1708 # -> { "execute": "client_migrate_info",
1709 # "arguments": { "protocol": "spice",
1710 # "hostname": "virt42.lab.kraxel.org",
1712 # <- { "return": {} }
1714 { 'command': 'client_migrate_info',
1715 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
1716 '*tls-port': 'int', '*cert-subject': 'str' } }