qemu/qapi/char.json

1 # -*- Mode: Python -*-
20 # @frontend-open: shows whether the frontend device attached to this
32             'frontend-open': 'bool' } }
35 # @query-chardev:
43 # .. qmp-example::
45 #     -> { "execute": "query-chardev" }
46 #     <- {
51 #                 "frontend-open": false
56 #                 "frontend-open": true
61 #                 "frontend-open": true
66 { 'command': 'query-chardev', 'returns': ['ChardevInfo'],
67   'allow-preconfig': true }
81 # @query-chardev-backends:
89 # .. qmp-example::
91 #     -> { "execute": "query-chardev-backends" }
92 #     <- {
109 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
116 # @utf8: Data is a UTF-8 string (RFC 3629)
126 # @ringbuf-write:
136 #     - base64: data must be base64 encoded text.  Its binary decoding
138 #     - utf8: data's UTF-8 encoding is written
139 #     - data itself is always Unicode regardless of format, like any
144 # .. qmp-example::
146 #     -> { "execute": "ringbuf-write",
150 #     <- { "return": {} }
152 { 'command': 'ringbuf-write',
158 # @ringbuf-read:
168 #     - base64: the data read is returned in base64 encoding.
169 #     - utf8: the data read is interpreted as UTF-8.
170 #       Bug: can screw up when the buffer contains invalid UTF-8
173 #     - The return value is always Unicode regardless of format, like
180 # .. qmp-example::
182 #     -> { "execute": "ringbuf-read",
186 #     <- { "return": "abcdefgh" }
188 { 'command': 'ringbuf-read',
250 # @tls-creds: the ID of the TLS credentials object (since 2.6)
252 # @tls-authz: the ID of the QAuthZ authorization object against which
277 #     deprecated, use @reconnect-ms instead. (default: 0) (Since: 2.2)
279 # @reconnect-ms: For a client socket, if a socket is disconnected,
287 # @deprecated: Member @reconnect is deprecated.  Use @reconnect-ms
294             '*tls-creds': 'str',
295             '*tls-authz'  : 'str',
303             '*reconnect-ms': 'int' },
368 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
382 # @name: name of the channel (following docs/spice-port-fqdn.txt)
404 # .. note:: The options are only effective when the VNC or SDL
406 #    GTK, Spice, VNC and D-Bus display backends.
435 # @mouse: enable/disable mouse, default is enabled.
437 # @clipboard: enable/disable clipboard, default is disabled.
476 # @pty: pseudo-terminal
488 # @testdev: device for test-suite control (since 2.2)
498 # @qemu-vdagent: Spice vdagent (since 6.1)
500 # @dbus: D-Bus channel (since 7.0)
532             { 'name': 'qemu-vdagent', 'if': 'CONFIG_SPICE_PROTOCOL' },
718             'qemu-vdagent': { 'type': 'ChardevQemuVDAgentWrapper',
740 # @chardev-add:
752 # .. qmp-example::
754 #     -> { "execute" : "chardev-add",
757 #     <- { "return": {} }
759 # .. qmp-example::
761 #     -> { "execute" : "chardev-add",
765 #     <- { "return": {} }
767 # .. qmp-example::
769 #     -> { "execute" : "chardev-add",
772 #     <- { "return": { "pty" : "/dev/pty/42" } }
774 { 'command': 'chardev-add',
780 # @chardev-change:
792 # .. qmp-example::
794 #     -> { "execute" : "chardev-change",
797 #     <- { "return": { "pty" : "/dev/pty/42" } }
799 # .. qmp-example::
801 #     -> {"execute" : "chardev-change",
815 #     <- {"return": {}}
817 { 'command': 'chardev-change',
823 # @chardev-remove:
831 # .. qmp-example::
833 #     -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
834 #     <- { "return": {} }
836 { 'command': 'chardev-remove',
840 # @chardev-send-break:
848 # .. qmp-example::
850 #     -> { "execute": "chardev-send-break", "arguments": { "id" : "foo" } }
851 #     <- { "return": {} }
853 { 'command': 'chardev-send-break',
859 # Emitted when the guest opens or closes a virtio-serial port.
861 # @id: device identifier of the virtio-serial port
863 # @open: true if the guest has opened the virtio-serial port
865 # .. note:: This event is rate-limited.
869 # .. qmp-example::
871 #     <- { "event": "VSERPORT_CHANGE",