8 { 'include': 'sockets.json' }
13 # Sets the password of a remote display session.
15 # @protocol: `vnc' to modify the VNC server password
16 # `spice' to modify the Spice server password
18 # @password: the new password
20 # @connected: how to handle existing clients when changing the
21 # password. If nothing is specified, defaults to `keep'
22 # `fail' to fail the command if clients are connected
23 # `disconnect' to disconnect existing clients
24 # `keep' to maintain existing clients
26 # Returns: Nothing on success
27 # If Spice is not enabled, DeviceNotFound
33 # -> { "execute": "set_password", "arguments": { "protocol": "vnc",
34 # "password": "secret" } }
38 { 'command': 'set_password',
39 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
44 # Expire the password of a remote display server.
46 # @protocol: the name of the remote display protocol `vnc' or `spice'
48 # @time: when to expire the password.
49 # `now' to expire the password immediately
50 # `never' to cancel password expiration
51 # `+INT' where INT is the number of seconds from now (integer)
52 # `INT' where INT is the absolute time in seconds
54 # Returns: Nothing on success
55 # If @protocol is `spice' and Spice is not active, DeviceNotFound
59 # Notes: Time is relative to the server and currently there is no way to
60 # coordinate server time with client time. It is not recommended to
61 # use the absolute time version of the @time parameter unless you're
62 # sure you are on the same machine as the QEMU instance.
66 # -> { "execute": "expire_password", "arguments": { "protocol": "vnc",
71 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
76 # Write a PPM of the VGA screen to a file.
78 # @filename: the path of a new PPM file to store the image
80 # @device: ID of the display device that should be dumped. If this parameter
81 # is missing, the primary display will be used. (Since 2.12)
83 # @head: head to use in case the device supports multiple heads. If this
84 # parameter is missing, head #0 will be used. Also note that the head
85 # can only be specified in conjunction with the device ID. (Since 2.12)
87 # Returns: Nothing on success
93 # -> { "execute": "screendump",
94 # "arguments": { "filename": "/tmp/image" } }
98 { 'command': 'screendump',
99 'data': {'filename': 'str', '*device': 'str', '*head': 'int'} }
108 # The basic information for SPICE network connection
114 # @family: address family
118 { 'struct': 'SpiceBasicInfo',
119 'data': { 'host': 'str',
121 'family': 'NetworkAddressFamily' },
122 'if': 'defined(CONFIG_SPICE)' }
127 # Information about a SPICE server
129 # @auth: authentication method
133 { 'struct': 'SpiceServerInfo',
134 'base': 'SpiceBasicInfo',
135 'data': { '*auth': 'str' },
136 'if': 'defined(CONFIG_SPICE)' }
141 # Information about a SPICE client channel.
143 # @connection-id: SPICE connection id number. All channels with the same id
144 # belong to the same SPICE session.
146 # @channel-type: SPICE channel type number. "1" is the main control
147 # channel, filter for this one if you want to track spice
150 # @channel-id: SPICE channel ID number. Usually "0", might be different when
151 # multiple channels of the same type exist, such as multiple
152 # display channels in a multihead setup
154 # @tls: true if the channel is encrypted, false otherwise.
158 { 'struct': 'SpiceChannel',
159 'base': 'SpiceBasicInfo',
160 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
162 'if': 'defined(CONFIG_SPICE)' }
165 # @SpiceQueryMouseMode:
167 # An enumeration of Spice mouse states.
169 # @client: Mouse cursor position is determined by the client.
171 # @server: Mouse cursor position is determined by the server.
173 # @unknown: No information is available about mouse mode used by
176 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
180 { 'enum': 'SpiceQueryMouseMode',
181 'data': [ 'client', 'server', 'unknown' ],
182 'if': 'defined(CONFIG_SPICE)' }
187 # Information about the SPICE session.
189 # @enabled: true if the SPICE server is enabled, false otherwise
191 # @migrated: true if the last guest migration completed and spice
192 # migration had completed as well. false otherwise. (since 1.4)
194 # @host: The hostname the SPICE server is bound to. This depends on
195 # the name resolution on the host and may be an IP address.
197 # @port: The SPICE server's port number.
199 # @compiled-version: SPICE server version.
201 # @tls-port: The SPICE server's TLS port number.
203 # @auth: the current authentication type used by the server
204 # 'none' if no authentication is being used
205 # 'spice' uses SASL or direct TLS authentication, depending on command
208 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
209 # be determined by the client or the server, or unknown if spice
210 # server doesn't provide this information. (since: 1.1)
212 # @channels: a list of @SpiceChannel for each active spice channel
216 { 'struct': 'SpiceInfo',
217 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
218 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
219 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']},
220 'if': 'defined(CONFIG_SPICE)' }
225 # Returns information about the current SPICE server
227 # Returns: @SpiceInfo
233 # -> { "execute": "query-spice" }
245 # "connection-id": 1804289383,
246 # "host": "127.0.0.1",
254 # "connection-id": 1804289383,
255 # "host": "127.0.0.1",
259 # [ ... more channels follow ... ]
265 { 'command': 'query-spice', 'returns': 'SpiceInfo',
266 'if': 'defined(CONFIG_SPICE)' }
271 # Emitted when a SPICE client establishes a connection
273 # @server: server information
275 # @client: client information
281 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
282 # "event": "SPICE_CONNECTED",
284 # "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
285 # "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
289 { 'event': 'SPICE_CONNECTED',
290 'data': { 'server': 'SpiceBasicInfo',
291 'client': 'SpiceBasicInfo' },
292 'if': 'defined(CONFIG_SPICE)' }
295 # @SPICE_INITIALIZED:
297 # Emitted after initial handshake and authentication takes place (if any)
298 # and the SPICE channel is up and running
300 # @server: server information
302 # @client: client information
308 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
309 # "event": "SPICE_INITIALIZED",
310 # "data": {"server": {"auth": "spice", "port": "5921",
311 # "family": "ipv4", "host": "127.0.0.1"},
312 # "client": {"port": "49004", "family": "ipv4", "channel-type": 3,
313 # "connection-id": 1804289383, "host": "127.0.0.1",
314 # "channel-id": 0, "tls": true}
318 { 'event': 'SPICE_INITIALIZED',
319 'data': { 'server': 'SpiceServerInfo',
320 'client': 'SpiceChannel' },
321 'if': 'defined(CONFIG_SPICE)' }
324 # @SPICE_DISCONNECTED:
326 # Emitted when the SPICE connection is closed
328 # @server: server information
330 # @client: client information
336 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707},
337 # "event": "SPICE_DISCONNECTED",
339 # "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
340 # "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
344 { 'event': 'SPICE_DISCONNECTED',
345 'data': { 'server': 'SpiceBasicInfo',
346 'client': 'SpiceBasicInfo' },
347 'if': 'defined(CONFIG_SPICE)' }
350 # @SPICE_MIGRATE_COMPLETED:
352 # Emitted when SPICE migration has completed
358 # <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172},
359 # "event": "SPICE_MIGRATE_COMPLETED" }
362 { 'event': 'SPICE_MIGRATE_COMPLETED',
363 'if': 'defined(CONFIG_SPICE)' }
372 # The basic information for vnc network connection
376 # @service: The service name of the vnc port. This may depend on the host
377 # system's service database so symbolic names should not be relied
380 # @family: address family
382 # @websocket: true in case the socket is a websocket (since 2.3).
386 { 'struct': 'VncBasicInfo',
387 'data': { 'host': 'str',
389 'family': 'NetworkAddressFamily',
390 'websocket': 'bool' },
391 'if': 'defined(CONFIG_VNC)' }
396 # The network connection information for server
398 # @auth: authentication method used for
399 # the plain (non-websocket) VNC server
403 { 'struct': 'VncServerInfo',
404 'base': 'VncBasicInfo',
405 'data': { '*auth': 'str' },
406 'if': 'defined(CONFIG_VNC)' }
411 # Information about a connected VNC client.
413 # @x509_dname: If x509 authentication is in use, the Distinguished
414 # Name of the client.
416 # @sasl_username: If SASL authentication is in use, the SASL username
417 # used for authentication.
421 { 'struct': 'VncClientInfo',
422 'base': 'VncBasicInfo',
423 'data': { '*x509_dname': 'str', '*sasl_username': 'str' },
424 'if': 'defined(CONFIG_VNC)' }
429 # Information about the VNC session.
431 # @enabled: true if the VNC server is enabled, false otherwise
433 # @host: The hostname the VNC server is bound to. This depends on
434 # the name resolution on the host and may be an IP address.
436 # @family: 'ipv6' if the host is listening for IPv6 connections
437 # 'ipv4' if the host is listening for IPv4 connections
438 # 'unix' if the host is listening on a unix domain socket
439 # 'unknown' otherwise
441 # @service: The service name of the server's port. This may depends
442 # on the host system's service database so symbolic names should not
445 # @auth: the current authentication type used by the server
446 # 'none' if no authentication is being used
447 # 'vnc' if VNC authentication is being used
448 # 'vencrypt+plain' if VEncrypt is used with plain text authentication
449 # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
450 # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
451 # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
452 # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
453 # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
454 # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
455 # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
456 # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
458 # @clients: a list of @VncClientInfo of all currently connected clients
462 { 'struct': 'VncInfo',
463 'data': {'enabled': 'bool', '*host': 'str',
464 '*family': 'NetworkAddressFamily',
465 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']},
466 'if': 'defined(CONFIG_VNC)' }
471 # vnc primary authentication method.
475 { 'enum': 'VncPrimaryAuth',
476 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
477 'tls', 'vencrypt', 'sasl' ],
478 'if': 'defined(CONFIG_VNC)' }
481 # @VncVencryptSubAuth:
483 # vnc sub authentication method with vencrypt.
487 { 'enum': 'VncVencryptSubAuth',
489 'tls-none', 'x509-none',
490 'tls-vnc', 'x509-vnc',
491 'tls-plain', 'x509-plain',
492 'tls-sasl', 'x509-sasl' ],
493 'if': 'defined(CONFIG_VNC)' }
498 # The network connection information for server
500 # @auth: The current authentication type used by the servers
502 # @vencrypt: The vencrypt sub authentication type used by the
503 # servers, only specified in case auth == vencrypt.
507 { 'struct': 'VncServerInfo2',
508 'base': 'VncBasicInfo',
509 'data': { 'auth' : 'VncPrimaryAuth',
510 '*vencrypt' : 'VncVencryptSubAuth' },
511 'if': 'defined(CONFIG_VNC)' }
516 # Information about a vnc server
518 # @id: vnc server name.
520 # @server: A list of @VncBasincInfo describing all listening sockets.
521 # The list can be empty (in case the vnc server is disabled).
522 # It also may have multiple entries: normal + websocket,
523 # possibly also ipv4 + ipv6 in the future.
525 # @clients: A list of @VncClientInfo of all currently connected clients.
526 # The list can be empty, for obvious reasons.
528 # @auth: The current authentication type used by the non-websockets servers
530 # @vencrypt: The vencrypt authentication type used by the servers,
531 # only specified in case auth == vencrypt.
533 # @display: The display device the vnc server is linked to.
537 { 'struct': 'VncInfo2',
538 'data': { 'id' : 'str',
539 'server' : ['VncServerInfo2'],
540 'clients' : ['VncClientInfo'],
541 'auth' : 'VncPrimaryAuth',
542 '*vencrypt' : 'VncVencryptSubAuth',
543 '*display' : 'str' },
544 'if': 'defined(CONFIG_VNC)' }
549 # Returns information about the current VNC server
557 # -> { "execute": "query-vnc" }
566 # "host":"127.0.0.1",
575 { 'command': 'query-vnc', 'returns': 'VncInfo',
576 'if': 'defined(CONFIG_VNC)' }
578 # @query-vnc-servers:
580 # Returns a list of vnc servers. The list can be empty.
582 # Returns: a list of @VncInfo2
586 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'],
587 'if': 'defined(CONFIG_VNC)' }
590 # @change-vnc-password:
592 # Change the VNC server password.
594 # @password: the new password to use with VNC authentication
598 # Notes: An empty password in this command will set the password to the empty
599 # string. Existing clients are unaffected by executing this command.
601 { 'command': 'change-vnc-password',
602 'data': { 'password': 'str' },
603 'if': 'defined(CONFIG_VNC)' }
608 # Emitted when a VNC client establishes a connection
610 # @server: server information
612 # @client: client information
614 # Note: This event is emitted before any authentication takes place, thus
615 # the authentication ID is not provided
621 # <- { "event": "VNC_CONNECTED",
623 # "server": { "auth": "sasl", "family": "ipv4",
624 # "service": "5901", "host": "0.0.0.0" },
625 # "client": { "family": "ipv4", "service": "58425",
626 # "host": "127.0.0.1" } },
627 # "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
630 { 'event': 'VNC_CONNECTED',
631 'data': { 'server': 'VncServerInfo',
632 'client': 'VncBasicInfo' },
633 'if': 'defined(CONFIG_VNC)' }
638 # Emitted after authentication takes place (if any) and the VNC session is
641 # @server: server information
643 # @client: client information
649 # <- { "event": "VNC_INITIALIZED",
651 # "server": { "auth": "sasl", "family": "ipv4",
652 # "service": "5901", "host": "0.0.0.0"},
653 # "client": { "family": "ipv4", "service": "46089",
654 # "host": "127.0.0.1", "sasl_username": "luiz" } },
655 # "timestamp": { "seconds": 1263475302, "microseconds": 150772 } }
658 { 'event': 'VNC_INITIALIZED',
659 'data': { 'server': 'VncServerInfo',
660 'client': 'VncClientInfo' },
661 'if': 'defined(CONFIG_VNC)' }
666 # Emitted when the connection is closed
668 # @server: server information
670 # @client: client information
676 # <- { "event": "VNC_DISCONNECTED",
678 # "server": { "auth": "sasl", "family": "ipv4",
679 # "service": "5901", "host": "0.0.0.0" },
680 # "client": { "family": "ipv4", "service": "58425",
681 # "host": "127.0.0.1", "sasl_username": "luiz" } },
682 # "timestamp": { "seconds": 1262976601, "microseconds": 975795 } }
685 { 'event': 'VNC_DISCONNECTED',
686 'data': { 'server': 'VncServerInfo',
687 'client': 'VncClientInfo' },
688 'if': 'defined(CONFIG_VNC)' }
697 # Information about a mouse device.
699 # @name: the name of the mouse device
701 # @index: the index of the mouse device
703 # @current: true if this device is currently receiving mouse events
705 # @absolute: true if this device supports absolute coordinates as input
709 { 'struct': 'MouseInfo',
710 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
711 'absolute': 'bool'} }
716 # Returns information about each active mouse device
718 # Returns: a list of @MouseInfo for each device
724 # -> { "execute": "query-mice" }
727 # "name":"QEMU Microsoft Mouse",
733 # "name":"QEMU PS/2 Mouse",
742 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
747 # An enumeration of key name.
749 # This is used by the @send-key command.
751 # @unmapped: since 2.0
754 # @kp_comma: since 2.4
755 # @kp_equals: since 2.6
757 # @hiragana: since 2.9
763 # @audionext: since 2.10
764 # @audioprev: since 2.10
765 # @audiostop: since 2.10
766 # @audioplay: since 2.10
767 # @audiomute: since 2.10
768 # @volumeup: since 2.10
769 # @volumedown: since 2.10
770 # @mediaselect: since 2.10
772 # @calculator: since 2.10
773 # @computer: since 2.10
774 # @ac_home: since 2.10
775 # @ac_back: since 2.10
776 # @ac_forward: since 2.10
777 # @ac_refresh: since 2.10
778 # @ac_bookmarks: since 2.10
779 # altgr, altgr_r: dropped in 2.10
781 # @muhenkan: since 2.12
782 # @katakanahiragana: since 2.12
784 # 'sysrq' was mistakenly added to hack around the fact that
785 # the ps2 driver was not generating correct scancodes sequences
786 # when 'alt+print' was pressed. This flaw is now fixed and the
787 # 'sysrq' key serves no further purpose. Any further use of
788 # 'sysrq' will be transparently changed to 'print', so they
789 # are effectively synonyms.
794 { 'enum': 'QKeyCode',
795 'data': [ 'unmapped',
796 'shift', 'shift_r', 'alt', 'alt_r', 'ctrl',
797 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
798 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
799 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
800 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
801 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
802 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
803 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
804 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
805 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
806 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
807 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
808 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
809 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
810 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause',
811 'ro', 'hiragana', 'henkan', 'yen', 'muhenkan', 'katakanahiragana',
812 'kp_comma', 'kp_equals', 'power', 'sleep', 'wake',
813 'audionext', 'audioprev', 'audiostop', 'audioplay', 'audiomute',
814 'volumeup', 'volumedown', 'mediaselect',
815 'mail', 'calculator', 'computer',
816 'ac_home', 'ac_back', 'ac_forward', 'ac_refresh', 'ac_bookmarks' ] }
821 # Represents a keyboard key.
825 { 'union': 'KeyValue',
828 'qcode': 'QKeyCode' } }
833 # Send keys to guest.
835 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
836 # simultaneously sent to the guest. A @KeyValue.number value is sent
837 # directly to the guest, while @KeyValue.qcode must be a valid
840 # @hold-time: time to delay key up events, milliseconds. Defaults
843 # Returns: Nothing on success
844 # If key is unknown or redundant, InvalidParameter
850 # -> { "execute": "send-key",
851 # "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
852 # { "type": "qcode", "data": "alt" },
853 # { "type": "qcode", "data": "delete" } ] } }
854 # <- { "return": {} }
857 { 'command': 'send-key',
858 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
863 # Button of a pointer input device (mouse, tablet).
865 # @side: front side button of a 5-button mouse (since 2.9)
867 # @extra: rear side button of a 5-button mouse (since 2.9)
871 { 'enum' : 'InputButton',
872 'data' : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down', 'side',
878 # Position axis of a pointer input device (mouse, tablet).
882 { 'enum' : 'InputAxis',
883 'data' : [ 'x', 'y' ] }
888 # Keyboard input event.
890 # @key: Which key this event is for.
891 # @down: True for key-down and false for key-up events.
895 { 'struct' : 'InputKeyEvent',
896 'data' : { 'key' : 'KeyValue',
902 # Pointer button input event.
904 # @button: Which button this event is for.
905 # @down: True for key-down and false for key-up events.
909 { 'struct' : 'InputBtnEvent',
910 'data' : { 'button' : 'InputButton',
916 # Pointer motion input event.
918 # @axis: Which axis is referenced by @value.
919 # @value: Pointer position. For absolute coordinates the
920 # valid range is 0 -> 0x7ffff
924 { 'struct' : 'InputMoveEvent',
925 'data' : { 'axis' : 'InputAxis',
933 # @type: the input type, one of:
934 # - 'key': Input event of Keyboard
935 # - 'btn': Input event of pointer buttons
936 # - 'rel': Input event of relative pointer motion
937 # - 'abs': Input event of absolute pointer motion
941 { 'union' : 'InputEvent',
942 'data' : { 'key' : 'InputKeyEvent',
943 'btn' : 'InputBtnEvent',
944 'rel' : 'InputMoveEvent',
945 'abs' : 'InputMoveEvent' } }
950 # Send input event(s) to guest.
952 # @device: display device to send event(s) to.
953 # @head: head to send event(s) to, in case the
954 # display device supports multiple scanouts.
955 # @events: List of InputEvent union.
957 # Returns: Nothing on success.
959 # The @device and @head parameters can be used to send the input event
960 # to specific input devices in case (a) multiple input devices of the
961 # same kind are added to the virtual machine and (b) you have
962 # configured input routing (see docs/multiseat.txt) for those input
963 # devices. The parameters work exactly like the device and head
964 # properties of input devices. If @device is missing, only devices
965 # that have no input routing config are admissible. If @device is
966 # specified, both input devices with and without input routing config
967 # are admissible, but devices with input routing config take
972 # Note: The consoles are visible in the qom tree, under
973 # /backend/console[$index]. They have a device link and head property,
974 # so it is possible to map which console belongs to which device and
979 # 1. Press left mouse button.
981 # -> { "execute": "input-send-event",
982 # "arguments": { "device": "video0",
983 # "events": [ { "type": "btn",
984 # "data" : { "down": true, "button": "left" } } ] } }
985 # <- { "return": {} }
987 # -> { "execute": "input-send-event",
988 # "arguments": { "device": "video0",
989 # "events": [ { "type": "btn",
990 # "data" : { "down": false, "button": "left" } } ] } }
991 # <- { "return": {} }
993 # 2. Press ctrl-alt-del.
995 # -> { "execute": "input-send-event",
996 # "arguments": { "events": [
997 # { "type": "key", "data" : { "down": true,
998 # "key": {"type": "qcode", "data": "ctrl" } } },
999 # { "type": "key", "data" : { "down": true,
1000 # "key": {"type": "qcode", "data": "alt" } } },
1001 # { "type": "key", "data" : { "down": true,
1002 # "key": {"type": "qcode", "data": "delete" } } } ] } }
1003 # <- { "return": {} }
1005 # 3. Move mouse pointer to absolute coordinates (20000, 400).
1007 # -> { "execute": "input-send-event" ,
1008 # "arguments": { "events": [
1009 # { "type": "abs", "data" : { "axis": "x", "value" : 20000 } },
1010 # { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
1011 # <- { "return": {} }
1014 { 'command': 'input-send-event',
1015 'data': { '*device': 'str',
1017 'events' : [ 'InputEvent' ] } }
1022 # Keys to toggle input-linux between host and guest.
1027 { 'enum': 'GrabToggleKeys',
1028 'data': [ 'ctrl-ctrl', 'alt-alt', 'meta-meta', 'scrolllock', 'ctrl-scrolllock' ] }
1033 # GTK display options.
1035 # @grab-on-hover: Grab keyboard input on mouse hover.
1036 # @zoom-to-fit: Zoom guest display to fit into the host window. When
1037 # turned off the host window will be resized instead.
1038 # In case the display device can notify the guest on
1039 # window resizes (virtio-gpu) this will default to "on",
1040 # assuming the guest will resize the display to match
1041 # the window size then. Otherwise it defaults to "off".
1047 { 'struct' : 'DisplayGTK',
1048 'data' : { '*grab-on-hover' : 'bool',
1049 '*zoom-to-fit' : 'bool' } }
1052 # @DisplayEGLHeadless:
1054 # EGL headless display options.
1056 # @rendernode: Which DRM render node should be used. Default is the first
1057 # available node on the host.
1062 { 'struct' : 'DisplayEGLHeadless',
1063 'data' : { '*rendernode' : 'str' } }
1068 # Display OpenGL mode.
1070 # @off: Disable OpenGL (default).
1071 # @on: Use OpenGL, pick context type automatically.
1072 # Would better be named 'auto' but is called 'on' for backward
1073 # compatibility with bool type.
1074 # @core: Use OpenGL with Core (desktop) Context.
1075 # @es: Use OpenGL with ES (embedded systems) Context.
1080 { 'enum' : 'DisplayGLMode',
1081 'data' : [ 'off', 'on', 'core', 'es' ] }
1086 # Curses display options.
1088 # @charset: Font charset used by guest (default: CP437).
1093 { 'struct' : 'DisplayCurses',
1094 'data' : { '*charset' : 'str' } }
1099 # Display (user interface) type.
1101 # @default: The default user interface, selecting from the first available
1102 # of gtk, sdl, cocoa, and vnc.
1104 # @none: No user interface or video output display. The guest will
1105 # still see an emulated graphics card, but its output will not
1106 # be displayed to the QEMU user.
1108 # @gtk: The GTK user interface.
1110 # @sdl: The SDL user interface.
1112 # @egl-headless: No user interface, offload GL operations to a local
1113 # DRI device. Graphical display need to be paired with
1114 # VNC or Spice. (Since 3.1)
1116 # @curses: Display video output via curses. For graphics device
1117 # models which support a text mode, QEMU can display this
1118 # output using a curses/ncurses interface. Nothing is
1119 # displayed when the graphics device is in graphical mode or
1120 # if the graphics device does not support a text
1121 # mode. Generally only the VGA device models support text
1124 # @cocoa: The Cocoa user interface.
1126 # @spice-app: Set up a Spice server and run the default associated
1127 # application to connect to it. The server will redirect
1128 # the serial console and QEMU monitors. (Since 4.0)
1133 { 'enum' : 'DisplayType',
1134 'data' : [ 'default', 'none', 'gtk', 'sdl',
1135 'egl-headless', 'curses', 'cocoa',
1141 # Display (user interface) options.
1143 # @type: Which DisplayType qemu should use.
1144 # @full-screen: Start user interface in fullscreen mode (default: off).
1145 # @window-close: Allow to quit qemu with window close button (default: on).
1146 # @gl: Enable OpenGL support (default: off).
1151 { 'union' : 'DisplayOptions',
1152 'base' : { 'type' : 'DisplayType',
1153 '*full-screen' : 'bool',
1154 '*window-close' : 'bool',
1155 '*gl' : 'DisplayGLMode' },
1156 'discriminator' : 'type',
1157 'data' : { 'gtk' : 'DisplayGTK',
1158 'curses' : 'DisplayCurses',
1159 'egl-headless' : 'DisplayEGLHeadless'} }
1162 # @query-display-options:
1164 # Returns information about display configuration
1166 # Returns: @DisplayOptions
1171 { 'command': 'query-display-options',
1172 'returns': 'DisplayOptions' }